Call IS instead of Solr for PDP query ✨

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Changed
+- Call IS for `product` query instead of SOLR API.
+
 ## [1.69.0] - 2024-03-21
 - Parameter `groupBy` into `recommendations` and `productRecommendations` resolvers and `groupByProduct` in `crossSelling` search client.
 

manifest.json

@@ -1,7 +1,7 @@
 {
   "vendor": "vtex",
   "name": "search-resolver",
-  "version": "1.69.0",
+  "version": "1.70.0-beta.0",
   "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

@@ -85,6 +85,19 @@ export class IntelligentSearchApi extends ExternalClient {
     return this.http.get(`/banners/${path}`, {params: {...params, query: params.query, locale: this.locale}, metric: 'banners'})
   }
 
+  public async product(params: { field: string, value: string, salesChannel: number }) {
+    const { field, value, salesChannel } = params
+    return this.http.get('/product', {
+      params: {
+        id: value,
+        type: field,
+        locale: this.locale,
+        salesChannel,
+      },
+      metric: 'product',
+    })
+  }
+
   public async facets(params: FacetsArgs, path: string, shippingHeader?: string[]) {
     if (isPathTraversal(path)) {
       throw new Error("Malformed URL")

node/clients/search.ts

@@ -95,44 +95,6 @@ export class Search extends AppClient {
     )
   }
 
-  public product = (
-    slug: string,
-    vtexSegment?: string,
-    salesChannel?: string | number | null
-  ) =>
-    this.get<SearchProduct[]>(
-      this.addCompleteSpecifications(
-        this.addSalesChannel(
-          `/pub/products/search/${this.searchEncodeURI(
-            slug && slug.toLowerCase()
-          )}/p`,
-          salesChannel
-        )
-      ),
-      {
-        metric: 'search-product',
-        headers: this.getVtexSegmentCookieAsHeader(vtexSegment),
-      }
-    )
-
-  public productByEan = (
-    id: string,
-    vtexSegment?: string,
-    salesChannel?: string | number | null
-  ) =>
-    this.get<SearchProduct[]>(
-      this.addCompleteSpecifications(
-        this.addSalesChannel(
-          `/pub/products/search?fq=alternateIds_Ean:${id}`,
-          salesChannel
-        )
-      ),
-      {
-        metric: 'search-productByEan',
-        headers: this.getVtexSegmentCookieAsHeader(vtexSegment),
-      }
-    )
-
   public productsByEan = (
     ids: string[],
     vtexSegment?: string,
@@ -195,24 +157,6 @@ export class Search extends AppClient {
       }
     )
 
-  public productByReference = (
-    id: string,
-    vtexSegment?: string,
-    salesChannel?: string | number | null
-  ) =>
-    this.get<SearchProduct[]>(
-      this.addCompleteSpecifications(
-        this.addSalesChannel(
-          `/pub/products/search?fq=alternateIds_RefId:${id}`,
-          salesChannel
-        )
-      ),
-      {
-        metric: 'search-productByReference',
-        headers: this.getVtexSegmentCookieAsHeader(vtexSegment),
-      }
-    )
-
   public productsByReference = (
     ids: string[],
     vtexSegment?: string,

node/resolvers/search/index.ts

@@ -375,7 +375,7 @@ export const queries = {
 
   product: async (_: any, rawArgs: ProductArgs, ctx: Context) => {
     const {
-      clients: { search },
+      clients: { intelligentSearchApi },
     } = ctx
 
     const args =
@@ -394,27 +394,28 @@ export const queries = {
     const { field, value } = args.identifier
 
     let products = [] as SearchProduct[]
-
-    const vtexSegment = (!cookie || (!cookie?.regionId && rawArgs.regionId)) ? buildVtexSegment(cookie, salesChannel, rawArgs.regionId) : ctx.vtex.segmentToken
+    let fieldId = ''
 
     switch (field) {
       case 'id':
-        products = await search.productById(value, vtexSegment, salesChannel)
+        fieldId = 'product.id'
         break
       case 'slug':
-        products = await search.product(value, vtexSegment, salesChannel)
+        fieldId = 'product.link'
         break
       case 'ean':
-        products = await search.productByEan(value, vtexSegment, salesChannel)
+        fieldId = 'sku.ean'
         break
       case 'reference':
-        products = await search.productByReference(value, vtexSegment, salesChannel)
+        fieldId = 'sku.reference'
         break
       case 'sku':
-        products = await search.productBySku(value, vtexSegment, salesChannel)
+        fieldId = 'sku.id'
         break
     }
 
+    products = await intelligentSearchApi.product({ field: fieldId, value, salesChannel})
+
     if (products.length > 0) {
       return head(products)
     }

node/resolvers/search/offer.ts

@@ -79,7 +79,7 @@ export const resolvers = {
     },
     giftSkuIds: propOr([], 'GiftSkuIds'),
     gifts: async ({ GiftSkuIds }: CommertialOffer, _: any, ctx: Context) => {
-      if (GiftSkuIds.length === 0) {
+      if (!GiftSkuIds || GiftSkuIds.length === 0) {
         return []
       }
 

node/resolvers/search/product.ts

@@ -69,6 +69,8 @@ const knownNotPG = [
   'link',
   'linkText',
   'productReference',
+  'origin',
+  'cacheId',
 ]
 
 const removeTrailingSlashes = (str: string) =>
@@ -181,7 +183,7 @@ export const resolvers = {
       cacheId || linkText,
 
     clusterHighlights: ({origin, clusterHighlights }: SearchProduct) => {
-      if (origin === 'intelligent-search') {
+      if (origin === 'intelligent-search' || origin === 'search-document') {
         return clusterHighlights
       }
 
@@ -201,7 +203,7 @@ export const resolvers = {
     },
 
     productClusters: ({origin, productClusters }: SearchProduct) => {
-      if (origin === 'intelligent-search') {
+      if (origin === 'intelligent-search' || origin === 'search-document') {
         return productClusters
       }
 
@@ -211,8 +213,8 @@ export const resolvers = {
     properties: async (product: SearchProduct, _: unknown, ctx: Context) => {
       let valuesUntranslated = []
 
-      if (product.origin === 'intelligent-search') {
-        valuesUntranslated = product.properties ?? []
+      if (product.origin === 'intelligent-search' || product.origin === 'search-document') {
+        valuesUntranslated = product.properties?.map((prop) => ({...prop, name: prop.originalName ?? prop.name })) ?? []
       } else {
         valuesUntranslated = (product.allSpecifications ?? []).map((name: string) => {
           const value = (product as unknown as DynamicKey<string[]>)[name]
@@ -287,45 +289,57 @@ export const resolvers = {
 
     specificationGroups: async (product: SearchProduct, _: unknown, ctx: Context) => {
       if (product.origin === 'intelligent-search') {
-        return product.specificationGroups
+        return product.specificationGroups ?? []
       }
 
-      const allSpecificationsGroups = (product.allSpecificationsGroups ?? []).concat(['allSpecifications'])
-
-      const visibleSpecifications = product.completeSpecifications
-        ? product.completeSpecifications.reduce<Record<string, boolean>>((acc, specification) => {
-            acc[specification.Name] = specification.IsOnProductDetails
-            return acc
-          }, {})
-        : null
-
-      let noTranslationSpecificationGroups = allSpecificationsGroups.map(
-        (groupName: string) => {
-          let groupSpecifications = (product as unknown as DynamicKey<string[]>)?.[groupName] ?? []
+      let noTranslationSpecificationGroups = []
 
-          groupSpecifications = groupSpecifications.filter(specificationName => {
-            if (visibleSpecifications && visibleSpecifications[specificationName] != null)
-              return visibleSpecifications[specificationName]
-            return true
+      if (product.origin === 'search-document') {
+        noTranslationSpecificationGroups = product.specificationGroups?.map(
+          (group) => ({
+            ...group,
+            specifications: group.specifications.map((spec) => ({...spec, name: spec.originalName }))
           })
-
-          return {
-            originalName: groupName,
-            name: groupName,
-            specifications: groupSpecifications.map((name) => {
-                const values = (product as unknown as DynamicKey<string[]>)[name] || []
-                return {
-                  originalName: name,
-                  name,
-                  values,
+        ) ?? []
+      } else {
+        const allSpecificationsGroups = (product.allSpecificationsGroups ?? []).concat(['allSpecifications'])
+
+        const visibleSpecifications = product.completeSpecifications
+          ? product.completeSpecifications.reduce<Record<string, boolean>>((acc, specification) => {
+              acc[specification.Name] = specification.IsOnProductDetails
+              return acc
+            }, {})
+          : null
+
+        noTranslationSpecificationGroups = allSpecificationsGroups.map(
+          (groupName: string) => {
+            let groupSpecifications = (product as unknown as DynamicKey<string[]>)?.[groupName] ?? []
+
+            groupSpecifications = groupSpecifications.filter(specificationName => {
+              if (visibleSpecifications && visibleSpecifications[specificationName] != null)
+                return visibleSpecifications[specificationName]
+              return true
+            })
+
+            return {
+              originalName: groupName,
+              name: groupName,
+              specifications: groupSpecifications.map((name) => {
+                  const values = (product as unknown as DynamicKey<string[]>)[name] || []
+                  return {
+                    originalName: name,
+                    name,
+                    values,
+                  }
                 }
-              }
-            ),
+              ),
+            }
           }
-        }
-      )
+        )
 
-      noTranslationSpecificationGroups = noTranslationSpecificationGroups.filter(group => group.specifications.length > 0)
+        noTranslationSpecificationGroups = noTranslationSpecificationGroups.filter(group => group.specifications.length > 0)
+
+      }
 
       if (!shouldTranslateToUserLocale(ctx)) {
         return noTranslationSpecificationGroups

node/resolvers/search/sku.ts

@@ -53,6 +53,11 @@ export const resolvers = {
       if (!sku) {
         return sku
       }
+
+      if (sku.variations?.length && typeof sku.variations[0] !== 'string') {
+        return sku.variations
+      }
+
       const variations = (sku.variations || []).map(variationObj => {
         const variationName = typeof variationObj === 'string' ? variationObj : (variationObj as {name: string}).name
         const fieldId = (sku.skuSpecifications || []).find(specification => specification.field.name === variationName)?.field?.id

node/typings/Catalog.ts

@@ -81,7 +81,7 @@ enum FacetsBehavior {
 interface SpecificationGroup {
   name: string
   originalName: string
-  specifications: { name: string; originalName: string; values: string[] }
+  specifications: { name: string; originalName: string; values: string[] }[]
 }
 interface SearchProduct {
   origin?: string
@@ -112,7 +112,9 @@ interface SearchProduct {
   completeSpecifications?: CompleteSpecification[]
   skuSpecifications?: SkuSpecification[]
   specificationGroups?: SpecificationGroup[]
-  properties?: { name: string; values: string[] }[]
+  properties?: {
+    originalName?: string; name: string; values: string[]
+}[]
 }
 
 interface SearchItem {
@@ -220,7 +222,7 @@ interface CommertialOffer {
   }[]
   GetInfoErrorMessage: any | null
   CacheVersionUsedToCallCheckout: string
-  // Supports the Intelligent Search API which 
+  // Supports the Intelligent Search API which
   // uses the same name from the simulation
   discountHighlights: any[]
 }