Feat/skip simulation

graphql/schema.graphql

@@ -63,6 +63,57 @@ type Query {
     hideUnavailableItems: Boolean = false
   ): ProductSearch @cacheControl(scope: SEGMENT, maxAge: SHORT) @withSegment
 
+  """
+  Returns products list filtered and ordered.
+  Is more cacheable than productSearch and is quicker when fetching from catalog.
+  """
+  productSearchNoSimulations(
+    """
+    Terms that is used in search e.g.: eletronics/samsung
+    """
+    query: String = ""
+    """
+    Defines terms types: Brand, Category, Department e.g.: c,b
+    """
+    map: String = ""
+    """
+    Filter by category. {a}/{b} - {a} and {b} are categoryIds
+    """
+    category: String = ""
+    """
+    Array of product specification. specificationFilter_{a}:{b} - {a} is the specificationId, {b} = specification value
+    """
+    specificationFilters: [String]
+    """
+    Filter by price range. e.g.: {a} TO {b} - {a} is the minimum price "from" and {b} is the highest price "to"
+    """
+    priceRange: String = ""
+    """
+    Filter by collection. where collection also know as productClusterId
+    """
+    collection: String = ""
+    """
+    Filter by availability at a specific sales channel. e.g.: salesChannel:4 if want filter by available products for the sales channel 4
+    """
+    salesChannel: String = ""
+    """
+    Order by a criteria. OrderByPriceDESC/OrderByPriceASC, OrderByTopSaleDESC, OrderByReviewRateDESC, OrderByNameASC/OrderByNameDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC
+    """
+    orderBy: String = "OrderByPriceDESC"
+    """
+    Pagination item start
+    """
+    from: Int = 0
+    """
+    Pagination item end
+    """
+    to: Int = 9
+    """
+    If true, uses isAvailablePerSalesChannel_ parameter on query with segment's sales channel. Will override any given salesChannel arg
+    """
+    hideUnavailableItems: Boolean = false
+  ): ProductSearch @cacheControl(scope: PUBLIC, maxAge: SHORT) @withSegment
+
   searchMetadata(
     """
     Terms that is used in search e.g.: eletronics/samsung
@@ -124,6 +175,57 @@ type Query {
     hideUnavailableItems: Boolean = false
   ): [Product] @cacheControl(scope: SEGMENT, maxAge: SHORT) @withSegment
 
+  """
+  Returns products list filtered and ordered
+  Is more cacheable than products and is quicker when fetching from catalog.
+  """
+  productsNoSimulations(
+    """
+    Terms that is used in search e.g.: eletronics/samsung
+    """
+    query: String = ""
+    """
+    Defines terms types: Brand, Category, Department e.g.: c,b
+    """
+    map: String = ""
+    """
+    Filter by category. {a}/{b} - {a} and {b} are categoryIds
+    """
+    category: String = ""
+    """
+    Array of product specification. specificationFilter_{a}:{b} - {a} is the specificationId, {b} = specification value
+    """
+    specificationFilters: [String]
+    """
+    Filter by price range. e.g.: {a} TO {b} - {a} is the minimum price "from" and {b} is the highest price "to"
+    """
+    priceRange: String = ""
+    """
+    Filter by collection. where collection also know as productClusterId
+    """
+    collection: String = ""
+    """
+    Filter by availability at a specific sales channel. e.g.: salesChannel:4 if want filter by available products for the sales channel 4
+    """
+    salesChannel: String = ""
+    """
+    Order by a criteria. OrderByPriceDESC/OrderByPriceASC, OrderByTopSaleDESC, OrderByReviewRateDESC, OrderByNameASC/OrderByNameDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC
+    """
+    orderBy: String = "OrderByPriceDESC"
+    """
+    Pagination item start
+    """
+    from: Int = 0
+    """
+    Pagination item end
+    """
+    to: Int = 9
+    """
+    If true, uses isAvailablePerSalesChannel_ parameter on query with segment's sales channel. Will override any given salesChannel arg
+    """
+    hideUnavailableItems: Boolean = false
+  ): [Product] @cacheControl(scope: PUBLIC, maxAge: SHORT) @withSegment
+
   productRecommendations(
     identifier: ProductUniqueIdentifier
     type: CrossSelingInputEnum

graphql/types/Product.graphql

@@ -252,6 +252,7 @@ type Offer {
   List of gifts associated with the product
   """
   giftSkuIds: [String]
+  skippedSimulation: Boolean
 }
 
 type Teaser {

node/clients/search.ts

@@ -7,7 +7,10 @@ import {
 } from '@vtex/api'
 import { stringify } from 'qs'
 
-import { searchEncodeURI, SearchCrossSellingTypes } from '../resolvers/search/utils'
+import {
+  searchEncodeURI,
+  SearchCrossSellingTypes,
+} from '../resolvers/search/utils'
 
 interface AutocompleteArgs {
   maxRows: number | string
@@ -57,7 +60,9 @@ export class Search extends AppClient {
 
   public product = (slug: string) =>
     this.get<SearchProduct[]>(
-      `/pub/products/search/${this.searchEncodeURI(slug && slug.toLowerCase())}/p`,
+      `/pub/products/search/${this.searchEncodeURI(
+        slug && slug.toLowerCase()
+      )}/p`,
       { metric: 'search-product' }
     )
 
@@ -115,9 +120,14 @@ export class Search extends AppClient {
       { metric: 'search-productBySku' }
     )
 
-  public products = (args: SearchArgs, useRaw = false) => {
-    const method = useRaw ? this.getRaw : this.get
-    return method<SearchProduct[]>(this.productSearchUrl(args), {
+  public products = (args: SearchArgs) => {
+    return this.get<SearchProduct[]>(this.productSearchUrl(args), {
+      metric: 'search-products',
+    })
+  }
+
+  public productsRaw = (args: SearchArgs) => {
+    return this.getRaw<SearchProduct[]>(this.productSearchUrl(args), {
       metric: 'search-products',
     })
   }
@@ -144,9 +154,9 @@ export class Search extends AppClient {
   public facets = (facets: string = '') => {
     const [path, options] = decodeURI(facets).split('?')
     return this.get<SearchFacets>(
-      `/pub/facets/search/${this.searchEncodeURI(encodeURI(
-        `${path.trim()}${options ? '?' + options : ''}`
-      ))}`,
+      `/pub/facets/search/${this.searchEncodeURI(
+        encodeURI(`${path.trim()}${options ? '?' + options : ''}`)
+      )}`,
       { metric: 'search-facets' }
     )
   }
@@ -210,11 +220,10 @@ export class Search extends AppClient {
     to = 9,
     map = '',
     hideUnavailableItems = false,
+    skipSimulation = false,
   }: SearchArgs) => {
     const sanitizedQuery = this.searchEncodeURI(
-      encodeURIComponent(
-        decodeURIComponent(query || '').trim()
-      )
+      encodeURIComponent(decodeURIComponent(query || '').trim())
     )
     if (hideUnavailableItems) {
       const segmentData = (this.context as CustomIOContext).segment
@@ -248,6 +257,10 @@ export class Search extends AppClient {
     if (to != null && to > -1) {
       url += `&_to=${to}`
     }
+    if (skipSimulation) {
+      url += '&simulation=false'
+    }
+
     return url
   }
 }

node/resolvers/search/index.ts

@@ -1,6 +1,16 @@
 import { IOContext, NotFoundError, UserInputError } from '@vtex/api'
 import { all } from 'bluebird'
-import { head, isEmpty, isNil, path, pluck, test, pathOr, zip, tail } from 'ramda'
+import {
+  head,
+  isEmpty,
+  isNil,
+  path,
+  pluck,
+  test,
+  pathOr,
+  zip,
+  tail,
+} from 'ramda'
 
 import { resolvers as assemblyOptionResolvers } from './assemblyOption'
 import { resolvers as autocompleteResolvers } from './autocomplete'
@@ -115,7 +125,7 @@ const isQueryingMetadata = (info: any) => {
   )
 }
 
-const filterSpecificationFilters = ({query, map, ...rest}: FacetsArgs) => {
+const filterSpecificationFilters = ({ query, map, ...rest }: FacetsArgs) => {
   const queryArray = query.split('/')
   const mapArray = map.split(',')
   const queryAndMap = zip(queryArray, mapArray)
@@ -124,9 +134,9 @@ const filterSpecificationFilters = ({query, map, ...rest}: FacetsArgs) => {
     ...tail(queryAndMap).filter(
       ([_, tupleMap]) => tupleMap === 'c' || tupleMap === 'ft'
     ),
-  ]
-  const finalQuery = pluck(0, relevantArgs).join('/')
-  const finalMap = pluck(1, relevantArgs).join(',')
+  ] as [string, string][]
+  const finalQuery = pluck<string>(0, relevantArgs).join('/')
+  const finalMap = pluck<string>(1, relevantArgs).join(',')
 
   return {
     ...rest,
@@ -165,12 +175,10 @@ export const queries = {
     }
   },
 
-  facets: async (
-    _: any,
-    args: FacetsArgs,
-    ctx: Context
-  ) => {
-    const { query, map, hideUnavailableItems } = filterSpecificationFilters(args)
+  facets: async (_: any, args: FacetsArgs, ctx: Context) => {
+    const { query, map, hideUnavailableItems } = filterSpecificationFilters(
+      args
+    )
     const {
       clients: { search },
       clients,
@@ -266,6 +274,37 @@ export const queries = {
     return search.products(args)
   },
 
+  productsNoSimulations: async (_: any, args: SearchArgs, ctx: Context) => {
+    const {
+      clients: { search },
+    } = ctx
+    const queryTerm = args.query
+    if (queryTerm == null || test(/[?&[\]=]/, queryTerm)) {
+      throw new UserInputError(
+        `The query term contains invalid characters. query=${queryTerm}`
+      )
+    }
+
+    if (args.to && args.to > 2500) {
+      throw new UserInputError(
+        `The maximum value allowed for the 'to' argument is 2500`
+      )
+    }
+
+    const newArgs = { ...args, skipSimulation: true }
+
+    const products = await search.products(newArgs)
+    return products.map(product => {
+      return {
+        ...product,
+        items: product.items.map(item => ({
+          ...item,
+          skippedSimulation: true,
+        })),
+      }
+    })
+  },
+
   productsByIdentifier: async (
     _: any,
     args: ProductsByIdentifierArgs,
@@ -327,10 +366,11 @@ export const queries = {
     const translatedArgs = {
       ...args,
       query,
+      skipSimulation: false,
     }
 
     const [productsRaw, searchMetaData] = await all([
-      search.products(args, true),
+      search.productsRaw(args),
       isQueryingMetadata(info)
         ? getSearchMetaData(_, translatedArgs, ctx)
         : emptyTitleTag,
@@ -391,4 +431,44 @@ export const queries = {
     }
     return getSearchMetaData(_, translatedArgs, ctx)
   },
+
+  productSearchNoSimulations: async (
+    _: any,
+    args: SearchArgs,
+    ctx: Context
+  ) => {
+    const {
+      clients,
+      clients: { search },
+      vtex,
+    } = ctx
+    const queryTerm = args.query
+    if (queryTerm == null || test(/[?&[\]=]/, queryTerm)) {
+      throw new UserInputError(
+        `The query term contains invalid characters. query=${queryTerm}`
+      )
+    }
+
+    if (args.to && args.to > 2500) {
+      throw new UserInputError(
+        `The maximum value allowed for the 'to' argument is 2500`
+      )
+    }
+
+    const query = await translateToStoreDefaultLanguage(
+      clients,
+      vtex,
+      args.query || ''
+    )
+    const translatedArgs = {
+      ...args,
+      query,
+      skipSimulation: true,
+    }
+    const productsRaw = await search.productsRaw(translatedArgs)
+    return {
+      translatedArgs,
+      productsRaw,
+    }
+  },
 }

node/resolvers/search/productSearch.ts

@@ -23,7 +23,20 @@ export const resolvers = {
       const quantity = resources.split('/')[1]
       return parseInt(quantity, 10)
     },
-    products: path(['productsRaw', 'data']),
+    products: ({
+      translatedArgs: { skipSimulation },
+      productsRaw: { data },
+    }: ProductSearchParent) => {
+      return data.map(product => {
+        return {
+          ...product,
+          items: product.items.map(item => ({
+            ...item,
+            skippedSimulation: !!skipSimulation,
+          })),
+        }
+      })
+    },
     breadcrumb: async (
       { translatedArgs, productsRaw: { data: products } }: ProductSearchParent,
       _: any,