Extract the productSearch and facets o a service

Author: salesfelipe

node/mocks/contextFactory.ts

@@ -57,6 +57,9 @@ export function createContext<Ctx = Context>({
       apps: {
         getAppSettings: jest.fn().mockReturnValue(appSettings ?? {}),
       },
+      vbase: {
+        getJSON: jest.fn().mockResolvedValue({}),
+      }
     },
     vtex: {
       production: production ?? false,

node/resolvers/search/index.ts

@@ -47,6 +47,8 @@ import {
   fetchCorrection,
 } from '../../services/autocomplete'
 import { fetchBanners } from '../../services/banners'
+import { fetchFacets } from '../../services/facets'
+import { fetchProductSearch } from '../../services/productSearch'
 import { AdvertisementOptions, FacetsInput, ProductSearchInput, ProductsInput, SuggestionProductsArgs } from '../../typings/Search'
 
 enum CrossSellingInput {
@@ -347,28 +349,7 @@ export const queries = {
 
     let { selectedFacets } = args
 
-    const {
-      clients: { intelligentSearchApi },
-    } = ctx
-
-    const biggyArgs: { [key: string]: any } = {
-      ...args,
-    }
-
-    // unnecessary field. It's is an object and breaks the @vtex/api cache
-    delete biggyArgs.selectedFacets
-
-    const result = await intelligentSearchApi.facets(
-      { ...biggyArgs, query: args.fullText },
-      buildAttributePath(selectedFacets),
-      shippingOptions
-    )
-
-    if (ctx.vtex.tenant) {
-      ctx.translated = result.translated
-    }
-
-    return result
+    return fetchFacets(ctx, args, selectedFacets, shippingOptions)
   },
 
   product: async (_: any, rawArgs: ProductArgs, ctx: Context) => {
@@ -464,41 +445,9 @@ export const queries = {
       })
     }
 
-    const { intelligentSearchApi } = ctx.clients
-    const {
-      selectedFacets,
-      fullText,
-      advertisementOptions = defaultAdvertisementOptions,
-    } = args
-
-    const workspaceSearchParams = await getWorkspaceSearchParamsFromStorage(ctx)
+    const { selectedFacets } = args
 
-    const biggyArgs: { [key: string]: any } = {
-      ...advertisementOptions,
-      ...args,
-      query: fullText,
-      sort: convertOrderBy(args.orderBy),
-      ...args.options,
-      ...workspaceSearchParams,
-    }
-
-    // unnecessary field. It's is an object and breaks the @vtex/api cache
-    delete biggyArgs.selectedFacets
-
-    const result = await intelligentSearchApi.productSearch(
-      { ...biggyArgs },
-      buildAttributePath(selectedFacets),
-      shippingOptions
-    )
-
-    if (ctx.vtex.tenant && !args.productOriginVtex) {
-      ctx.translated = result.translated
-    }
-
-    return {
-      searchState: args.searchState,
-      ...result,
-    }
+    return fetchProductSearch(ctx, args, selectedFacets, shippingOptions)
   },
 
   sponsoredProducts: async (_: any, args: ProductSearchInput, ctx: any) => {

node/services/facets.test.ts

@@ -0,0 +1,110 @@
+import { fetchFacets } from './facets'
+import { createContext } from '../mocks/contextFactory'
+import type { FacetsInput } from '../typings/Search'
+
+describe('fetchFacets service', () => {
+  const mockFacetsResponse = {
+    facets: [
+      {
+        name: 'Category',
+        values: [
+          { name: 'Electronics', quantity: 10 },
+          { name: 'Clothing', quantity: 5 },
+        ],
+      },
+    ],
+    translated: false,
+  }
+
+  const mockArgs: FacetsInput = {
+    fullText: 'test query',
+    query: 'test',
+    map: 'ft',
+    selectedFacets: [],
+    removeHiddenFacets: false,
+    hideUnavailableItems: false,
+    categoryTreeBehavior: 'default',
+  }
+
+  const mockSelectedFacets: SelectedFacet[] = []
+
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('should use intelligentSearchApi when shouldUseNewPLPEndpoint is false', async () => {
+    const ctx = createContext({
+      accountName: 'testaccount',
+      appSettings: {
+        shouldUseNewPLPEndpoint: false,
+      },
+      intelligentSearchApiSettings: {
+        facets: mockFacetsResponse,
+      },
+    })
+
+    const result = await fetchFacets(ctx, mockArgs, mockSelectedFacets)
+
+    expect(ctx.clients.intelligentSearchApi.facets).toHaveBeenCalled()
+    expect(ctx.clients.intsch.facets).not.toHaveBeenCalled()
+    expect(result).toEqual(mockFacetsResponse)
+  })
+
+  it('should use intsch when shouldUseNewPLPEndpoint is true', async () => {
+    const ctx = createContext({
+      accountName: 'testaccount',
+      appSettings: {
+        shouldUseNewPLPEndpoint: true,
+      },
+      intschSettings: {
+        facets: mockFacetsResponse,
+      },
+    })
+
+    const result = await fetchFacets(ctx, mockArgs, mockSelectedFacets)
+
+    expect(ctx.clients.intsch.facets).toHaveBeenCalled()
+    expect(ctx.clients.intelligentSearchApi.facets).not.toHaveBeenCalled()
+    expect(result).toEqual(mockFacetsResponse)
+  })
+
+  it('should handle shipping options correctly', async () => {
+    const ctx = createContext({
+      accountName: 'testaccount',
+      appSettings: {
+        shouldUseNewPLPEndpoint: false,
+      },
+      intelligentSearchApiSettings: {
+        facets: mockFacetsResponse,
+      },
+    })
+
+    const shippingOptions = ['delivery', 'pickup']
+
+    await fetchFacets(ctx, mockArgs, mockSelectedFacets, shippingOptions)
+
+    expect(ctx.clients.intelligentSearchApi.facets).toHaveBeenCalledWith(
+      expect.objectContaining({ query: 'test query' }),
+      expect.any(String),
+      shippingOptions
+    )
+  })
+
+  it('should set translated flag in context when tenant is present', async () => {
+    const ctx = createContext({
+      accountName: 'testaccount',
+      appSettings: {
+        shouldUseNewPLPEndpoint: false,
+      },
+      intelligentSearchApiSettings: {
+        facets: { ...mockFacetsResponse, translated: true },
+      },
+      tenantLocale: 'en-US',
+    })
+
+    await fetchFacets(ctx, mockArgs, mockSelectedFacets)
+
+    expect(ctx.translated).toBe(true)
+  })
+})
+

node/services/facets.ts

@@ -0,0 +1,90 @@
+import { buildAttributePath } from '../commons/compatibility-layer'
+import { fetchAppSettings } from './settings'
+import type { FacetsInput } from '../typings/Search'
+
+/**
+ * Fetches facets using the intelligentSearchApi client (Biggy)
+ */
+async function fetchFacetsFromBiggy(
+  ctx: Context,
+  args: FacetsInput,
+  selectedFacets: SelectedFacet[],
+  shippingOptions?: string[]
+) {
+  const {
+    clients: { intelligentSearchApi },
+  } = ctx
+
+  const biggyArgs: { [key: string]: any } = {
+    ...args,
+  }
+
+  // unnecessary field. It's is an object and breaks the @vtex/api cache
+  delete biggyArgs.selectedFacets
+
+  const result: any = await intelligentSearchApi.facets(
+    { ...biggyArgs, query: args.fullText },
+    buildAttributePath(selectedFacets),
+    shippingOptions
+  )
+
+  if (ctx.vtex.tenant) {
+    ctx.translated = result.translated
+  }
+
+  return result
+}
+
+/**
+ * Fetches facets using the intsch client (Intelligent Search)
+ */
+async function fetchFacetsFromIntsch(
+  ctx: Context,
+  args: FacetsInput,
+  selectedFacets: SelectedFacet[],
+  shippingOptions?: string[]
+) {
+  const {
+    clients: { intsch },
+  } = ctx
+
+  const intschArgs: { [key: string]: any } = {
+    ...args,
+  }
+
+  // unnecessary field. It's is an object and breaks the @vtex/api cache
+  delete intschArgs.selectedFacets
+
+  const result: any = await intsch.facets(
+    { ...intschArgs, query: args.fullText },
+    buildAttributePath(selectedFacets),
+    shippingOptions
+  )
+
+  if (ctx.vtex.tenant) {
+    ctx.translated = result.translated
+  }
+
+  return result
+}
+
+/**
+ * Facets service that extracts facets fetching logic and implements flag-based routing
+ * using intelligentSearchApi as primary and intsch as alternative based on shouldUseNewPLPEndpoint flag
+ */
+export async function fetchFacets(
+  ctx: Context,
+  args: FacetsInput,
+  selectedFacets: SelectedFacet[],
+  shippingOptions?: string[]
+) {
+  const { shouldUseNewPLPEndpoint } = await fetchAppSettings(ctx)
+
+  // Check if current account should use intsch directly
+  if (shouldUseNewPLPEndpoint) {
+    return fetchFacetsFromIntsch(ctx, args, selectedFacets, shippingOptions)
+  }
+
+  return fetchFacetsFromBiggy(ctx, args, selectedFacets, shippingOptions)
+}
+