feat: add new site preference for indexing out-of-stock products

.github/workflows/ci.yml

@@ -143,12 +143,19 @@ jobs:
       - name: Checkout Code
         uses: actions/checkout@v3
 
+      - name: Install Dependencies for browser
+        run: |
+          sudo apt-get install -y \
+          libnss3 \
+          libgbm1 \
+          xvfb
+
       - name: Run Cypress Tests
         uses: cypress-io/github-action@v6
         with:
           install: npm ci
-          browser: electron
-          headless: true
+          headed: false
+          browser: chrome
           config-file: cypress.config.js
         env:
           CYPRESS_SANDBOX_HOST: ${{ vars.SANDBOX_HOST }}

cartridges/bm_algolia/cartridge/controllers/AlgoliaBM.js

@@ -49,6 +49,7 @@ function handleSettings() {
         algoliaData.setPreference('EnableContentSearch', algoliaEnableContentSearch);
         algoliaData.setPreference('EnableRecommend', algoliaEnableRecommend);
         algoliaData.setPreference('EnablePricingLazyLoad', algoliaEnablePricingLazyLoad);
+        algoliaData.setPreference('IndexOutOfStock', params.IndexOutOfStock.submitted);
     } catch (error) {
         Logger.error(error);
     }

cartridges/bm_algolia/cartridge/templates/default/algoliabm/dashboard/index.isml

@@ -228,6 +228,18 @@
                     </td>
                 </tr>
 
+                <iscomment> Algolia_IndexOutOfStock </iscomment>
+                <tr>
+                    <td class="table_detail w s" colspan="1">
+                        <isprint value="${Resource.msg('algolia.label.preference.indexoutofstock', 'algolia', null)}" />
+                        <i class="fa fa-info-circle dw-nc-text-info info-hover"></i>
+                        <div class="tooltip">${Resource.msg('algolia.label.preference.indexoutofstock.help', 'algolia', null)}</div>
+                    </td>
+                    <td class="table_detail w e s">
+                        <input type="checkbox" ${pdict.algoliaData.getPreference('IndexOutOfStock') ? "checked": ""} id="IndexOutOfStock" name="IndexOutOfStock" />
+                    </td>
+                </tr>
+
                 <iscomment> Apply button </iscomment>
                 <tr>
                     <td class="w e s buttonspacing" align="right" colspan="2">

cartridges/bm_algolia/cartridge/templates/resources/algolia.properties

@@ -20,6 +20,7 @@ algolia.label.preference.enablessr=Enable server-side rendering
 algolia.label.preference.enablecontentsearch=Enable content search
 algolia.label.preference.enablerecommend=Recommend
 algolia.label.preference.enablePricingLazyLoad=Lazy Loading for prices
+algolia.label.preference.indexoutofstock=Index out of stock products
 algolia.label.preference.clientid=OCAPI Client ID
 algolia.label.preference.clientpassword=OCAPI Client password
 algolia.label.button.apply=Apply
@@ -43,7 +44,7 @@ algolia.label.preference.enablessr.help=Server-side rendering for SFRA's CLP (ca
 algolia.label.preference.enablecontentsearch.help=Enable Content Search on the storefront
 algolia.label.preference.enablerecommend.help=Enable Algolia Recommend on the SFRA storefront cartridge. See the documentation for additional setup steps
 algolia.label.preference.enablePricingLazyLoad.help=When enabled, prices are fetched from SFCC when search results are displayed. Permits to display the most up-to-date promotions without having to index them.
-
+algolia.label.preference.indexoutofstock.help=Index out of stock products, when disabled, only in-stock (ATS higher than the InStock Threshold) products are indexed. 
 
 # v2 job report table
 algolia.label.jobtype=job type:

cartridges/int_algolia/cartridge/scripts/algolia/filters/productFilter.js

@@ -15,4 +15,44 @@ function isInclude(product) {
     return true;
 }
 
-module.exports.isInclude = isInclude;
+/**
+ * Returns `true` if the product’s ATS >= threshold, false otherwise.
+ * @param {dw.catalog.Product} product - The SFCC product or variant to check
+ * @param {number} threshold - The min ATS to consider in-stock
+ * @returns {boolean}
+ */
+function isInStock(product, threshold) {
+    var availabilityModel = product.getAvailabilityModel();
+    if (!availabilityModel) {
+        return false;
+    }
+
+    // even if one variant is in stock, we consider the product as in stock
+    if (product.master || product.variationGroup) {
+        const variantsIt = product.variants.iterator();
+        while (variantsIt.hasNext()) {
+            let variant = variantsIt.next();
+            let variantAvailabilityModel = variant.getAvailabilityModel();
+            if (variantAvailabilityModel) {
+                let variantInvRecord = variantAvailabilityModel.getInventoryRecord();
+                if (variantInvRecord) {
+                    let variantAtsValue = variantInvRecord.getATS().getValue();
+                    if (variantAtsValue >= threshold) {
+                        return true;
+                    }
+                }
+            }
+        }
+    }
+
+    var invRecord = availabilityModel.getInventoryRecord();
+    var atsValue = invRecord ? invRecord.getATS().getValue() : 0;
+    return atsValue >= threshold;
+}
+
+
+
+module.exports = {
+    isInStock: isInStock,
+    isInclude: isInclude,
+};

cartridges/int_algolia/cartridge/scripts/algolia/model/algoliaLocalizedProduct.js

@@ -12,6 +12,8 @@ var productModelCustomizer = require('*/cartridge/scripts/algolia/customization/
 var ObjectHelper = require('*/cartridge/scripts/algolia/helper/objectHelper');
 var jobHelper = require('*/cartridge/scripts/algolia/helper/jobHelper');
 var logger = require('*/cartridge/scripts/algolia/helper/jobHelper').getAlgoliaLogger();
+var productFilter = require('*/cartridge/scripts/algolia/filters/productFilter');
+
 
 var extendedProductAttributesConfig;
 try {
@@ -28,6 +30,7 @@ try {
 }
 
 const ALGOLIA_IN_STOCK_THRESHOLD = algoliaData.getPreference('InStockThreshold');
+const INDEX_OUT_OF_STOCK = algoliaData.getPreference('IndexOutOfStock');
 
 /**
  * Get the lowest promotional price for product
@@ -356,14 +359,15 @@ var aggregatedValueHandlers = {
         return pricebooks;
     },
     in_stock: function (product) {
-        let availabilityModel = product.getAvailabilityModel();
+        let threshold = algoliaData.getPreference('InStockThreshold');
+        let indexOutOfStock = algoliaData.getPreference('IndexOutOfStock');
 
-        if (product.isMaster() || product.isVariationGroup()) {
-            return availabilityModel.availabilityStatus === 'IN_STOCK';
+        let inStock = productFilter.isInStock(product, threshold);
+
+        if (!inStock && !indexOutOfStock) {
+            return undefined;
         }
 
-        let inventoryRecord = availabilityModel.getInventoryRecord();
-        let inStock = (inventoryRecord ? inventoryRecord.getATS().getValue() >= ALGOLIA_IN_STOCK_THRESHOLD : false);
         return inStock;
     },
     image_groups: function (product) {
@@ -444,11 +448,21 @@ var aggregatedValueHandlers = {
         const variantsIt = product.variants.iterator();
         while (variantsIt.hasNext()) {
             var variant = variantsIt.next();
+
+            let inStock = productFilter.isInStock(variant, ALGOLIA_IN_STOCK_THRESHOLD);
+
+            if (!inStock && !INDEX_OUT_OF_STOCK) {
+                continue;
+            }
+
+            var baseModel = { in_stock: inStock };
+
             var localizedVariant = new algoliaLocalizedProduct({
                 product: variant,
                 locale: request.getLocale(),
                 attributeList: parameters.variantAttributes,
                 isVariant: true,
+                baseModel: baseModel,
             });
             variants.push(localizedVariant);
         }

cartridges/int_algolia/cartridge/scripts/algolia/steps/algoliaProductDeltaIndex.js

@@ -32,6 +32,8 @@ var fullRecordUpdate = false;
 
 const VARIANT_LEVEL = 'variant-level';
 const MASTER_LEVEL = 'master-level';
+var ALGOLIA_IN_STOCK_THRESHOLD;
+var INDEX_OUT_OF_STOCK;
 
 /*
  * Rough algorithm of chunk-oriented script module execution:
@@ -72,6 +74,9 @@ exports.beforeStep = function(parameters, stepExecution) {
     CPObjectIterator = require('*/cartridge/scripts/algolia/helper/CPObjectIterator');
     AlgoliaJobReport = require('*/cartridge/scripts/algolia/helper/AlgoliaJobReport');
 
+    ALGOLIA_IN_STOCK_THRESHOLD = algoliaData.getPreference('InStockThreshold');
+    INDEX_OUT_OF_STOCK = algoliaData.getPreference('IndexOutOfStock');
+
     try {
         extendedProductAttributesConfig = require('*/cartridge/configuration/productAttributesConfig.js');
         logger.info('Configuration file "productAttributesConfig.js" loaded')
@@ -359,25 +364,40 @@ exports.process = function(cpObj, parameters, stepExecution) {
                         let indexName = algoliaData.calculateIndexName('products', locale);
                         let records = recordsPerLocale[locale];
                         processedVariantsToSend = records.length;
+
                         records.forEach(function(record) {
-                            algoliaOperations.push(new jobHelper.AlgoliaOperation(baseIndexingOperation, record, indexName))
+                            if (INDEX_OUT_OF_STOCK || record.in_stock) {
+                                algoliaOperations.push(new jobHelper.AlgoliaOperation(baseIndexingOperation, record, indexName))
+                            } else {
+                                algoliaOperations.push(new jobHelper.AlgoliaOperation(deleteIndexingOperation, { objectID: record.objectID }, indexName));
+                            }
                         });
                     }
                 } else {
                     // Master-level indexing
-                    let baseModel = new AlgoliaLocalizedProduct({ product: product, locale: 'default', attributeList: nonLocalizedMasterAttributes });
-                    for (let l = 0; l < siteLocales.size(); ++l) {
-                        let locale = siteLocales[l];
-                        let indexName = algoliaData.calculateIndexName('products', locale);
-                        let localizedMaster = new AlgoliaLocalizedProduct({
-                            product: product,
-                            locale: locale,
-                            attributeList: masterAttributes,
-                            variantAttributes: variantAttributes,
-                            baseModel: baseModel,
-                        });
-                        processedVariantsToSend = localizedMaster.variants ? localizedMaster.variants.length : 0;
-                        algoliaOperations.push(new jobHelper.AlgoliaOperation(baseIndexingOperation, localizedMaster, indexName));
+                    let inStock = productFilter.isInStock(product, ALGOLIA_IN_STOCK_THRESHOLD);
+                    if (inStock || INDEX_OUT_OF_STOCK) {
+                        let baseModel = new AlgoliaLocalizedProduct({ product: product, locale: 'default', attributeList: nonLocalizedMasterAttributes });
+                        for (let l = 0; l < siteLocales.size(); ++l) {
+                            let locale = siteLocales[l];
+                            let indexName = algoliaData.calculateIndexName('products', locale);
+                            let localizedMaster = new AlgoliaLocalizedProduct({
+                                product: product,
+                                locale: locale,
+                                attributeList: masterAttributes,
+                                variantAttributes: variantAttributes,
+                                baseModel: baseModel,
+                            });
+                            processedVariantsToSend = localizedMaster.variants ? localizedMaster.variants.length : 0;
+                            algoliaOperations.push(new jobHelper.AlgoliaOperation(baseIndexingOperation, localizedMaster, indexName));
+                        }
+                    } else {
+                        // => product is out-of-stock and IndexOutOfStock=false => must delete from Algolia
+                        for (let l = 0; l < siteLocales.size(); l++) {
+                            let locale = siteLocales[l];
+                            let indexName = algoliaData.calculateIndexName('products', locale);
+                            algoliaOperations.push(new jobHelper.AlgoliaOperation(deleteIndexingOperation, { objectID: cpObj.productID }, indexName));
+                        }
                     }
                 }
 
@@ -388,22 +408,31 @@ exports.process = function(cpObj, parameters, stepExecution) {
         }
 
         if (productFilter.isInclude(product)) {
-
-            // Pre-fetch a partial model containing all non-localized attributes, to avoid re-fetching them for each locale
-            var baseModel = new AlgoliaLocalizedProduct({ product: product, locale: 'default', attributeList: nonLocalizedAttributes, fullRecordUpdate: fullRecordUpdate });
-            for (let l = 0; l < siteLocales.size(); l++) {
-                let locale = siteLocales[l];
-                let indexName = algoliaData.calculateIndexName('products', locale);
-                let localizedProduct = new AlgoliaLocalizedProduct({ product: product, locale: locale, attributeList: attributesToSend, baseModel: baseModel, fullRecordUpdate: fullRecordUpdate });
-                algoliaOperations.push(new jobHelper.AlgoliaOperation(baseIndexingOperation, localizedProduct, indexName));
+            let inStock = productFilter.isInStock(product, ALGOLIA_IN_STOCK_THRESHOLD);
+            if (inStock || INDEX_OUT_OF_STOCK) {
+                // Pre-fetch a partial model containing all non-localized attributes, to avoid re-fetching them for each locale
+                var baseModel = new AlgoliaLocalizedProduct({ product: product, locale: 'default', attributeList: nonLocalizedAttributes, fullRecordUpdate: fullRecordUpdate });
+                for (let l = 0; l < siteLocales.size(); l++) {
+                    let locale = siteLocales[l];
+                    let indexName = algoliaData.calculateIndexName('products', locale);
+                    let localizedProduct = new AlgoliaLocalizedProduct({ product: product, locale: locale, attributeList: attributesToSend, baseModel: baseModel, fullRecordUpdate: fullRecordUpdate });
+                    algoliaOperations.push(new jobHelper.AlgoliaOperation(baseIndexingOperation, localizedProduct, indexName));
+                }
+                jobReport.processedItemsToSend++;
+            } else {
+                // => product is out-of-stock and IndexOutOfStock=false => must delete from Algolia
+                for (let l = 0; l < siteLocales.size(); l++) {
+                    var locale = siteLocales[l];
+                    var indexName = algoliaData.calculateIndexName('products', locale);
+                    algoliaOperations.push(new jobHelper.AlgoliaOperation(deleteIndexingOperation, { objectID: cpObj.productID }, indexName));
+                }
+                jobReport.processedItemsToSend++;
             }
-            jobReport.processedItemsToSend++;
         }
     } else {
         for (let l = 0; l < siteLocales.size(); l++) {
-            var locale = siteLocales[l];
-            var indexName = algoliaData.calculateIndexName('products', locale);
-            algoliaOperations.push(new jobHelper.AlgoliaOperation(deleteIndexingOperation, { objectID: cpObj.productID }, indexName));
+            let localeIndexName = algoliaData.calculateIndexName('products', siteLocales[l]);
+            algoliaOperations.push(new jobHelper.AlgoliaOperation(deleteIndexingOperation, { objectID: cpObj.productID }, localeIndexName));
         }
         jobReport.processedItemsToSend++;
     }

cartridges/int_algolia/cartridge/scripts/algolia/steps/algoliaProductIndex.js

@@ -28,6 +28,8 @@ var extendedProductAttributesConfig;
 
 const VARIANT_LEVEL = 'variant-level';
 const MASTER_LEVEL = 'master-level';
+var ALGOLIA_IN_STOCK_THRESHOLD;
+var INDEX_OUT_OF_STOCK;
 
 /*
  * Rough algorithm of chunk-oriented script module execution:
@@ -64,6 +66,8 @@ exports.beforeStep = function(parameters, stepExecution) {
     productFilter = require('*/cartridge/scripts/algolia/filters/productFilter');
     algoliaProductConfig = require('*/cartridge/scripts/algolia/lib/algoliaProductConfig');
     AlgoliaJobReport = require('*/cartridge/scripts/algolia/helper/AlgoliaJobReport');
+    ALGOLIA_IN_STOCK_THRESHOLD = algoliaData.getPreference('InStockThreshold');
+    INDEX_OUT_OF_STOCK = algoliaData.getPreference('IndexOutOfStock');
 
     try {
         extendedProductAttributesConfig = require('*/cartridge/configuration/productAttributesConfig.js');
@@ -270,7 +274,9 @@ exports.process = function(product, parameters, stepExecution) {
                     var records = recordsPerLocale[locale];
                     processedVariantsToSend = records.length;
                     records.forEach(function(record) {
-                        algoliaOperations.push(new jobHelper.AlgoliaOperation(indexingOperation, record, indexName));
+                        if (INDEX_OUT_OF_STOCK || record.in_stock) {
+                            algoliaOperations.push(new jobHelper.AlgoliaOperation(indexingOperation, record, indexName));
+                        }
                     });
                 }
             } else {
@@ -289,8 +295,13 @@ exports.process = function(product, parameters, stepExecution) {
                         variantAttributes: variantAttributes,
                         baseModel: baseModel,
                     });
-                    processedVariantsToSend = localizedMaster.variants ? localizedMaster.variants.length : 0;
-                    algoliaOperations.push(new jobHelper.AlgoliaOperation(indexingOperation, localizedMaster, indexName));
+
+                    if (!INDEX_OUT_OF_STOCK && (localizedMaster && localizedMaster.variants && (localizedMaster.variants.length === 0))) {
+                        continue;
+                    } else {
+                        processedVariantsToSend = localizedMaster.variants ? localizedMaster.variants.length : 0;
+                        algoliaOperations.push(new jobHelper.AlgoliaOperation(indexingOperation, localizedMaster, indexName));
+                    }
                 }
             }
 
@@ -301,6 +312,11 @@ exports.process = function(product, parameters, stepExecution) {
     }
 
     if (productFilter.isInclude(product)) {
+        const inStock = productFilter.isInStock(product, ALGOLIA_IN_STOCK_THRESHOLD);
+        if (!inStock && !INDEX_OUT_OF_STOCK) {
+            return [];
+        }
+
         var algoliaOperations = [];
 
         // Pre-fetch a partial model containing all non-localized attributes, to avoid re-fetching them for each locale

cypress.config.js

@@ -10,5 +10,6 @@ module.exports = defineConfig({
             // Important: return the updated config
             return config;
         },
+        pageLoadTimeout: 15000,
     },
 });

cypress/e2e/variation.cy.js

@@ -15,6 +15,8 @@ describe('Algolia Search', () => {
 
         // Handle the cookie consent pop-up
         cy.get('.affirm').click()
+
+        cy.get('.modal-backdrop', { timeout: 4000 }).should('not.exist');
     })
 
     it('performs a search and displays results', () => {

metadata/algolia/meta/system-objecttype-extensions.xml

@@ -175,6 +175,15 @@ Setting this preference replaces the first two segments, the final index name be
                 </value-definitions>
             </attribute-definition>
 
+            <attribute-definition attribute-id="Algolia_IndexOutOfStock">
+                <display-name xml:lang="x-default">Index Out of Stock</display-name>
+                <description xml:lang="x-default">Index out of stock products</description>
+                <type>boolean</type>
+                <mandatory-flag>false</mandatory-flag>
+                <externally-managed-flag>false</externally-managed-flag>
+                <default-value>true</default-value>
+            </attribute-definition>
+
             <attribute-definition attribute-id="Algolia_LocalesForIndexing">
                 <display-name xml:lang="x-default">Locales for indexing</display-name>
                 <description xml:lang="x-default">List of locales that will be used by the indexing jobs</description>
@@ -274,6 +283,7 @@ Setting this preference replaces the first two segments, the final index name be
                 <attribute attribute-id="Algolia_EnableContentSearch"/>
                 <attribute attribute-id="Algolia_EnableRecommend"/>
                 <attribute attribute-id="Algolia_EnablePricingLazyLoad"/>
+                <attribute attribute-id="Algolia_IndexOutOfStock"/>
             </attribute-group>
         </group-definitions>