@internetarchive/collection-browser 1.14.17-alpha.3 → 1.14.17-alpha.31

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

@@ -1,8 +1,7 @@
 import type { ReactiveController, ReactiveControllerHost } from 'lit';
 import { AccountExtraInfo, Aggregation, CollectionExtraInfo, FilterMap, PageElementMap, SearchParams } from '@internetarchive/search-service';
-import { type PrefixFilterType, type TileModel, PrefixFilterCounts } from '../models';
+import { type PrefixFilterType, TileModel, PrefixFilterCounts, RequestKind } from '../models';
 import type { CollectionBrowserSearchInterface, CollectionTitles, PageSpecifierParams } from './models';
-declare type RequestKind = 'full' | 'hits' | 'aggregations';
 export interface CollectionBrowserDataSourceInterface extends ReactiveController {
     /**
      * How many tile models are present in this data source
@@ -20,6 +19,11 @@ export interface CollectionBrowserDataSourceInterface extends ReactiveController
      * encountered (i.e., the last page of results).
      */
     readonly endOfDataReached: boolean;
+    /**
+     * True if the initial work for a new query state has been completed (i.e., firing initial
+     * page/facet requests). False otherwise.
+     */
+    readonly queryInitialized: boolean;
     /**
      * A string key compactly representing the current full search state, which can
      * be used to determine, e.g., when a new search is required or whether an arriving
@@ -88,6 +92,18 @@ export interface CollectionBrowserDataSourceInterface extends ReactiveController
      * An array of all the tile models whose management checkboxes are unchecked
      */
     readonly uncheckedTileModels: TileModel[];
+    /**
+     * 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.
+     */
+    readonly initialSearchComplete: Promise<boolean>;
+    /**
+     * Resets the data source to its empty state, with no result pages, aggregations, etc.
+     */
+    reset(): void;
     /**
      * Adds the given page of tile models to the data source.
      * If the given page number already exists, that page will be overwritten.
@@ -142,10 +158,6 @@ export interface CollectionBrowserDataSourceInterface extends ReactiveController
      * @param pageSize
      */
     setPageSize(pageSize: number): void;
-    /**
-     * Resets the data source to its empty state, with no result pages, aggregations, etc.
-     */
-    reset(): void;
     /**
      * Notifies the data source that a query change has occurred, which may trigger a data
      * reset & new fetches.
@@ -183,6 +195,12 @@ export declare class CollectionBrowserDataSource implements CollectionBrowserDat
      * Maps the full query key to the pages being fetched for that query
      */
     private pageFetchesInProgress;
+    /**
+     * A record of the query key used for the last search.
+     * If this changes, we need to load new results.
+     */
+    private previousQueryKey;
+    private id;
     /**
      * @inheritdoc
      */
@@ -191,6 +209,10 @@ export declare class CollectionBrowserDataSource implements CollectionBrowserDat
      * @inheritdoc
      */
     endOfDataReached: boolean;
+    /**
+     * @inheritdoc
+     */
+    queryInitialized: boolean;
     /**
      * @inheritdoc
      */
@@ -223,15 +245,33 @@ export declare class CollectionBrowserDataSource implements CollectionBrowserDat
      * @inheritdoc
      */
     prefixFilterCountMap: Partial<Record<PrefixFilterType, PrefixFilterCounts>>;
+    /**
+     * 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;
+    /**
+     * @inheritdoc
+     */
+    get initialSearchComplete(): Promise<boolean>;
     constructor(
     /** The host element to which this controller should attach listeners */
     host: ReactiveControllerHost & CollectionBrowserSearchInterface, 
     /** Default size of result pages */
     pageSize: number);
+    hostUpdate(): void;
     /**
      * @inheritdoc
      */
     get size(): number;
+    /**
+     * @inheritdoc
+     */
+    reset(): void;
     /**
      * @inheritdoc
      */
@@ -260,10 +300,6 @@ export declare class CollectionBrowserDataSource implements CollectionBrowserDat
      * @inheritdoc
      */
     setPageSize(pageSize: number): void;
-    /**
-     * @inheritdoc
-     */
-    reset(): void;
     /**
      * @inheritdoc
      */
@@ -315,8 +351,8 @@ export declare class CollectionBrowserDataSource implements CollectionBrowserDat
      *  - Any currently-applied prefix filters
      *  - The current sort options
      *
-     * This lets us keep track of queries so we don't persist data that's
-     * no longer relevant.
+     * This lets us internally keep track of queries so we don't persist data that's
+     * no longer relevant. Not meant to be human-readable.
      */
     get pageFetchQueryKey(): string;
     /**
@@ -416,23 +452,6 @@ export declare class CollectionBrowserDataSource implements CollectionBrowserDat
      * @param results
      */
     private addTilesToDataSource;
-    /**
-     * Returns the mediatype string for the given search result, taking into account
-     * the special `favorited_search` hit type.
-     * @param result The search result to extract a mediatype from
-     */
-    private getMediatype;
-    /**
-     * Returns the input string, but removing one set of quotes from all instances of
-     * ""clauses wrapped in two sets of quotes"". This assumes the quotes are already
-     * URL-encoded.
-     *
-     * This should be a temporary measure to address the fact that the __href__ field
-     * sometimes acquires extra quotation marks during query rewriting. Once there is a
-     * full Lucene parser in place that handles quoted queries correctly, this can likely
-     * be removed.
-     */
-    private collapseRepeatedQuotes;
     /**
      * Fetches the aggregation buckets for the given prefix filter type.
      */
@@ -442,4 +461,3 @@ export declare class CollectionBrowserDataSource implements CollectionBrowserDat
      */
     updatePrefixFilterCounts(filterType: PrefixFilterType): Promise<void>;
 }
-export {};

package/dist/src/data-source/collection-browser-data-source.js

@@ -1,5 +1,5 @@
 import { FilterConstraint, FilterMapBuilder, SearchType, } from '@internetarchive/search-service';
-import { prefixFilterAggregationKeys, } from '../models';
+import { prefixFilterAggregationKeys, TileModel, } from '../models';
 import { sha1 } from '../utils/sha1';
 export class CollectionBrowserDataSource {
     constructor(
@@ -16,6 +16,12 @@ export class CollectionBrowserDataSource {
          * Maps the full query key to the pages being fetched for that query
          */
         this.pageFetchesInProgress = {};
+        /**
+         * A record of the query key used for the last search.
+         * If this changes, we need to load new results.
+         */
+        this.previousQueryKey = '';
+        this.id = Math.random();
         /**
          * @inheritdoc
          */
@@ -24,6 +30,10 @@ export class CollectionBrowserDataSource {
          * @inheritdoc
          */
         this.endOfDataReached = false;
+        /**
+         * @inheritdoc
+         */
+        this.queryInitialized = false;
         /**
          * @inheritdoc
          */
@@ -36,17 +46,31 @@ export class CollectionBrowserDataSource {
          * @inheritdoc
          */
         this.prefixFilterCountMap = {};
+        /**
+         * Internal property to store the private value backing the `initialSearchComplete` getter.
+         */
+        this._initialSearchCompletePromise = new Promise(res => {
+            this._initialSearchCompleteResolver = res;
+        });
         /**
          * @inheritdoc
          */
         this.checkAllTiles = () => {
-            this.map(model => ({ ...model, checked: true }));
+            this.map(model => {
+                const cloned = model.clone();
+                cloned.checked = true;
+                return cloned;
+            });
         };
         /**
          * @inheritdoc
          */
         this.uncheckAllTiles = () => {
-            this.map(model => ({ ...model, checked: false }));
+            this.map(model => {
+                const cloned = model.clone();
+                cloned.checked = false;
+                return cloned;
+            });
         };
         /**
          * @inheritdoc
@@ -87,8 +111,40 @@ export class CollectionBrowserDataSource {
             this.pages = newPages;
             this.numTileModels -= numChecked;
             this.host.requestUpdate();
+            this.host.refreshVisibleResults();
         };
-        this.host.addController(this);
+        // console.log('adding controller', this.id);
+        // this.host.addController(this as CollectionBrowserDataSourceInterface);
+    }
+    /**
+     * @inheritdoc
+     */
+    get initialSearchComplete() {
+        return this._initialSearchCompletePromise;
+    }
+    hostUpdate() {
+        console.log('hostUpdate', this.id, this.previousQueryKey, this.pageFetchQueryKey);
+        // This reactive controller hook is run whenever the host component (collection-browser) performs an update.
+        // We check whether the host's state has changed in a way which should trigger a reset & new results fetch.
+        // Only the currently-installed data source should react to the update
+        if (this.host.dataSource !== this)
+            return;
+        // Can't perform searches without a search service
+        if (!this.host.searchService)
+            return;
+        // We should only reset if part of the full query state has changed
+        const queryKeyChanged = this.pageFetchQueryKey !== this.previousQueryKey;
+        console.log('query keys', this.pageFetchQueryKey, this.previousQueryKey);
+        if (!queryKeyChanged)
+            return;
+        // We should only reset if either:
+        //  (a) our state permits a valid search, or
+        //  (b) we have a blank query that we want to show empty results for
+        const shouldShowEmptyQueryResults = this.host.clearResultsOnEmptyQuery && this.host.baseQuery === '';
+        if (!(this.canPerformSearch || shouldShowEmptyQueryResults))
+            return;
+        this.host.emitQueryStateChanged();
+        this.handleQueryChange();
     }
     /**
      * @inheritdoc
@@ -96,6 +152,25 @@ export class CollectionBrowserDataSource {
     get size() {
         return this.numTileModels;
     }
+    /**
+     * @inheritdoc
+     */
+    reset() {
+        this.pages = {};
+        this.aggregations = {};
+        this.yearHistogramAggregation = undefined;
+        this.pageFetchesInProgress = {};
+        this.pageElements = undefined;
+        this.parentCollections = [];
+        this.prefixFilterCountMap = {};
+        this.offset = 0;
+        this.numTileModels = 0;
+        this.totalResults = 0;
+        this.endOfDataReached = false;
+        this.queryInitialized = false;
+        this.host.setTotalResultCount(0);
+        this.host.requestUpdate();
+    }
     /**
      * @inheritdoc
      */
@@ -144,32 +219,23 @@ export class CollectionBrowserDataSource {
         this.reset();
         this.pageSize = pageSize;
     }
-    /**
-     * @inheritdoc
-     */
-    reset() {
-        this.pages = {};
-        this.aggregations = {};
-        this.yearHistogramAggregation = undefined;
-        this.pageFetchesInProgress = {};
-        this.pageElements = undefined;
-        this.parentCollections = [];
-        this.prefixFilterCountMap = {};
-        this.offset = 0;
-        this.numTileModels = 0;
-        this.totalResults = 0;
-        this.endOfDataReached = false;
-        this.host.requestUpdate();
-    }
     /**
      * @inheritdoc
      */
     async handleQueryChange() {
         this.reset();
+        // Reset the `initialSearchComplete` promise with a new value for the imminent search
+        this._initialSearchCompletePromise = new Promise(res => {
+            this._initialSearchCompleteResolver = res;
+        });
+        // Fire the initial page & facet requests
+        this.queryInitialized = true;
         await Promise.all([
             this.doInitialPageFetch(),
             this.host.suppressFacets ? null : this.fetchFacets(),
         ]);
+        // Resolve the `initialSearchComplete` promise for this search
+        this._initialSearchCompleteResolver(true);
     }
     /**
      * @inheritdoc
@@ -237,16 +303,16 @@ export class CollectionBrowserDataSource {
      *  - Any currently-applied prefix filters
      *  - The current sort options
      *
-     * This lets us keep track of queries so we don't persist data that's
-     * no longer relevant.
+     * This lets us internally keep track of queries so we don't persist data that's
+     * no longer relevant. Not meant to be human-readable.
      */
     get pageFetchQueryKey() {
         var _a, _b, _c, _d, _e;
-        const profileKey = `${this.host.withinProfile}--${this.host.profileElement}`;
+        const profileKey = `pf;${this.host.withinProfile}--pe;${this.host.profileElement}`;
         const pageTarget = (_a = this.host.withinCollection) !== null && _a !== void 0 ? _a : profileKey;
         const sortField = (_c = (_b = this.host.sortParam) === null || _b === void 0 ? void 0 : _b.field) !== null && _c !== void 0 ? _c : 'none';
         const sortDirection = (_e = (_d = this.host.sortParam) === null || _d === void 0 ? void 0 : _d.direction) !== null && _e !== void 0 ? _e : 'none';
-        return `${this.fullQuery}-${pageTarget}-${this.host.searchType}-${sortField}-${sortDirection}`;
+        return `fq:${this.fullQuery}-pt:${pageTarget}-st:${this.host.searchType}-sf:${sortField}-sd:${sortDirection}`;
     }
     /**
      * Similar to `pageFetchQueryKey` above, but excludes sort fields since they
@@ -468,9 +534,11 @@ export class CollectionBrowserDataSource {
      */
     async fetchFacets() {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        console.log('fetchFacets', this.id, this.host.profileElement);
         const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
         if (!this.canPerformSearch)
             return;
+        console.log('will actually fetch facets');
         const { facetFetchQueryKey } = this;
         const sortParams = this.host.sortParam ? [this.host.sortParam] : [];
         const params = {
@@ -491,8 +559,10 @@ export class CollectionBrowserDataSource {
         // If so, we just want to discard this set of aggregations because they are
         // likely no longer valid for the newer query.
         const queryChangedSinceFetch = facetFetchQueryKey !== this.facetFetchQueryKey;
-        if (queryChangedSinceFetch)
+        if (queryChangedSinceFetch) {
+            console.log('facet query has changed since fetch, returning. new/old:', this.facetFetchQueryKey, facetFetchQueryKey);
             return;
+        }
         if (!success) {
             const errorMsg = (_c = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.error) === null || _c === void 0 ? void 0 : _c.message;
             const detailMsg = (_e = (_d = searchResponse === null || searchResponse === void 0 ? void 0 : searchResponse.error) === null || _d === void 0 ? void 0 : _d.details) === null || _e === void 0 ? void 0 : _e.message;
@@ -500,6 +570,7 @@ export class CollectionBrowserDataSource {
                 // @ts-ignore: Property 'Sentry' does not exist on type 'Window & typeof globalThis'
                 (_g = (_f = window === null || window === void 0 ? void 0 : window.Sentry) === null || _f === void 0 ? void 0 : _f.captureMessage) === null || _g === void 0 ? void 0 : _g.call(_f, 'Missing or malformed facet response from backend', 'error');
             }
+            this.host.setFacetsLoading(false);
             return;
         }
         const { aggregations, collectionTitles } = success.response;
@@ -533,7 +604,6 @@ export class CollectionBrowserDataSource {
      */
     async fetchPage(pageNumber, numInitialPages = 1) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
-        console.log(`fetchPage(${pageNumber})`, this.canPerformSearch, this.hasPage(pageNumber), this.endOfDataReached, this.host.baseQuery, JSON.stringify(this.host.selectedFacets));
         const trimmedQuery = (_a = this.host.baseQuery) === null || _a === void 0 ? void 0 : _a.trim();
         if (!this.canPerformSearch)
             return;
@@ -549,14 +619,14 @@ export class CollectionBrowserDataSource {
         // if a fetch is already in progress for this query and page, don't fetch again
         const { pageFetchQueryKey } = this;
         const pageFetches = (_b = this.pageFetchesInProgress[pageFetchQueryKey]) !== null && _b !== void 0 ? _b : new Set();
-        if (pageFetches.has(pageNumber)) {
-            console.log(`Skipping fetch for page ${pageNumber} because one is already in progress`);
+        if (pageFetches.has(pageNumber))
             return;
-        }
         for (let i = 0; i < numPages; i += 1) {
             pageFetches.add(pageNumber + i);
         }
+        console.log(`fetchPage(${pageNumber})`, this.id, this.canPerformSearch, this.hasPage(pageNumber), this.endOfDataReached, this.host.baseQuery, JSON.stringify(this.host.selectedFacets), this.pageFetchQueryKey);
         this.pageFetchesInProgress[pageFetchQueryKey] = pageFetches;
+        this.previousQueryKey = pageFetchQueryKey;
         const sortParams = this.host.sortParam ? [this.host.sortParam] : [];
         const params = {
             ...this.pageSpecifierParams,
@@ -602,6 +672,7 @@ export class CollectionBrowserDataSource {
             this.host.emitEmptyResults();
         }
         if (this.host.withinCollection) {
+            console.log('host is within collection, setting collection info:', success.response.collectionExtraInfo);
             this.collectionExtraInfo = success.response.collectionExtraInfo;
             // For collections, we want the UI to respect the default sort option
             // which can be specified in metadata, or otherwise assumed to be week:desc
@@ -611,10 +682,13 @@ export class CollectionBrowserDataSource {
             }
         }
         else if (this.host.withinProfile) {
-            console.log('host is within profile, setting acct info:', success.response.accountExtraInfo);
+            console.log('host is within profile, setting acct info:', success.response.accountExtraInfo, success.response.pageElements);
             this.accountExtraInfo = success.response.accountExtraInfo;
             this.pageElements = success.response.pageElements;
         }
+        else {
+            console.log('not within profile/collxn', this.host.withinCollection, this.host.withinProfile);
+        }
         const { results, collectionTitles } = success.response;
         if (results && results.length > 0) {
             // Load any collection titles present on the response into the cache,
@@ -657,57 +731,9 @@ export class CollectionBrowserDataSource {
         // const datasource = { ...this.dataSource };
         const tiles = [];
         results === null || results === void 0 ? void 0 : results.forEach(result => {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13;
             if (!result.identifier)
                 return;
-            let loginRequired = false;
-            let contentWarning = false;
-            // Check if item and item in "modifying" collection, setting above flags
-            if (((_a = result.collection) === null || _a === void 0 ? void 0 : _a.values.length) &&
-                ((_b = result.mediatype) === null || _b === void 0 ? void 0 : _b.value) !== 'collection') {
-                for (const collection of (_d = (_c = result.collection) === null || _c === void 0 ? void 0 : _c.values) !== null && _d !== void 0 ? _d : []) {
-                    if (collection === 'loggedin') {
-                        loginRequired = true;
-                        if (contentWarning)
-                            break;
-                    }
-                    if (collection === 'no-preview') {
-                        contentWarning = true;
-                        if (loginRequired)
-                            break;
-                    }
-                }
-            }
-            tiles.push({
-                averageRating: (_e = result.avg_rating) === null || _e === void 0 ? void 0 : _e.value,
-                checked: false,
-                collections: (_g = (_f = result.collection) === null || _f === void 0 ? void 0 : _f.values) !== null && _g !== void 0 ? _g : [],
-                collectionFilesCount: (_j = (_h = result.collection_files_count) === null || _h === void 0 ? void 0 : _h.value) !== null && _j !== void 0 ? _j : 0,
-                collectionSize: (_l = (_k = result.collection_size) === null || _k === void 0 ? void 0 : _k.value) !== null && _l !== void 0 ? _l : 0,
-                commentCount: (_o = (_m = result.num_reviews) === null || _m === void 0 ? void 0 : _m.value) !== null && _o !== void 0 ? _o : 0,
-                creator: (_p = result.creator) === null || _p === void 0 ? void 0 : _p.value,
-                creators: (_r = (_q = result.creator) === null || _q === void 0 ? void 0 : _q.values) !== null && _r !== void 0 ? _r : [],
-                dateAdded: (_s = result.addeddate) === null || _s === void 0 ? void 0 : _s.value,
-                dateArchived: (_t = result.publicdate) === null || _t === void 0 ? void 0 : _t.value,
-                datePublished: (_u = result.date) === null || _u === void 0 ? void 0 : _u.value,
-                dateReviewed: (_v = result.reviewdate) === null || _v === void 0 ? void 0 : _v.value,
-                description: (_w = result.description) === null || _w === void 0 ? void 0 : _w.values.join('\n'),
-                favCount: (_y = (_x = result.num_favorites) === null || _x === void 0 ? void 0 : _x.value) !== null && _y !== void 0 ? _y : 0,
-                href: this.collapseRepeatedQuotes((_z = result.__href__) === null || _z === void 0 ? void 0 : _z.value),
-                identifier: result.identifier,
-                issue: (_0 = result.issue) === null || _0 === void 0 ? void 0 : _0.value,
-                itemCount: (_2 = (_1 = result.item_count) === null || _1 === void 0 ? void 0 : _1.value) !== null && _2 !== void 0 ? _2 : 0,
-                mediatype: this.getMediatype(result),
-                snippets: (_4 = (_3 = result.highlight) === null || _3 === void 0 ? void 0 : _3.values) !== null && _4 !== void 0 ? _4 : [],
-                source: (_5 = result.source) === null || _5 === void 0 ? void 0 : _5.value,
-                subjects: (_7 = (_6 = result.subject) === null || _6 === void 0 ? void 0 : _6.values) !== null && _7 !== void 0 ? _7 : [],
-                title: (_9 = (_8 = result.title) === null || _8 === void 0 ? void 0 : _8.value) !== null && _9 !== void 0 ? _9 : '',
-                volume: (_10 = result.volume) === null || _10 === void 0 ? void 0 : _10.value,
-                viewCount: (_12 = (_11 = result.downloads) === null || _11 === void 0 ? void 0 : _11.value) !== null && _12 !== void 0 ? _12 : 0,
-                weeklyViewCount: (_13 = result.week) === null || _13 === void 0 ? void 0 : _13.value,
-                loginRequired,
-                contentWarning,
-            });
+            tiles.push(new TileModel(result));
         });
         this.addPage(pageNumber, tiles);
         const visiblePages = this.host.currentVisiblePageNumbers;
@@ -716,42 +742,6 @@ export class CollectionBrowserDataSource {
             this.host.refreshVisibleResults();
         }
     }
-    /**
-     * Returns the mediatype string for the given search result, taking into account
-     * the special `favorited_search` hit type.
-     * @param result The search result to extract a mediatype from
-     */
-    getMediatype(result) {
-        var _a, _b, _c;
-        /**
-         * hit_type == 'favorited_search' is basically a new hit_type
-         * - we are getting from PPS.
-         * - which gives response for fav- collection
-         * - having favorited items like account/collection/item etc..
-         * - as user can also favorite a search result (a search page)
-         * - so we need to have response (having fav- items and fav- search results)
-         *
-         * if backend hit_type == 'favorited_search'
-         * - let's assume a "search" as new mediatype
-         */
-        if (((_a = result === null || result === void 0 ? void 0 : result.rawMetadata) === null || _a === void 0 ? void 0 : _a.hit_type) === 'favorited_search') {
-            return 'search';
-        }
-        return (_c = (_b = result.mediatype) === null || _b === void 0 ? void 0 : _b.value) !== null && _c !== void 0 ? _c : 'data';
-    }
-    /**
-     * Returns the input string, but removing one set of quotes from all instances of
-     * ""clauses wrapped in two sets of quotes"". This assumes the quotes are already
-     * URL-encoded.
-     *
-     * This should be a temporary measure to address the fact that the __href__ field
-     * sometimes acquires extra quotation marks during query rewriting. Once there is a
-     * full Lucene parser in place that handles quoted queries correctly, this can likely
-     * be removed.
-     */
-    collapseRepeatedQuotes(str) {
-        return str === null || str === void 0 ? void 0 : str.replace(/%22%22(?!%22%22)(.+?)%22%22/g, '%22$1%22');
-    }
     /**
      * Fetches the aggregation buckets for the given prefix filter type.
      */