WEBDEV-7738 Use TV channel-network mapping provided by PPS (#475)

* Add tv channel aliases to data source

* Remove old temporary list & swap in new PPS-derived mapping

* Add unit test

Author: latonv

src/collection-browser.ts

@@ -1144,6 +1144,7 @@ export class CollectionBrowser
         .selectedFacets=${this.selectedFacets}
         .baseNavigationUrl=${this.baseNavigationUrl}
         .collectionTitles=${this.dataSource.collectionTitles}
+        .tvChannelAliases=${this.dataSource.tvChannelAliases}
         .showHistogramDatePicker=${this.showHistogramDatePicker}
         .allowExpandingDatePicker=${!this.mobileView}
         .allowDatePickerMonths=${shouldUseTvInterface}

src/collection-facets.ts

@@ -45,11 +45,11 @@ import {
   suppressedCollections,
   defaultFacetSort,
   FacetEventDetails,
-  tvChannelFacetLabels,
 } from './models';
 import type {
   CollectionTitles,
   PageSpecifierParams,
+  TVChannelAliases,
 } from './data-source/models';
 import {
   analyticsActions,
@@ -137,6 +137,9 @@ export class CollectionFacets extends LitElement {
   @property({ type: Object, attribute: false })
   collectionTitles?: CollectionTitles;
 
+  @property({ type: Object, attribute: false })
+  tvChannelAliases?: TVChannelAliases;
+
   @state() openFacets: Record<FacetOption, boolean> = {
     subject: false,
     lending: false,
@@ -536,7 +539,7 @@ export class CollectionFacets extends LitElement {
         bucketsWithCount.forEach(b => {
           b.displayText = (b.displayText ?? b.key)?.toLocaleUpperCase();
 
-          const channelLabel = tvChannelFacetLabels[b.displayText];
+          const channelLabel = this.tvChannelAliases?.get(b.displayText);
           if (channelLabel && channelLabel !== b.displayText) {
             b.extraNote = `(${channelLabel})`;
           }
@@ -772,6 +775,7 @@ export class CollectionFacets extends LitElement {
         .searchService=${this.searchService}
         .searchType=${this.searchType}
         .collectionTitles=${this.collectionTitles}
+        .tvChannelAliases=${this.tvChannelAliases}
         .selectedFacets=${this.selectedFacets}
         .sortedBy=${sortedBy}
         .isTvSearch=${this.isTvSearch}

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

@@ -32,11 +32,11 @@ import {
   defaultFacetSort,
   getDefaultSelectedFacets,
   FacetEventDetails,
-  tvChannelFacetLabels,
 } from '../models';
 import type {
   CollectionTitles,
   PageSpecifierParams,
+  TVChannelAliases,
 } from '../data-source/models';
 import '@internetarchive/ia-activity-indicator';
 import './more-facets-pagination';
@@ -68,6 +68,9 @@ export class MoreFacetsContent extends LitElement {
   @property({ type: Object })
   collectionTitles?: CollectionTitles;
 
+  @property({ type: Object })
+  tvChannelAliases?: TVChannelAliases;
+
   /**
    * Maximum number of facets to show per page within the modal.
    */
@@ -287,7 +290,7 @@ export class MoreFacetsContent extends LitElement {
       bucketsWithCount.forEach(b => {
         b.displayText = (b.displayText ?? b.key)?.toLocaleUpperCase();
 
-        const channelLabel = tvChannelFacetLabels[b.displayText];
+        const channelLabel = this.tvChannelAliases?.get(b.displayText);
         if (channelLabel && channelLabel !== b.displayText) {
           b.extraNote = `(${channelLabel})`;
         }

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

@@ -12,7 +12,11 @@ import type {
   PrefixFilterCounts,
   TileModel,
 } from '../models';
-import type { PageSpecifierParams, CollectionTitles } from './models';
+import type {
+  PageSpecifierParams,
+  CollectionTitles,
+  TVChannelAliases,
+} from './models';
 
 export interface CollectionBrowserDataSourceInterface
   extends ReactiveController {
@@ -88,6 +92,12 @@ export interface CollectionBrowserDataSourceInterface
    */
   readonly collectionTitles: CollectionTitles;
 
+  /**
+   * A map from TV channel names appearing in `creator` aggregations, to their
+   * more human-readable network names.
+   */
+  readonly tvChannelAliases: TVChannelAliases;
+
   /**
    * The "extra info" package provided by the PPS for collection pages, including details
    * used to populate the target collection header & About tab content.

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

@@ -121,6 +121,11 @@ export class CollectionBrowserDataSource
    */
   collectionTitles = new Map<string, string>();
 
+  /**
+   * @inheritdoc
+   */
+  tvChannelAliases = new Map<string, string>();
+
   /**
    * @inheritdoc
    */
@@ -1031,19 +1036,25 @@ export class CollectionBrowserDataSource
       return;
     }
 
-    const { aggregations, collectionTitles } = success.response;
+    const { aggregations, collectionTitles, tvChannelAliases } =
+      success.response;
     this.aggregations = aggregations;
 
+    this.histogramAggregation =
+      this.host.searchType === SearchType.TV
+        ? aggregations?.date_histogram
+        : aggregations?.year_histogram;
+
     if (collectionTitles) {
       for (const [id, title] of Object.entries(collectionTitles)) {
         this.collectionTitles.set(id, title);
       }
     }
-
-    this.histogramAggregation =
-      this.host.searchType === SearchType.TV
-        ? aggregations?.date_histogram
-        : aggregations?.year_histogram;
+    if (tvChannelAliases) {
+      for (const [channel, network] of Object.entries(tvChannelAliases)) {
+        this.tvChannelAliases.set(channel, network);
+      }
+    }
 
     this.setFacetsLoading(false);
     this.requestHostUpdate();
@@ -1191,7 +1202,7 @@ export class CollectionBrowserDataSource
       this.pageElements = success.response.pageElements;
     }
 
-    const { results, collectionTitles } = success.response;
+    const { results, collectionTitles, tvChannelAliases } = success.response;
     if (results && results.length > 0) {
       // Load any collection titles present on the response into the cache,
       // or queue up preload fetches for them if none were present.
@@ -1207,6 +1218,12 @@ export class CollectionBrowserDataSource
         }
       }
 
+      if (tvChannelAliases) {
+        for (const [channel, network] of Object.entries(tvChannelAliases)) {
+          this.tvChannelAliases.set(channel, network);
+        }
+      }
+
       // Update the data source for each returned page.
       // For loans and web archives, we must account for receiving more pages than we asked for.
       const isUnpagedElement = ['lending', 'web_archives'].includes(

src/data-source/models.ts

@@ -8,6 +8,11 @@ import type {
  */
 export type CollectionTitles = Map<string, string>;
 
+/**
+ * A Map from channel names to their corresponding, more human-readable network name.
+ */
+export type TVChannelAliases = Map<string, string>;
+
 /**
  * The subset of search service params that uniquely specify the type of results
  * that are sought by an instance of collection browser.

src/models.ts

@@ -750,42 +750,6 @@ export const valueFacetSort: Record<FacetOption, AggregationSortType> = {
   sponsor: AggregationSortType.ALPHABETICAL,
 };
 
-/**
- * Extra parenthesized labels to show next to certain TV channel facets
- *
- * TODO: This is only needed until we can receive the appropriate mapping via PPS,
- * and can be removed/replaced once that is set up.
- */
-export const tvChannelFacetLabels: Record<string, string> = Object.fromEntries(
-  // prettier-ignore
-  Object.entries({
-    'Al Jazeera'     : ['ALJAZAM', 'ALJAZ'],
-    'Bloomberg'      : ['BLOOMBERG'],
-    'BBC'            : ['BBC', 'BBC1', 'BBC2'],
-    'BBC America'    : ['BBCAMERICA'],
-    'BBC News'       : ['BBCNEWS'],
-    'GB News'        : ['GBN'],
-    'BET'            : ['BETW'],
-    'CNBC'           : ['CNBC'],
-    'CNN'            : ['CNNW', 'CNN'],
-    'Comedy Central' : ['COM', 'COMW'],
-    'CSPAN'          : ['CSPAN', 'CSPAN2', 'CSPAN3'],
-    'Current'        : ['CURRENT'],
-    'Deutsche Welle' : ['DW'],
-    'France 24'      : ['FRANCE24'],
-    'FOX Business'   : ['FBC'],
-    'FOX News'       : ['FOXNEWSW', 'FOXNEWS'],
-    'LINKTV'         : ['LINKTV'],
-    'MSNBC'          : ['MSNBCW', 'MSNBC'],
-    'NHK World'      : ['NHK'],
-    'RT'             : ['RT'],
-    'Sky News'       : ['SKY'],
-  }).reduce(
-    (acc, [label, channels]) => acc.concat(channels.map(ch => [ch, label])),
-    [] as [string, string][],
-  ),
-);
-
 export type LendingFacetKey =
   | 'is_lendable'
   | 'is_borrowable'

test/collection-browser.test.ts

@@ -744,6 +744,22 @@ describe('Collection Browser', () => {
     );
   });
 
+  it('adds tv channel aliases to cache when present on response', async () => {
+    const searchService = new MockSearchService();
+
+    const el = await fixture<CollectionBrowser>(
+      html`<collection-browser .searchService=${searchService}>
+      </collection-browser>`,
+    );
+
+    el.baseQuery = 'channel-aliases';
+    await el.updateComplete;
+    await el.initialSearchComplete;
+
+    expect(el.dataSource.tvChannelAliases.get('foo')).to.equal('Foo Network');
+    expect(el.dataSource.tvChannelAliases.get('bar')).to.equal('Bar Network');
+  });
+
   it('keeps search results from fetch if no change to query or sort param', async () => {
     const resultsSpy = sinon.spy();
     const searchService = new MockSearchService({

test/mocks/mock-search-responses.ts

@@ -565,6 +565,52 @@ export const getMockSuccessWithCollectionTitles: () => Result<
   },
 });
 
+export const getMockSuccessWithChannelAliases: () => Result<
+  SearchResponse,
+  SearchServiceError
+> = () => ({
+  success: {
+    request: {
+      kind: 'hits',
+      clientParameters: {
+        user_query: 'collection:foo',
+        sort: [],
+      },
+      backendRequests: {
+        primary: {
+          kind: 'hits',
+          finalized_parameters: {
+            user_query: 'collection:foo',
+            sort: [],
+          },
+        },
+      },
+    },
+    rawResponse: {},
+    sessionContext: {},
+    response: {
+      totalResults: 1,
+      returnedCount: 1,
+      results: [
+        new TvClipHit({
+          fields: {
+            identifier: 'foo',
+            creator: ['foo', 'bar'],
+          },
+        }),
+      ],
+      tvChannelAliases: {
+        foo: 'Foo Network',
+        bar: 'Bar Network',
+      },
+    },
+    responseHeader: {
+      succeeded: true,
+      query_time: 0,
+    },
+  },
+});
+
 export const getMockSuccessWithCollectionAggregations: () => Result<
   SearchResponse,
   SearchServiceError

test/mocks/mock-search-service.ts

@@ -21,6 +21,7 @@ import {
   getMockErrorResult,
   getMockMalformedResult,
   getMockSuccessWithCollectionTitles,
+  getMockSuccessWithChannelAliases,
   getMockSuccessWithCollectionAggregations,
   getMockSuccessExtraQuotedHref,
   getMockSuccessWithDefaultSort,
@@ -49,6 +50,7 @@ const responses: Record<
   'first-title': getMockSuccessFirstTitleResult,
   'first-creator': getMockSuccessFirstCreatorResult,
   'collection-titles': getMockSuccessWithCollectionTitles,
+  'channel-aliases': getMockSuccessWithChannelAliases,
   'collection-aggregations': getMockSuccessWithCollectionAggregations,
   'extra-quoted-href': getMockSuccessExtraQuotedHref,
   'default-sort': getMockSuccessWithDefaultSort,