instantsearch.js 4.38.0 → 4.38.1

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [4.38.1](https://github.com/algolia/instantsearch.js/compare/v4.38.0...v4.38.1) (2022-02-08)
+
+
+### Bug Fixes
+
+* **routing:** fix history router based on history length ([#5004](https://github.com/algolia/instantsearch.js/issues/5004)) ([40541af](https://github.com/algolia/instantsearch.js/commit/40541af5c8face0e32a1ec3a4665a8387d89c626))
+* **metadata:** ensure safe user agent detection ([#5009](https://github.com/algolia/instantsearch.js/pull/5009) [15a6a9d](https://github.com/algolia/instantsearch.js/commit/15a6a9d10ee512fab6884696bc59bedea13bd1b3))
+
+
 # [4.38.0](https://github.com/algolia/instantsearch.js/compare/v4.37.3...v4.38.0) (2022-01-28)
 
 

package/cjs/lib/routers/history.js

@@ -58,16 +58,23 @@ var BrowserHistory = /*#__PURE__*/function () {
 
     _defineProperty(this, "shouldPushState", true);
 
+    _defineProperty(this, "isDisposed", false);
+
+    _defineProperty(this, "latestAcknowledgedHistory", 0);
+
     this.windowTitle = windowTitle;
     this.writeTimer = undefined;
     this.writeDelay = writeDelay;
     this._createURL = createURL;
     this.parseURL = parseURL;
     this.getLocation = getLocation;
-    (0, _index.safelyRunOnBrowser)(function () {
+    (0, _index.safelyRunOnBrowser)(function (_ref2) {
+      var window = _ref2.window;
+
       var title = _this.windowTitle && _this.windowTitle(_this.read());
 
       setWindowTitle(title);
+      _this.latestAcknowledgedHistory = window.history.length;
     });
   }
   /**
@@ -92,8 +99,8 @@ var BrowserHistory = /*#__PURE__*/function () {
     value: function write(routeState) {
       var _this2 = this;
 
-      (0, _index.safelyRunOnBrowser)(function (_ref2) {
-        var window = _ref2.window;
+      (0, _index.safelyRunOnBrowser)(function (_ref3) {
+        var window = _ref3.window;
 
         var url = _this2.createURL(routeState);
 
@@ -104,10 +111,17 @@ var BrowserHistory = /*#__PURE__*/function () {
         }
 
         _this2.writeTimer = setTimeout(function () {
-          setWindowTitle(title);
+          setWindowTitle(title); // We do want to `pushState` if:
+          // - the router is not disposed, IS.js needs to update the URL
+          // OR
+          // - the last write was from InstantSearch.js
+          // (unlike a SPA, where it would have last written)
+
+          var lastPushWasByISAfterDispose = !_this2.isDisposed || _this2.latestAcknowledgedHistory === window.history.length;
 
-          if (_this2.shouldPushState) {
+          if (_this2.shouldPushState && lastPushWasByISAfterDispose) {
             window.history.pushState(routeState, title || '', url);
+            _this2.latestAcknowledgedHistory = window.history.length;
           }
 
           _this2.shouldPushState = true;
@@ -143,8 +157,8 @@ var BrowserHistory = /*#__PURE__*/function () {
         }
       };
 
-      (0, _index.safelyRunOnBrowser)(function (_ref3) {
-        var window = _ref3.window;
+      (0, _index.safelyRunOnBrowser)(function (_ref4) {
+        var window = _ref4.window;
         window.addEventListener('popstate', _this3._onPopState);
       });
     }
@@ -174,8 +188,9 @@ var BrowserHistory = /*#__PURE__*/function () {
     value: function dispose() {
       var _this4 = this;
 
-      (0, _index.safelyRunOnBrowser)(function (_ref4) {
-        var window = _ref4.window;
+      this.isDisposed = true;
+      (0, _index.safelyRunOnBrowser)(function (_ref5) {
+        var window = _ref5.window;
 
         if (_this4._onPopState) {
           window.removeEventListener('popstate', _this4._onPopState);
@@ -194,12 +209,12 @@ var BrowserHistory = /*#__PURE__*/function () {
 }();
 
 function historyRouter() {
-  var _ref5 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-      _ref5$createURL = _ref5.createURL,
-      createURL = _ref5$createURL === void 0 ? function (_ref6) {
-    var qsModule = _ref6.qsModule,
-        routeState = _ref6.routeState,
-        location = _ref6.location;
+  var _ref6 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+      _ref6$createURL = _ref6.createURL,
+      createURL = _ref6$createURL === void 0 ? function (_ref7) {
+    var qsModule = _ref7.qsModule,
+        routeState = _ref7.routeState,
+        location = _ref7.location;
     var protocol = location.protocol,
         hostname = location.hostname,
         _location$port = location.port,
@@ -215,11 +230,11 @@ function historyRouter() {
     }
 
     return "".concat(protocol, "//").concat(hostname).concat(portWithPrefix).concat(pathname, "?").concat(queryString).concat(hash);
-  } : _ref5$createURL,
-      _ref5$parseURL = _ref5.parseURL,
-      parseURL = _ref5$parseURL === void 0 ? function (_ref7) {
-    var qsModule = _ref7.qsModule,
-        location = _ref7.location;
+  } : _ref6$createURL,
+      _ref6$parseURL = _ref6.parseURL,
+      parseURL = _ref6$parseURL === void 0 ? function (_ref8) {
+    var qsModule = _ref8.qsModule,
+        location = _ref8.location;
     // `qs` by default converts arrays with more than 20 items to an object.
     // We want to avoid this because the data structure manipulated can therefore vary.
     // Setting the limit to `100` seems a good number because the engine's default is 100
@@ -233,21 +248,21 @@ function historyRouter() {
     return qsModule.parse(location.search.slice(1), {
       arrayLimit: 99
     });
-  } : _ref5$parseURL,
-      _ref5$writeDelay = _ref5.writeDelay,
-      writeDelay = _ref5$writeDelay === void 0 ? 400 : _ref5$writeDelay,
-      windowTitle = _ref5.windowTitle,
-      _ref5$getLocation = _ref5.getLocation,
-      getLocation = _ref5$getLocation === void 0 ? function () {
-    return (0, _index.safelyRunOnBrowser)(function (_ref8) {
-      var window = _ref8.window;
+  } : _ref6$parseURL,
+      _ref6$writeDelay = _ref6.writeDelay,
+      writeDelay = _ref6$writeDelay === void 0 ? 400 : _ref6$writeDelay,
+      windowTitle = _ref6.windowTitle,
+      _ref6$getLocation = _ref6.getLocation,
+      getLocation = _ref6$getLocation === void 0 ? function () {
+    return (0, _index.safelyRunOnBrowser)(function (_ref9) {
+      var window = _ref9.window;
       return window.location;
     }, {
       fallback: function fallback() {
         throw new Error('You need to provide `getLocation` to the `history` router in environments where `window` does not exist.');
       }
     });
-  } : _ref5$getLocation;
+  } : _ref6$getLocation;
 
   return new BrowserHistory({
     createURL: createURL,

package/cjs/lib/version.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = '4.38.0';
+var _default = '4.38.1';
 exports.default = _default;

package/cjs/middlewares/createMetadataMiddleware.js

@@ -54,8 +54,10 @@ function extractPayload(widgets, instantSearchInstance, payload) {
 
 function isMetadataEnabled() {
   return (0, _index.safelyRunOnBrowser)(function (_ref) {
+    var _window$navigator, _window$navigator$use;
+
     var window = _ref.window;
-    return window.navigator.userAgent.indexOf('Algolia Crawler') > -1;
+    return ((_window$navigator = window.navigator) === null || _window$navigator === void 0 ? void 0 : (_window$navigator$use = _window$navigator.userAgent) === null || _window$navigator$use === void 0 ? void 0 : _window$navigator$use.indexOf('Algolia Crawler')) > -1;
   }, {
     fallback: function fallback() {
       return false;

package/dist/instantsearch.development.d.ts

@@ -466,6 +466,17 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * It needs to avoid pushing state to history in case of back/forward in browser
      */
     private shouldPushState;
+    /**
+     * Indicates whether the history router is disposed or not.
+     */
+    private isDisposed;
+    /**
+     * Indicates the window.history.length before the last call to
+     * window.history.pushState (called in `write`).
+     * It allows to determine if a `pushState` has been triggered elsewhere,
+     * and thus to prevent the `write` method from calling `pushState`.
+     */
+    private latestAcknowledgedHistory;
     /**
      * Initializes a new storage provider that syncs the search state to the URL
      * using web APIs (`window.location.pushState` and `onpopstate` event).

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.38.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.38.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -8483,7 +8483,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.38.0';
+  var version$1 = '4.38.1';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -9600,16 +9600,23 @@
 
       _defineProperty(this, "shouldPushState", true);
 
+      _defineProperty(this, "isDisposed", false);
+
+      _defineProperty(this, "latestAcknowledgedHistory", 0);
+
       this.windowTitle = windowTitle;
       this.writeTimer = undefined;
       this.writeDelay = writeDelay;
       this._createURL = createURL;
       this.parseURL = parseURL;
       this.getLocation = getLocation;
-      safelyRunOnBrowser(function () {
+      safelyRunOnBrowser(function (_ref2) {
+        var window = _ref2.window;
+
         var title = _this.windowTitle && _this.windowTitle(_this.read());
 
         setWindowTitle(title);
+        _this.latestAcknowledgedHistory = window.history.length;
       });
     }
     /**
@@ -9634,8 +9641,8 @@
       value: function write(routeState) {
         var _this2 = this;
 
-        safelyRunOnBrowser(function (_ref2) {
-          var window = _ref2.window;
+        safelyRunOnBrowser(function (_ref3) {
+          var window = _ref3.window;
 
           var url = _this2.createURL(routeState);
 
@@ -9646,10 +9653,17 @@
           }
 
           _this2.writeTimer = setTimeout(function () {
-            setWindowTitle(title);
+            setWindowTitle(title); // We do want to `pushState` if:
+            // - the router is not disposed, IS.js needs to update the URL
+            // OR
+            // - the last write was from InstantSearch.js
+            // (unlike a SPA, where it would have last written)
 
-            if (_this2.shouldPushState) {
+            var lastPushWasByISAfterDispose = !_this2.isDisposed || _this2.latestAcknowledgedHistory === window.history.length;
+
+            if (_this2.shouldPushState && lastPushWasByISAfterDispose) {
               window.history.pushState(routeState, title || '', url);
+              _this2.latestAcknowledgedHistory = window.history.length;
             }
 
             _this2.shouldPushState = true;
@@ -9685,8 +9699,8 @@
           }
         };
 
-        safelyRunOnBrowser(function (_ref3) {
-          var window = _ref3.window;
+        safelyRunOnBrowser(function (_ref4) {
+          var window = _ref4.window;
           window.addEventListener('popstate', _this3._onPopState);
         });
       }
@@ -9716,8 +9730,9 @@
       value: function dispose() {
         var _this4 = this;
 
-        safelyRunOnBrowser(function (_ref4) {
-          var window = _ref4.window;
+        this.isDisposed = true;
+        safelyRunOnBrowser(function (_ref5) {
+          var window = _ref5.window;
 
           if (_this4._onPopState) {
             window.removeEventListener('popstate', _this4._onPopState);
@@ -9736,12 +9751,12 @@
   }();
 
   function historyRouter() {
-    var _ref5 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-        _ref5$createURL = _ref5.createURL,
-        createURL = _ref5$createURL === void 0 ? function (_ref6) {
-      var qsModule = _ref6.qsModule,
-          routeState = _ref6.routeState,
-          location = _ref6.location;
+    var _ref6 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+        _ref6$createURL = _ref6.createURL,
+        createURL = _ref6$createURL === void 0 ? function (_ref7) {
+      var qsModule = _ref7.qsModule,
+          routeState = _ref7.routeState,
+          location = _ref7.location;
       var protocol = location.protocol,
           hostname = location.hostname,
           _location$port = location.port,
@@ -9757,11 +9772,11 @@
       }
 
       return "".concat(protocol, "//").concat(hostname).concat(portWithPrefix).concat(pathname, "?").concat(queryString).concat(hash);
-    } : _ref5$createURL,
-        _ref5$parseURL = _ref5.parseURL,
-        parseURL = _ref5$parseURL === void 0 ? function (_ref7) {
-      var qsModule = _ref7.qsModule,
-          location = _ref7.location;
+    } : _ref6$createURL,
+        _ref6$parseURL = _ref6.parseURL,
+        parseURL = _ref6$parseURL === void 0 ? function (_ref8) {
+      var qsModule = _ref8.qsModule,
+          location = _ref8.location;
       // `qs` by default converts arrays with more than 20 items to an object.
       // We want to avoid this because the data structure manipulated can therefore vary.
       // Setting the limit to `100` seems a good number because the engine's default is 100
@@ -9775,21 +9790,21 @@
       return qsModule.parse(location.search.slice(1), {
         arrayLimit: 99
       });
-    } : _ref5$parseURL,
-        _ref5$writeDelay = _ref5.writeDelay,
-        writeDelay = _ref5$writeDelay === void 0 ? 400 : _ref5$writeDelay,
-        windowTitle = _ref5.windowTitle,
-        _ref5$getLocation = _ref5.getLocation,
-        getLocation = _ref5$getLocation === void 0 ? function () {
-      return safelyRunOnBrowser(function (_ref8) {
-        var window = _ref8.window;
+    } : _ref6$parseURL,
+        _ref6$writeDelay = _ref6.writeDelay,
+        writeDelay = _ref6$writeDelay === void 0 ? 400 : _ref6$writeDelay,
+        windowTitle = _ref6.windowTitle,
+        _ref6$getLocation = _ref6.getLocation,
+        getLocation = _ref6$getLocation === void 0 ? function () {
+      return safelyRunOnBrowser(function (_ref9) {
+        var window = _ref9.window;
         return window.location;
       }, {
         fallback: function fallback() {
           throw new Error('You need to provide `getLocation` to the `history` router in environments where `window` does not exist.');
         }
       });
-    } : _ref5$getLocation;
+    } : _ref6$getLocation;
 
     return new BrowserHistory({
       createURL: createURL,
@@ -9891,8 +9906,10 @@
 
   function isMetadataEnabled() {
     return safelyRunOnBrowser(function (_ref) {
+      var _window$navigator, _window$navigator$use;
+
       var window = _ref.window;
-      return window.navigator.userAgent.indexOf('Algolia Crawler') > -1;
+      return ((_window$navigator = window.navigator) === null || _window$navigator === void 0 ? void 0 : (_window$navigator$use = _window$navigator.userAgent) === null || _window$navigator$use === void 0 ? void 0 : _window$navigator$use.indexOf('Algolia Crawler')) > -1;
     }, {
       fallback: function fallback() {
         return false;