Implement shadow traffic comparisson to facets and productSearch

Author: salesfelipe

node/services/facets.test.ts

@@ -1,6 +1,7 @@
 import { fetchFacets } from './facets'
 import { createContext } from '../mocks/contextFactory'
 import type { FacetsInput } from '../typings/Search'
+import * as compareResultsModule from '../utils/compareResults'
 
 describe('fetchFacets service', () => {
   const mockFacetsResponse = {
@@ -32,40 +33,48 @@ describe('fetchFacets service', () => {
     jest.clearAllMocks()
   })
 
-  it('should use intelligentSearchApi when shouldUseNewPLPEndpoint is false', async () => {
+  it('should use intsch when shouldUseNewPLPEndpoint is true', async () => {
     const ctx = createContext({
       accountName: 'testaccount',
       appSettings: {
-        shouldUseNewPLPEndpoint: false,
+        shouldUseNewPLPEndpoint: true,
       },
-      intelligentSearchApiSettings: {
+      intschSettings: {
         facets: mockFacetsResponse,
       },
     })
 
     const result = await fetchFacets(ctx, mockArgs, mockSelectedFacets)
 
-    expect(ctx.clients.intelligentSearchApi.facets).toHaveBeenCalled()
-    expect(ctx.clients.intsch.facets).not.toHaveBeenCalled()
+    expect(ctx.clients.intsch.facets).toHaveBeenCalled()
+    expect(ctx.clients.intelligentSearchApi.facets).not.toHaveBeenCalled()
     expect(result).toEqual(mockFacetsResponse)
   })
 
-  it('should use intsch when shouldUseNewPLPEndpoint is true', async () => {
+  it('should compare both APIs when shouldUseNewPLPEndpoint is undefined', async () => {
     const ctx = createContext({
       accountName: 'testaccount',
       appSettings: {
-        shouldUseNewPLPEndpoint: true,
+        shouldUseNewPLPEndpoint: undefined,
+      },
+      intelligentSearchApiSettings: {
+        facets: mockFacetsResponse,
       },
       intschSettings: {
         facets: mockFacetsResponse,
       },
     })
 
+    const compareApiResultsSpy = jest
+      .spyOn(compareResultsModule, 'compareApiResults')
+      .mockResolvedValue(mockFacetsResponse)
+
     const result = await fetchFacets(ctx, mockArgs, mockSelectedFacets)
 
-    expect(ctx.clients.intsch.facets).toHaveBeenCalled()
-    expect(ctx.clients.intelligentSearchApi.facets).not.toHaveBeenCalled()
+    expect(compareApiResultsSpy).toHaveBeenCalled()
     expect(result).toEqual(mockFacetsResponse)
+
+    compareApiResultsSpy.mockRestore()
   })
 
   it('should handle shipping options correctly', async () => {
@@ -107,4 +116,3 @@ describe('fetchFacets service', () => {
     expect(ctx.translated).toBe(true)
   })
 })
-

node/services/facets.ts

@@ -1,4 +1,5 @@
 import { buildAttributePath } from '../commons/compatibility-layer'
+import { compareApiResults } from '../utils/compareResults'
 import { fetchAppSettings } from './settings'
 import type { FacetsInput } from '../typings/Search'
 
@@ -69,8 +70,7 @@ async function fetchFacetsFromIntsch(
 }
 
 /**
- * Facets service that extracts facets fetching logic and implements flag-based routing
- * using intelligentSearchApi as primary and intsch as alternative based on shouldUseNewPLPEndpoint flag
+ * Facets service that extracts facets fetching logic and implements comparison or flag-based routing
  */
 export async function fetchFacets(
   ctx: Context,
@@ -80,11 +80,24 @@ export async function fetchFacets(
 ) {
   const { shouldUseNewPLPEndpoint } = await fetchAppSettings(ctx)
 
-  // Check if current account should use intsch directly
+  // If flag is explicitly true, use intsch
   if (shouldUseNewPLPEndpoint) {
     return fetchFacetsFromIntsch(ctx, args, selectedFacets, shippingOptions)
   }
 
-  return fetchFacetsFromBiggy(ctx, args, selectedFacets, shippingOptions)
+  // If flag is undefined, compare both APIs
+  return compareApiResults(
+    () => fetchFacetsFromBiggy(ctx, args, selectedFacets, shippingOptions),
+    () => fetchFacetsFromIntsch(ctx, args, selectedFacets, shippingOptions),
+    ctx.vtex.production ? 10 : 100,
+    ctx.vtex.logger,
+    {
+      logPrefix: 'Facets',
+      args: {
+        fullText: args.fullText,
+        selectedFacets,
+        shippingOptions,
+      },
+    }
+  )
 }
-

node/services/productSearch.test.ts

@@ -1,6 +1,7 @@
 import { fetchProductSearch } from './productSearch'
 import { createContext } from '../mocks/contextFactory'
 import type { ProductSearchInput } from '../typings/Search'
+import * as compareResultsModule from '../utils/compareResults'
 
 describe('fetchProductSearch service', () => {
   const mockProductSearchResponse = {
@@ -29,46 +30,58 @@ describe('fetchProductSearch service', () => {
     jest.clearAllMocks()
   })
 
-  it('should use intelligentSearchApi when shouldUseNewPLPEndpoint is false', async () => {
+  it('should use intsch when shouldUseNewPLPEndpoint is true', async () => {
     const ctx = createContext({
       accountName: 'testaccount',
       appSettings: {
-        shouldUseNewPLPEndpoint: false,
+        shouldUseNewPLPEndpoint: true,
       },
-      intelligentSearchApiSettings: {
+      intschSettings: {
         productSearch: mockProductSearchResponse,
       },
     })
 
     const result = await fetchProductSearch(ctx, mockArgs, mockSelectedFacets)
 
-    expect(ctx.clients.intelligentSearchApi.productSearch).toHaveBeenCalled()
-    expect(ctx.clients.intsch.productSearch).not.toHaveBeenCalled()
+    expect(ctx.clients.intsch.productSearch).toHaveBeenCalled()
+    expect(
+      ctx.clients.intelligentSearchApi.productSearch
+    ).not.toHaveBeenCalled()
     expect(result).toEqual({
       searchState: undefined,
       ...mockProductSearchResponse,
     })
   })
 
-  it('should use intsch when shouldUseNewPLPEndpoint is true', async () => {
+  it('should compare both APIs when shouldUseNewPLPEndpoint is undefined', async () => {
     const ctx = createContext({
       accountName: 'testaccount',
       appSettings: {
-        shouldUseNewPLPEndpoint: true,
+        shouldUseNewPLPEndpoint: undefined,
+      },
+      intelligentSearchApiSettings: {
+        productSearch: mockProductSearchResponse,
       },
       intschSettings: {
         productSearch: mockProductSearchResponse,
       },
     })
 
-    const result = await fetchProductSearch(ctx, mockArgs, mockSelectedFacets)
-
-    expect(ctx.clients.intsch.productSearch).toHaveBeenCalled()
-    expect(ctx.clients.intelligentSearchApi.productSearch).not.toHaveBeenCalled()
-    expect(result).toEqual({
+    const mockResult = {
       searchState: undefined,
       ...mockProductSearchResponse,
-    })
+    }
+
+    const compareApiResultsSpy = jest
+      .spyOn(compareResultsModule, 'compareApiResults')
+      .mockResolvedValue(mockResult)
+
+    const result = await fetchProductSearch(ctx, mockArgs, mockSelectedFacets)
+
+    expect(compareApiResultsSpy).toHaveBeenCalled()
+    expect(result).toEqual(mockResult)
+
+    compareApiResultsSpy.mockRestore()
   })
 
   it('should handle shipping options correctly', async () => {
@@ -200,4 +213,3 @@ describe('fetchProductSearch service', () => {
     )
   })
 })
-

node/services/productSearch.ts

@@ -1,5 +1,9 @@
-import { buildAttributePath, convertOrderBy } from '../commons/compatibility-layer'
+import {
+  buildAttributePath,
+  convertOrderBy,
+} from '../commons/compatibility-layer'
 import { getWorkspaceSearchParamsFromStorage } from '../routes/workspaceSearchParams'
+import { compareApiResults } from '../utils/compareResults'
 import { fetchAppSettings } from './settings'
 import type { ProductSearchInput } from '../typings/Search'
 
@@ -19,10 +23,7 @@ async function fetchProductSearchFromBiggy(
   shippingOptions?: string[]
 ) {
   const { intelligentSearchApi } = ctx.clients
-  const {
-    fullText,
-    advertisementOptions = defaultAdvertisementOptions,
-  } = args
+  const { fullText, advertisementOptions = defaultAdvertisementOptions } = args
 
   const workspaceSearchParams = await getWorkspaceSearchParamsFromStorage(ctx)
 
@@ -64,10 +65,7 @@ async function fetchProductSearchFromIntsch(
   shippingOptions?: string[]
 ) {
   const { intsch } = ctx.clients
-  const {
-    fullText,
-    advertisementOptions = defaultAdvertisementOptions,
-  } = args
+  const { fullText, advertisementOptions = defaultAdvertisementOptions } = args
 
   const workspaceSearchParams = await getWorkspaceSearchParamsFromStorage(ctx)
 
@@ -100,8 +98,7 @@ async function fetchProductSearchFromIntsch(
 }
 
 /**
- * ProductSearch service that extracts product search fetching logic and implements flag-based routing
- * using intelligentSearchApi as primary and intsch as alternative based on shouldUseNewPLPEndpoint flag
+ * ProductSearch service that extracts product search fetching logic and implements comparison or flag-based routing
  */
 export async function fetchProductSearch(
   ctx: Context,
@@ -111,11 +108,32 @@ export async function fetchProductSearch(
 ) {
   const { shouldUseNewPLPEndpoint } = await fetchAppSettings(ctx)
 
-  // Check if current account should use intsch directly
   if (shouldUseNewPLPEndpoint) {
-    return fetchProductSearchFromIntsch(ctx, args, selectedFacets, shippingOptions)
+    return fetchProductSearchFromIntsch(
+      ctx,
+      args,
+      selectedFacets,
+      shippingOptions
+    )
   }
 
-  return fetchProductSearchFromBiggy(ctx, args, selectedFacets, shippingOptions)
+  return compareApiResults(
+    () =>
+      fetchProductSearchFromBiggy(ctx, args, selectedFacets, shippingOptions),
+    () =>
+      fetchProductSearchFromIntsch(ctx, args, selectedFacets, shippingOptions),
+    ctx.vtex.production ? 10 : 100,
+    ctx.vtex.logger,
+    {
+      logPrefix: 'ProductSearch',
+      args: {
+        fullText: args.fullText,
+        query: args.query,
+        from: args.from,
+        to: args.to,
+        selectedFacets,
+        shippingOptions,
+      },
+    }
+  )
 }
-