Add feature flag to call the new Facets and Search endpoints (#507)

* Add new feature flag to PLP

* Extract productsByIdentifier to use the same endpoint

* Add product search endpoint ot intsch

* Add facets to the intsch client

* Extract the productSearch and facets o a service

* Implement shadow traffic comparisson to facets and productSearch

* Fix lint warnings

* Update changelog

* Add cache to intsch

* update changelog

Author: salesfelipe

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Added
+
+- Feature flag to call the productSearch and facets using the intsch api.
+
+### Changed 
+
+- Make productSearch and facets send a % of the traffic to our routes on intsch.
+
+### Fixed
+
+- Make the productIdentifier call the intsch when the feature flag is on.
+
 ## [1.86.0] - 2025-10-21
 
 ### Changed

manifest.json

@@ -30,6 +30,11 @@
         "title": "Feature flag to use the new PDP endpoint",
         "type": "boolean",
         "default": false
+      },
+      "shouldUseNewPLPEndpoint": {
+        "title": "Feature flag to use the new PLP endpoint",
+        "type": "boolean",
+        "default": false
       }
     }
   },

node/clients/intelligent-search-api.ts

@@ -15,7 +15,7 @@ import type {
 } from './intsch/types'
 import type { Options, SearchResultArgs } from '../typings/Search'
 
-const isPathTraversal = (str: string) => str.indexOf('..') >= 0
+export const isPathTraversal = (str: string) => str.indexOf('..') >= 0
 
 interface CorrectionParams {
   query: string
@@ -29,7 +29,7 @@ interface AutocompleteSearchSuggestionsParams {
   query: string
 }
 
-interface FacetsArgs {
+export type FacetsArgs = {
   query?: string
   page?: number
   count?: number
@@ -47,7 +47,7 @@ interface FacetsArgs {
   regionId?: string | null
 }
 
-const decodeQuery = (query: string) => {
+export const decodeQuery = (query: string) => {
   try {
     return decodeURIComponent(query)
   } catch (e) {

node/clients/intsch/index.ts

@@ -8,17 +8,23 @@ import type {
   CorrectionArgs,
   CorrectionArgsV1,
   CorrectionResponse,
+  FacetsResponse,
   FetchBannersArgs,
   FetchBannersArgsV1,
   FetchBannersResponse,
   FetchProductArgs,
   FetchProductResponse,
   IIntelligentSearchClient,
+  ProductSearchResponse,
   SearchSuggestionsArgs,
   SearchSuggestionsArgsV1,
   SearchSuggestionsResponse,
   TopSearchesResponse,
 } from './types'
+import type { SearchResultArgs } from '../../typings/Search'
+import type { FacetsArgs } from '../intelligent-search-api'
+import { decodeQuery, isPathTraversal } from '../intelligent-search-api'
+import { parseState } from '../../utils/searchState'
 
 export class Intsch extends JanusClient implements IIntelligentSearchClient {
   private locale: string | undefined
@@ -133,4 +139,56 @@ export class Intsch extends JanusClient implements IIntelligentSearchClient {
       metric: 'banners-new-v1',
     })
   }
+
+  public productSearch(
+    params: SearchResultArgs,
+    path: string,
+    shippingHeader?: string[]
+  ): Promise<ProductSearchResponse> {
+    const { query, leap, searchState } = params
+
+    if (isPathTraversal(path)) {
+      throw new Error('Malformed URL')
+    }
+
+    return this.http.get(`/api/intelligent-search/v0/product-search/${path}`, {
+      params: {
+        query: query && decodeQuery(query),
+        locale: this.locale,
+        bgy_leap: leap ? true : undefined,
+        ...parseState(searchState),
+        ...params,
+      },
+      metric: 'product-search-new',
+      headers: {
+        'x-vtex-shipping-options': shippingHeader ?? '',
+      },
+    })
+  }
+
+  public facets(
+    params: FacetsArgs,
+    path: string,
+    shippingHeader?: string[]
+  ): Promise<FacetsResponse> {
+    if (isPathTraversal(path)) {
+      throw new Error('Malformed URL')
+    }
+
+    const { query, leap, searchState } = params
+
+    return this.http.get(`/api/intelligent-search/v0/facets/${path}`, {
+      params: {
+        ...params,
+        query: query && decodeQuery(query),
+        locale: this.locale,
+        bgy_leap: leap ? true : undefined,
+        ...parseState(searchState),
+      },
+      metric: 'facets-new',
+      headers: {
+        'x-vtex-shipping-options': shippingHeader ?? '',
+      },
+    })
+  }
 }

node/clients/intsch/types.ts

@@ -1,3 +1,6 @@
+import type { SearchResultArgs } from '../../typings/Search'
+import type { FacetsArgs } from '../intelligent-search-api'
+
 export type AutocompleteSuggestionsArgs = {
   query: string
 }
@@ -91,6 +94,12 @@ export type FetchProductArgs = {
 
 export type FetchProductResponse = SearchProduct
 
+export type ProductSearchResponse = {
+  products: SearchProduct[]
+}
+
+export type FacetsResponse = any
+
 export interface IIntelligentSearchClient {
   fetchAutocompleteSuggestions(
     args: AutocompleteSuggestionsArgs
@@ -111,4 +120,14 @@ export interface IIntelligentSearchClient {
   ): Promise<SearchSuggestionsResponse>
   fetchCorrectionV1(args: CorrectionArgsV1): Promise<CorrectionResponse>
   fetchBannersV1(args: FetchBannersArgsV1): Promise<FetchBannersResponse>
+  productSearch(
+    args: SearchResultArgs,
+    path: string,
+    shippingHeader?: string[]
+  ): Promise<ProductSearchResponse>
+  facets(
+    params: FacetsArgs,
+    path: string,
+    shippingHeader?: string[]
+  ): Promise<FacetsResponse>
 }

node/index.ts

@@ -21,12 +21,14 @@ const searchCache = new LRUCache<string, Cached>({ max: 3000 })
 const messagesCache = new LRUCache<string, Cached>({ max: 3000 })
 const vbaseCache = new LRUCache<string, Cached>({ max: 3000 })
 const appsCache = new LRUCache<string, Cached>({ max: 1500 })
+const intschCache = new LRUCache<string, Cached>({ max: 3000 })
 
 metrics.trackCache('segment', segmentCache)
 metrics.trackCache('search', searchCache)
 metrics.trackCache('messages', messagesCache)
 metrics.trackCache('vbase', vbaseCache)
 metrics.trackCache('apps', appsCache)
+metrics.trackCache('intsch', intschCache)
 
 export default new Service<Clients, RecorderState, CustomContext>({
   clients: {

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/mocks/intsch.ts

@@ -6,6 +6,8 @@ import type {
   CorrectionResponse,
   FetchBannersResponse,
   FetchProductResponse,
+  ProductSearchResponse,
+  FacetsResponse,
 } from '../clients/intsch/types'
 
 export class MockedIntschClient implements IIntelligentSearchClient {
@@ -91,6 +93,18 @@ export class MockedIntschClient implements IIntelligentSearchClient {
     } else {
       this.fetchBannersV1.mockResolvedValue(args?.fetchBannersV1 ?? null)
     }
+
+    if (args?.productSearch instanceof Error) {
+      this.productSearch.mockRejectedValue(args.productSearch)
+    } else {
+      this.productSearch.mockResolvedValue(args?.productSearch ?? null)
+    }
+
+    if (args?.facets instanceof Error) {
+      this.facets.mockRejectedValue(args.facets)
+    } else {
+      this.facets.mockResolvedValue(args?.facets ?? null)
+    }
   }
 
   public fetchAutocompleteSuggestions = jest.fn()
@@ -104,6 +118,8 @@ export class MockedIntschClient implements IIntelligentSearchClient {
   public fetchSearchSuggestionsV1 = jest.fn()
   public fetchCorrectionV1 = jest.fn()
   public fetchBannersV1 = jest.fn()
+  public productSearch = jest.fn()
+  public facets = jest.fn()
 }
 
 export type IntelligentSearchClientArgs = {
@@ -118,4 +134,6 @@ export type IntelligentSearchClientArgs = {
   fetchSearchSuggestionsV1?: SearchSuggestionsResponse | Error
   fetchCorrectionV1?: CorrectionResponse | Error
   fetchBannersV1?: FetchBannersResponse | Error
+  productSearch?: ProductSearchResponse | Error
+  facets?: FacetsResponse | Error
 }