Fix: Load settings when extension has been enabled

packages/extension/src/serviceWorker/chromeListeners/index.ts

@@ -30,6 +30,7 @@ import { onTabRemovedListener } from './tabOnRemovedListener';
 import { onCommittedNavigationListener } from './onCommittedNavigationListener';
 import { windowsOnRemovedListener } from './windowsOnRemovedListener';
 import { windowsOnCreatedListener } from './windowsOnCreatedListener';
+import { onEnabledListener } from './onEnabledListener';
 
 /**
  * Fires before sending an HTTP request, once the request headers are available.
@@ -51,6 +52,12 @@ chrome?.webRequest?.onResponseStarted?.addListener(
   ['extraHeaders', 'responseHeaders']
 );
 
+/**
+ * Fires when the etension is enabled.
+ * @see https://developer.chrome.com/docs/extensions/reference/api/management#event-onEnabled
+ */
+chrome.management.onEnabled.addListener(onEnabledListener);
+
 chrome.tabs.onCreated.addListener(onTabCreatedListener);
 
 /**

packages/extension/src/serviceWorker/chromeListeners/onEnabledListener.ts

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal dependencies
+ */
+import synchnorousCookieStore from '../../store/synchnorousCookieStore';
+import { updateGlobalVariableAndAttachCDP, setupIntervals } from './utils';
+
+export const onEnabledListener = async (
+  details: chrome.management.ExtensionInfo
+) => {
+  if (chrome.runtime.id !== details.id) {
+    return;
+  }
+
+  synchnorousCookieStore?.clear();
+
+  setupIntervals();
+
+  await updateGlobalVariableAndAttachCDP();
+};

packages/extension/src/serviceWorker/chromeListeners/runtimeOnInstalledListener.ts

@@ -1,18 +1,3 @@
-/*
- * Copyright 2023 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 /*
  * Copyright 2023 Google LLC
  *
@@ -32,41 +17,14 @@
  * Internal dependencies
  */
 import synchnorousCookieStore from '../../store/synchnorousCookieStore';
-import { getAndParseNetworkCookies } from '../../utils/getAndParseNetworkCookies';
-import attachCDP from '../attachCDP';
+import { updateGlobalVariableAndAttachCDP, setupIntervals } from './utils';
 
 export const runtimeOnInstalledListener = async (
   details: chrome.runtime.InstalledDetails
 ) => {
   synchnorousCookieStore?.clear();
 
-  // @see https://developer.chrome.com/blog/longer-esw-lifetimes#whats_changed
-  // Doing this to keep the service worker alive so that we dont loose any data and introduce any bug.
-  setInterval(async () => {
-    await chrome.storage.session.get();
-  }, 20000);
-
-  // @todo Send tab data of the active tab only, also if sending only the difference would make it any faster.
-  setInterval(() => {
-    if (Object.keys(synchnorousCookieStore?.tabsData ?? {}).length === 0) {
-      return;
-    }
-
-    Object.keys(synchnorousCookieStore?.tabsData ?? {}).forEach((key) => {
-      synchnorousCookieStore?.sendUpdatedDataToPopupAndDevTools(Number(key));
-    });
-  }, 1200);
-
-  // @todo Send tab data of the active tab only, also if sending only the difference would make it any faster.
-  setInterval(() => {
-    if (Object.keys(synchnorousCookieStore?.tabsData ?? {}).length === 0) {
-      return;
-    }
-
-    Object.keys(synchnorousCookieStore?.tabsData ?? {}).forEach((key) => {
-      getAndParseNetworkCookies(key);
-    });
-  }, 5000);
+  setupIntervals();
 
   if (details.reason === 'install') {
     await chrome.storage.sync.clear();
@@ -77,43 +35,9 @@ export const runtimeOnInstalledListener = async (
   }
 
   if (details.reason === 'update') {
-    await chrome.storage.local.clear();
     const preSetSettings = await chrome.storage.sync.get();
-    synchnorousCookieStore.tabMode =
-      preSetSettings?.allowedNumberOfTabs ?? 'single';
-    synchnorousCookieStore.globalIsUsingCDP =
-      preSetSettings?.isUsingCDP ?? false;
-
-    if (synchnorousCookieStore.tabMode === 'unlimited') {
-      const allTabs = await chrome.tabs.query({});
-      const targets = await chrome.debugger.getTargets();
-      await Promise.all(
-        allTabs.map(async (tab) => {
-          if (!tab.id || tab.url?.startsWith('chrome://')) {
-            return;
-          }
-
-          synchnorousCookieStore?.addTabData(tab.id);
 
-          if (synchnorousCookieStore.globalIsUsingCDP) {
-            synchnorousCookieStore.initialiseVariablesForNewTab(
-              tab.id.toString()
-            );
-
-            await attachCDP({ tabId: tab.id });
-
-            const currentTab = targets.filter(
-              ({ tabId }) => tabId && tab.id && tabId === tab.id
-            );
-            synchnorousCookieStore?.updateParentChildFrameAssociation(
-              tab.id,
-              currentTab[0].id,
-              '0'
-            );
-          }
-        })
-      );
-    }
+    await updateGlobalVariableAndAttachCDP();
 
     if (
       preSetSettings?.allowedNumberOfTabs &&

packages/extension/src/serviceWorker/chromeListeners/runtimeStartUpListener.ts

@@ -17,38 +17,11 @@
  * Internal dependencies
  */
 import synchnorousCookieStore from '../../store/synchnorousCookieStore';
-import { getAndParseNetworkCookies } from '../../utils/getAndParseNetworkCookies';
+import { setupIntervals } from './utils';
 
 export const onStartUpListener = async () => {
   const storage = await chrome.storage.sync.get();
-
-  // @see https://developer.chrome.com/blog/longer-esw-lifetimes#whats_changed
-  // Doing this to keep the service worker alive so that we dont loose any data and introduce any bug.
-  setInterval(async () => {
-    await chrome.storage.session.get();
-  }, 20000);
-
-  // @todo Send tab data of the active tab only, also if sending only the difference would make it any faster.
-  setInterval(() => {
-    if (Object.keys(synchnorousCookieStore?.tabsData ?? {}).length === 0) {
-      return;
-    }
-
-    Object.keys(synchnorousCookieStore?.tabsData ?? {}).forEach((key) => {
-      synchnorousCookieStore?.sendUpdatedDataToPopupAndDevTools(Number(key));
-    });
-  }, 1200);
-
-  // @todo Send tab data of the active tab only, also if sending only the difference would make it any faster.
-  setInterval(() => {
-    if (Object.keys(synchnorousCookieStore?.tabsData ?? {}).length === 0) {
-      return;
-    }
-
-    Object.keys(synchnorousCookieStore?.tabsData ?? {}).forEach((key) => {
-      getAndParseNetworkCookies(key);
-    });
-  }, 5000);
+  setupIntervals();
 
   if (storage?.allowedNumberOfTabs) {
     synchnorousCookieStore.tabMode = storage.allowedNumberOfTabs;

packages/extension/src/serviceWorker/chromeListeners/utils/index.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export { default as setupIntervals } from './setupIntervals';
+export { default as updateGlobalVariableAndAttachCDP } from './updateGlobalVariableAndAttachCDP';

packages/extension/src/serviceWorker/chromeListeners/utils/setupIntervals.ts

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Internal dependencies
+ */
+import synchnorousCookieStore from '../../../store/synchnorousCookieStore';
+import { getAndParseNetworkCookies } from '../../../utils/getAndParseNetworkCookies';
+
+const setupIntervals = () => {
+  // @see https://developer.chrome.com/blog/longer-esw-lifetimes#whats_changed
+  // Doing this to keep the service worker alive so that we dont loose any data and introduce any bug.
+  setInterval(async () => {
+    await chrome.storage.session.get();
+  }, 20000);
+
+  // @todo Send tab data of the active tab only, also if sending only the difference would make it any faster.
+  setInterval(() => {
+    if (Object.keys(synchnorousCookieStore?.tabsData ?? {}).length === 0) {
+      return;
+    }
+
+    Object.keys(synchnorousCookieStore?.tabsData ?? {}).forEach((key) => {
+      synchnorousCookieStore?.sendUpdatedDataToPopupAndDevTools(Number(key));
+    });
+  }, 1200);
+
+  // @todo Send tab data of the active tab only, also if sending only the difference would make it any faster.
+  setInterval(() => {
+    if (Object.keys(synchnorousCookieStore?.tabsData ?? {}).length === 0) {
+      return;
+    }
+
+    Object.keys(synchnorousCookieStore?.tabsData ?? {}).forEach((key) => {
+      getAndParseNetworkCookies(key);
+    });
+  }, 5000);
+};
+
+export default setupIntervals;

packages/extension/src/serviceWorker/chromeListeners/utils/updateGlobalVariableAndAttachCDP.ts

@@ -0,0 +1,64 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Internal dependencies
+ */
+import synchnorousCookieStore from '../../../store/synchnorousCookieStore';
+import attachCDP from '../../attachCDP';
+
+const updateGlobalVariableAndAttachCDP = async () => {
+  await chrome.storage.local.clear();
+
+  const preSetSettings = await chrome.storage.sync.get();
+
+  synchnorousCookieStore.tabMode =
+    preSetSettings?.allowedNumberOfTabs ?? 'single';
+  synchnorousCookieStore.globalIsUsingCDP = preSetSettings?.isUsingCDP ?? false;
+
+  if (synchnorousCookieStore.tabMode === 'unlimited') {
+    const allTabs = await chrome.tabs.query({});
+    const targets = await chrome.debugger.getTargets();
+
+    await Promise.all(
+      allTabs.map(async (tab) => {
+        if (!tab.id || tab.url?.startsWith('chrome://')) {
+          return;
+        }
+
+        synchnorousCookieStore?.addTabData(tab.id);
+
+        if (synchnorousCookieStore.globalIsUsingCDP) {
+          synchnorousCookieStore.initialiseVariablesForNewTab(
+            tab.id.toString()
+          );
+
+          await attachCDP({ tabId: tab.id });
+
+          const currentTab = targets.filter(
+            ({ tabId }) => tabId && tab.id && tabId === tab.id
+          );
+          synchnorousCookieStore?.updateParentChildFrameAssociation(
+            tab.id,
+            currentTab[0].id,
+            '0'
+          );
+        }
+      })
+    );
+  }
+};
+
+export default updateGlobalVariableAndAttachCDP;