vue-instantsearch 4.8.8 → 4.8.10

package/package.json

@@ -16,7 +16,7 @@
     "autocomplete"
   ],
   "license": "MIT",
-  "version": "4.8.8",
+  "version": "4.8.10",
   "files": [
     "vue2",
     "vue3",
@@ -35,7 +35,7 @@
     "test:exports:vue3": "node ./test/module/vue3/is-es-module.mjs && node ./test/module/vue3/is-cjs-module.cjs"
   },
   "dependencies": {
-    "instantsearch.js": "4.53.0",
+    "instantsearch.js": "4.54.1",
     "mitt": "^2.1.0"
   },
   "peerDependencies": {
@@ -85,5 +85,5 @@
     "vuex": "3.5.1",
     "vuex4": "npm:vuex@4.0.0"
   },
-  "gitHead": "a00311c99cae3e6f4b9f659945d46d62347bc6d8"
+  "gitHead": "1f81b61cf0e78aeb7022d5e9eca0d49de727dc64"
 }

package/src/components/__tests__/InstantSearch.js

@@ -2,6 +2,7 @@
  * @jest-environment jsdom
  */
 
+import { createAlgoliaSearchClient } from '@instantsearch/mocks';
 import { isVue3, version as vueVersion } from '../../util/vue-compat';
 import { mount, nextTick } from '../../../test/utils';
 import instantsearch from 'instantsearch.js/es';
@@ -177,6 +178,37 @@ it('Allows a change in `search-client`', async () => {
   expect(helper.search).toHaveBeenCalledTimes(1);
 });
 
+it('warns when the `search-client` changes', async () => {
+  const wrapper = mount(InstantSearch, {
+    propsData: {
+      searchClient: createAlgoliaSearchClient({}),
+      indexName: 'indexName',
+    },
+  });
+
+  const newClient = createAlgoliaSearchClient({});
+
+  await wrapper.setProps({ searchClient: newClient });
+
+  expect(warn).toHaveBeenCalledWith(
+    false,
+    'The `search-client` prop of `<ais-instant-search>` changed between renders, which may cause more search requests than necessary. If this is an unwanted behavior, please provide a stable reference: https://www.algolia.com/doc/api-reference/widgets/instantsearch/vue/#widget-param-search-client'
+  );
+});
+
+it('does not warn when the `search-client` does not change', async () => {
+  const wrapper = mount(InstantSearch, {
+    propsData: {
+      searchClient: createAlgoliaSearchClient({}),
+      indexName: 'indexName',
+    },
+  });
+
+  await wrapper.setProps({ indexName: 'indexName2' });
+
+  expect(warn).not.toHaveBeenCalled();
+});
+
 it('Allows a change in `search-function`', async () => {
   const oldValue = () => {};
   const newValue = () => {};

package/src/util/createInstantSearchComponent.js

@@ -2,6 +2,7 @@ import { createSuitMixin } from '../mixins/suit';
 import { version } from '../../package.json'; // rollup does pick only what needed from json
 import { _objectSpread } from './polyfills';
 import { isVue3, version as vueVersion } from './vue-compat';
+import { warn } from './warn';
 
 export const createInstantSearchComponent = (component) =>
   _objectSpread(
@@ -14,6 +15,11 @@ export const createInstantSearchComponent = (component) =>
       },
       watch: {
         searchClient(searchClient) {
+          warn(
+            false,
+            'The `search-client` prop of `<ais-instant-search>` changed between renders, which may cause more search requests than necessary. If this is an unwanted behavior, please provide a stable reference: https://www.algolia.com/doc/api-reference/widgets/instantsearch/vue/#widget-param-search-client'
+          );
+
           this.instantSearchInstance.helper.setClient(searchClient).search();
         },
         indexName(indexName) {

package/src/util/createServerRootMixin.js

@@ -1,34 +1,11 @@
 import instantsearch from 'instantsearch.js/es';
+import {
+  waitForResults,
+  getInitialResults,
+} from 'instantsearch.js/es/lib/server';
 import { isVue3, isVue2, Vue2, createSSRApp } from './vue-compat';
 import { warn } from './warn';
 
-function walkIndex(indexWidget, visit) {
-  visit(indexWidget);
-
-  return indexWidget.getWidgets().forEach((widget) => {
-    if (widget.$$type !== 'ais.index') return;
-    visit(widget);
-    walkIndex(widget, visit);
-  });
-}
-
-function searchOnlyWithDerivedHelpers(helper) {
-  return new Promise((resolve, reject) => {
-    helper.searchOnlyWithDerivedHelpers();
-
-    // we assume all derived helpers resolve at least in the same tick
-    helper.derivedHelpers[0].on('result', () => {
-      resolve();
-    });
-
-    helper.derivedHelpers.forEach((derivedHelper) =>
-      derivedHelper.on('error', (e) => {
-        reject(e);
-      })
-    );
-  });
-}
-
 function defaultCloneComponent(componentInstance, { mixins = [] } = {}) {
   const options = {
     serverPrefetch: undefined,
@@ -133,24 +110,9 @@ function augmentInstantSearch(instantSearchOptions, cloneComponent) {
         });
       })
       .then(() => renderToString(app))
-      .then(() => searchOnlyWithDerivedHelpers(instance.mainHelper))
+      .then(() => waitForResults(instance))
       .then(() => {
-        initialResults = {};
-        walkIndex(instance.mainIndex, (widget) => {
-          initialResults[widget.getIndexId()] = {
-            // copy just the values of SearchParameters, not the functions
-            state: Object.entries(widget.getHelper().state).reduce(
-              (acc, [key, value]) => {
-                // eslint-disable-next-line no-param-reassign
-                acc[key] = value;
-                return acc;
-              },
-              {}
-            ),
-            results: widget.getResults()._rawResults,
-          };
-        });
-
+        initialResults = getInitialResults(instance.mainIndex);
         search.hydrate(initialResults);
         return search.getState();
       });