added ability to query the connected scripts tabs and fixed tests

Author: andreadev-it

src/BackgroundHandler.js

@@ -4,10 +4,6 @@ import { BgHandlerErrors as ERRORS, Error } from './Errors.js';
 
 /** 
  * Class that will handle all the content scripts that will connect to the background script.
- * 
- * @property {Map<string, Connection>} scriptConnections A Map that will relate every script ID to its Connection object.
- * @property {object} exposedData The properties and methods exposed to the connecting scripts.
- * @property {function} errorCallback A callback that gets fired whenever there is an error in the script. It will get passed some details about the error.
  */
 class BackgroundHandler extends CustomEventTarget {
 
@@ -20,9 +16,14 @@ class BackgroundHandler extends CustomEventTarget {
     constructor(exposedData = {}, options = { runtime: chrome.runtime }) {
         super();
 
+        /** @type {Map<string, Connection>} scriptConnections A Map that will relate every script ID to its Connection object. */
         this.scriptConnections = new Map(); // script-id --> connection
+        /** @property {object} exposedData The properties and methods exposed to the connecting scripts. */
         this.exposedData = exposedData;
+        /** @property {function} errorCallback A callback that gets fired whenever there is an error in the script. It will get passed some details about the error. */
         this.errorCallback = options.errorCallback ?? null;
+
+        /** @property {chrome.runtime} runtime The runtime that will be used to create the connections. */
         this.runtime = options.runtime ?? chrome.runtime;
 
         this.runtime.onConnect.addListener( (port) => this.handleNewConnection(port) );
@@ -170,6 +171,24 @@ class BackgroundHandler extends CustomEventTarget {
         return proxy;
     }
 
+    /**
+     * Get all tab ids where a specific scriptId is present.
+     *
+     * @param {string} scriptId
+     * @returns {number[]} The tab IDs
+     */
+    getScriptTabs(scriptId) {
+        let tabs = [];
+        for (let [id, connection] of this.scriptConnections) {
+            if (id.startsWith(scriptId)) {
+                if (connection.port.sender?.tab?.id) {
+                    tabs.push(connection.port.sender.tab.id);
+                }
+            }
+        }
+        return tabs;
+    }
+
     /**
      * Check if a script with a specific id associated to a specific tab has made a connection to the background page.
      * 

tests/Integrations.test.js

@@ -28,7 +28,11 @@ describe("The Background Handler", () => {
 
         await waitFor(100);
 
-        assert.ok(bgHandler.scriptConnections.has(bgScript.scriptId));
+        /** @type {string[]} */
+        let scriptIds = [...bgHandler.scriptConnections.keys()];
+
+        assert.equal(scriptIds.length, 1);
+        assert.ok(scriptIds[0].startsWith(bgScript.scriptId));
     });
 
     test("should allow functions to be executed remotely", async () => {
@@ -116,7 +120,7 @@ describe("The Background Script should", () => {
         let [bgHandler, [bgScript, otherScript]] = setupScripts({}, [
             { name: "test", exposed: {} },
             { name: "test", exposed: {} }
-        ]);
+        ], 1);
 
         let cb = mock.fn();
 
@@ -149,4 +153,23 @@ describe("The Background Script should", () => {
         // just reset the value for next tests
         global.window = new MockedWindow();
     });
+});
+
+describe("The Background Handler should", () => {
+    test("be able to show the tabs to which a script is connected", async () => {
+        let [bgHandler, [bgScript, otherScript, thirdScript]] = setupScripts({}, [
+            { name: "test", exposed: {} },
+            { name: "other", exposed: {} }
+        ]);
+
+        await waitFor(50);
+
+        let tabs = bgHandler.getScriptTabs("test");
+
+        assert.equal(tabs.length, 1);
+
+        tabs = bgHandler.getScriptTabs("other");
+
+        assert.equal(tabs.length, 1);
+    });
 })

tests/mocks/mockedChromeRuntime.js

@@ -2,12 +2,13 @@ import { getMockedPortPair } from "./mockedPort.js";
 import { MockedEvent } from "./mockedEvent.js";
 
 export class MockedChromeRuntime {
-    constructor() {
+    constructor(fixedTabId = null) {
         this.onConnect = new MockedEvent();
+        this.fixedTabId = fixedTabId;
     }
 
     connect({ name }) {
-        let [port, otherPort] = getMockedPortPair(name);
+        let [port, otherPort] = getMockedPortPair(name, this.fixedTabId);
 
         // Don't do it in the same task
         setTimeout(() => {

tests/mocks/mockedPort.js

@@ -1,11 +1,16 @@
 import { MockedEvent } from "./mockedEvent.js";
 
 export class MockedPort {
-    constructor(name) {
+    constructor(name, tabId) {
         this.name = name;
         this.onMessage = new MockedEvent();
         this.onDisconnect = new MockedEvent();
         this.other = null;
+        this.sender = {
+            tab: {
+                id: tabId ?? crypto.randomUUID()
+            }
+        }
     }
 
     _join(port) {
@@ -22,9 +27,9 @@ export class MockedPort {
     }
 }
 
-export const getMockedPortPair = (name) => {
-    let portA = new MockedPort(name);
-    let portB = new MockedPort(name);
+export const getMockedPortPair = (name, tabId = null) => {
+    let portA = new MockedPort(name, tabId);
+    let portB = new MockedPort(name, tabId);
     portA._join(portB);
     portB._join(portA);
     return [portA, portB];

tests/utilities.js

@@ -8,8 +8,8 @@ export function waitFor(ms) {
     });
 }
 
-export function setupScripts(handlerData, scriptsData) {
-    let runtime = new MockedChromeRuntime();
+export function setupScripts(handlerData, scriptsData, fixedTabId = null) {
+    let runtime = new MockedChromeRuntime(fixedTabId);
     let bgHandler = new BackgroundHandler(handlerData, { runtime });
 
     let scripts = [];