Feature: use settings to determine whether or not to fetch ads

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Added
+
+- Use the advanced setting `fetchSponsoredProductsOnSearch` to determine whether or not to fetch sponsored products.
+
 ## [3.127.1] - 2023-10-24
 
 ### Changed

react/components/SearchQuery.js

@@ -13,6 +13,7 @@
   detachFiltersByType,
   buildQueryArgsFromSelectedFacets,
 } from '../utils/compatibilityLayer'
+import shouldSkipSponsoredProducts from '../utils/shouldSkipSponsoredProducts'
 import { FACETS_RENDER_THRESHOLD } from '../constants/filterConstants'
 import useRedirect from '../hooks/useRedirect'
 import useSession from '../hooks/useSession'
@@ -125,7 +126,7 @@
 
 const isCurrentDifferent = (ref, currentVal) => ref.current !== currentVal
 
 const useShouldResetPage = (query, map, orderBy, priceRange) => {
   const queryRef = useRef(query)
   const mapRef = useRef(map)
   const orderByRef = useRef(orderBy)
@@ -154,7 +155,7 @@
   operator,
   searchState,
   fullText
 ) => {
   const fullTextRef = useRef(fullText)
   const shouldReset = isCurrentDifferent(fullTextRef, fullText)
 
@@ -189,10 +190,11 @@
   facetsArgs,
   price,
   sponsoredProductsBehavior = 'skip'
 ) => {
   const { getSettings, query: runtimeQuery } = useRuntime()
-  const isLazyFacetsFetchEnabled =
-    getSettings('vtex.store')?.enableFiltersFetchOptimization
+  const settings = getSettings('vtex.store')
+
+  const isLazyFacetsFetchEnabled = settings?.enableFiltersFetchOptimization
 
   const productSearchResult = useQuery(productSearchQuery, {
     ssr: false,
@@ -209,7 +211,7 @@
     error: sponsoredProductsError,
   } = useQuery(sponsoredProductsQuery, {
     variables,
-    skip: sponsoredProductsBehavior === 'skip',
+    skip: shouldSkipSponsoredProducts(sponsoredProductsBehavior, settings),
   })
 
   const sponsoredProductsReturn = sponsoredProductsResult(

react/utils/shouldSkipSponsoredProducts.ts

@@ -0,0 +1,23 @@
+type SponsoredProductsBehavior = 'skip' | string
+
+type Settings = {
+  fetchSponsoredProductsOnSearch: boolean
+} & Record<string, unknown>
+
+/**
+ * This function checks the store's settings, as well as the passed value of
+ * `sponsoredProductsBehavior` passed in the store-theme, to determine if the
+ * sponsored products request should be skipped or not.
+ * Some accounts may not have configured the store's settings, so we need to check if the
+ * `sponsoredProductsBehavior` parameter for compatibility.
+ */
+const shouldSkipSponsoredProducts = (
+  sponsoredProductsBehavior: SponsoredProductsBehavior,
+  settings: Settings
+) => {
+  const fetchSponsoredProductsConfig = settings?.fetchSponsoredProductsOnSearch
+
+  return !fetchSponsoredProductsConfig && sponsoredProductsBehavior === 'skip'
+}
+
+export default shouldSkipSponsoredProducts