#1509 Migrate to Manifest V3

extension/chrome/dev/ci_unit_test.ts

@@ -17,7 +17,6 @@ import { ContactStore } from '../../js/common/platform/store/contact-store.js';
 import { Debug } from '../../js/common/platform/debug.js';
 import { Catch } from '../../js/common/platform/catch.js';
 import { Url } from '../../js/common/core/common.js';
-import * as forge from 'node-forge';
 import { Gmail } from '../../js/common/api/email-provider/gmail/gmail.js';
 import { PgpHash } from '../../js/common/core/crypto/pgp/pgp-hash.js';
 import { PgpArmor } from '../../js/common/core/crypto/pgp/pgp-armor.js';
@@ -53,5 +52,4 @@ const libs: unknown[] = [
 for (const lib of libs) {
   (window as any)[(lib as any).name] = lib;
 }
-(window as any).forge = forge;
 /* eslint-enable @typescript-eslint/no-explicit-any */

extension/js/common/api/email-provider/gmail/gmail.ts

@@ -217,7 +217,7 @@ export class Gmail extends EmailProviderApi implements EmailProviderInterface {
           let status: number;
           const responsePollInterval = Catch.setHandledInterval(() => {
             if (status >= 200 && status <= 299 && (r.responseText.length >= minBytes || treatAs === 'publicKey')) {
-              window.clearInterval(responsePollInterval);
+              clearInterval(responsePollInterval);
               processChunkAndResolve(r.responseText);
               r.abort();
             }
@@ -228,7 +228,7 @@ export class Gmail extends EmailProviderApi implements EmailProviderInterface {
               status = r.status;
               if (status >= 300) {
                 reject(AjaxErr.fromXhr({ status, readyState: r.readyState }, { method, url, stack }));
-                window.clearInterval(responsePollInterval);
+                clearInterval(responsePollInterval);
                 r.abort();
               }
             }
@@ -237,14 +237,14 @@ export class Gmail extends EmailProviderApi implements EmailProviderInterface {
               if (status >= 200 && status <= 299 && (r.responseText.length >= minBytes || treatAs === 'publicKey')) {
                 // done as a success - resolve in case response_poll didn't catch this yet
                 processChunkAndResolve(r.responseText);
-                window.clearInterval(responsePollInterval);
+                clearInterval(responsePollInterval);
                 if (r.readyState === 3) {
                   r.abort();
                 }
               } else {
                 // done as a fail - reject
                 reject(AjaxErr.fromXhr({ status, readyState: r.readyState }, { method, url, stack }));
-                window.clearInterval(responsePollInterval);
+                clearInterval(responsePollInterval);
               }
             }
           };

extension/js/common/browser/browser-msg.ts

@@ -163,6 +163,7 @@ export namespace Bm {
 }
 
 type Handler = Bm.AsyncRespondingHandler | Bm.AsyncResponselessHandler;
+type IntervalHandler = () => void | Promise<void>;
 type Handlers = Dict<Handler>;
 
 export class BgNotReadyErr extends Error {}
@@ -228,6 +229,7 @@ export class BrowserMsg {
   private static readonly processed = new Set<string>(); // or ExpirationCache?
   /* eslint-disable @typescript-eslint/naming-convention */
   private static HANDLERS_REGISTERED_BACKGROUND: Handlers = {};
+  private static INTERVAL_HANDLERS: Dict<IntervalHandler> = {};
   private static HANDLERS_REGISTERED_FRAME: Handlers = {
     set_css: BrowserMsgCommonHandlers.setCss,
     add_class: BrowserMsgCommonHandlers.addClass,
@@ -251,14 +253,14 @@ export class BrowserMsg {
       div.style.backgroundColor = '#a44';
       div.style.padding = '4px 6px';
       const a = document.createElement('a');
-      a.href = window.location.href.split('#')[0];
+      a.href = location.href.split('#')[0];
       a.textContent = 'RELOAD';
       a.style.color = 'white';
       a.style.fontWeight = 'bold';
       a.style.marginLeft = '12px';
       div.appendChild(a);
     }
-    window.document.body.appendChild(div);
+    document.body.appendChild(div);
   }
 
   public static generateTabId(contentScript?: boolean) {
@@ -285,6 +287,16 @@ export class BrowserMsg {
     BrowserMsg.HANDLERS_REGISTERED_BACKGROUND[name] = handler;
   }
 
+  public static createIntervalAlarm(action: string, ms: number) {
+    // Create the alarm with delay
+    const alarmName = `${action}_interval_${Date.now()}_${ms}`;
+    void chrome.alarms.create(alarmName, { when: Date.now() + ms });
+  }
+
+  public static intervalAddListener(name: string, handler: IntervalHandler) {
+    BrowserMsg.INTERVAL_HANDLERS[name] = handler;
+  }
+
   public static bgListen() {
     chrome.runtime.onMessage.addListener((msg: Bm.Raw, _sender, rawRespond: (rawRes: Bm.RawResponse) => void) => {
       const respondIfPageStillOpen = (response: Bm.RawResponse) => {
@@ -321,9 +333,30 @@ export class BrowserMsg {
     });
   }
 
+  public static alarmListen() {
+    const alarmListener = (alarm: { name: string }) => {
+      const alarmName = alarm.name;
+      const actionName = alarmName.split('_interval')[0];
+      if (BrowserMsg.INTERVAL_HANDLERS[actionName]) {
+        Catch.try(BrowserMsg.INTERVAL_HANDLERS[actionName])();
+      }
+      if (alarmName.includes('interval')) {
+        const splitAry = alarmName.split('_');
+        const ms = splitAry[splitAry.length - 1];
+        if (ms) {
+          // Recreate alarm so that interval can be called again
+          void chrome.alarms.create(alarmName, { when: Date.now() + parseInt(ms) });
+        }
+      }
+    };
+
+    // Listen for the alarm and execute the callback when it triggers, then clear the alarm
+    chrome.alarms.onAlarm.addListener(alarmListener);
+  }
+
   protected static listenForWindowMessages(dest: Bm.Dest) {
     const extensionOrigin = Env.getExtensionOrigin();
-    window.addEventListener('message', async e => {
+    addEventListener('message', async e => {
       if (e.origin !== 'https://mail.google.com' && e.origin !== extensionOrigin) return;
       const encryptedMsg = e.data as SymEncryptedMessage;
       if (BrowserMsg.processed.has(encryptedMsg.uid)) return;
@@ -438,7 +471,7 @@ export class BrowserMsg {
         // todo: can objUrls be deleted by another recipient?
         const encryptedMsg = await SymmetricMessageEncryption.encrypt(validMsg);
         BrowserMsg.sendToChildren(encryptedMsg);
-        window.postMessage(encryptedMsg, '*');
+        postMessage(encryptedMsg, '*');
         BrowserMsg.sendUpParentLine(encryptedMsg);
       })();
     }
@@ -505,7 +538,7 @@ export class BrowserMsg {
     let w: Window = window;
     while (w.parent && w.parent !== w) {
       w = w.parent;
-      window.parent.postMessage(encryptedWithPropagationFlag, '*');
+      parent.postMessage(encryptedWithPropagationFlag, '*');
     }
   }
   /**

extension/js/common/browser/env.ts

@@ -28,11 +28,27 @@ export class Env {
   }
 
   public static isContentScript() {
-    return Env.isExtension() && window.location.href.indexOf(chrome.runtime.getURL('')) === -1; // extension but not on its own url
+    if (Env.isExtension()) {
+      try {
+        // Attempt to get the URL of an extension resource. This will succeed if we're in an extension context.
+        const extensionUrl = chrome.runtime.getURL('');
+        // Check if the current page URL is different from the extension's base URL (i.e., it's not an extension page)
+        return window.location.href.indexOf(extensionUrl) !== 0;
+      } catch (e) {
+        // In case of any errors (which shouldn't happen in a proper extension context), assume it's not a content script
+        return false;
+      }
+    }
+    // chrome.runtime is not available, so it's not running within an extension
+    return false;
   }
 
+  // Check if the current context is a Service Worker
   public static isBackgroundPage() {
-    return Boolean(window.location && window.location.href.includes('background_page.htm'));
+    // 'self.registration' exists in service worker contexts
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    return typeof self.registration !== 'undefined';
   }
 
   public static isExtension() {

extension/js/common/core/crypto/pgp/pgp-armor.ts

@@ -3,7 +3,7 @@
 'use strict';
 
 // todo: move this file level up as it handles both S/MIME and OpenPGP?
-import * as forge from 'node-forge';
+import type * as Forge from 'node-forge';
 import { Buf } from '../../buf.js';
 import { ReplaceableMsgBlockType } from '../../msg-block.js';
 import { Str } from '../../common.js';
@@ -20,7 +20,7 @@ export type PreparedForDecrypt =
       message: OpenPGP.CleartextMessage | OpenPGP.Message<OpenPGP.Data>;
     }
   | { isArmored: boolean; isCleartext: false; isPkcs7: false; message: OpenPGP.Message<OpenPGP.Data> }
-  | { isArmored: boolean; isCleartext: false; isPkcs7: true; message: forge.pkcs7.PkcsEnvelopedData };
+  | { isArmored: boolean; isCleartext: false; isPkcs7: true; message: Forge.pkcs7.PkcsEnvelopedData };
 
 type CryptoArmorHeaderDefinitions = {
   readonly [type in ReplaceableMsgBlockType | 'null' | 'signature']: CryptoArmorHeaderDefinition;