Merge pull request #491 from vtex-apps/feature/newIsApi

Send autocomplete shadow traffic to the new EKS Api.

Author: salesfelipe

.vtexignore

@@ -12,4 +12,4 @@ node/**/*.test.js
 node/**/*.test.ts
 node/**/*.test.tsx
 node/coverage/*
-node/mocks
+node/mocks/

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Changed
+
+- Send 1% of the production traffic to the new intsch service authough still uses the result from the I/O app. 
+
 ## [1.76.0] - 2025-02-07
 
 ### Changed

lint.sh

@@ -64,6 +64,20 @@
         "path": "/*"
       }
     },
+    {
+      "name": "outbound-access",
+      "attrs": {
+        "host": "portal.vtexcommercestable.com.br",
+        "path": "/api/intelligent-search"
+      }
+    },
+    {
+      "name": "outbound-access",
+      "attrs": {
+        "host": "portal.vtexcommercebeta.com.br",
+        "path": "/api/intelligent-search"
+      }
+    },
     {
       "name": "vtex.messages:graphql-translate-messages"
     }

manifest.json

@@ -4,18 +4,26 @@ import { Search } from './search'
 import { Checkout } from './checkout'
 import { Rewriter } from './rewriter'
 import { IntelligentSearchApi } from './intelligent-search-api'
+import { Intsch } from './intsch'
 
 export class Clients extends IOClients {
   public get search() {
     return this.getOrSet('search', Search)
   }
+
   public get checkout() {
     return this.getOrSet('checkout', Checkout)
   }
+
   public get rewriter() {
     return this.getOrSet('rewriter', Rewriter)
   }
+
   public get intelligentSearchApi() {
     return this.getOrSet('intelligentSearchApi', IntelligentSearchApi)
   }
+
+  public get intsch() {
+    return this.getOrSet('intsch', Intsch)
+  }
 }

node/clients/index.ts

@@ -1,7 +1,11 @@
-import { ExternalClient, InstanceOptions, IOContext } from "@vtex/api";
-import { parseState } from "../utils/searchState";
+import type { InstanceOptions, IOContext } from '@vtex/api'
+import { ExternalClient } from '@vtex/api'
+
+import { parseState } from '../utils/searchState'
+import type { IIntelligentSearchClient } from './intsch/types'
 
 const isPathTraversal = (str: string) => str.indexOf('..') >= 0
+
 interface CorrectionParams {
   query: string
 }
@@ -44,59 +48,89 @@ const decodeQuery = (query: string) => {
   }
 }
 
-export class IntelligentSearchApi extends ExternalClient {
+export class IntelligentSearchApi
+  extends ExternalClient
+  implements IIntelligentSearchClient
+{
   private locale: string | undefined
 
   public constructor(context: IOContext, options?: InstanceOptions) {
-    super(`http://${context.workspace}--${context.account}.myvtex.com/_v/api/intelligent-search`, context, {
-      ...options,
-      headers: {
-        ...options?.headers,
+    super(
+      `http://${context.workspace}--${context.account}.myvtex.com/_v/api/intelligent-search`,
+      context,
+      {
+        ...options,
+        headers: {
+          ...options?.headers,
+        },
       }
-    })
+    )
 
     const { locale, tenant } = context
+
     this.locale = locale ?? tenant?.locale
   }
 
   public async topSearches() {
-    return this.http.get('/top_searches', {params: {
-      locale: this.locale
-    }, metric: 'topSearches'})
+    return this.http.get('/top_searches', {
+      params: {
+        locale: this.locale,
+      },
+      metric: 'topSearches',
+    })
   }
 
   public async correction(params: CorrectionParams) {
-    return this.http.get('/correction_search', {params: {...params, locale: this.locale}, metric: 'correction'})
+    return this.http.get('/correction_search', {
+      params: { ...params, locale: this.locale },
+      metric: 'correction',
+    })
   }
 
   public async searchSuggestions(params: SearchSuggestionsParams) {
-    return this.http.get('/search_suggestions', {params: {...params, locale: this.locale}, metric: 'searchSuggestions'})
+    return this.http.get('/search_suggestions', {
+      params: { ...params, locale: this.locale },
+      metric: 'searchSuggestions',
+    })
   }
 
-  public async autocompleteSearchSuggestions(params: AutocompleteSearchSuggestionsParams) {
-    return this.http.get('/autocomplete_suggestions', {params: {...params, locale: this.locale}, metric: 'autocompleteSearchSuggestions'})
+  public async fetchAutocompleteSuggestions(
+    params: AutocompleteSearchSuggestionsParams
+  ) {
+    return this.http.get('/autocomplete_suggestions', {
+      params: { ...params, locale: this.locale },
+      metric: 'autocompleteSearchSuggestions',
+    })
   }
 
   public async banners(params: BannersArgs, path: string) {
     if (isPathTraversal(path)) {
-      throw new Error("Malformed URL")
+      throw new Error('Malformed URL')
     }
 
-    return this.http.get(`/banners/${path}`, {params: {...params, query: params.query, locale: this.locale}, metric: 'banners'})
+    return this.http.get(`/banners/${path}`, {
+      params: { ...params, query: params.query, locale: this.locale },
+      metric: 'banners',
+    })
   }
 
-  public async facets(params: FacetsArgs, path: string, shippingHeader?: string[]) {
+  public async facets(
+    params: FacetsArgs,
+    path: string,
+    shippingHeader?: string[]
+  ) {
     if (isPathTraversal(path)) {
-      throw new Error("Malformed URL")
+      throw new Error('Malformed URL')
     }
 
-    const {query, leap, searchState} = params
+    const { query, leap, searchState } = params
 
     return this.http.get(`/facets/${path}`, {
       params: {
         ...params,
         query: query && decodeQuery(query),
         locale: this.locale,
+        // eslint-disable-next-line @typescript-eslint/camelcase
         bgy_leap: leap ? true : undefined,
         ...parseState(searchState),
       },
@@ -107,16 +141,22 @@ export class IntelligentSearchApi extends ExternalClient {
     })
   }
 
-  public async productSearch(params: SearchResultArgs, path: string, shippingHeader?: string[]) {
-    const {query, leap, searchState} = params
+  public async productSearch(
+    params: SearchResultArgs,
+    path: string,
+    shippingHeader?: string[]
+  ) {
+    const { query, leap, searchState } = params
+
     if (isPathTraversal(path)) {
-      throw new Error("Malformed URL")
+      throw new Error('Malformed URL')
     }
 
     return this.http.get(`/product_search/${path}`, {
       params: {
         query: query && decodeQuery(query),
         locale: this.locale,
+        // eslint-disable-next-line @typescript-eslint/camelcase
         bgy_leap: leap ? true : undefined,
         ...parseState(searchState),
         ...params,
@@ -128,16 +168,22 @@ export class IntelligentSearchApi extends ExternalClient {
     })
   }
 
-  public async sponsoredProducts(params: SearchResultArgs, path: string, shippingHeader?: string[]) {
-    const {query, leap, searchState} = params
+  public async sponsoredProducts(
+    params: SearchResultArgs,
+    path: string,
+    shippingHeader?: string[]
+  ) {
+    const { query, leap, searchState } = params
+
     if (isPathTraversal(path)) {
-      throw new Error("Malformed URL")
+      throw new Error('Malformed URL')
     }
 
     return this.http.get(`/sponsored_products/${path}`, {
       params: {
         query: query && decodeQuery(query),
         locale: this.locale,
+        // eslint-disable-next-line @typescript-eslint/camelcase
         bgy_leap: leap ? true : undefined,
         ...parseState(searchState),
         ...params,

node/clients/intelligent-search-api.ts

@@ -0,0 +1,33 @@
+import { InstanceOptions, IOContext, JanusClient } from '@vtex/api'
+
+import {
+  AutocompleteSuggestionsArgs,
+  AutocompleteSuggestionsResponse,
+  IIntelligentSearchClient,
+} from './types'
+
+export class Intsch extends JanusClient implements IIntelligentSearchClient {
+  private locale: string | undefined
+
+  public constructor(ctx: IOContext, options?: InstanceOptions) {
+    const env = ctx.production ? 'stable' : 'beta'
+
+    super(ctx, options, env)
+
+    const { locale, tenant } = ctx
+
+    this.locale = locale ?? tenant?.locale
+  }
+
+  public fetchAutocompleteSuggestions(
+    args: AutocompleteSuggestionsArgs
+  ): Promise<AutocompleteSuggestionsResponse> {
+    return this.http.get(
+      '/api/intelligent-search/v0/autocomplete-suggestions',
+      {
+        params: { query: args.query, locale: this.locale },
+        metric: 'autocompleteSearchSuggestions-new',
+      }
+    )
+  }
+}

node/clients/intsch/index.ts

@@ -0,0 +1,25 @@
+/* eslint-disable @typescript-eslint/prefer-interface */
+
+export type AutocompleteSuggestionsArgs = {
+  query: string
+}
+
+export type AutocompleteSuggestionsResponse = {
+  searches: {
+    term: string
+    count: number
+    attributes?: {
+      key: string
+      value: string
+      labelKey: string
+      labelValue: string
+    }[]
+  }[]
+}
+
+// eslint-disable-next-line @typescript-eslint/interface-name-prefix
+export interface IIntelligentSearchClient {
+  fetchAutocompleteSuggestions(
+    args: AutocompleteSuggestionsArgs
+  ): Promise<AutocompleteSuggestionsResponse>
+}

node/clients/intsch/types.ts

@@ -25,10 +25,10 @@ enum SimulationBehavior {
 
 const inflightKey = ({ baseURL, url, params, headers }: RequestConfig) => {
   return (
-    baseURL! +
-    url! +
+    (baseURL ?? '') +
+    (url ?? '') +
     stringify(params, { arrayFormat: 'repeat', addQueryPrefix: true }) +
-    `&segmentToken=${headers['x-vtex-segment']}`
+    `&segmentToken=${headers ? headers['x-vtex-segment'] : ''}`
   )
 }
 

node/clients/search.ts

@@ -0,0 +1,65 @@
+import parse from 'co-body'
+
+import { MockedIntelligentSearchApiClient } from './intelligent-search-api'
+import type { IntelligentSearchClientArgs } from './intsch'
+import { MockedIntschClient } from './intsch'
+
+export function createContext<Ctx = Context>({
+  accountName,
+  intelligentSearchApiSettings,
+  intschSettings,
+  cookies,
+  body,
+  req,
+  query,
+  production,
+}: {
+  production?: boolean
+  appSettings?: Record<string, any>
+  intschSettings?: IntelligentSearchClientArgs
+  intelligentSearchApiSettings?: IntelligentSearchClientArgs
+  req?: {
+    body?: any
+  }
+  query?: Record<string, unknown>
+  body?: any
+  cookies?: Record<string, string>
+  accountName?: string
+}) {
+  if (req?.body instanceof Error) {
+    jest.spyOn(parse, 'json').mockRejectedValue(req.body)
+  } else {
+    jest.spyOn(parse, 'json').mockReturnValue(req?.body ?? {})
+  }
+
+  return {
+    req: {},
+    body: body ?? {},
+    cookies: {
+      get: jest.fn().mockImplementation((key: string) => cookies?.[key]),
+    },
+    get: jest.fn().mockReturnValue('localhost'),
+    response: {
+      set: jest.fn(),
+    },
+    clients: {
+      intsch: new MockedIntschClient(intschSettings),
+      intelligentSearchApi: new MockedIntelligentSearchApiClient(
+        intelligentSearchApiSettings
+      ),
+      apps: {
+        getAppSettings: jest.fn().mockReturnValue({}),
+      },
+    },
+    vtex: {
+      production: production ?? false,
+      account: accountName ?? 'biggy',
+      logger: {
+        info: jest.fn(),
+        warn: jest.fn(),
+        error: jest.fn(),
+      },
+    },
+    query: query ?? {},
+  } as unknown as Ctx
+}