Add test cases for getTabHostname

Author: jonathanKingston

injected/src/utils.js

@@ -134,15 +134,9 @@ export function getTabUrl() {
         // @ts-expect-error - globalThis.top is possibly 'null' here
         framingURLString = globalThis.top.location.href;
     } catch {
-        framingURLString = globalThis.document.referrer;
-    }
-
-    if (!framingURLString) {
-        // This is suboptimal, but we need to get the top level origin in an about:blank frame
-        const topLevelOriginFromFrameAncestors = getTopLevelOriginFromFrameAncestors();
-        if (topLevelOriginFromFrameAncestors) {
-            framingURLString = topLevelOriginFromFrameAncestors;
-        }
+        // If there's no URL then let's fall back to using the frame ancestors origin which won't have path
+        // Fall back to the referrer if we can't get the top level origin
+        framingURLString = getTopLevelOriginFromFrameAncestors() ?? globalThis.document.referrer;
     }
 
     let framingURL;

injected/unit-test/helpers/polyfill-process-globals.js

@@ -1,26 +1,63 @@
-export function polyfillProcessGlobals() {
+/**
+ * Creates a mock location object for testing purposes.
+ * @returns {Location} A mock location object.
+ */
+export function createLocationObject(href, frameAncestorsList = []) {
+    return {
+        href,
+        // @ts-expect-error - ancestorOrigins is not defined in the type definition
+        ancestorOrigins: createDomStringList(frameAncestorsList)
+    };
+}
+
+export function createDomStringList(list) {
+    const domStringList = {
+        length: list.length,
+        item(index) {
+            if (index < 0 || index >= list.length) {
+                return null;
+            }
+            return list[index];
+        },
+        contains(item) {
+            return list.includes(item);
+        },
+    };
+
+    // Add index access support
+    for (let i = 0; i < list.length; i++) {
+        Object.defineProperty(domStringList, i, {
+            get() {
+                return list[i];
+            },
+            enumerable: true,
+        });
+    }
+
+    return domStringList;
+}
+
+export function polyfillProcessGlobals(defaultLocation = 'http://localhost:8080', frameAncestorsList = [], topisNull = false) {
     // Store original values to restore later
     const originalDocument = globalThis.document;
     const originalLocation = globalThis.location;
     const originalTop = globalThis.top;
 
     // Apply the patch
+    // @ts-expect-error - document is not defined in the type definition
     globalThis.document = {
-        referrer: 'http://localhost:8080',
-        location: {
-            href: 'http://localhost:8080',
-            // @ts-expect-error - ancestorOrigins is not defined in the type definition
-            ancestorOrigins: {
-                length: 0,
-            },
-        },
+        referrer: defaultLocation,
+        location: createLocationObject(defaultLocation, frameAncestorsList)
     };
 
-    globalThis.location = globalThis.document.location;
+    globalThis.location = createLocationObject(defaultLocation, frameAncestorsList);
 
     globalThis.top = Object.assign({}, originalTop, {
-        location: globalThis.location,
+        location: createLocationObject(defaultLocation, frameAncestorsList)
     });
+    if (topisNull) {
+        globalThis.top = null;
+    }
 
     // Return a cleanup function
     return function cleanup() {

injected/unit-test/utils.js

@@ -1,4 +1,4 @@
-import { matchHostname, postDebugMessage, initStringExemptionLists, processConfig, satisfiesMinVersion } from '../src/utils.js';
+import { matchHostname, postDebugMessage, initStringExemptionLists, processConfig, satisfiesMinVersion, getTabHostname } from '../src/utils.js';
 import { polyfillProcessGlobals } from './helpers/polyfill-process-globals.js';
 
 polyfillProcessGlobals();
@@ -243,4 +243,25 @@ describe('Helpers checks', () => {
             expect(counters.get('testf')).toEqual(5000);
         });
     });
+
+    describe('utils.getTabHostname', () => {
+        it('returns the hostname of the URL', () => {
+            const hostname = getTabHostname();
+            expect(hostname).toEqual('localhost');
+
+            const reset = polyfillProcessGlobals('http://example.com');
+            const hostname2 = getTabHostname();
+            expect(hostname2).toEqual('example.com');
+            reset();
+
+            const hostname3 = getTabHostname();
+            expect(hostname3).toEqual('localhost');
+
+            // Validates when we're in a frame thats sandboxed so top is null
+            const reset2 = polyfillProcessGlobals('https://bloop.com', ['http://example.com'], true);
+            const hostname5 = getTabHostname();
+            expect(hostname5).toEqual('example.com');
+            reset2();
+        });
+    });
 });