instantsearch.js 4.40.4 → 4.40.5

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [4.40.5](https://github.com/algolia/instantsearch.js/compare/v4.40.4...v4.40.5) (2022-04-26)
+
+
+### Bug Fixes
+
+* **routing:** prevent writing the same URL twice ([#5045](https://github.com/algolia/instantsearch.js/issues/5045)) ([5d79d92](https://github.com/algolia/instantsearch.js/commit/5d79d92b30e188e5206dcb5fe86fcac058c3f09b))
+
+
+
 ## [4.40.4](https://github.com/algolia/instantsearch.js/compare/v4.40.3...v4.40.4) (2022-04-13)
 
 

package/cjs/lib/routers/history.js

@@ -56,7 +56,7 @@ var BrowserHistory = /*#__PURE__*/function () {
 
     _defineProperty(this, "writeTimer", void 0);
 
-    _defineProperty(this, "shouldPushState", true);
+    _defineProperty(this, "inPopState", false);
 
     _defineProperty(this, "isDisposed", false);
 
@@ -111,20 +111,14 @@ var BrowserHistory = /*#__PURE__*/function () {
         }
 
         _this2.writeTimer = setTimeout(function () {
-          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)
+          setWindowTitle(title);
 
-          var lastPushWasByISAfterDispose = !_this2.isDisposed || _this2.latestAcknowledgedHistory === window.history.length;
-
-          if (_this2.shouldPushState && lastPushWasByISAfterDispose) {
+          if (_this2.shouldWrite(url)) {
             window.history.pushState(routeState, title || '', url);
             _this2.latestAcknowledgedHistory = window.history.length;
           }
 
-          _this2.shouldPushState = true;
+          _this2.inPopState = false;
           _this2.writeTimer = undefined;
         }, _this2.writeDelay);
       });
@@ -145,7 +139,7 @@ var BrowserHistory = /*#__PURE__*/function () {
           _this3.writeTimer = undefined;
         }
 
-        _this3.shouldPushState = false;
+        _this3.inPopState = true;
         var routeState = event.state; // At initial load, the state is read from the URL without update.
         // Therefore the state object is not available.
         // In this case, we fallback and read the URL.
@@ -203,18 +197,39 @@ var BrowserHistory = /*#__PURE__*/function () {
 
       this.write({});
     }
+  }, {
+    key: "shouldWrite",
+    value: function shouldWrite(url) {
+      var _this5 = this;
+
+      return (0, _index.safelyRunOnBrowser)(function (_ref6) {
+        var window = _ref6.window;
+        // 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 = !(_this5.isDisposed && _this5.latestAcknowledgedHistory !== window.history.length);
+        return (// When the last state change was through popstate, the IS.js state changes,
+          // but that should not write the URL.
+          !_this5.inPopState && // When the previous pushState after dispose was by IS.js, we want to write the URL.
+          lastPushWasByISAfterDispose && // When the URL is the same as the current one, we do not want to write it.
+          url !== window.location.href
+        );
+      });
+    }
   }]);
 
   return BrowserHistory;
 }();
 
 function historyRouter() {
-  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 _ref7 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+      _ref7$createURL = _ref7.createURL,
+      createURL = _ref7$createURL === void 0 ? function (_ref8) {
+    var qsModule = _ref8.qsModule,
+        routeState = _ref8.routeState,
+        location = _ref8.location;
     var protocol = location.protocol,
         hostname = location.hostname,
         _location$port = location.port,
@@ -230,11 +245,11 @@ function historyRouter() {
     }
 
     return "".concat(protocol, "//").concat(hostname).concat(portWithPrefix).concat(pathname, "?").concat(queryString).concat(hash);
-  } : _ref6$createURL,
-      _ref6$parseURL = _ref6.parseURL,
-      parseURL = _ref6$parseURL === void 0 ? function (_ref8) {
-    var qsModule = _ref8.qsModule,
-        location = _ref8.location;
+  } : _ref7$createURL,
+      _ref7$parseURL = _ref7.parseURL,
+      parseURL = _ref7$parseURL === void 0 ? function (_ref9) {
+    var qsModule = _ref9.qsModule,
+        location = _ref9.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
@@ -248,21 +263,21 @@ function historyRouter() {
     return qsModule.parse(location.search.slice(1), {
       arrayLimit: 99
     });
-  } : _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;
+  } : _ref7$parseURL,
+      _ref7$writeDelay = _ref7.writeDelay,
+      writeDelay = _ref7$writeDelay === void 0 ? 400 : _ref7$writeDelay,
+      windowTitle = _ref7.windowTitle,
+      _ref7$getLocation = _ref7.getLocation,
+      getLocation = _ref7$getLocation === void 0 ? function () {
+    return (0, _index.safelyRunOnBrowser)(function (_ref10) {
+      var window = _ref10.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.');
       }
     });
-  } : _ref6$getLocation;
+  } : _ref7$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.40.4';
+var _default = '4.40.5';
 exports.default = _default;

package/dist/instantsearch.development.d.ts

@@ -463,10 +463,9 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
     private writeTimer?;
     private _onPopState;
     /**
-     * Indicates if history.pushState should be executed.
-     * It needs to avoid pushing state to history in case of back/forward in browser
+     * Indicates if last action was back/forward in the browser.
      */
-    private shouldPushState;
+    private inPopState;
     /**
      * Indicates whether the history router is disposed or not.
      */
@@ -508,6 +507,7 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * Removes the event listener and cleans up the URL.
      */
     dispose(): void;
+    private shouldWrite;
 }
 
 declare type BrowserHistoryArgs<TRouteState> = {

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.40.4 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.40.5 | © 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) :
@@ -8536,7 +8536,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.40.4';
+  var version$1 = '4.40.5';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -9651,7 +9651,7 @@
 
       _defineProperty(this, "writeTimer", void 0);
 
-      _defineProperty(this, "shouldPushState", true);
+      _defineProperty(this, "inPopState", false);
 
       _defineProperty(this, "isDisposed", false);
 
@@ -9706,20 +9706,14 @@
           }
 
           _this2.writeTimer = setTimeout(function () {
-            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)
+            setWindowTitle(title);
 
-            var lastPushWasByISAfterDispose = !_this2.isDisposed || _this2.latestAcknowledgedHistory === window.history.length;
-
-            if (_this2.shouldPushState && lastPushWasByISAfterDispose) {
+            if (_this2.shouldWrite(url)) {
               window.history.pushState(routeState, title || '', url);
               _this2.latestAcknowledgedHistory = window.history.length;
             }
 
-            _this2.shouldPushState = true;
+            _this2.inPopState = false;
             _this2.writeTimer = undefined;
           }, _this2.writeDelay);
         });
@@ -9740,7 +9734,7 @@
             _this3.writeTimer = undefined;
           }
 
-          _this3.shouldPushState = false;
+          _this3.inPopState = true;
           var routeState = event.state; // At initial load, the state is read from the URL without update.
           // Therefore the state object is not available.
           // In this case, we fallback and read the URL.
@@ -9798,18 +9792,39 @@
 
         this.write({});
       }
+    }, {
+      key: "shouldWrite",
+      value: function shouldWrite(url) {
+        var _this5 = this;
+
+        return safelyRunOnBrowser(function (_ref6) {
+          var window = _ref6.window;
+          // 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 = !(_this5.isDisposed && _this5.latestAcknowledgedHistory !== window.history.length);
+          return (// When the last state change was through popstate, the IS.js state changes,
+            // but that should not write the URL.
+            !_this5.inPopState && // When the previous pushState after dispose was by IS.js, we want to write the URL.
+            lastPushWasByISAfterDispose && // When the URL is the same as the current one, we do not want to write it.
+            url !== window.location.href
+          );
+        });
+      }
     }]);
 
     return BrowserHistory;
   }();
 
   function historyRouter() {
-    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 _ref7 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+        _ref7$createURL = _ref7.createURL,
+        createURL = _ref7$createURL === void 0 ? function (_ref8) {
+      var qsModule = _ref8.qsModule,
+          routeState = _ref8.routeState,
+          location = _ref8.location;
       var protocol = location.protocol,
           hostname = location.hostname,
           _location$port = location.port,
@@ -9825,11 +9840,11 @@
       }
 
       return "".concat(protocol, "//").concat(hostname).concat(portWithPrefix).concat(pathname, "?").concat(queryString).concat(hash);
-    } : _ref6$createURL,
-        _ref6$parseURL = _ref6.parseURL,
-        parseURL = _ref6$parseURL === void 0 ? function (_ref8) {
-      var qsModule = _ref8.qsModule,
-          location = _ref8.location;
+    } : _ref7$createURL,
+        _ref7$parseURL = _ref7.parseURL,
+        parseURL = _ref7$parseURL === void 0 ? function (_ref9) {
+      var qsModule = _ref9.qsModule,
+          location = _ref9.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
@@ -9843,21 +9858,21 @@
       return qsModule.parse(location.search.slice(1), {
         arrayLimit: 99
       });
-    } : _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;
+    } : _ref7$parseURL,
+        _ref7$writeDelay = _ref7.writeDelay,
+        writeDelay = _ref7$writeDelay === void 0 ? 400 : _ref7$writeDelay,
+        windowTitle = _ref7.windowTitle,
+        _ref7$getLocation = _ref7.getLocation,
+        getLocation = _ref7$getLocation === void 0 ? function () {
+      return safelyRunOnBrowser(function (_ref10) {
+        var window = _ref10.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.');
         }
       });
-    } : _ref6$getLocation;
+    } : _ref7$getLocation;
 
     return new BrowserHistory({
       createURL: createURL,