fix(searchForFacetValues): only call client.search

This signature is the easiest to detect and makes the required signature of the searchClient simpler (only `search`, `getRecommendations` and `addAlgoliaAgent` are now used). In this PR I also fix the signature of `search` in `SearchClient` type to make this usage fit reality
algolia · Dec 6, 2024 · f32ae15 · f32ae15
1 parent 1914511
commit f32ae15
Show file tree

Hide file tree

Showing 5 changed files with 140 additions and 378 deletions.
diff --git a/packages/algoliasearch-helper/src/algoliasearch.helper.js b/packages/algoliasearch-helper/src/algoliasearch.helper.js
@@ -322,21 +322,6 @@ AlgoliaSearchHelper.prototype.searchForFacetValues = function (
   maxFacetHits,
   userState
 ) {
-  var clientHasSFFV =
-    typeof this.client.searchForFacetValues === 'function' &&
-    // v5 has a wrong sffv signature
-    typeof this.client.searchForFacets !== 'function';
-  var clientHasInitIndex = typeof this.client.initIndex === 'function';
-  if (
-    !clientHasSFFV &&
-    !clientHasInitIndex &&
-    typeof this.client.search !== 'function'
-  ) {
-    throw new Error(
-      'search for facet values (searchable) was called, but this client does not have a function client.searchForFacetValues or client.initIndex(index).searchForFacetValues'
-    );
-  }
-
   var state = this.state.setQueryParameters(userState || {});
   var isDisjunctive = state.isDisjunctiveFacet(facet);
   var algoliaQuery = requestBuilder.getSearchForFacetQuery(
@@ -349,34 +334,15 @@ AlgoliaSearchHelper.prototype.searchForFacetValues = function (
   this._currentNbQueries++;
   // eslint-disable-next-line consistent-this
   var self = this;
-  var searchForFacetValuesPromise;
-  // newer algoliasearch ^3.27.1 - ~4.0.0
-  if (clientHasSFFV) {
-    searchForFacetValuesPromise = this.client.searchForFacetValues([
-      { indexName: state.index, params: algoliaQuery },
-    ]);
-    // algoliasearch < 3.27.1
-  } else if (clientHasInitIndex) {
-    searchForFacetValuesPromise = this.client
-      .initIndex(state.index)
-      .searchForFacetValues(algoliaQuery);
-    // algoliasearch ~5.0.0
-  } else {
-    // @MAJOR only use client.search
-    delete algoliaQuery.facetName;
-    searchForFacetValuesPromise = this.client
-      .search([
-        {
-          type: 'facet',
-          facet: facet,
-          indexName: state.index,
-          params: algoliaQuery,
-        },
-      ])
-      .then(function processResponse(response) {
-        return response.results[0];
-      });
-  }
+
+  var searchForFacetValuesPromise = this.client.search([
+    {
+      type: 'facet',
+      facet: facet,
+      indexName: state.index,
+      params: algoliaQuery,
+    },
+  ]);
 
   this.emit('searchForFacetValues', {
     state: state,
@@ -389,16 +355,16 @@ AlgoliaSearchHelper.prototype.searchForFacetValues = function (
       self._currentNbQueries--;
       if (self._currentNbQueries === 0) self.emit('searchQueueEmpty');
 
-      content = Array.isArray(content) ? content[0] : content;
+      var result = content.results[0];
 
-      content.facetHits.forEach(function (f) {
+      result.facetHits.forEach(function (f) {
         f.escapedValue = escapeFacetValue(f.value);
         f.isRefined = isDisjunctive
           ? state.isDisjunctiveFacetRefined(facet, f.escapedValue)
           : state.isFacetRefined(facet, f.escapedValue);
       });
 
-      return content;
+      return result;
     },
     function (e) {
       self._currentNbQueries--;

diff --git a/packages/algoliasearch-helper/src/requestBuilder.js b/packages/algoliasearch-helper/src/requestBuilder.js
@@ -434,7 +434,6 @@ var requestBuilder = {
       : state;
     var searchForFacetSearchParameters = {
       facetQuery: query,
-      facetName: facetName,
     };
     if (typeof maxFacetHits === 'number') {
       searchForFacetSearchParameters.maxFacetHits = maxFacetHits;

diff --git a/packages/algoliasearch-helper/test/spec/algoliasearch.helper/events.js b/packages/algoliasearch-helper/test/spec/algoliasearch.helper/events.js
@@ -7,9 +7,6 @@ function makeFakeClient() {
     search: jest.fn(function () {
       return new Promise(function () {});
     }),
-    searchForFacetValues: jest.fn(function () {
-      return new Promise(function () {});
-    }),
   };
 }
 
@@ -297,7 +294,7 @@ test(
     helper.on('searchForFacetValues', searchedForFacetValues);
 
     expect(searchedForFacetValues).toHaveBeenCalledTimes(0);
-    expect(fakeClient.searchForFacetValues).toHaveBeenCalledTimes(0);
+    expect(fakeClient.search).toHaveBeenCalledTimes(0);
 
     helper.searchForFacetValues('city', 'NYC');
     expect(searchedForFacetValues).toHaveBeenCalledTimes(1);
@@ -306,7 +303,7 @@ test(
       facet: 'city',
       query: 'NYC',
     });
-    expect(fakeClient.searchForFacetValues).toHaveBeenCalledTimes(1);
+    expect(fakeClient.search).toHaveBeenCalledTimes(1);
   }
 );