@internetarchive/collection-browser 0.3.3-alpha.4 → 0.3.3

package/src/collection-facets/more-facets-content.ts

@@ -20,6 +20,7 @@ import {
 } from '@internetarchive/search-service';
 import type { CollectionNameCacheInterface } from '@internetarchive/collection-name-cache';
 import type { ModalManagerInterface } from '@internetarchive/modal-manager';
+import type { AnalyticsManagerInterface } from '@internetarchive/analytics-manager';
 import {
   SelectedFacets,
   FacetGroup,
@@ -31,12 +32,16 @@ import type { LanguageCodeHandlerInterface } from '../language-code-handler/lang
 import '@internetarchive/ia-activity-indicator/ia-activity-indicator';
 import './more-facets-pagination';
 import './facets-template';
+import {
+  analyticsActions,
+  analyticsCategories,
+} from '../utils/analytics-events';
 
 @customElement('more-facets-content')
 export class MoreFacetsContent extends LitElement {
-  @property({ type: String }) facetKey?: string;
+  @property({ type: String }) facetKey?: FacetOption;
 
-  @property({ type: String }) facetAggregationKey?: string;
+  @property({ type: String }) facetAggregationKey?: FacetOption;
 
   @property({ type: String }) fullQuery?: string;
 
@@ -54,7 +59,10 @@ export class MoreFacetsContent extends LitElement {
 
   @property({ type: Object }) selectedFacets?: SelectedFacets;
 
-  @property({ type: String }) sortedBy = 'count'; // count | alpha
+  @property({ type: String }) sortedBy: 'count' | 'alpha' = 'count';
+
+  @property({ type: Object, attribute: false })
+  analyticsHandler?: AnalyticsManagerInterface;
 
   @state() aggregations?: Record<string, Aggregation>;
 
@@ -136,6 +144,12 @@ export class MoreFacetsContent extends LitElement {
     if (page) {
       this.pageNumber = Number(page);
     }
+
+    this.analyticsHandler?.sendEventNoSampling({
+      category: analyticsCategories.default,
+      action: analyticsActions.moreFacetsPageChange,
+      label: `${this.pageNumber}`,
+    });
   }
 
   /**
@@ -419,10 +433,20 @@ export class MoreFacetsContent extends LitElement {
     });
     this.dispatchEvent(event);
     this.modalManager?.closeModal();
+    this.analyticsHandler?.sendEventNoSampling({
+      category: analyticsCategories.default,
+      action: `${analyticsActions.applyMoreFacetsModal}`,
+      label: `${this.facetKey}`,
+    });
   }
 
   private cancelClick() {
     this.modalManager?.closeModal();
+    this.analyticsHandler?.sendEventNoSampling({
+      category: analyticsCategories.default,
+      action: analyticsActions.closeMoreFacetsModal,
+      label: `${this.facetKey}`,
+    });
   }
 
   static get styles(): CSSResultGroup {

package/src/collection-facets.ts

@@ -22,6 +22,7 @@ import {
   ModalConfig,
   ModalManagerInterface,
 } from '@internetarchive/modal-manager';
+import type { AnalyticsManagerInterface } from '@internetarchive/analytics-manager';
 import chevronIcon from './assets/img/icons/chevron';
 import {
   FacetOption,
@@ -37,6 +38,10 @@ import {
 import type { LanguageCodeHandlerInterface } from './language-code-handler/language-code-handler';
 import './collection-facets/more-facets-content';
 import './collection-facets/facets-template';
+import {
+  analyticsActions,
+  analyticsCategories,
+} from './utils/analytics-events';
 
 @customElement('collection-facets')
 export class CollectionFacets extends LitElement {
@@ -66,7 +71,11 @@ export class CollectionFacets extends LitElement {
 
   @property({ type: String }) fullQuery?: string;
 
-  @property({ type: Object }) modalManager?: ModalManagerInterface;
+  @property({ type: Object, attribute: false })
+  modalManager?: ModalManagerInterface;
+
+  @property({ type: Object, attribute: false })
+  analyticsHandler?: AnalyticsManagerInterface;
 
   @property({ type: Object })
   languageCodeHandler?: LanguageCodeHandlerInterface;
@@ -429,6 +438,11 @@ export class CollectionFacets extends LitElement {
       class="more-link"
       @click=${() => {
         this.showMoreFacetsModal(facetGroup, 'count');
+        this.analyticsHandler?.sendEventNoSampling({
+          category: analyticsCategories.default,
+          action: analyticsActions.showMoreFacetsModal,
+          label: facetGroup.key,
+        });
         this.dispatchEvent(
           new CustomEvent('showMoreFacets', { detail: facetGroup.key })
         );
@@ -446,6 +460,7 @@ export class CollectionFacets extends LitElement {
 
     const customModalContent = html`
       <more-facets-content
+        .analyticsHandler=${this.analyticsHandler}
         .facetKey=${facetGroup.key}
         .facetAggregationKey=${facetAggrKey}
         .fullQuery=${this.fullQuery}

package/src/restoration-state-handler.ts

@@ -1,8 +1,4 @@
-import {
-  SearchType,
-  SortDirection,
-  SortParam,
-} from '@internetarchive/search-service';
+import type { SortDirection, SortParam } from '@internetarchive/search-service';
 import { getCookie, setCookie } from 'typescript-cookie';
 import {
   MetadataFieldToSortField,
@@ -18,7 +14,6 @@ import {
 
 export interface RestorationState {
   displayMode?: CollectionDisplayMode;
-  searchType?: SearchType;
   sortParam?: SortParam;
   selectedSort?: SortField;
   sortDirection?: SortDirection;
@@ -92,20 +87,12 @@ export class RestorationStateHandler
   private persistQueryStateToUrl(state: RestorationState) {
     const url = new URL(window.location.href);
     const { searchParams } = url;
-    searchParams.delete('sin');
     searchParams.delete('sort');
     searchParams.delete('query');
     searchParams.delete('page');
     searchParams.delete('and[]');
     searchParams.delete('not[]');
 
-    if (state.searchType) {
-      searchParams.set(
-        'sin',
-        state.searchType === SearchType.FULLTEXT ? 'TXT' : ''
-      );
-    }
-
     if (state.sortParam) {
       const prefix = state.sortParam.direction === 'desc' ? '-' : '';
       searchParams.set('sort', `${prefix}${state.sortParam.field}`);
@@ -168,7 +155,6 @@ export class RestorationStateHandler
 
   private loadQueryStateFromUrl(): RestorationState {
     const url = new URL(window.location.href);
-    const searchInside = url.searchParams.get('sin');
     const pageNumber = url.searchParams.get('page');
     const searchQuery = url.searchParams.get('query');
     const sortQuery = url.searchParams.get('sort');
@@ -187,10 +173,6 @@ export class RestorationStateHandler
       },
     };
 
-    if (searchInside) {
-      restorationState.searchType =
-        searchInside === 'TXT' ? SearchType.FULLTEXT : undefined; // No explicit metadata sin
-    }
     if (pageNumber) {
       const parsed = parseInt(pageNumber, 10);
       restorationState.currentPage = parsed;

package/src/utils/analytics-events.ts

@@ -16,4 +16,8 @@ export enum analyticsActions {
   facetNegativeDeselected = 'facetNegativeDeselected',
   histogramChanged = 'histogramChanged',
   resultSelected = 'resultSelected',
+  moreFacetsPageChange = 'moreFacetsPageChange',
+  showMoreFacetsModal = 'showMoreFacetsModal',
+  closeMoreFacetsModal = 'closeMoreFacetsModal',
+  applyMoreFacetsModal = 'applyMoreFacetsModal',
 }

package/test/collection-browser.test.ts

@@ -18,21 +18,6 @@ import { MockAnalyticsHandler } from './mocks/mock-analytics-handler';
 import { analyticsCategories } from '../src/utils/analytics-events';
 
 describe('Collection Browser', () => {
-  beforeEach(async () => {
-    // Apparently query params set by one test can bleed into other tests.
-    // Since collection browser restores its state from certain query params, we need
-    // to clear these before each test to ensure they run in isolation from one another.
-    const url = new URL(window.location.href);
-    const { searchParams } = url;
-    searchParams.delete('sin');
-    searchParams.delete('sort');
-    searchParams.delete('query');
-    searchParams.delete('page');
-    searchParams.delete('and[]');
-    searchParams.delete('not[]');
-    window.history.replaceState({}, '', url);
-  });
-
   it('clear existing filter for facets & sort-bar', async () => {
     const el = await fixture<CollectionBrowser>(
       html`<collection-browser></collection-browser>`
@@ -385,11 +370,8 @@ describe('Collection Browser', () => {
   });
 
   it('sets sort properties when user changes sort', async () => {
-    const searchService = new MockSearchService();
     const el = await fixture<CollectionBrowser>(
-      html`<collection-browser
-        .searchService=${searchService}
-      ></collection-browser>`
+      html`<collection-browser></collection-browser>`
     );
 
     expect(el.selectedSort).to.equal(SortField.relevance);
@@ -415,17 +397,10 @@ describe('Collection Browser', () => {
   });
 
   it('scrolls to page', async () => {
-    const searchService = new MockSearchService();
     const el = await fixture<CollectionBrowser>(
-      html`<collection-browser
-        .searchService=${searchService}
-      ></collection-browser>`
+      html`<collection-browser></collection-browser>`
     );
 
-    // Infinite scroller won't exist unless there's a base query
-    el.baseQuery = 'collection:foo';
-    await el.updateComplete;
-
     const infiniteScroller = el.shadowRoot?.querySelector(
       'infinite-scroller'
     ) as InfiniteScroller;
@@ -460,10 +435,6 @@ describe('Collection Browser', () => {
     );
     const infiniteScrollerRefreshSpy = sinon.spy();
 
-    // Infinite scroller won't exist unless there's a base query
-    el.baseQuery = 'collection:foo';
-    await el.updateComplete;
-
     const infiniteScroller = el.shadowRoot?.querySelector('infinite-scroller');
     (infiniteScroller as InfiniteScroller).reload = infiniteScrollerRefreshSpy;
     expect(infiniteScrollerRefreshSpy.called).to.be.false;

package/test/collection-facets/more-facets-content.test.ts

@@ -1,10 +1,11 @@
 /* eslint-disable import/no-duplicates */
-import { expect, fixture, oneEvent } from '@open-wc/testing';
+import { expect, fixture } from '@open-wc/testing';
 import { html } from 'lit';
 import { Aggregation } from '@internetarchive/search-service';
 import type { MoreFacetsContent } from '../../src/collection-facets/more-facets-content';
 import '../../src/collection-facets/more-facets-content';
 import { MockSearchService } from '../mocks/mock-search-service';
+import { MockAnalyticsHandler } from '../mocks/mock-analytics-handler';
 
 const selectedFacetsGroup = {
   title: 'Media Type',
@@ -126,21 +127,52 @@ describe('More facets content', () => {
     expect(bucket?.count).to.equal(5);
   });
 
-  it('page number clicked event', async () => {
-    const searchService = new MockSearchService();
+  it('cancel button clicked event', async () => {
+    const mockAnalyticsHandler = new MockAnalyticsHandler();
 
     const el = await fixture<MoreFacetsContent>(
       html`<more-facets-content
-        .searchService=${searchService}
+        .analyticsHandler=${mockAnalyticsHandler}
       ></more-facets-content>`
     );
 
-    setTimeout(() =>
-      el.dispatchEvent(
-        new CustomEvent('pageNumberClicked', { detail: { page: 15 } })
-      )
+    el.facetsLoading = false;
+    el.paginationSize = 5;
+    await el.updateComplete;
+
+    // select cancel button
+    const cancelButton = el.shadowRoot?.querySelector(
+      '.footer > .btn-cancel'
+    ) as HTMLButtonElement;
+    cancelButton?.click();
+
+    expect(mockAnalyticsHandler.callCategory).to.equal('collection-browser');
+    expect(mockAnalyticsHandler.callAction).to.equal('closeMoreFacetsModal');
+    expect(mockAnalyticsHandler.callLabel).to.equal('undefined');
+  });
+
+  it('facet apply button clicked event', async () => {
+    const mockAnalyticsHandler = new MockAnalyticsHandler();
+
+    const el = await fixture<MoreFacetsContent>(
+      html`<more-facets-content
+        .analyticsHandler=${mockAnalyticsHandler}
+      ></more-facets-content>`
     );
-    const { detail } = await oneEvent(el, 'pageNumberClicked');
-    expect(detail?.page).to.equal(15);
+
+    el.facetsLoading = false;
+    el.paginationSize = 5;
+    el.facetKey = 'collection';
+    await el.updateComplete;
+
+    // select submit button
+    const submitButton = el.shadowRoot?.querySelector(
+      '.footer > .btn-submit'
+    ) as HTMLButtonElement;
+    submitButton?.click();
+
+    expect(mockAnalyticsHandler.callCategory).to.equal('collection-browser');
+    expect(mockAnalyticsHandler.callAction).to.equal('applyMoreFacetsModal');
+    expect(mockAnalyticsHandler.callLabel).to.equal('collection');
   });
 });

package/test/collection-facets.test.ts

@@ -15,6 +15,7 @@ import {
   LanguageCodeHandler,
   LanguageCodeHandlerInterface,
 } from '../src/language-code-handler/language-code-handler';
+import { MockAnalyticsHandler } from './mocks/mock-analytics-handler';
 
 describe('Collection Facets', () => {
   it('has loader', async () => {
@@ -60,7 +61,7 @@ describe('Collection Facets', () => {
     const titleFacetRow = titleFacetGroup
       ?.querySelector('facets-template')
       ?.shadowRoot?.querySelector('.facet-row');
-    console.log(titleFacetGroup?.querySelector('facets-template'));
+
     expect(titleFacetRow?.textContent?.trim()).to.satisfy((text: string) =>
       /^foo\s*5$/.test(text)
     );
@@ -553,4 +554,64 @@ describe('Collection Facets', () => {
       expect(eventFacet).to.equal('subject' as FacetOption);
     });
   });
+
+  it('fire analytics on more link', async () => {
+    const mockAnalyticsHandler = new MockAnalyticsHandler();
+
+    const el = await fixture<CollectionFacets>(
+      html`<collection-facets
+        .analyticsHandler=${mockAnalyticsHandler}
+      ></collection-facets>`
+    );
+    const aggs: Record<string, Aggregation> = {
+      subject: new Aggregation({
+        buckets: [
+          {
+            key: 'foo',
+            doc_count: 5,
+          },
+          {
+            key: 'fi',
+            doc_count: 5,
+          },
+          {
+            key: 'fum',
+            doc_count: 5,
+          },
+          {
+            key: 'flee',
+            doc_count: 5,
+          },
+          {
+            key: 'wheee',
+            doc_count: 5,
+          },
+          {
+            key: 'whooo',
+            doc_count: 5,
+          },
+          {
+            key: 'boop',
+            doc_count: 5,
+          },
+        ],
+      }),
+    };
+
+    el.aggregations = aggs;
+    await el.updateComplete;
+
+    const moreLink = el.shadowRoot?.querySelector(
+      '.more-link'
+    ) as HTMLButtonElement;
+
+    expect(moreLink).to.exist; // has link
+
+    moreLink?.click();
+    await el.updateComplete;
+
+    expect(mockAnalyticsHandler.callCategory).to.equal('collection-browser');
+    expect(mockAnalyticsHandler.callAction).to.equal('showMoreFacetsModal');
+    expect(mockAnalyticsHandler.callLabel).to.equal('subject');
+  });
 });

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