@internetarchive/collection-browser 0.4.2 → 0.4.3-alpha.1

package/local.archive.org.key

@@ -1,27 +1,27 @@
------BEGIN RSA PRIVATE KEY-----
-MIIEowIBAAKCAQEAqVTKNP+LMgI5l2G99RJcStCHLtZCY3LqtJCVzErvWmYJnx0I
-DbL0LrNVWZwPdzce16Nctz2BhPxVryDnPL2eKyue0ZWdFJBwfJl48d1CK/2HuQnw
-9lDHkEHe4u7doEpN3iBq6BuBf9kXDfXyodyJ2OmJnP9Atw67FtvR4GdfJN47uBi4
-pt3VJooqpPIDsagVIzHJZd6bWrDwT+938Yt7kZWgYb4fZCnGLiwDG/CRlrar+xG3
-HEG8Q24bbyiIQL2oRyiepGQx4KVy2wnLsJ561dB/FRV11NZ4QcmhVHNIGU9ylaEx
-s0yBQRND2ZuM0C4pCaJZaxVtXJMiA/Vy8Ea+ZQIDAQABAoIBAAQgUdEazQyJ61da
-BWP8b41PKYwlonaD7V47C7tvtAdy5xcegPy8eKDOs+y8FdBk4naEv5Sjhg10jK34
-0kmzoTASHwuiZrKClosivkS+jIc/5VfH+zw1WbeVM1Y6VeI7DUy1Y4WGbhBsfNhV
-PvVcx2smvbi6q5wKWtrCvomGW1YtngNBXJBPDWXysaVZdpF+6iWtw0RjWxbKEeMb
-fjZ2sxl7h1EkTXxQR9pfl9WVgl6vRRXp1o+N71M14jp5t95xCyf49YzeEuZmc1Fc
-dD77LNGcxr3kpkcQH5FdDP/spla+lR+JKb78FVqhEdPP3WcJ1qcrAstG2npAfKpj
-MD9AhsECgYEA3BddOjeK9epaGbTZRKgmIOSgGEHo8WbVHqBHhyQKAb8kFVEPn+Hl
-sq2EEQZf0ZJ/HhlVBc0Gj4/2PI8vj1Lzh+QWJnFu+XN/doOm5X62Ctz13qC5oWJp
-foQ9HXcg4GAXhm/o3KUIntLrUwoi/UW8YOSRFXS8RSJtuh1rI5P2jjECgYEAxPVP
-o/9+12Fc2ujdm8cQ1tB1Ab9Z73/vloG/xit0uMp89OqXUHEmtud/WzaIQvNxdaWi
-9/BqAG9Oml51T3cuYPxNDkSmtd2fieq9Nh17dw8zYGMk0cSYeecgvCJOrRIJnebW
-Glyt8vzBb3eD6FzhZoVNOVYareainSP1cwl5YnUCgYAsr2m0OjayeyRT983tDJ7B
-Kun+QtOCv7ghgbVEEOMfO6md0llzwq+aOXSI6Fxn9nBssgP7K4dbeoUqAoBLfzIG
-sx50K6+2YebNLymhirp3NimNS+CkjZCRqVOnOdqo85mTKAGFWtSHOpegwnwcJB59
-Jar3Sj43YygYE4T/Mjlq4QKBgQC8zUcdt2J4xl1Df6xHkuiic0tmdG6a9jHOPex+
-49NM/NYR1Ptd4kmxVXKxFjJCs6jUlQYG1NBYQFrCAcBEf8PWtqSLA+YnOh6gD4R3
-ZoWfGNQwFnoKF4HugU/Q6LYwk7TiR5B/zs30urQWzSOGT9rF8wyW5OJIR2kkZ373
-WmKgrQKBgGaw32CMejz3wBpzOAXsYJcMsVfNCMD4bJ2EbXhYuY8HB8IEEv6wqMsp
-wtXIgHJubfIiA3MlVsfaUkRdtHMHbN+Us1oynu6nByLhYlAMKpOsJFzPVHHwGB/1
-g3WtzfFk5eOoZltJBm5K41zjS7lyr1t05648pT6niy9snu6LaF94
------END RSA PRIVATE KEY-----
+-----BEGIN RSA PRIVATE KEY-----
+MIIEowIBAAKCAQEAqVTKNP+LMgI5l2G99RJcStCHLtZCY3LqtJCVzErvWmYJnx0I
+DbL0LrNVWZwPdzce16Nctz2BhPxVryDnPL2eKyue0ZWdFJBwfJl48d1CK/2HuQnw
+9lDHkEHe4u7doEpN3iBq6BuBf9kXDfXyodyJ2OmJnP9Atw67FtvR4GdfJN47uBi4
+pt3VJooqpPIDsagVIzHJZd6bWrDwT+938Yt7kZWgYb4fZCnGLiwDG/CRlrar+xG3
+HEG8Q24bbyiIQL2oRyiepGQx4KVy2wnLsJ561dB/FRV11NZ4QcmhVHNIGU9ylaEx
+s0yBQRND2ZuM0C4pCaJZaxVtXJMiA/Vy8Ea+ZQIDAQABAoIBAAQgUdEazQyJ61da
+BWP8b41PKYwlonaD7V47C7tvtAdy5xcegPy8eKDOs+y8FdBk4naEv5Sjhg10jK34
+0kmzoTASHwuiZrKClosivkS+jIc/5VfH+zw1WbeVM1Y6VeI7DUy1Y4WGbhBsfNhV
+PvVcx2smvbi6q5wKWtrCvomGW1YtngNBXJBPDWXysaVZdpF+6iWtw0RjWxbKEeMb
+fjZ2sxl7h1EkTXxQR9pfl9WVgl6vRRXp1o+N71M14jp5t95xCyf49YzeEuZmc1Fc
+dD77LNGcxr3kpkcQH5FdDP/spla+lR+JKb78FVqhEdPP3WcJ1qcrAstG2npAfKpj
+MD9AhsECgYEA3BddOjeK9epaGbTZRKgmIOSgGEHo8WbVHqBHhyQKAb8kFVEPn+Hl
+sq2EEQZf0ZJ/HhlVBc0Gj4/2PI8vj1Lzh+QWJnFu+XN/doOm5X62Ctz13qC5oWJp
+foQ9HXcg4GAXhm/o3KUIntLrUwoi/UW8YOSRFXS8RSJtuh1rI5P2jjECgYEAxPVP
+o/9+12Fc2ujdm8cQ1tB1Ab9Z73/vloG/xit0uMp89OqXUHEmtud/WzaIQvNxdaWi
+9/BqAG9Oml51T3cuYPxNDkSmtd2fieq9Nh17dw8zYGMk0cSYeecgvCJOrRIJnebW
+Glyt8vzBb3eD6FzhZoVNOVYareainSP1cwl5YnUCgYAsr2m0OjayeyRT983tDJ7B
+Kun+QtOCv7ghgbVEEOMfO6md0llzwq+aOXSI6Fxn9nBssgP7K4dbeoUqAoBLfzIG
+sx50K6+2YebNLymhirp3NimNS+CkjZCRqVOnOdqo85mTKAGFWtSHOpegwnwcJB59
+Jar3Sj43YygYE4T/Mjlq4QKBgQC8zUcdt2J4xl1Df6xHkuiic0tmdG6a9jHOPex+
+49NM/NYR1Ptd4kmxVXKxFjJCs6jUlQYG1NBYQFrCAcBEf8PWtqSLA+YnOh6gD4R3
+ZoWfGNQwFnoKF4HugU/Q6LYwk7TiR5B/zs30urQWzSOGT9rF8wyW5OJIR2kkZ373
+WmKgrQKBgGaw32CMejz3wBpzOAXsYJcMsVfNCMD4bJ2EbXhYuY8HB8IEEv6wqMsp
+wtXIgHJubfIiA3MlVsfaUkRdtHMHbN+Us1oynu6nByLhYlAMKpOsJFzPVHHwGB/1
+g3WtzfFk5eOoZltJBm5K41zjS7lyr1t05648pT6niy9snu6LaF94
+-----END RSA PRIVATE KEY-----

package/package.json

@@ -3,7 +3,7 @@
   "description": "The Internet Archive Collection Browser.",
   "license": "AGPL-3.0-only",
   "author": "Internet Archive",
-  "version": "0.4.2",
+  "version": "0.4.3-alpha.1",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "scripts": {

package/renovate.json

@@ -1,6 +1,6 @@
-{
-  "extends": [
-    "config:base",
-    ":preserveSemverRanges"
-  ]
-}
+{
+  "extends": [
+    "config:base",
+    ":preserveSemverRanges"
+  ]
+}

package/src/collection-browser.ts

@@ -618,10 +618,12 @@ export class CollectionBrowser
 
   firstUpdated(): void {
     this.setupStateRestorationObserver();
+    console.log('first updated - restoring state');
     this.restoreState();
   }
 
   updated(changed: PropertyValues) {
+    console.log('updated', changed);
     if (
       changed.has('displayMode') ||
       changed.has('baseNavigationUrl') ||
@@ -631,12 +633,19 @@ export class CollectionBrowser
       this.infiniteScroller?.reload();
     }
     if (changed.has('baseQuery')) {
+      console.log('base query changed', changed.get('baseQuery'));
       this.emitBaseQueryChanged();
     }
     if (changed.has('searchType')) {
+      console.log('search type changed', changed.get('searchType'));
       this.emitSearchTypeChanged();
     }
     if (changed.has('currentPage') || changed.has('displayMode')) {
+      console.log(
+        'current page or display mode changed',
+        changed.get('currentPage'),
+        changed.get('displayMode')
+      );
       this.persistState();
     }
     if (
@@ -649,6 +658,7 @@ export class CollectionBrowser
       changed.has('selectedFacets') ||
       changed.has('searchService')
     ) {
+      console.log('handling query change', changed);
       this.handleQueryChange();
     }
     if (
@@ -783,6 +793,11 @@ export class CollectionBrowser
   private previousQueryKey?: string;
 
   private async handleQueryChange() {
+    console.log(
+      'handleQueryChange',
+      this.pageFetchQueryKey,
+      this.previousQueryKey
+    );
     // only reset if the query has actually changed
     if (!this.searchService || this.pageFetchQueryKey === this.previousQueryKey)
       return;
@@ -804,9 +819,9 @@ export class CollectionBrowser
       this.scrollToPage(this.initialPageNumber);
     }
     this.initialQueryChangeHappened = true;
+
     // if the query changed as part of a window.history pop event, we don't want to
     // persist the state because it overwrites the forward history
-
     if (!this.historyPopOccurred) {
       this.persistState();
       this.historyPopOccurred = false;
@@ -1290,6 +1305,7 @@ export class CollectionBrowser
   private pageFetchesInProgress: Record<string, Set<number>> = {};
 
   async fetchPage(pageNumber: number) {
+    console.log('maybe fetch page', pageNumber);
     if (!this.filteredQuery) return;
 
     // if we already have data, don't fetch again
@@ -1304,6 +1320,7 @@ export class CollectionBrowser
     if (pageFetches.has(pageNumber)) return;
     pageFetches.add(pageNumber);
     this.pageFetchesInProgress[pageFetchQueryKey] = pageFetches;
+    console.log('fetching page', pageNumber);
 
     const sortParams = this.sortParam ? [this.sortParam] : [];
     const params: SearchParams = {

package/src/restoration-state-handler.ts

@@ -89,6 +89,7 @@ export class RestorationStateHandler
   }
 
   private persistQueryStateToUrl(state: RestorationState) {
+    console.log('persistQueryStateToUrl', state);
     const url = new URL(window.location.href);
     const { searchParams } = url;
     searchParams.delete('sin');
@@ -98,6 +99,10 @@ export class RestorationStateHandler
     searchParams.delete('and[]');
     searchParams.delete('not[]');
 
+    if (state.baseQuery) {
+      searchParams.set('query', state.baseQuery);
+    }
+
     if (state.searchType) {
       searchParams.set(
         'sin',
@@ -105,15 +110,6 @@ export class RestorationStateHandler
       );
     }
 
-    if (state.sortParam) {
-      const prefix = state.sortParam.direction === 'desc' ? '-' : '';
-      searchParams.set('sort', `${prefix}${state.sortParam.field}`);
-    }
-
-    if (state.baseQuery) {
-      searchParams.set('query', state.baseQuery);
-    }
-
     if (state.currentPage) {
       if (state.currentPage > 1) {
         searchParams.set('page', state.currentPage.toString());
@@ -122,6 +118,11 @@ export class RestorationStateHandler
       }
     }
 
+    if (state.sortParam) {
+      const prefix = state.sortParam.direction === 'desc' ? '-' : '';
+      searchParams.set('sort', `${prefix}${state.sortParam.field}`);
+    }
+
     if (state.selectedFacets) {
       for (const [facetName, facetValues] of Object.entries(
         state.selectedFacets
@@ -147,22 +148,41 @@ export class RestorationStateHandler
         `year:[${state.minSelectedDate} TO ${state.maxSelectedDate}]`
       );
     }
+
     if (state.titleQuery) {
       searchParams.append('and[]', state.titleQuery);
     }
+
     if (state.creatorQuery) {
       searchParams.append('and[]', state.creatorQuery);
     }
 
+    // Ensure we aren't pushing an identical state to the stack
+    const prevState = window.history.state;
+    if (
+      prevState &&
+      prevState.query === state.baseQuery &&
+      prevState.searchType === state.searchType &&
+      prevState.page === state.currentPage &&
+      prevState.sort?.field === state.sortParam?.field &&
+      prevState.sort?.direction === state.sortParam?.direction &&
+      prevState.minDate === state.minSelectedDate &&
+      prevState.maxDate === state.maxSelectedDate &&
+      this.selectedFacetStatesEqual(prevState.facets, state.selectedFacets)
+    ) {
+      console.log('Ignoring identical history state');
+      return;
+    }
+
     window.history.pushState(
       {
-        sort: state.sortParam,
         query: state.baseQuery,
+        searchType: state.searchType,
         page: state.currentPage,
-        and: state.selectedFacets,
-        not: state.selectedFacets,
+        sort: state.sortParam,
         minDate: state.minSelectedDate,
         maxDate: state.maxSelectedDate,
+        facets: state.selectedFacets,
       },
       '',
       url
@@ -170,6 +190,7 @@ export class RestorationStateHandler
   }
 
   private loadQueryStateFromUrl(): RestorationState {
+    console.log('loadQueryStateFromUrl', window.location.href);
     const url = new URL(window.location.href);
     const searchInside = url.searchParams.get('sin');
     const pageNumber = url.searchParams.get('page');
@@ -295,6 +316,32 @@ export class RestorationStateHandler
     return value;
   }
 
+  private selectedFacetStatesEqual(
+    facets1: SelectedFacets,
+    facets2: SelectedFacets
+  ): boolean {
+    if (facets1 === facets2) return true;
+
+    // We can assume they both have the same top-level entries (the allowable facet fields)
+    for (const [key, values] of Object.entries(facets1)) {
+      const facetField = key as keyof SelectedFacets;
+
+      // They must have the same number of bucket entries for each field
+      const bucketEntries1 = Object.entries(values);
+      const bucketEntries2 = Object.entries(facets2[facetField]);
+      if (bucketEntries1.length !== bucketEntries2.length) return false;
+
+      // And since they have the same length, we just ensure every bucket state from the
+      // first object matches a corresponding bucket state in the second object.
+      // If the corresponding bucket doesn't exist or has a different state, we're done.
+      for (const [value, bucket] of bucketEntries1) {
+        if (bucket.state !== facets2[facetField][value]?.state) return false;
+      }
+    }
+
+    return true;
+  }
+
   /**
    * Sets the facet state for the given field & value to the given state,
    * creating any previously-undefined buckets as needed.

package/tsconfig.json

@@ -1,21 +1,21 @@
-{
-  "compilerOptions": {
-    "target": "es2018",
-    "module": "esnext",
-    "moduleResolution": "node",
-    "noEmitOnError": true,
-    "lib": ["es2017", "dom"],
-    "strict": true,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "importHelpers": true,
-    "outDir": "dist",
-    "sourceMap": true,
-    "inlineSources": true,
-    "rootDir": "./",
-    "declaration": true,
-    "importsNotUsedAsValues": "error"
-  },
-  "include": ["src", "test", "index.ts", "types"],
-}
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noEmitOnError": true,
+    "lib": ["es2017", "dom"],
+    "strict": true,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "importHelpers": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "inlineSources": true,
+    "rootDir": "./",
+    "declaration": true,
+    "importsNotUsedAsValues": "error"
+  },
+  "include": ["src", "test", "index.ts", "types"],
+}

package/web-dev-server.config.mjs

@@ -1,30 +1,30 @@
-// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
-
-/** Use Hot Module replacement by adding --hmr to the start command */
-const hmr = process.argv.includes('--hmr');
-
-export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
-  nodeResolve: true,
-  open: '/',
-  watch: !hmr,
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto'
-
-  /** Set appIndex to enable SPA routing */
-  // appIndex: 'demo/index.html',
-
-  /** Confgure bare import resolve plugin */
-  // nodeResolve: {
-  //   exportConditions: ['browser', 'development']
-  // },
-
-  plugins: [
-    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
-    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
-  ],
-
-  http2: true,
-  sslCert: './local.archive.org.cert',
-  sslKey: './local.archive.org.key',
-});
+// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
+
+/** Use Hot Module replacement by adding --hmr to the start command */
+const hmr = process.argv.includes('--hmr');
+
+export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
+  nodeResolve: true,
+  open: '/',
+  watch: !hmr,
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto'
+
+  /** Set appIndex to enable SPA routing */
+  // appIndex: 'demo/index.html',
+
+  /** Confgure bare import resolve plugin */
+  // nodeResolve: {
+  //   exportConditions: ['browser', 'development']
+  // },
+
+  plugins: [
+    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
+    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
+  ],
+
+  http2: true,
+  sslCert: './local.archive.org.cert',
+  sslKey: './local.archive.org.key',
+});

package/web-test-runner.config.mjs

@@ -1,41 +1,41 @@
-// import { playwrightLauncher } from '@web/test-runner-playwright';
-
-const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
-
-export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
-  /** Test files to run */
-  files: 'dist/test/**/*.test.js',
-
-  /** Resolve bare module imports */
-  nodeResolve: {
-    exportConditions: ['browser', 'development'],
-  },
-
-  /** Filter out lit dev mode logs */
-  filterBrowserLogs(log) {
-    for (const arg of log.args) {
-      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
-        return false;
-      }
-    }
-    return true;
-  },
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto',
-
-  /** Amount of browsers to run concurrently */
-  // concurrentBrowsers: 2,
-
-  /** Amount of test files per browser to test concurrently */
-  // concurrency: 1,
-
-  /** Browsers to run tests on */
-  // browsers: [
-  //   playwrightLauncher({ product: 'chromium' }),
-  //   playwrightLauncher({ product: 'firefox' }),
-  //   playwrightLauncher({ product: 'webkit' }),
-  // ],
-
-  // See documentation for all available options
-});
+// import { playwrightLauncher } from '@web/test-runner-playwright';
+
+const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
+
+export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
+  /** Test files to run */
+  files: 'dist/test/**/*.test.js',
+
+  /** Resolve bare module imports */
+  nodeResolve: {
+    exportConditions: ['browser', 'development'],
+  },
+
+  /** Filter out lit dev mode logs */
+  filterBrowserLogs(log) {
+    for (const arg of log.args) {
+      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
+        return false;
+      }
+    }
+    return true;
+  },
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto',
+
+  /** Amount of browsers to run concurrently */
+  // concurrentBrowsers: 2,
+
+  /** Amount of test files per browser to test concurrently */
+  // concurrency: 1,
+
+  /** Browsers to run tests on */
+  // browsers: [
+  //   playwrightLauncher({ product: 'chromium' }),
+  //   playwrightLauncher({ product: 'firefox' }),
+  //   playwrightLauncher({ product: 'webkit' }),
+  // ],
+
+  // See documentation for all available options
+});