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

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

@@ -12,13 +12,13 @@ import {
   SearchResult,
   SearchType,
 } from '@internetarchive/search-service';
-import type { MediaType } from '@internetarchive/field-parsers';
 import {
   prefixFilterAggregationKeys,
   type FacetBucket,
   type PrefixFilterType,
-  type TileModel,
+  TileModel,
   PrefixFilterCounts,
+  RequestKind,
 } from '../models';
 import type {
   CollectionBrowserSearchInterface,
@@ -27,8 +27,6 @@ import type {
 } from './models';
 import { sha1 } from '../utils/sha1';
 
-type RequestKind = 'full' | 'hits' | 'aggregations';
-
 export interface CollectionBrowserDataSourceInterface
   extends ReactiveController {
   /**
@@ -50,6 +48,12 @@ export interface CollectionBrowserDataSourceInterface
    */
   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
@@ -134,6 +138,20 @@ export interface CollectionBrowserDataSourceInterface
    */
   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.
@@ -197,11 +215,6 @@ export interface CollectionBrowserDataSourceInterface
    */
   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.
@@ -248,6 +261,14 @@ export class CollectionBrowserDataSource
    */
   private pageFetchesInProgress: Record<string, Set<number>> = {};
 
+  /**
+   * A record of the query key used for the last search.
+   * If this changes, we need to load new results.
+   */
+  private previousQueryKey: string = '';
+
+  private id = Math.random();
+
   /**
    * @inheritdoc
    */
@@ -258,6 +279,11 @@ export class CollectionBrowserDataSource
    */
   endOfDataReached = false;
 
+  /**
+   * @inheritdoc
+   */
+  queryInitialized = false;
+
   /**
    * @inheritdoc
    */
@@ -299,6 +325,26 @@ export class CollectionBrowserDataSource
   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!: (val: boolean) => void;
+
+  /**
+   * Internal property to store the private value backing the `initialSearchComplete` getter.
+   */
+  private _initialSearchCompletePromise: Promise<boolean> = new Promise(res => {
+    this._initialSearchCompleteResolver = res;
+  });
+
+  /**
+   * @inheritdoc
+   */
+  get initialSearchComplete(): Promise<boolean> {
+    return this._initialSearchCompletePromise;
+  }
+
   constructor(
     /** The host element to which this controller should attach listeners */
     private readonly host: ReactiveControllerHost &
@@ -306,7 +352,35 @@ export class CollectionBrowserDataSource
     /** Default size of result pages */
     private pageSize: number
   ) {
-    this.host.addController(this as CollectionBrowserDataSourceInterface);
+    // console.log('adding controller', this.id);
+    // this.host.addController(this as CollectionBrowserDataSourceInterface);
+  }
+
+  hostUpdate(): void {
+    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();
   }
 
   /**
@@ -316,6 +390,29 @@ export class CollectionBrowserDataSource
     return this.numTileModels;
   }
 
+  /**
+   * @inheritdoc
+   */
+  reset(): void {
+    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
    */
@@ -370,35 +467,26 @@ export class CollectionBrowserDataSource
     this.pageSize = pageSize;
   }
 
-  /**
-   * @inheritdoc
-   */
-  reset(): void {
-    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(): Promise<void> {
     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);
   }
 
   /**
@@ -423,14 +511,22 @@ export class CollectionBrowserDataSource
    * @inheritdoc
    */
   checkAllTiles = (): void => {
-    this.map(model => ({ ...model, checked: true }));
+    this.map(model => {
+      const cloned = model.clone();
+      cloned.checked = true;
+      return cloned;
+    });
   };
 
   /**
    * @inheritdoc
    */
   uncheckAllTiles = (): void => {
-    this.map(model => ({ ...model, checked: false }));
+    this.map(model => {
+      const cloned = model.clone();
+      cloned.checked = false;
+      return cloned;
+    });
   };
 
   /**
@@ -474,6 +570,7 @@ export class CollectionBrowserDataSource
     this.pages = newPages;
     this.numTileModels -= numChecked;
     this.host.requestUpdate();
+    this.host.refreshVisibleResults();
   };
 
   /**
@@ -542,15 +639,15 @@ 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(): string {
-    const profileKey = `${this.host.withinProfile}--${this.host.profileElement}`;
+    const profileKey = `pf;${this.host.withinProfile}--pe;${this.host.profileElement}`;
     const pageTarget = this.host.withinCollection ?? profileKey;
     const sortField = this.host.sortParam?.field ?? 'none';
     const sortDirection = this.host.sortParam?.direction ?? 'none';
-    return `${this.fullQuery}-${pageTarget}-${this.host.searchType}-${sortField}-${sortDirection}`;
+    return `fq:${this.fullQuery}-pt:${pageTarget}-st:${this.host.searchType}-sf:${sortField}-sd:${sortDirection}`;
   }
 
   /**
@@ -826,8 +923,10 @@ export class CollectionBrowserDataSource
    * the current search state.
    */
   private async fetchFacets(): Promise<void> {
+    console.log('fetchFacets', this.id, this.host.profileElement);
     const trimmedQuery = this.host.baseQuery?.trim();
     if (!this.canPerformSearch) return;
+    console.log('will actually fetch facets');
 
     const { facetFetchQueryKey } = this;
 
@@ -859,7 +958,14 @@ export class CollectionBrowserDataSource
     // likely no longer valid for the newer query.
     const queryChangedSinceFetch =
       facetFetchQueryKey !== this.facetFetchQueryKey;
-    if (queryChangedSinceFetch) return;
+    if (queryChangedSinceFetch) {
+      console.log(
+        'facet query has changed since fetch, returning. new/old:',
+        this.facetFetchQueryKey,
+        facetFetchQueryKey
+      );
+      return;
+    }
 
     if (!success) {
       const errorMsg = searchResponse?.error?.message;
@@ -873,6 +979,7 @@ export class CollectionBrowserDataSource
         );
       }
 
+      this.host.setFacetsLoading(false);
       return;
     }
 
@@ -911,14 +1018,6 @@ export class CollectionBrowserDataSource
    *  if `pageNumber != 1`, defaulting to a single page.
    */
   async fetchPage(pageNumber: number, numInitialPages = 1): Promise<void> {
-    console.log(
-      `fetchPage(${pageNumber})`,
-      this.canPerformSearch,
-      this.hasPage(pageNumber),
-      this.endOfDataReached,
-      this.host.baseQuery,
-      JSON.stringify(this.host.selectedFacets)
-    );
     const trimmedQuery = this.host.baseQuery?.trim();
     if (!this.canPerformSearch) return;
 
@@ -936,16 +1035,23 @@ export class CollectionBrowserDataSource
     const { pageFetchQueryKey } = this;
     const pageFetches =
       this.pageFetchesInProgress[pageFetchQueryKey] ?? new Set();
-    if (pageFetches.has(pageNumber)) {
-      console.log(
-        `Skipping fetch for page ${pageNumber} because one is already in progress`
-      );
-      return;
-    }
+    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: SearchParams = {
@@ -1006,6 +1112,10 @@ export class CollectionBrowserDataSource
     }
 
     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
@@ -1020,10 +1130,17 @@ export class CollectionBrowserDataSource
     } else if (this.host.withinProfile) {
       console.log(
         'host is within profile, setting acct info:',
-        success.response.accountExtraInfo
+        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;
@@ -1080,56 +1197,7 @@ export class CollectionBrowserDataSource
     const tiles: TileModel[] = [];
     results?.forEach(result => {
       if (!result.identifier) return;
-
-      let loginRequired = false;
-      let contentWarning = false;
-      // Check if item and item in "modifying" collection, setting above flags
-      if (
-        result.collection?.values.length &&
-        result.mediatype?.value !== 'collection'
-      ) {
-        for (const collection of result.collection?.values ?? []) {
-          if (collection === 'loggedin') {
-            loginRequired = true;
-            if (contentWarning) break;
-          }
-          if (collection === 'no-preview') {
-            contentWarning = true;
-            if (loginRequired) break;
-          }
-        }
-      }
-
-      tiles.push({
-        averageRating: result.avg_rating?.value,
-        checked: false,
-        collections: result.collection?.values ?? [],
-        collectionFilesCount: result.collection_files_count?.value ?? 0,
-        collectionSize: result.collection_size?.value ?? 0,
-        commentCount: result.num_reviews?.value ?? 0,
-        creator: result.creator?.value,
-        creators: result.creator?.values ?? [],
-        dateAdded: result.addeddate?.value,
-        dateArchived: result.publicdate?.value,
-        datePublished: result.date?.value,
-        dateReviewed: result.reviewdate?.value,
-        description: result.description?.values.join('\n'),
-        favCount: result.num_favorites?.value ?? 0,
-        href: this.collapseRepeatedQuotes(result.__href__?.value),
-        identifier: result.identifier,
-        issue: result.issue?.value,
-        itemCount: result.item_count?.value ?? 0,
-        mediatype: this.getMediatype(result),
-        snippets: result.highlight?.values ?? [],
-        source: result.source?.value,
-        subjects: result.subject?.values ?? [],
-        title: result.title?.value ?? '',
-        volume: result.volume?.value,
-        viewCount: result.downloads?.value ?? 0,
-        weeklyViewCount: result.week?.value,
-        loginRequired,
-        contentWarning,
-      });
+      tiles.push(new TileModel(result));
     });
     this.addPage(pageNumber, tiles);
     const visiblePages = this.host.currentVisiblePageNumbers;
@@ -1139,44 +1207,6 @@ export class CollectionBrowserDataSource
     }
   }
 
-  /**
-   * 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(result: SearchResult): MediaType {
-    /**
-     * 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 (result?.rawMetadata?.hit_type === 'favorited_search') {
-      return 'search';
-    }
-
-    return result.mediatype?.value ?? '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.
-   */
-  private collapseRepeatedQuotes(str?: string): string | undefined {
-    return str?.replace(/%22%22(?!%22%22)(.+?)%22%22/g, '%22$1%22');
-  }
-
   /**
    * Fetches the aggregation buckets for the given prefix filter type.
    */

package/src/data-source/models.ts

@@ -1,5 +1,6 @@
 import type {
   CollectionExtraInfo,
+  PageElementName,
   PageType,
   SearchServiceInterface,
   SearchType,
@@ -7,6 +8,7 @@ import type {
   SortParam,
 } from '@internetarchive/search-service';
 import type { SelectedFacets, SortField } from '../models';
+import type { CollectionBrowserDataSourceInterface } from './collection-browser-data-source';
 
 /**
  * A Map from collection identifiers to their corresponding collection titles.
@@ -30,7 +32,7 @@ export type PageSpecifierParams = {
    * Which specific elements of a profile page to fetch. Corresponds to individual tab data
    * (e.g., "uploads", "reviews", ...)
    */
-  pageElements?: string[];
+  pageElements?: PageElementName[];
 };
 
 /**
@@ -40,7 +42,7 @@ export interface CollectionBrowserQueryState {
   baseQuery?: string;
   withinCollection?: string;
   withinProfile?: string;
-  profileElement?: string;
+  profileElement?: PageElementName;
   searchType: SearchType;
   selectedFacets?: SelectedFacets;
   minSelectedDate?: string;
@@ -63,6 +65,8 @@ export interface CollectionBrowserSearchInterface
   readonly suppressFacets?: boolean;
   readonly initialPageNumber: number;
   readonly currentVisiblePageNumbers: number[];
+  readonly clearResultsOnEmptyQuery?: boolean;
+  readonly dataSource?: CollectionBrowserDataSourceInterface;
 
   getSessionId(): Promise<string>;
   setSearchResultsLoading(loading: boolean): void;
@@ -71,5 +75,6 @@ export interface CollectionBrowserSearchInterface
   setTileCount(count: number): void;
   applyDefaultCollectionSort(collectionInfo?: CollectionExtraInfo): void;
   emitEmptyResults(): void;
+  emitQueryStateChanged(): void;
   refreshVisibleResults(): void;
 }

package/src/manage/manage-bar.ts

@@ -6,7 +6,7 @@ import { when } from 'lit/directives/when.js';
 export interface ManageableItem {
   identifier: string;
   title?: string;
-  date?: string;
+  dateStr?: string;
 }
 
 @customElement('manage-bar')