@internetarchive/collection-browser 0.3.7 → 0.3.8

package/test/collection-browser.test.ts

@@ -4,6 +4,7 @@ import { html } from 'lit';
 import sinon from 'sinon';
 import type { InfiniteScroller } from '@internetarchive/infinite-scroller';
 import { SearchType } from '@internetarchive/search-service';
+import type { HistogramDateRange } from '@internetarchive/histogram-date-range';
 import type { CollectionBrowser } from '../src/collection-browser';
 import '../src/collection-browser';
 import {
@@ -17,6 +18,7 @@ import { MockCollectionNameCache } from './mocks/mock-collection-name-cache';
 import { MockAnalyticsHandler } from './mocks/mock-analytics-handler';
 import { analyticsCategories } from '../src/utils/analytics-events';
 import type { TileDispatcher } from '../src/tiles/tile-dispatcher';
+import type { CollectionFacets } from '../src/collection-facets';
 
 describe('Collection Browser', () => {
   beforeEach(async () => {
@@ -289,6 +291,98 @@ describe('Collection Browser', () => {
     );
   });
 
+  it('fires a separate date histogram query when year facets are applied', async () => {
+    const searchService = new MockSearchService();
+    const selectedFacets: SelectedFacets = {
+      subject: {},
+      lending: {},
+      mediatype: {},
+      language: {},
+      creator: {},
+      collection: {},
+      year: {
+        '2000': {
+          key: '2000',
+          state: 'selected',
+          count: 123,
+        },
+      },
+    };
+
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser .searchService=${searchService}>
+      </collection-browser>`
+    );
+
+    el.baseQuery = 'collection:foo';
+    el.showHistogramDatePicker = true;
+    el.selectedFacets = selectedFacets;
+    await el.updateComplete;
+
+    expect(
+      searchService.searchParams?.aggregations?.simpleParams
+    ).to.deep.equal(['year']); // Explicitly requests year aggregations
+    expect(searchService.searchParams?.query).to.equal(
+      'collection:foo' // No date clause on query
+    );
+  });
+
+  it('fires a separate date histogram query when a date range is applied', async () => {
+    const searchService = new MockSearchService();
+
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser .searchService=${searchService}>
+      </collection-browser>`
+    );
+
+    el.baseQuery = 'collection:foo';
+    el.showHistogramDatePicker = true;
+    el.dateRangeQueryClause = 'year:[1995 TO 2005]';
+    await el.updateComplete;
+
+    expect(
+      searchService.searchParams?.aggregations?.simpleParams
+    ).to.deep.equal(['year']); // Explicitly requests year aggregations
+    expect(searchService.searchParams?.query).to.equal(
+      'collection:foo' // No date clause on query
+    );
+  });
+
+  it('does not fire a separate date histogram query when no date filters are applied', async () => {
+    const searchService = new MockSearchService();
+
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser .searchService=${searchService}>
+      </collection-browser>`
+    );
+
+    el.baseQuery = 'collection:foo';
+    el.showHistogramDatePicker = true;
+    await el.updateComplete;
+
+    expect(searchService.searchParams?.aggregations?.simpleParams).to.satisfy(
+      (aggTypes: string[]) => !aggTypes || !aggTypes.includes('year') // Not requesting year aggregations explicitly
+    );
+  });
+
+  it('does not fire a separate date histogram query when date picker is disabled', async () => {
+    const searchService = new MockSearchService();
+
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser .searchService=${searchService}>
+      </collection-browser>`
+    );
+
+    el.baseQuery = 'collection:foo';
+    el.showHistogramDatePicker = false;
+    el.dateRangeQueryClause = 'year:[1995 TO 2005]';
+    await el.updateComplete;
+
+    expect(searchService.searchParams?.aggregations?.simpleParams).to.satisfy(
+      (aggTypes: string[]) => !aggTypes || !aggTypes.includes('year') // Not requesting year aggregations explicitly
+    );
+  });
+
   it('fails gracefully if no search service provided', async () => {
     const el = await fixture<CollectionBrowser>(
       html`<collection-browser></collection-browser>`
@@ -381,6 +475,28 @@ describe('Collection Browser', () => {
     expect(cell.model?.contentWarning).to.be.true;
   });
 
+  it('joins full description array into a single string with line breaks', async () => {
+    const searchService = new MockSearchService();
+
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser .searchService=${searchService}>
+      </collection-browser>`
+    );
+
+    // This query receives an array description like ['line1', 'line2']
+    el.baseQuery = 'multi-line-description';
+    await el.updateComplete;
+
+    const cellTemplate = el.cellForIndex(0);
+    expect(cellTemplate).to.exist;
+
+    const cell = await fixture<TileDispatcher>(cellTemplate!);
+    expect(cell).to.exist;
+
+    // Actual model description should be joined
+    expect(cell.model?.description).to.equal('line1\nline2');
+  });
+
   it('can search on demand if only search type has changed', async () => {
     const searchService = new MockSearchService();
 
@@ -552,6 +668,97 @@ describe('Collection Browser', () => {
     expect(el.selectedSort).to.equal(SortField.title);
   });
 
+  it('sets sort filter properties when user selects title filter', async () => {
+    const searchService = new MockSearchService();
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser .searchService=${searchService}>
+      </collection-browser>`
+    );
+
+    el.baseQuery = 'collection:foo';
+    el.selectedTitleFilter = 'X';
+    await el.updateComplete;
+
+    // Wait an extra tick
+    await new Promise(res => {
+      setTimeout(res, 0);
+    });
+
+    expect(searchService.searchParams?.query).to.equal(
+      'collection:foo AND firstTitle:X'
+    );
+  });
+
+  it('sets sort filter properties when user selects creator filter', async () => {
+    const searchService = new MockSearchService();
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser .searchService=${searchService}>
+      </collection-browser>`
+    );
+
+    el.baseQuery = 'collection:foo';
+    el.selectedCreatorFilter = 'X';
+    await el.updateComplete;
+
+    // Wait an extra tick
+    await new Promise(res => {
+      setTimeout(res, 0);
+    });
+
+    expect(searchService.searchParams?.query).to.equal(
+      'collection:foo AND firstCreator:X'
+    );
+  });
+
+  it('sets date range query when date picker selection changed', async () => {
+    const searchService = new MockSearchService();
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser .searchService=${searchService}>
+      </collection-browser>`
+    );
+
+    el.baseQuery = 'years'; // Includes year_histogram aggregation in response
+    el.showHistogramDatePicker = true;
+    await el.updateComplete;
+
+    const facets = el.shadowRoot?.querySelector(
+      'collection-facets'
+    ) as CollectionFacets;
+    await facets?.updateComplete;
+
+    // Wait for the date picker to be rendered (which may take until the next tick)
+    await new Promise(res => {
+      setTimeout(res, 0);
+    });
+
+    const histogram = facets?.shadowRoot?.querySelector(
+      'histogram-date-range'
+    ) as HistogramDateRange;
+    expect(histogram).to.exist;
+
+    // Enter a new min date into the date picker
+    const minDateInput = histogram.shadowRoot?.querySelector(
+      '#date-min'
+    ) as HTMLInputElement;
+
+    const pressEnterEvent = new KeyboardEvent('keyup', {
+      key: 'Enter',
+    });
+
+    minDateInput.value = '1960';
+    minDateInput.dispatchEvent(pressEnterEvent);
+
+    // Wait for the histogram's update delay
+    await new Promise(res => {
+      setTimeout(res, histogram.updateDelay + 50);
+    });
+
+    // Ensure that the histogram change propagated to the collection browser's
+    // date query correctly.
+    await el.updateComplete;
+    expect(el.dateRangeQueryClause).to.equal('year:[1960 TO 2000]');
+  });
+
   it('scrolls to page', async () => {
     const searchService = new MockSearchService();
     const el = await fixture<CollectionBrowser>(

package/test/collection-facets.test.ts

@@ -34,6 +34,73 @@ describe('Collection Facets', () => {
       el.shadowRoot?.querySelector('#container')?.classList.contains('loading')
     ).to.be.false;
   });
+
+  it('renders a date picker loading placeholder when date picker enabled', async () => {
+    const el = await fixture<CollectionFacets>(
+      html`<collection-facets></collection-facets>`
+    );
+
+    el.fullYearAggregationLoading = true;
+    el.showHistogramDatePicker = true;
+    await el.updateComplete;
+
+    const histogramLoader = el.shadowRoot?.querySelector(
+      '.histogram-loading-indicator'
+    );
+    expect(histogramLoader).to.exist;
+  });
+
+  it('does not render a date picker loading placeholder when date picker disabled', async () => {
+    const el = await fixture<CollectionFacets>(
+      html`<collection-facets></collection-facets>`
+    );
+
+    el.fullYearAggregationLoading = true;
+    el.showHistogramDatePicker = false;
+    await el.updateComplete;
+
+    const histogramLoader = el.shadowRoot?.querySelector(
+      '.histogram-loading-indicator'
+    );
+    expect(histogramLoader).to.be.null;
+  });
+
+  it('renders the date picker when enabled with data present', async () => {
+    const el = await fixture<CollectionFacets>(
+      html`<collection-facets></collection-facets>`
+    );
+
+    el.fullYearAggregationLoading = false;
+    el.showHistogramDatePicker = true;
+    el.fullYearsHistogramAggregation = new Aggregation({
+      buckets: [1, 2, 3],
+      first_bucket_key: 0,
+      last_bucket_key: 2,
+    });
+    await el.updateComplete;
+
+    const histogram = el.shadowRoot?.querySelector('histogram-date-range');
+    expect(histogram).to.exist;
+  });
+
+  it('does not render the date picker when disabled', async () => {
+    const el = await fixture<CollectionFacets>(
+      html`<collection-facets></collection-facets>`
+    );
+
+    el.fullYearAggregationLoading = false;
+    el.showHistogramDatePicker = false;
+    el.fullYearsHistogramAggregation = new Aggregation({
+      buckets: [1, 2, 3],
+      first_bucket_key: 0,
+      last_bucket_key: 2,
+    });
+    await el.updateComplete;
+
+    const histogram = el.shadowRoot?.querySelector('histogram-date-range');
+    expect(histogram).to.be.null;
+  });
+
   it('renders aggregations as facets', async () => {
     const el = await fixture<CollectionFacets>(
       html`<collection-facets></collection-facets>`

package/test/mocks/mock-search-responses.ts

@@ -1,5 +1,6 @@
 import type { Result } from '@internetarchive/result-type';
 import {
+  Aggregation,
   ItemHit,
   SearchResponse,
   SearchServiceError,
@@ -40,6 +41,51 @@ export const mockSuccessSingleResult: Result<
   },
 };
 
+export const mockSuccessWithYearHistogramAggs: Result<
+  SearchResponse,
+  SearchServiceError
+> = {
+  success: {
+    request: {
+      clientParameters: {
+        user_query: 'years',
+        sort: [],
+      },
+      finalizedParameters: {
+        user_query: 'years',
+        sort: [],
+      },
+    },
+    rawResponse: {},
+    response: {
+      totalResults: 1,
+      returnedCount: 1,
+      aggregations: {
+        subject: new Aggregation({
+          buckets: [
+            {
+              key: 'foo',
+              doc_count: 3,
+            },
+          ],
+        }),
+        year_histogram: new Aggregation({
+          buckets: [1, 2, 3, 3, 2, 1],
+          first_bucket_key: 1950,
+          last_bucket_key: 2000,
+          interval: 10,
+          number_buckets: 6,
+        }),
+      },
+      results: [],
+    },
+    responseHeader: {
+      succeeded: true,
+      query_time: 0,
+    },
+  },
+};
+
 export const mockSuccessLoggedInResult: Result<
   SearchResponse,
   SearchServiceError
@@ -224,3 +270,39 @@ export const mockSuccessMultipleResults: Result<
     },
   },
 };
+
+export const mockSuccessMultiLineDescription: Result<
+  SearchResponse,
+  SearchServiceError
+> = {
+  success: {
+    request: {
+      clientParameters: {
+        user_query: 'multi-line-description',
+        sort: [],
+      },
+      finalizedParameters: {
+        user_query: 'multi-line-description',
+        sort: [],
+      },
+    },
+    rawResponse: {},
+    response: {
+      totalResults: 1,
+      returnedCount: 1,
+      results: [
+        new ItemHit({
+          fields: {
+            identifier: 'foo',
+            collection: ['foo', 'bar'],
+            description: ['line1', 'line2'],
+          },
+        }),
+      ],
+    },
+    responseHeader: {
+      succeeded: true,
+      query_time: 0,
+    },
+  },
+};

package/test/mocks/mock-search-service.ts

@@ -13,6 +13,8 @@ import {
   mockSuccessLoggedInResult,
   mockSuccessNoPreviewResult,
   mockSuccessLoggedInAndNoPreviewResult,
+  mockSuccessWithYearHistogramAggs,
+  mockSuccessMultiLineDescription,
 } from './mock-search-responses';
 
 export class MockSearchService implements SearchServiceInterface {
@@ -46,6 +48,10 @@ export class MockSearchService implements SearchServiceInterface {
     switch (this.searchParams?.query) {
       case 'single-result':
         return mockSuccessSingleResult;
+      case 'years':
+        return mockSuccessWithYearHistogramAggs;
+      case 'multi-line-description':
+        return mockSuccessMultiLineDescription;
       case 'loggedin':
         return mockSuccessLoggedInResult;
       case 'no-preview':

package/test/tiles/list/tile-list.test.ts

@@ -105,4 +105,44 @@ describe('List Tile', () => {
     expect(dateRow).to.exist;
     expect(dateRow?.textContent?.trim()).to.contain('Added:  Jan 01, 2010');
   });
+
+  it('should render links to /search pages (not search.php) for subject, creator, and source', async () => {
+    const model: Partial<TileModel> = {
+      subjects: ['foo'],
+      creators: ['bar'],
+      source: 'baz',
+    };
+
+    const el = await fixture<TileList>(html`
+      <tile-list .model=${model}></tile-list>
+    `);
+
+    const subjectLink = el.shadowRoot?.querySelector('#topics a[href]');
+    expect(subjectLink).to.exist;
+    expect(subjectLink?.getAttribute('href')).to.equal(
+      `/search?query=${encodeURIComponent('subject:"foo"')}`
+    );
+
+    const creatorLink = el.shadowRoot?.querySelector('#creator a[href]');
+    expect(creatorLink).to.exist;
+    expect(creatorLink?.getAttribute('href')).to.equal(
+      `/search?query=${encodeURIComponent('creator:"bar"')}`
+    );
+
+    const sourceLink = el.shadowRoot?.querySelector('#source a[href]');
+    expect(sourceLink).to.exist;
+    expect(sourceLink?.getAttribute('href')).to.equal(
+      `/search?query=${encodeURIComponent('source:"baz"')}`
+    );
+  });
+
+  it('should render multi-line descriptions with spaces b/w lines', async () => {
+    const el = await fixture<TileList>(html`
+      <tile-list .model=${{ description: 'line1\nline2' }}> </tile-list>
+    `);
+
+    const descriptionBlock = el.shadowRoot?.getElementById('description');
+    expect(descriptionBlock).to.exist;
+    expect(descriptionBlock?.textContent?.trim()).to.equal('line1 line2'); // line break replaced by space
+  });
 });

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
+});