Merge branch 'v1.x' into feat/add-param-to-crossselling

CHANGELOG.md

@@ -12,6 +12,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `groupByProduct` param to `productRecommendations` query.
 - `quantity` param to `Recommendation.similars` resolver.
 
+## [1.67.1] - 2023-10-18
+
+## [1.67.0] - 2023-08-22
+
+### Added
+- `sponsoredProducts` query.
+
+## [1.66.1] - 2023-08-18
+
+### Fixed
+- Retrieve translated text-based product specification values ("properties") when using the `productSearch` and `products` queries.
+
+## [1.66.0] - 2023-08-01
+
+### Fixed
+- Version bump to reset circuit breaker
 ## [1.65.1] - 2023-04-24
 
 ### Fixed

manifest.json

@@ -1,7 +1,7 @@
 {
   "vendor": "vtex",
   "name": "search-resolver",
-  "version": "1.65.1",
+  "version": "1.67.1",
   "title": "GraphQL resolver for the VTEX store APIs",
   "description": "GraphQL resolvers for the VTEX API for the catalog and orders.",
   "credentialType": "absolute",

node/clients/intelligent-search-api.ts

@@ -127,4 +127,25 @@ export class IntelligentSearchApi extends ExternalClient {
       },
     })
   }
+
+  public async sponsoredProducts(params: SearchResultArgs, path: string, shippingHeader?: string[]) {
+    const {query, leap, searchState} = params
+    if (isPathTraversal(path)) {
+      throw new Error("Malformed URL")
+    }
+
+    return this.http.get(`/sponsored_products/${path}`, {
+      params: {
+        query: query && decodeQuery(query),
+        locale: this.locale,
+        bgy_leap: leap ? true : undefined,
+        ...parseState(searchState),
+        ...params,
+      },
+      metric: 'product-search',
+      headers: {
+        'x-vtex-shipping-options': shippingHeader ?? '',
+      },
+    })
+  }
 }

node/package.json

@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "@gocommerce/utils": "^0.6.11",
-    "@vtex/vtexis-compatibility-layer": "^0.2.5",
+    "@vtex/vtexis-compatibility-layer": "^1.2.13",
     "atob": "^2.1.2",
     "axios": "^0.21.2",
     "camelcase": "^5.0.0",
@@ -33,7 +33,7 @@
     "slugify": "^1.6.4",
     "typescript": "3.9.7",
     "unescape": "^1.0.1",
-    "vtex.search-graphql": "http://vtex.vtexassets.com/_v/public/typings/v1/vtex.search-graphql@0.46.0/public"
+    "vtex.search-graphql": "http://vtex.vtexassets.com/_v/public/typings/v1/vtex.search-graphql@0.54.0-beta.1/public"
   },
   "devDependencies": {
     "@types/atob": "^2.1.2",
@@ -46,7 +46,7 @@
     "@types/node": "^12.0.0",
     "@types/qs": "^6.5.1",
     "@types/ramda": "^0.26.21",
-    "@vtex/api": "6.45.15",
+    "@vtex/api": "6.45.22",
     "@vtex/tsconfig": "^0.6.0",
     "eslint": "^5.15.3",
     "eslint-config-vtex": "^10.1.0",
@@ -59,5 +59,5 @@
     "vtex.rewriter": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected]/public/@types/vtex.rewriter",
     "vtex.search-graphql": "http://vtex.vtexassets.com/_v/public/typings/v1/[email protected]/public/@types/vtex.search-graphql"
   },
-  "version": "1.65.1"
+  "version": "1.67.1"
 }

node/resolvers/search/index.ts

@@ -37,7 +37,6 @@ import {
   convertOrderBy,
 } from '../../commons/compatibility-layer'
 import { getWorkspaceSearchParamsFromStorage } from '../../routes/workspaceSearchParams'
-
 interface ProductIndentifier {
   field: 'id' | 'slug' | 'ean' | 'reference' | 'sku'
   value: string
@@ -540,6 +539,51 @@ export const queries = {
     }
   },
 
+  sponsoredProducts: async (_: any, args: ProductSearchInput, ctx: any) => {
+    const [shippingOptions, facets] = getShippingOptionsFromSelectedFacets(args.selectedFacets)
+    args.selectedFacets = facets
+
+    args = (await getCompatibilityArgsFromSelectedFacets(
+      ctx,
+      args
+    )) as ProductSearchInput
+
+    if (!validMapAndQuery(args.query, args.map)) {
+      ctx.vtex.logger.warn({
+        message: 'Invalid map or query',
+        query: args.query,
+        map: args.map
+      })
+    }
+
+    const { intelligentSearchApi } = ctx.clients
+    const {
+      selectedFacets,
+      fullText
+    } = args
+
+    const workspaceSearchParams = await getWorkspaceSearchParamsFromStorage(ctx)
+
+    const biggyArgs: {[key:string]: any} = {
+      ...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.sponsoredProducts({...biggyArgs}, buildAttributePath(selectedFacets), shippingOptions)
+
+    if (ctx.vtex.tenant && !args.productOriginVtex) {
+      ctx.translated = result.translated
+    }
+
+    return result
+  },
+
   productRecommendations: async (
     _: any,
     { identifier, type, groupByProduct = true  }: ProductRecommendationArg,

node/resolvers/search/product.ts

@@ -209,14 +209,17 @@ export const resolvers = {
     },
 
     properties: async (product: SearchProduct, _: unknown, ctx: Context) => {
+      let valuesUntranslated = []
+
       if (product.origin === 'intelligent-search') {
-        return product.properties
+        valuesUntranslated = product.properties ?? []
+      } else {
+        valuesUntranslated = (product.allSpecifications ?? []).map((name: string) => {
+          const value = (product as unknown as DynamicKey<string[]>)[name]
+          return { name, originalName: name, values: value }
+        })
       }
 
-      const valuesUntranslated = (product.allSpecifications ?? []).map((name: string) => {
-        const value = (product as unknown as DynamicKey<string[]>)[name]
-        return { name, originalName: name, values: value }
-      })
       if (!shouldTranslateToUserLocale(ctx)) {
         return valuesUntranslated
       }

node/tsconfig.json

@@ -1,7 +1,14 @@
 {
   "extends": "@vtex/tsconfig",
-  "include": ["./typings/*.d.ts", "./**/*.tsx", "./**/*.ts"],
+  "include": [
+    "./typings/*.d.ts",
+    "./**/*.tsx",
+    "./**/*.ts"
+  ],
   "compilerOptions": {
-    "types": ["node", "jest"]
+    "types": [
+      "node",
+      "jest"
+    ]
   }
 }

node/utils/i18n.ts

@@ -3,6 +3,7 @@ import {
   parseTranslatableStringV2,
   createMessagesLoader,
 } from '@vtex/api'
+import { logDegradedSearchError } from '../resolvers/search/utils'
 
 export const formatTranslatableProp = <R, P extends keyof R, I extends keyof R>(prop: P, idProp: I) =>
   (root: R, _: unknown, ctx: Context) => addContextToTranslatableString(
@@ -34,16 +35,25 @@ export const addContextToTranslatableString = (message: Message, ctx: Context) =
     return message.content
   }
 
-  const {
-    content,
-    context: originalContext,
-    from: originalFrom
-  } = parseTranslatableStringV2(message.content)
 
-  const context = (originalContext || message.context)?.toString()
-  const from = originalFrom || message.from || locale
-
-  return formatTranslatableStringV2({ content, context, from })
+  try {
+    const {
+      content,
+      context: originalContext,
+      from: originalFrom
+    } = parseTranslatableStringV2(message.content)
+
+    const context = (originalContext || message.context)?.toString()
+    const from = originalFrom || message.from || locale
+    return formatTranslatableStringV2({ content, context, from })
+  } catch (e) {
+    logDegradedSearchError(ctx.vtex.logger, {
+      service: 'node-vtex-api translation',
+      error: 'Error when trying to add context to translatable string',
+      errorStack: e,
+    })
+    return message.content
+  }
 }
 
 export const translateToCurrentLanguage = (message: MessageWithContext, ctx: Context) => {
@@ -78,4 +88,4 @@ export const shouldTranslateToBinding = ({ translated, vtex: { binding, tenant }
   binding && binding?.locale !== tenant?.locale && (!translated || ignoreIndexedTranslation)
 
 export const shouldTranslateToTenantLocale = ({ vtex: { locale, tenant } }: Context) =>
-  Boolean(tenant?.locale && locale && tenant.locale !== locale)
+  Boolean(tenant?.locale && locale && tenant.locale !== locale)