Hack: Periodically re-create context menus

In Firefox, when context menus were created in MV3, they may disappear unintentionally, even after restart. This is due to a bug in Firefox [1]. This patch introduces a hack which removes and re-creates all the menus every 30 seconds. [1]: https://discourse.mozilla.org/t/strange-mv3-behaviour-browser-runtime-oninstalled-event-and-menus-create/111208/7
yorkxin · Apr 16, 2024 · a16292c · a16292c
1 parent f4828d5
commit a16292c
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 4 deletions.
diff --git a/firefox/hacks.js b/firefox/hacks.js
@@ -0,0 +1 @@
+globalThis["PERIDOCIALLY_REFRESH_MENU"] = true;
diff --git a/firefox/manifest.json b/firefox/manifest.json
@@ -1,6 +1,6 @@
 {
   "name": "Copy as Markdown",
-  "version": "2.8.3",
+  "version": "2.9.0",
   "manifest_version": 3,
   "description": "Copy Link or Image as Markdown code",
   "permissions": [
@@ -26,7 +26,10 @@
     "128": "./dist/images/icon-128.png"
   },
   "background": {
-    "scripts": ["./dist/background.js"],
+    "scripts": [
+      "hacks.js",
+      "./dist/background.js"
+    ],
     "type": "module"
   },
   "commands": {

diff --git a/src/background.js b/src/background.js
@@ -13,6 +13,8 @@ const TEXT_EMPTY = '';
 
 const FLASH_BADGE_TIMEOUT = 3000; // ms
 
+const ALARM_REFRESH_MENU = 'refreshMenu';
+
 async function flashBadge(type) {
   const entrypoint = chrome.action /* MV3 */ || chrome.browserAction; /* Firefox MV2 */
 
@@ -42,6 +44,10 @@ chrome.alarms.onAlarm.addListener((alarm) => {
     ])
       .then(() => { /* NOP */ });
   }
+
+  if (alarm.name === ALARM_REFRESH_MENU) {
+    chrome.contextMenus.removeAll(createMenus);
+  }
 });
 
 async function handleContentOfContextMenu(info, tab) {
@@ -158,7 +164,7 @@ async function mustGetCurrentTab() {
   return Promise.resolve(tabs[0]);
 }
 
-chrome.runtime.onInstalled.addListener(() => {
+function createMenus() {
   chrome.contextMenus.create({
     id: 'current-page',
     title: 'Copy [Page Title](URL)',
@@ -179,7 +185,16 @@ chrome.runtime.onInstalled.addListener(() => {
     type: 'normal',
     contexts: ['image'],
   });
-});
+}
+
+chrome.runtime.onInstalled.addListener(createMenus);
+
+if (globalThis["PERIDOCIALLY_REFRESH_MENU"] === true) {
+  // Hack for Firefox, in which Context Menu disappears after some time.
+  // See https://discourse.mozilla.org/t/strange-mv3-behaviour-browser-runtime-oninstalled-event-and-menus-create/111208/7
+  console.info("Hack PERIDOCIALLY_REFRESH_MENU is enabled");
+  chrome.alarms.create("refreshMenu", { periodInMinutes: 0.5});
+}
 
 // NOTE: All listeners must be registered at top level scope.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		globalThis["PERIDOCIALLY_REFRESH_MENU"] = true;
Check failure on line 1 in firefox/hacks.js View workflow job for this annotation GitHub Actions / build `'globalThis' is not defined` Check failure on line 1 in firefox/hacks.js View workflow job for this annotation GitHub Actions / build `["PERIDOCIALLY_REFRESH_MENU"] is better written in dot notation` Check failure on line 1 in firefox/hacks.js View workflow job for this annotation GitHub Actions / build `Strings must use singlequote`