@internetarchive/collection-browser 4.2.1-alpha-webdev8165.0 → 4.3.0

package/src/tiles/tile-display-value-provider.ts

@@ -1,124 +1,134 @@
-import { TemplateResult, html, nothing } from 'lit';
-import { msg, str } from '@lit/localize';
-import type { SortParam } from '@internetarchive/search-service';
-import type { TileModel } from '../models';
-import { formatDate } from '../utils/format-date';
-
-/**
- * A class encapsulating shared logic for converting model values into display values
- * across different types of tiles.
- */
-export class TileDisplayValueProvider {
-  private model?: TileModel;
-
-  private baseNavigationUrl?: string;
-
-  private collectionPagePath?: string;
-
-  private sortParam?: SortParam;
-
-  private creatorFilter?: string;
-
-  constructor(
-    options: {
-      model?: TileModel;
-      baseNavigationUrl?: string;
-      collectionPagePath?: string;
-      sortParam?: SortParam;
-      creatorFilter?: string;
-    } = {},
-  ) {
-    this.model = options.model;
-    this.baseNavigationUrl = options.baseNavigationUrl;
-    this.collectionPagePath = options.collectionPagePath ?? '/details/';
-    this.sortParam = options.sortParam;
-    this.creatorFilter = options.creatorFilter;
-  }
-
-  /**
-   * Examines the creator(s) for the given tile model, returning
-   * the first creator whose name matches the provided filter
-   * (or simply the first creator overall if no filter is provided).
-   */
-  get firstCreatorMatchingFilter(): string | undefined {
-    let matchingCreator;
-
-    // If we're filtering by creator initial and have multiple creators, we want
-    // to surface the first creator who matches the filter.
-    if (this.creatorFilter && this.model?.creators.length) {
-      const firstLetter = this.creatorFilter; // This is just to satisfy tsc
-      matchingCreator = this.model.creators.find(creator =>
-        // Decompose combining characters first, so that e.g., filtering on E matches É too.
-        // Then remove anything that isn't strictly alphabetic, since our filters currently
-        // only handle A-Z. The first such letter (if one exists) is what needs to match.
-        creator
-          .normalize('NFD')
-          .replace(/[^A-Z]+/gi, '')
-          .toUpperCase()
-          .startsWith(firstLetter),
-      );
-    }
-
-    return matchingCreator ?? this.model?.creator;
-  }
-
-  /**
-   * The label indicating what year an account item was created.
-   * E.g., "Archivist since 2015"
-   */
-  get accountLabel(): string {
-    return this.model?.dateAdded
-      ? msg(str`Archivist since ${this.model.dateAdded.getFullYear()}`)
-      : '';
-  }
-
-  /**
-   * The readable label for the current sort if it is a type of date sort,
-   * or the empty string otherwise.
-   */
-  get dateLabel(): string {
-    switch (this.sortParam?.field) {
-      case 'publicdate':
-        return msg('Archived');
-      case 'reviewdate':
-        return msg('Reviewed');
-      case 'addeddate':
-        return msg('Added');
-      case 'date':
-        return msg('Published');
-      default:
-        return '';
-    }
-  }
-
-  /**
-   * Produces a URL pointing at the item page for the given identifier,
-   * using the current base URL and the correct path based on whether the
-   * item is specified to be a collection (default false).
-   */
-  itemPageUrl(
-    identifier?: string,
-    isCollection = false,
-  ): string | typeof nothing {
-    if (!identifier || this.baseNavigationUrl == null) return nothing;
-    const basePath = isCollection ? this.collectionPagePath : '/details/';
-    return `${this.baseNavigationUrl}${basePath}${identifier}`;
-  }
-
-  /**
-   * Produces a template for a link to a single web capture of the given URL and date
-   */
-  webArchivesCaptureLink(url: string, date: Date): TemplateResult {
-    // Convert the date into the format used to identify wayback captures (e.g., '20150102124550')
-    const captureDateStr = date
-      .toISOString()
-      .replace(/[TZ:-]/g, '')
-      .replace(/\..*/, '');
-    const captureHref = `https://web.archive.org/web/${captureDateStr}/${encodeURIComponent(
-      url,
-    )}`;
-    const captureText = formatDate(date, 'long');
-
-    return html` <a href=${captureHref}> ${captureText} </a> `;
-  }
-}
+import { TemplateResult, html, nothing } from 'lit';
+import { msg, str } from '@lit/localize';
+import type { SortParam } from '@internetarchive/search-service';
+import type { TileModel } from '../models';
+import { formatDate } from '../utils/format-date';
+
+/**
+ * A class encapsulating shared logic for converting model values into display values
+ * across different types of tiles.
+ */
+export class TileDisplayValueProvider {
+  private model?: TileModel;
+
+  private baseNavigationUrl?: string;
+
+  private collectionPagePath?: string;
+
+  private sortParam?: SortParam;
+
+  private creatorFilter?: string;
+
+  constructor(
+    options: {
+      model?: TileModel;
+      baseNavigationUrl?: string;
+      collectionPagePath?: string;
+      sortParam?: SortParam;
+      creatorFilter?: string;
+    } = {},
+  ) {
+    this.model = options.model;
+    this.baseNavigationUrl = options.baseNavigationUrl;
+    this.collectionPagePath = options.collectionPagePath ?? '/details/';
+    this.sortParam = options.sortParam;
+    this.creatorFilter = options.creatorFilter;
+  }
+
+  /**
+   * Examines the creator(s) for the given tile model, returning
+   * the first creator whose name matches the provided filter
+   * (or simply the first creator overall if no filter is provided).
+   */
+  get firstCreatorMatchingFilter(): string | undefined {
+    let matchingCreator;
+
+    // If we're filtering by creator initial and have multiple creators, we want
+    // to surface the first creator who matches the filter.
+    if (this.creatorFilter && this.model?.creators.length) {
+      const firstLetter = this.creatorFilter; // This is just to satisfy tsc
+      matchingCreator = this.model.creators.find(creator =>
+        // Decompose combining characters first, so that e.g., filtering on E matches É too.
+        // Then remove anything that isn't strictly alphabetic, since our filters currently
+        // only handle A-Z. The first such letter (if one exists) is what needs to match.
+        creator
+          .normalize('NFD')
+          .replace(/[^A-Z]+/gi, '')
+          .toUpperCase()
+          .startsWith(firstLetter),
+      );
+    }
+
+    return matchingCreator ?? this.model?.creator;
+  }
+
+  /**
+   * The label indicating what year an account item was created.
+   * E.g., "Archivist since 2015"
+   */
+  get accountLabel(): string {
+    return this.model?.dateAdded
+      ? msg(str`Archivist since ${this.model.dateAdded.getFullYear()}`)
+      : '';
+  }
+
+  /**
+   * The readable label for the current sort if it is a type of date sort,
+   * or the empty string otherwise.
+   */
+  get dateLabel(): string {
+    switch (this.sortParam?.field) {
+      case 'publicdate':
+        return msg('Archived');
+      case 'reviewdate':
+        return msg('Reviewed');
+      case 'addeddate':
+        return msg('Added');
+      case 'date':
+        return msg('Published');
+      default:
+        return '';
+    }
+  }
+
+  /**
+   * The readable label for the current views column, based on whether
+   * weekly or all-time views are being shown.
+   */
+  get viewsLabel(): string {
+    return this.sortParam?.field === 'week'
+      ? msg('Weekly views')
+      : msg('All-time views');
+  }
+
+  /**
+   * Produces a URL pointing at the item page for the given identifier,
+   * using the current base URL and the correct path based on whether the
+   * item is specified to be a collection (default false).
+   */
+  itemPageUrl(
+    identifier?: string,
+    isCollection = false,
+  ): string | typeof nothing {
+    if (!identifier || this.baseNavigationUrl == null) return nothing;
+    const basePath = isCollection ? this.collectionPagePath : '/details/';
+    return `${this.baseNavigationUrl}${basePath}${identifier}`;
+  }
+
+  /**
+   * Produces a template for a link to a single web capture of the given URL and date
+   */
+  webArchivesCaptureLink(url: string, date: Date): TemplateResult {
+    // Convert the date into the format used to identify wayback captures (e.g., '20150102124550')
+    const captureDateStr = date
+      .toISOString()
+      .replace(/[TZ:-]/g, '')
+      .replace(/\..*/, '');
+    const captureHref = `https://web.archive.org/web/${captureDateStr}/${encodeURIComponent(
+      url,
+    )}`;
+    const captureText = formatDate(date, 'long');
+
+    return html` <a href=${captureHref}> ${captureText} </a> `;
+  }
+}

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

@@ -1,131 +1,193 @@
-import { expect, fixture } from '@open-wc/testing';
-import { html } from 'lit';
-import sinon from 'sinon';
-import { ItemHit, SearchType } from '@internetarchive/search-service';
-import { CollectionBrowserDataSource } from '../../src/data-source/collection-browser-data-source';
-import { TileModel } from '../../src/models';
-import type { CollectionBrowser } from '../../src/collection-browser';
-import '../../src/collection-browser';
-import { MockSearchService } from '../mocks/mock-search-service';
-
-const dataPage: TileModel[] = [
-  new TileModel(
-    new ItemHit({
-      fields: {
-        identifier: 'foo',
-      },
-    }),
-  ),
-  new TileModel(
-    new ItemHit({
-      fields: {
-        identifier: 'bar',
-      },
-    }),
-  ),
-];
-
-describe('Collection Browser Data Source', () => {
-  let host: CollectionBrowser;
-
-  beforeEach(async () => {
-    host = await fixture<CollectionBrowser>(html`
-      <collection-browser></collection-browser>
-    `);
-  });
-
-  it('can add and retrieve data pages', () => {
-    const dataSource = new CollectionBrowserDataSource(host);
-    dataSource.addPage(1, dataPage);
-
-    expect(Object.keys(dataSource.getAllPages()).length).to.equal(1);
-    expect(dataSource.getPage(1).length).to.equal(2);
-    expect(dataSource.getPage(1)[0].identifier).to.equal('foo');
-    expect(dataSource.getPage(1)[1].identifier).to.equal('bar');
-  });
-
-  it('can add data split across multiple pages', () => {
-    const dataSource = new CollectionBrowserDataSource(host, 3);
-    const doubledDataPage = [...dataPage, ...dataPage];
-    dataSource.addMultiplePages(1, doubledDataPage);
-
-    expect(Object.keys(dataSource.getAllPages()).length).to.equal(2);
-    expect(dataSource.getPage(1).length).to.equal(3);
-    expect(dataSource.getPage(2).length).to.equal(1);
-    expect(dataSource.getPage(1)[0].identifier).to.equal('foo');
-    expect(dataSource.getPage(1)[1].identifier).to.equal('bar');
-    expect(dataSource.getPage(1)[2].identifier).to.equal('foo');
-    expect(dataSource.getPage(2)[0].identifier).to.equal('bar');
-  });
-
-  it('resets data when changing page size', () => {
-    const dataSource = new CollectionBrowserDataSource(host);
-    dataSource.addPage(1, dataPage);
-
-    dataSource.setPageSize(100);
-    expect(Object.keys(dataSource.getAllPages()).length).to.equal(0);
-    expect(dataSource.getPageSize()).to.equal(100);
-  });
-
-  it('can be installed on the host', async () => {
-    const dataSource = new CollectionBrowserDataSource(host);
-    dataSource.addPage(1, dataPage);
-
-    host.installDataSourceAndQueryState(dataSource, {
-      searchType: SearchType.METADATA,
-      sortDirection: null,
-      selectedTitleFilter: null,
-      selectedCreatorFilter: null,
-      baseQuery: 'foobar',
-    });
-
-    await host.updateComplete;
-
-    expect(host.dataSource).to.equal(dataSource);
-    expect(host.baseQuery).to.equal('foobar');
-
-    host.removeController(dataSource);
-  });
-
-  it('can suppress further fetches', async () => {
-    host.searchService = new MockSearchService();
-
-    const pageFetchSpy = sinon.spy();
-    const dataSource = new CollectionBrowserDataSource(host);
-    dataSource.fetchPage = pageFetchSpy;
-
-    dataSource.addPage(1, dataPage);
-    dataSource.setFetchesSuppressed(true);
-    dataSource.handleQueryChange();
-
-    expect(pageFetchSpy.callCount).to.equal(0);
-  });
-
-  it('can set its initial page batch size', async () => {
-    host.searchService = new MockSearchService();
-
-    const pageFetchSpy = sinon.spy();
-    const dataSource = new CollectionBrowserDataSource(host);
-    dataSource.setNumInitialPages(10);
-    dataSource.fetchPage = pageFetchSpy;
-
-    dataSource.handleQueryChange();
-
-    // Uses specified number of initial pages
-    expect(pageFetchSpy.args[0][1]).to.equal(10);
-  });
-
-  it('refreshes prefix filter counts', () => {
-    const dataSource = new CollectionBrowserDataSource(host);
-    dataSource.addPage(1, dataPage);
-
-    dataSource.prefixFilterCountMap = {
-      title: {
-        X: 10,
-      },
-    };
-
-    dataSource.refreshLetterCounts();
-    expect(dataSource.prefixFilterCountMap).to.deep.equal({});
-  });
-});
+import { expect, fixture } from '@open-wc/testing';
+import { html } from 'lit';
+import sinon from 'sinon';
+import { ItemHit, SearchType } from '@internetarchive/search-service';
+import { CollectionBrowserDataSource } from '../../src/data-source/collection-browser-data-source';
+import { TileModel } from '../../src/models';
+import type { CollectionBrowser } from '../../src/collection-browser';
+import '../../src/collection-browser';
+import { MockSearchService } from '../mocks/mock-search-service';
+
+const dataPage: TileModel[] = [
+  new TileModel(
+    new ItemHit({
+      fields: {
+        identifier: 'foo',
+      },
+    }),
+  ),
+  new TileModel(
+    new ItemHit({
+      fields: {
+        identifier: 'bar',
+      },
+    }),
+  ),
+];
+
+describe('Collection Browser Data Source', () => {
+  let host: CollectionBrowser;
+
+  beforeEach(async () => {
+    host = await fixture<CollectionBrowser>(html`
+      <collection-browser></collection-browser>
+    `);
+  });
+
+  it('can add and retrieve data pages', () => {
+    const dataSource = new CollectionBrowserDataSource(host);
+    dataSource.addPage(1, dataPage);
+
+    expect(Object.keys(dataSource.getAllPages()).length).to.equal(1);
+    expect(dataSource.getPage(1).length).to.equal(2);
+    expect(dataSource.getPage(1)[0].identifier).to.equal('foo');
+    expect(dataSource.getPage(1)[1].identifier).to.equal('bar');
+  });
+
+  it('can add data split across multiple pages', () => {
+    const dataSource = new CollectionBrowserDataSource(host, 3);
+    const doubledDataPage = [...dataPage, ...dataPage];
+    dataSource.addMultiplePages(1, doubledDataPage);
+
+    expect(Object.keys(dataSource.getAllPages()).length).to.equal(2);
+    expect(dataSource.getPage(1).length).to.equal(3);
+    expect(dataSource.getPage(2).length).to.equal(1);
+    expect(dataSource.getPage(1)[0].identifier).to.equal('foo');
+    expect(dataSource.getPage(1)[1].identifier).to.equal('bar');
+    expect(dataSource.getPage(1)[2].identifier).to.equal('foo');
+    expect(dataSource.getPage(2)[0].identifier).to.equal('bar');
+  });
+
+  it('resets data when changing page size', () => {
+    const dataSource = new CollectionBrowserDataSource(host);
+    dataSource.addPage(1, dataPage);
+
+    dataSource.setPageSize(100);
+    expect(Object.keys(dataSource.getAllPages()).length).to.equal(0);
+    expect(dataSource.getPageSize()).to.equal(100);
+  });
+
+  it('can be installed on the host', async () => {
+    const dataSource = new CollectionBrowserDataSource(host);
+    dataSource.addPage(1, dataPage);
+
+    host.installDataSourceAndQueryState(dataSource, {
+      searchType: SearchType.METADATA,
+      sortDirection: null,
+      selectedTitleFilter: null,
+      selectedCreatorFilter: null,
+      baseQuery: 'foobar',
+    });
+
+    await host.updateComplete;
+
+    expect(host.dataSource).to.equal(dataSource);
+    expect(host.baseQuery).to.equal('foobar');
+
+    host.removeController(dataSource);
+  });
+
+  it('can suppress further fetches', async () => {
+    host.searchService = new MockSearchService();
+
+    const pageFetchSpy = sinon.spy();
+    const dataSource = new CollectionBrowserDataSource(host);
+    dataSource.fetchPage = pageFetchSpy;
+
+    dataSource.addPage(1, dataPage);
+    dataSource.setFetchesSuppressed(true);
+    dataSource.handleQueryChange();
+
+    expect(pageFetchSpy.callCount).to.equal(0);
+  });
+
+  it('can set its initial page batch size', async () => {
+    host.searchService = new MockSearchService();
+
+    const pageFetchSpy = sinon.spy();
+    const dataSource = new CollectionBrowserDataSource(host);
+    dataSource.setNumInitialPages(10);
+    dataSource.fetchPage = pageFetchSpy;
+
+    dataSource.handleQueryChange();
+
+    // Uses specified number of initial pages
+    expect(pageFetchSpy.args[0][1]).to.equal(10);
+  });
+
+  it('refreshes prefix filter counts', () => {
+    const dataSource = new CollectionBrowserDataSource(host);
+    dataSource.addPage(1, dataPage);
+
+    dataSource.prefixFilterCountMap = {
+      title: {
+        X: 10,
+      },
+    };
+
+    dataSource.refreshLetterCounts();
+    expect(dataSource.prefixFilterCountMap).to.deep.equal({});
+  });
+
+  describe('empty FTS query in collection falls back to metadata search', () => {
+    it('allows search with empty query and FTS in a collection', async () => {
+      const searchService = new MockSearchService();
+      host.searchService = searchService;
+      host.withinCollection = 'test-collection';
+      host.searchType = SearchType.FULLTEXT;
+      host.baseQuery = '';
+      await host.updateComplete;
+
+      const dataSource = new CollectionBrowserDataSource(host);
+      host.addController(dataSource);
+      expect(dataSource.canPerformSearch).to.be.true;
+      host.removeController(dataSource);
+    });
+
+    it('uses metadata search type for fetch when FTS query is empty in a collection', async () => {
+      const searchService = new MockSearchService();
+      host.searchService = searchService;
+      host.withinCollection = 'test-collection';
+      host.searchType = SearchType.FULLTEXT;
+      host.baseQuery = '';
+      await host.updateComplete;
+
+      const dataSource = new CollectionBrowserDataSource(host);
+      host.addController(dataSource);
+      await dataSource.fetchPage(1);
+
+      expect(searchService.searchType).to.equal(SearchType.METADATA);
+      host.removeController(dataSource);
+    });
+
+    it('uses FTS search type for fetch when FTS query is non-empty in a collection', async () => {
+      const searchService = new MockSearchService();
+      host.searchService = searchService;
+      host.withinCollection = 'test-collection';
+      host.searchType = SearchType.FULLTEXT;
+      host.baseQuery = 'some query';
+      await host.updateComplete;
+
+      const dataSource = new CollectionBrowserDataSource(host);
+      host.addController(dataSource);
+      await dataSource.fetchPage(1);
+
+      expect(searchService.searchType).to.equal(SearchType.FULLTEXT);
+      host.removeController(dataSource);
+    });
+
+    it('does not allow search with empty FTS query outside a collection', async () => {
+      const searchService = new MockSearchService();
+      host.searchService = searchService;
+      host.withinCollection = undefined;
+      host.searchType = SearchType.FULLTEXT;
+      host.baseQuery = '';
+      await host.updateComplete;
+
+      const dataSource = new CollectionBrowserDataSource(host);
+      host.addController(dataSource);
+      expect(dataSource.canPerformSearch).to.be.false;
+      host.removeController(dataSource);
+    });
+  });
+});