Streamline deduplication logic, add test, and increment package version

Author: mkouzel-yext

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@yext/search-ui-react",
-  "version": "1.8.3",
+  "version": "1.8.4",
   "description": "A library of React Components for powering Yext Search integrations",
   "author": "watson@yext.com",
   "license": "BSD-3-Clause",

package.json

@@ -189,22 +189,17 @@ function Citations(props: CitationsProps) {
     citationClickHandler
   } = props;
   const citationResults = React.useMemo(() => {
+    // If an entity is returned by multiple different verticals, it will be present in
+    // searchResults multiple times. We want to only show it once in the citations.
+    let citationIds = new Set(gdaResponse.citations);
     return searchResults.filter(result => {
       const {uid, name} = result.rawData ?? {};
-      if (!uid || typeof uid != 'string' || !name) {
+      const dataIsInvalid = !uid || !name || typeof name != 'string' || typeof uid != 'string';
+      if (dataIsInvalid || !citationIds.has(uid)) {
         return false;
       }
-      return gdaResponse.citations.includes(uid);
-    }).filter((result, index, self) => {
-      // If an entity is returned by multiple different verticals, it will be present in
-      // searchResults multiple times. We want to only show it once in the citations.
-      const {uid} = result.rawData ?? {};
-      if (!uid) {
-        return false;
-      }
-      return self.findIndex(r => {
-        return uid === r.rawData?.uid;
-      }) === index;
+      citationIds.delete(uid);
+      return true;
     });
   }, [gdaResponse.citations, searchResults]);
 

src/components/GenerativeDirectAnswer.tsx

@@ -71,8 +71,32 @@ const vertical3: VerticalResults = {
   verticalKey: 'vertical3'
 };
 
+const vertical4: VerticalResults = {
+  appliedQueryFilters: [],
+  queryDurationMillis: 500,
+  results: [{
+    rawData: {
+      name: 'title3',
+      description: 'text3',
+      uid: 'uid3'
+    },
+    source: Source.KnowledgeManager,
+    id: 'id3'
+  }],
+  resultsCount: 1,
+  source: Source.KnowledgeManager,
+  verticalKey: 'vertical4'
+};
+
 export const verticalResults = [
   vertical1,
   vertical2,
   vertical3
-];
+];
+
+export const verticalResultsWithDuplicateEntity = [
+  vertical1,
+  vertical2,
+  vertical3,
+  vertical4
+];

tests/__fixtures__/data/universalresults.ts

@@ -5,7 +5,10 @@ import { useAnalytics } from '../../src/hooks/useAnalytics';
 
 import { State } from '@yext/search-headless-react';
 import { mockAnswersState, ignoreLinkClickErrors } from '../__utils__/mocks';
-import { verticalResults } from '../__fixtures__/data/universalresults';
+import {
+  verticalResults,
+  verticalResultsWithDuplicateEntity
+} from '../__fixtures__/data/universalresults';
 import { generativeDirectAnswerText, generativeDirectAnswerLink, generativeDirectAnswerResponse } from '../__fixtures__/data/generativeDirectAnswer';
 import userEvent from '@testing-library/user-event';
 import React from 'react';
@@ -27,6 +30,23 @@ const mockedState: Partial<State> = {
   }
 };
 
+const mockedStateWithDuplicateEntity: Partial<State> = {
+  generativeDirectAnswer: {
+    isLoading: false,
+    response: generativeDirectAnswerResponse,
+  },
+  universal: {
+    verticals: verticalResultsWithDuplicateEntity
+  },
+  query: {
+    queryId: '[queryId]',
+    mostRecentSearch: 'test'
+  },
+  meta: {
+    searchType: 'universal'
+  }
+};
+
 const CustomCitationsComponent = (props: CitationsProps) => {
   return (
       <>
@@ -109,6 +129,17 @@ describe('GenerativeDirectAnswer with sufficient citation fields', () => {
     expect(screen.getByText(generativeDirectAnswerText)).toBeDefined();
     expect(screen.getByText("CustomCitationsComponentTest")).toBeTruthy();
   });
+
+  it('citations are deduplicated', () => {
+    mockAnswersState(mockedStateWithDuplicateEntity);
+    render(<GenerativeDirectAnswer />);
+    expect(screen.getByText(generativeDirectAnswerText)).toBeDefined();
+    expect(screen.getByText('Sources (2)')).toBeDefined();
+
+    checkResultData(verticalResultsWithDuplicateEntity[0].results[0].rawData, false); //not a citation
+    checkResultData(verticalResultsWithDuplicateEntity[0].results[1].rawData, true);
+    checkResultData(verticalResultsWithDuplicateEntity[1].results[0].rawData, true);
+  });
 });
 
 describe('GenerativeDirectAnswer without sufficient citation fields', () => {
@@ -139,6 +170,14 @@ describe('GenerativeDirectAnswer without sufficient citation fields', () => {
   });
 });
 
+// describe('GenerativeDirectAnswer with same entity appearing twice in search results', () => {
+//   beforeEach(() => {
+//     mockAnswersState(mockedStateWithDuplicateEntity);
+//   });
+//
+//
+// });
+
 function checkResultData(resultData: Record<string, unknown>, shouldDisplay: boolean) {
   if (typeof resultData.name === 'string') {
     if (shouldDisplay) {
@@ -153,5 +192,5 @@ function checkResultData(resultData: Record<string, unknown>, shouldDisplay: boo
     } else {
       expect(screen.queryByText(resultData.description)).toBeNull();
     }
-  } 
-}
+  }
+}