Location Assignment Check (#77)

* location assignment check: when assigning to location, check if same object is in the arguments array and skip to avoid some false positive location assignments, partial fix for webrecorder/pywb#684

* test: add overrides test to ensure local assign via __WB_check_loc() does not trigger redirect

* bump to 3.3.5

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webrecorder/wombat",
-  "version": "3.3.4",
+  "version": "3.3.5",
   "main": "index.js",
   "license": "AGPL-3.0-or-later",
   "author": "Ilya Kreymer, Webrecorder Software",

src/wombat.js

@@ -5123,8 +5123,18 @@ Wombat.prototype.initProtoPmOrigin = function(win) {
     });
   } catch (e) {}
 
-  win.__WB_check_loc = function(loc) {
+  win.__WB_check_loc = function(loc, args) {
     if (loc instanceof Location || loc instanceof WombatLocation) {
+      // args, if provided, should be the 'arguments' from calling function
+      // check if the location is actually a locally passed in argument,
+      // if so, don't assign to global location
+      if (args) {
+        for (var i = 0; i < args.length; i++) {
+          if (loc === args[i]) {
+            return {};
+          }
+        }
+      }
       return this.WB_wombat_location;
     } else {
       return {};

test/overrides-browser.js

@@ -139,6 +139,25 @@ test('WombatLocation: should have a Symbol.toStringTag value of "Location"', asy
   );
 });
 
+test('WombatLocation should not navigate when assigning to local object', async t => {
+  const { sandbox, server } = t.context;
+  const result = await sandbox.evaluate(() => {
+    let location = window.WB_wombat_location;
+
+    function navTest(location) {
+      location = ((self.__WB_check_loc && self.__WB_check_loc(location, arguments)) || {}).href = location.protocol + '//' + location.hostname + '/it';
+      return location;
+    }
+
+    return navTest(location);
+  });
+  t.is(
+    result,
+    'https://tests.wombat.io/it',
+    'the page navigated away and did not return a URL'
+  );
+});
+
 test('WombatLocation browser navigation control: should rewrite Location.replace usage', async t => {
   const { sandbox, server } = t.context;
   const [navigationResponse] = await Promise.all([