feat(recommend): handle multiple objectIDs for one widget (#6160)

* feat(recommend): handle multiple objectIDs for one widget

* move flat to its own file with comment to remove it

Author: aymeric-giraudet

bundlesize.config.json

@@ -2,11 +2,11 @@
   "files": [
     {
       "path": "packages/algoliasearch-helper/dist/algoliasearch.helper.js",
-      "maxSize": "40.5 kB"
+      "maxSize": "41 kB"
     },
     {
       "path": "packages/algoliasearch-helper/dist/algoliasearch.helper.min.js",
-      "maxSize": "13 kB"
+      "maxSize": "13.25 kB"
     },
     {
       "path": "./packages/instantsearch.js/dist/instantsearch.production.min.js",
@@ -30,7 +30,7 @@
     },
     {
       "path": "packages/vue-instantsearch/vue3/umd/index.js",
-      "maxSize": "67 kB"
+      "maxSize": "67.25 kB"
     },
     {
       "path": "packages/vue-instantsearch/vue2/cjs/index.js",

packages/algoliasearch-helper/src/RecommendParameters/index.js

@@ -23,15 +23,8 @@ RecommendParameters.prototype = {
 
   addParams: function (params) {
     var newParams = this.params.slice();
-    var existingParamsIndex = this.params.findIndex(function (currentParams) {
-      return currentParams.$$id === params.$$id;
-    });
 
-    if (existingParamsIndex !== -1) {
-      newParams.splice(existingParamsIndex, 1, params);
-    } else {
-      newParams.push(params);
-    }
+    newParams.push(params);
 
     return new RecommendParameters({ params: newParams });
   },

packages/algoliasearch-helper/src/algoliasearch.helper.js

@@ -13,6 +13,7 @@ var RecommendResults = require('./RecommendResults');
 var requestBuilder = require('./requestBuilder');
 var SearchParameters = require('./SearchParameters');
 var SearchResults = require('./SearchResults');
+var sortAndMergeRecommendations = require('./utils/sortAndMergeRecommendations');
 var version = require('./version');
 
 /**
@@ -1740,10 +1741,25 @@ AlgoliaSearchHelper.prototype._dispatchRecommendResponse = function (
 
   if (this._currentNbRecommendQueries === 0) this.emit('recommendQueueEmpty');
 
+  var idsMap = {};
+  ids.forEach(function (id, index) {
+    if (!idsMap[id]) idsMap[id] = [];
+
+    idsMap[id].push(index);
+  });
+
   var results = {};
-  content.results.forEach(function (result, index) {
-    var id = ids[index];
-    results[id] = result;
+  Object.keys(idsMap).forEach(function (id) {
+    var indices = idsMap[id];
+    if (indices.length === 1) {
+      results[id] = content.results[indices[0]];
+      return;
+    }
+    results[id] = sortAndMergeRecommendations(
+      indices.map(function (idx) {
+        return content.results[idx].hits;
+      })
+    );
   });
 
   states.forEach(function (s) {

packages/algoliasearch-helper/src/functions/flat.js

@@ -0,0 +1,6 @@
+// @MAJOR: remove this function and use Array.prototype.flat
+module.exports = function flat(arr) {
+  return arr.reduce(function (acc, val) {
+    return acc.concat(val);
+  }, []);
+};

packages/algoliasearch-helper/src/utils/sortAndMergeRecommendations.js

@@ -0,0 +1,56 @@
+'use strict';
+
+var find = require('../functions/find');
+var flat = require('../functions/flat');
+
+function getAverageIndices(indexTracker, nrOfObjs) {
+  var avgIndices = [];
+
+  Object.keys(indexTracker).forEach(function (key) {
+    if (indexTracker[key].count < 2) {
+      indexTracker[key].indexSum += 100;
+    }
+    avgIndices.push({
+      objectID: key,
+      avgOfIndices: indexTracker[key].indexSum / nrOfObjs,
+    });
+  });
+
+  return avgIndices.sort(function (a, b) {
+    return a.avgOfIndices > b.avgOfIndices ? 1 : -1;
+  });
+}
+
+function sortAndMergeRecommendations(results) {
+  var indexTracker = {};
+
+  results.forEach(function (hits) {
+    hits.forEach(function (hit, index) {
+      if (!indexTracker[hit.objectID]) {
+        indexTracker[hit.objectID] = { indexSum: index, count: 1 };
+      } else {
+        indexTracker[hit.objectID] = {
+          indexSum: indexTracker[hit.objectID].indexSum + index,
+          count: indexTracker[hit.objectID].count + 1,
+        };
+      }
+    });
+  });
+
+  var sortedAverageIndices = getAverageIndices(indexTracker, results.length);
+
+  var finalOrder = sortedAverageIndices.reduce(function (
+    orderedHits,
+    avgIndexRef
+  ) {
+    var result = find(flat(results), function (hit) {
+      return hit.objectID === avgIndexRef.objectID;
+    });
+    return result ? orderedHits.concat(result) : orderedHits;
+  },
+  []);
+
+  return finalOrder;
+}
+
+module.exports = sortAndMergeRecommendations;

packages/algoliasearch-helper/test/datasets/RecommendParameters/recommend.dataset.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var RecommendParameters = require('../../../src/SearchParameters');
+var RecommendParameters = require('../../../src/RecommendParameters');
 
 module.exports = getData;
 
@@ -9,7 +9,7 @@ function getData() {
     results: [
       {
         exhaustiveNbHits: true,
-        ExhaustiveFacetsCount: false,
+        exhaustiveFacetsCount: false,
         hits: [
           {
             _highlightResult: {
@@ -99,9 +99,47 @@ function getData() {
         page: 0,
         processingTimeMS: 11,
       },
+      {
+        exhaustiveNbHits: true,
+        exhaustiveFacetsCount: false,
+        hits: [
+          {
+            _highlightResult: {
+              brand: {
+                matchLevel: 'none',
+                matchedWords: [],
+                value: 'Gabs',
+              },
+              name: {
+                matchLevel: 'none',
+                matchedWords: [],
+                value: 'Bag “Sabrina“ medium Gabs',
+              },
+            },
+            _score: 40.91,
+            brand: 'Gabs',
+            list_categories: ['Women', 'Bags', 'Shoulder bags'],
+            name: 'Bag “Sabrina“ medium Gabs',
+            objectID: 'A0E200000001WFI',
+            parentID: 'SABRINA',
+            price: {
+              currency: 'EUR',
+              discount_level: -100,
+              discounted_value: 0,
+              on_sales: false,
+              value: 210,
+            },
+          },
+        ],
+        hitsPerPage: 3,
+        nbHits: 3,
+        nbPages: 1,
+        page: 0,
+        processingTimeMS: 11,
+      },
       {
         exhaustiveNbHits: false,
-        ExhaustiveFacetsCount: false,
+        exhaustiveFacetsCount: false,
         hits: [
           {
             _score: 40.89,
@@ -156,6 +194,11 @@ function getData() {
         objectID: 'A0E20000000279B',
         model: 'bought-together',
       },
+      {
+        $$id: 1,
+        objectID: 'A0E20000000279C',
+        model: 'bought-together',
+      },
       {
         $$id: 2,
         facetName: 'brand',

packages/algoliasearch-helper/test/spec/RecommendParameters/methods.js

@@ -18,7 +18,7 @@ describe('addParams', () => {
     expect(recommendParameters.params).toEqual([params1, params2]);
   });
 
-  test('replaces params for the same $$id', () => {
+  test('can have params with the same $$id', () => {
     var recommendParameters = new RecommendParameters({
       params: [params1, params2],
     });
@@ -33,8 +33,12 @@ describe('addParams', () => {
     };
 
     recommendParameters = recommendParameters.addParams(params1Updated);
-    expect(recommendParameters.params).toHaveLength(2);
-    expect(recommendParameters.params).toEqual([params1Updated, params2]);
+    expect(recommendParameters.params).toHaveLength(3);
+    expect(recommendParameters.params).toEqual([
+      params1,
+      params2,
+      params1Updated,
+    ]);
   });
 });
 

packages/algoliasearch-helper/test/spec/recommend.js

@@ -19,6 +19,10 @@ describe('recommend()', () => {
       $$id: 1,
       objectID: 'A0E20000000279B',
     });
+    helper.addFrequentlyBoughtTogether({
+      $$id: 1,
+      objectID: 'A0E20000000279C',
+    });
     helper.addTrendingFacets({ $$id: 2, facetName: 'brand' });
 
     // eslint-disable-next-line no-warning-comments
@@ -28,8 +32,10 @@ describe('recommend()', () => {
       // As it also includes '_state' and '_rawResults'
       expect(Object.keys(results)).toHaveLength(4);
 
-      expect(results[1]).toBe(testData.response.results[0]);
-      expect(results[2]).toBe(testData.response.results[1]);
+      // This one should be sorted
+      var hits = testData.response.results[0].hits;
+      expect(results[1]).toEqual([hits[1], hits[0], hits[2]]);
+      expect(results[2]).toBe(testData.response.results[2]);
 
       var state = event.recommend.state;
       expect(state.params).toEqual(testData.recommendParams.params);
@@ -45,6 +51,11 @@ describe('recommend()', () => {
         model: 'bought-together',
         objectID: 'A0E20000000279B',
       },
+      {
+        indexName: 'indexName',
+        model: 'bought-together',
+        objectID: 'A0E20000000279C',
+      },
       { indexName: 'indexName', model: 'trending-facets', facetName: 'brand' },
     ]);
   });