@internetarchive/collection-browser 1.2.0 → 1.2.1-alpha.2

package/dist/src/collection-browser.d.ts

@@ -107,6 +107,13 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
      */
     private dataSource;
     private infiniteScroller;
+    private sessionIdGenPromise?;
+    /**
+     * Returns a promise resolving to a unique string that persists for the current browser session.
+     * Used in generating unique IDs for search requests, so that multiple requests coming from the
+     * same browser session can be identified.
+     */
+    private getSessionId;
     /**
      * Go to the given page of results
      *
@@ -268,6 +275,23 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
     private initialQueryChangeHappened;
     private historyPopOccurred;
     private previousQueryKey?;
+    /**
+     * Internal property to store the `resolve` function for the most recent
+     * `initialSearchComplete` promise, allowing us to resolve it at the appropriate time.
+     */
+    private _initialSearchCompleteResolver;
+    /**
+     * Internal property to store the private value backing the `initialSearchComplete` getter.
+     */
+    private _initialSearchCompletePromise;
+    /**
+     * A Promise which, after each query change, resolves once the fetches for the initial
+     * search have completed. Waits for *both* the hits and aggregations fetches to finish.
+     *
+     * Ensure you await this component's `updateComplete` promise before awaiting this
+     * one, to ensure you do not await an obsolete promise from the previous update.
+     */
+    get initialSearchComplete(): Promise<boolean>;
     private handleQueryChange;
     private setupStateRestorationObserver;
     private boundNavigationHandler?;
@@ -276,6 +300,16 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
     private persistState;
     private doInitialPageFetch;
     private emitSearchResultsLoadingChanged;
+    /**
+     * Produces a compact unique ID for a search request that can help with debugging
+     * on the backend by making related requests easier to trace through different services.
+     * (e.g., tying the hits/aggregations requests for the same page back to a single hash).
+     *
+     * @param params The search service parameters for the request
+     * @param kind The kind of request (hits-only, aggregations-only, or both)
+     * @returns A Promise resolving to the uid to apply to the request
+     */
+    private requestUID;
     /**
      * Constructs a search service FilterMap object from the combination of
      * all the currently-applied filters. This includes any facets, letter

package/dist/src/collection-browser.js

@@ -17,6 +17,7 @@ import chevronIcon from './assets/img/icons/chevron';
 import './empty-placeholder';
 import { analyticsActions, analyticsCategories, } from './utils/analytics-events';
 import { srOnlyStyle } from './styles/sr-only';
+import { sha1 } from './utils/sha1';
 let CollectionBrowser = class CollectionBrowser extends LitElement {
     constructor() {
         super(...arguments);
@@ -114,6 +115,12 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
         // so this keeps track of whether we've already set the initial query
         this.initialQueryChangeHappened = false;
         this.historyPopOccurred = false;
+        /**
+         * Internal property to store the private value backing the `initialSearchComplete` getter.
+         */
+        this._initialSearchCompletePromise = new Promise(res => {
+            this._initialSearchCompleteResolver = res;
+        });
         // this maps the query to the pages being fetched for that query
         this.pageFetchesInProgress = {};
     }
@@ -145,6 +152,32 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
     get estimatedTileCount() {
         return this.pagesToRender * this.pageSize;
     }
+    /**
+     * Returns a promise resolving to a unique string that persists for the current browser session.
+     * Used in generating unique IDs for search requests, so that multiple requests coming from the
+     * same browser session can be identified.
+     */
+    async getSessionId() {
+        try {
+            const storedSessionId = sessionStorage === null || sessionStorage === void 0 ? void 0 : sessionStorage.getItem('cb-session');
+            if (storedSessionId) {
+                return storedSessionId;
+            }
+            // If we enter this method a second time while a first session ID is already being generated,
+            // ensure we produce the same ID from both calls instead of generating another one.
+            if (this.sessionIdGenPromise) {
+                return this.sessionIdGenPromise;
+            }
+            this.sessionIdGenPromise = sha1(Math.random().toString());
+            const newSessionId = await this.sessionIdGenPromise;
+            sessionStorage === null || sessionStorage === void 0 ? void 0 : sessionStorage.setItem('cb-session', newSessionId);
+            return newSessionId;
+        }
+        catch (err) {
+            // Either we can't generate the hash or we're restricted from accessing sessionStorage
+            return '';
+        }
+    }
     /**
      * Go to the given page of results
      *
@@ -807,6 +840,16 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
         });
         this.dispatchEvent(event);
     }
+    /**
+     * A Promise which, after each query change, resolves once the fetches for the initial
+     * search have completed. Waits for *both* the hits and aggregations fetches to finish.
+     *
+     * Ensure you await this component's `updateComplete` promise before awaiting this
+     * one, to ensure you do not await an obsolete promise from the previous update.
+     */
+    get initialSearchComplete() {
+        return this._initialSearchCompletePromise;
+    }
     async handleQueryChange() {
         // only reset if the query has actually changed
         if (!this.searchService || this.pageFetchQueryKey === this.previousQueryKey)
@@ -839,7 +882,14 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
             this.persistState();
         }
         this.historyPopOccurred = false;
+        // Reset the `initialSearchComplete` promise with a new value for the imminent search
+        this._initialSearchCompletePromise = new Promise(res => {
+            this._initialSearchCompleteResolver = res;
+        });
+        // Fire the initial page and facets requests
         await Promise.all([this.doInitialPageFetch(), this.fetchFacets()]);
+        // Resolve the `initialSearchComplete` promise for this search
+        this._initialSearchCompleteResolver(true);
     }
     setupStateRestorationObserver() {
         if (this.boundNavigationHandler)
@@ -904,6 +954,33 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
             },
         }));
     }
+    /**
+     * Produces a compact unique ID for a search request that can help with debugging
+     * on the backend by making related requests easier to trace through different services.
+     * (e.g., tying the hits/aggregations requests for the same page back to a single hash).
+     *
+     * @param params The search service parameters for the request
+     * @param kind The kind of request (hits-only, aggregations-only, or both)
+     * @returns A Promise resolving to the uid to apply to the request
+     */
+    async requestUID(params, kind) {
+        var _a;
+        const paramsToHash = JSON.stringify({
+            pageType: params.pageType,
+            pageTarget: params.pageTarget,
+            query: params.query,
+            fields: params.fields,
+            filters: params.filters,
+            sort: params.sort,
+            searchType: this.searchType,
+        });
+        const fullQueryHash = (await sha1(paramsToHash)).slice(0, 20); // First 80 bits of SHA-1 are plenty for this
+        const sessionId = (await this.getSessionId()).slice(0, 20); // Likewise
+        const page = (_a = params.page) !== null && _a !== void 0 ? _a : 0;
+        const kindPrefix = kind.charAt(0); // f = full, h = hits, a = aggregations
+        const currentTime = Date.now();
+        return `R:${fullQueryHash}-S:${sessionId}-P:${page}-K:${kindPrefix}-T:${currentTime}`;
+    }
     /**
      * Constructs a search service FilterMap object from the combination of
      * all the currently-applied filters. This includes any facets, letter
@@ -1063,6 +1140,7 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
         if (!this.searchService)
             return;
         const { facetFetchQueryKey } = this;
+        const sortParams = this.sortParam ? [this.sortParam] : [];
         const params = {
             query: trimmedQuery,
             rows: 0,
@@ -1071,8 +1149,8 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
             aggregationsSize: 10,
             // Note: we don't need an aggregations param to fetch the default aggregations from the PPS.
             // The default aggregations for the search_results page type should be what we need here.
-            uid: this.facetFetchQueryKey,
         };
+        params.uid = await this.requestUID({ ...params, sort: sortParams }, 'aggregations');
         this.facetsLoading = true;
         const searchResponse = await this.searchService.search(params, this.searchType);
         const success = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.success;
@@ -1192,8 +1270,8 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
             sort: sortParams,
             filters: this.filterMap,
             aggregations: { omit: true },
-            uid: this.pageFetchQueryKey,
         };
+        params.uid = await this.requestUID(params, 'hits');
         const searchResponse = await this.searchService.search(params, this.searchType);
         const success = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.success;
         // This is checking to see if the query has changed since the data was fetched.
@@ -1351,6 +1429,7 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
         if (!trimmedQuery)
             return [];
         const filterAggregationKey = prefixFilterAggregationKeys[filterType];
+        const sortParams = this.sortParam ? [this.sortParam] : [];
         const params = {
             query: trimmedQuery,
             rows: 0,
@@ -1360,6 +1439,7 @@ let CollectionBrowser = class CollectionBrowser extends LitElement {
             // Fetch all 26 letter buckets
             aggregationsSize: 26,
         };
+        params.uid = await this.requestUID({ ...params, sort: sortParams }, 'aggregations');
         const searchResponse = await ((_b = this.searchService) === null || _b === void 0 ? void 0 : _b.search(params, this.searchType));
         return ((_g = (_f = (_e = (_d = (_c = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.success) === null || _c === void 0 ? void 0 : _c.response) === null || _d === void 0 ? void 0 : _d.aggregations) === null || _e === void 0 ? void 0 : _e[filterAggregationKey]) === null || _f === void 0 ? void 0 : _f.buckets) !== null && _g !== void 0 ? _g : []);
     }