WEBDEV-6399 Legacy caching params (#44)

* Translate legacy caching params into PPS equivalents * Enable debugging for both 'debugging' and 'cacheDebug' aliases * Add unit tests
internetarchive · Nov 10, 2023 · 56d2952 · 56d2952
1 parent 937e063
commit 56d2952
Show file tree

Hide file tree

Showing 3 changed files with 127 additions and 10 deletions.
diff --git a/src/search-backend/base-search-backend.ts b/src/search-backend/base-search-backend.ts
@@ -8,6 +8,15 @@ import {
 } from '../search-service-error';
 import type { SearchBackendOptionsInterface } from './search-backend-options';
 
+/**
+ * Map from URL aliases for caching strategies to the corresponding PPS flags
+ */
+const CACHING_ALIASES: Record<string, string> = {
+  reCache: JSON.stringify({ recompute: true }),
+  noCache: JSON.stringify({ bypass: true }),
+  dontCache: JSON.stringify({ no_compute: true }),
+};
+
 /**
  * An abstract base class for search backends.
  */
@@ -30,7 +39,6 @@ export abstract class BaseSearchBackend implements SearchBackendInterface {
 
   constructor(options?: SearchBackendOptionsInterface) {
     this.baseUrl = options?.baseUrl ?? 'archive.org';
-    this.debuggingEnabled = options?.debuggingEnabled ?? false;
 
     if (options?.includeCredentials !== undefined) {
       this.includeCredentials = options.includeCredentials;
@@ -44,23 +52,42 @@ export abstract class BaseSearchBackend implements SearchBackendInterface {
         null;
     }
 
-    const currentUrl = new URL(window.location.href);
-    const scopeParam = currentUrl.searchParams.get('scope');
-    const cachingParam = currentUrl.searchParams.get('caching');
-    const verboseParam = currentUrl.searchParams.get('verbose');
-
-    if (options?.scope !== undefined) {
-      this.requestScope = options.scope;
-    } else if (scopeParam) {
-      this.requestScope = scopeParam;
+    const searchParams = new URL(window.location.href).searchParams;
+    const scopeParam = searchParams.get('scope');
+    const verboseParam = searchParams.get('verbose');
+    const debuggingParam = searchParams.get('debugging');
+    const cacheDebugParam = searchParams.get('cacheDebug');
+
+    // Caching param aliases
+    let cachingParam = '';
+    for (const alias of Object.keys(CACHING_ALIASES)) {
+      if (searchParams.get(alias)) {
+        cachingParam = CACHING_ALIASES[alias];
+        break;
+      }
     }
 
+    // Explicit PPS caching param overrides any aliases
+    cachingParam = searchParams.get('caching') ?? cachingParam;
+
     if (options?.caching !== undefined) {
       this.cachingFlags = options.caching;
     } else if (cachingParam) {
       this.cachingFlags = cachingParam;
     }
 
+    if (options?.debuggingEnabled !== undefined) {
+      this.debuggingEnabled = options.debuggingEnabled;
+    } else if (debuggingParam || cacheDebugParam) {
+      this.debuggingEnabled = true;
+    }
+
+    if (options?.scope !== undefined) {
+      this.requestScope = options.scope;
+    } else if (scopeParam) {
+      this.requestScope = scopeParam;
+    }
+
     if (options?.verbose !== undefined) {
       this.verbose = options.verbose;
     } else if (verboseParam) {

diff --git a/test/search-backend/fulltext-search-backend.test.ts b/test/search-backend/fulltext-search-backend.test.ts
@@ -118,6 +118,51 @@ describe('FulltextSearchBackend', () => {
       window.history.replaceState({}, '', url.toString());
     });
 
+    it('includes reCache param from URL if not provided', async () => {
+      const url = new URL(window.location.href);
+      url.searchParams.set('reCache', '1');
+      window.history.replaceState({}, '', url.toString());
+
+      const backend = new FulltextSearchBackend();
+      await backend.performSearch({ query: 'foo' });
+
+      const queryParams = new URL(urlCalled!.toString()).searchParams;
+      expect(queryParams.get('caching')).to.equal('{"recompute":true}');
+
+      url.searchParams.delete('reCache');
+      window.history.replaceState({}, '', url.toString());
+    });
+
+    it('includes noCache param from URL if not provided', async () => {
+      const url = new URL(window.location.href);
+      url.searchParams.set('noCache', '1');
+      window.history.replaceState({}, '', url.toString());
+
+      const backend = new FulltextSearchBackend();
+      await backend.performSearch({ query: 'foo' });
+
+      const queryParams = new URL(urlCalled!.toString()).searchParams;
+      expect(queryParams.get('caching')).to.equal('{"bypass":true}');
+
+      url.searchParams.delete('noCache');
+      window.history.replaceState({}, '', url.toString());
+    });
+
+    it('includes dontCache param from URL if not provided', async () => {
+      const url = new URL(window.location.href);
+      url.searchParams.set('dontCache', '1');
+      window.history.replaceState({}, '', url.toString());
+
+      const backend = new FulltextSearchBackend();
+      await backend.performSearch({ query: 'foo' });
+
+      const queryParams = new URL(urlCalled!.toString()).searchParams;
+      expect(queryParams.get('caching')).to.equal('{"no_compute":true}');
+
+      url.searchParams.delete('dontCache');
+      window.history.replaceState({}, '', url.toString());
+    });
+
     it('can enable debugging by default on all searches', async () => {
       const backend = new FulltextSearchBackend({
         baseUrl: 'foo.bar',

diff --git a/test/search-backend/metadata-search-backend.test.ts b/test/search-backend/metadata-search-backend.test.ts
@@ -118,6 +118,51 @@ describe('MetadataSearchBackend', () => {
       window.history.replaceState({}, '', url.toString());
     });
 
+    it('includes reCache param from URL if not provided', async () => {
+      const url = new URL(window.location.href);
+      url.searchParams.set('reCache', '1');
+      window.history.replaceState({}, '', url.toString());
+
+      const backend = new MetadataSearchBackend();
+      await backend.performSearch({ query: 'foo' });
+
+      const queryParams = new URL(urlCalled!.toString()).searchParams;
+      expect(queryParams.get('caching')).to.equal('{"recompute":true}');
+
+      url.searchParams.delete('reCache');
+      window.history.replaceState({}, '', url.toString());
+    });
+
+    it('includes noCache param from URL if not provided', async () => {
+      const url = new URL(window.location.href);
+      url.searchParams.set('noCache', '1');
+      window.history.replaceState({}, '', url.toString());
+
+      const backend = new MetadataSearchBackend();
+      await backend.performSearch({ query: 'foo' });
+
+      const queryParams = new URL(urlCalled!.toString()).searchParams;
+      expect(queryParams.get('caching')).to.equal('{"bypass":true}');
+
+      url.searchParams.delete('noCache');
+      window.history.replaceState({}, '', url.toString());
+    });
+
+    it('includes dontCache param from URL if not provided', async () => {
+      const url = new URL(window.location.href);
+      url.searchParams.set('dontCache', '1');
+      window.history.replaceState({}, '', url.toString());
+
+      const backend = new MetadataSearchBackend();
+      await backend.performSearch({ query: 'foo' });
+
+      const queryParams = new URL(urlCalled!.toString()).searchParams;
+      expect(queryParams.get('caching')).to.equal('{"no_compute":true}');
+
+      url.searchParams.delete('dontCache');
+      window.history.replaceState({}, '', url.toString());
+    });
+
     it('can enable debugging by default on all searches', async () => {
       const backend = new MetadataSearchBackend({
         baseUrl: 'foo.bar',