Add lint to try to limit reappearance of Safari memory leaks (#6382)

bitwarden · Oct 10, 2023 · 524123a · 524123a
1 parent 3e720c0
commit 524123a
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -179,6 +179,23 @@
       "rules": {
         "no-restricted-imports": ["error", { "patterns": ["@bitwarden/vault/*", "src/**/*"] }]
       }
+    },
+    {
+      "files": ["apps/browser/src/**/*.ts", "libs/**/*.ts"],
+      "excludedFiles": "apps/browser/src/autofill/{content,notification}/**/*.ts",
+      "rules": {
+        "no-restricted-syntax": [
+          "error",
+          {
+            "message": "Using addListener in the browser popup produces a memory leak in Safari, use `BrowserApi.messageListener` instead",
+            "selector": "CallExpression > [object.object.object.name='chrome'][object.object.property.name='runtime'][object.property.name='onMessage'][property.name='addListener']"
+          },
+          {
+            "message": "Using addListener in the browser popup produces a memory leak in Safari, use `BrowserApi.storageChangeListener` instead",
+            "selector": "CallExpression > [object.object.object.name='chrome'][object.object.property.name='storage'][object.property.name='onChanged'][property.name='addListener']"
+          }
+        ]
+      }
     }
   ]
 }
diff --git a/apps/browser/src/platform/browser/browser-api.ts b/apps/browser/src/platform/browser/browser-api.ts
@@ -208,6 +208,7 @@ export class BrowserApi {
     name: string,
     callback: (message: any, sender: chrome.runtime.MessageSender, response: any) => void
   ) {
+    // eslint-disable-next-line no-restricted-syntax
     chrome.runtime.onMessage.addListener(callback);
 
     if (BrowserApi.isSafariApi && !BrowserApi.isBackgroundPage(window)) {
@@ -219,6 +220,7 @@ export class BrowserApi {
   static storageChangeListener(
     callback: Parameters<typeof chrome.storage.onChanged.addListener>[0]
   ) {
+    // eslint-disable-next-line no-restricted-syntax
     chrome.storage.onChanged.addListener(callback);
 
     if (BrowserApi.isSafariApi && !BrowserApi.isBackgroundPage(window)) {