Merge pull request #6 from phanirithvij/develop

phanirithvij · web-flow · commit e47acbb52597 · 2022-03-06T00:08:40.000+05:30
merge phanirithvij/develop
diff --git a/docs/internal/DEVLOG.md b/docs/internal/DEVLOG.md
@@ -380,9 +380,12 @@ This document describes the development workflow that went into this project.
     - And it runs perfectly fine with no errors on the previous stable chrome version `98.0.4758.102`.
     - maybe related https://crbug.com/1296492
     - [update channel](https://chromereleases.googleblog.com/2022/03/stable-channel-update-for-desktop.html)
-    - [ ] Fix this
+    - [x] Fixed this
       - Might require massive restructuring and removing the uses of `chrome.runtime.sendMessage`, maybe use `chrome.tabs.sendMessage`idk.
+        - Nope, it was trivial
       - If using `chrome.tabs.sendMessage` instead of `chrome.runtime.sendMessage` and also manifest v2 thus background page instead of service workers, we won't be affected.
+      - Solution was to use `sendResponse` everytime and never miss sending a response back, even if it is empty.
+        - In case of async methods, `sendResponse` need not be used and `return true` still keeps the port open.
 
   - Found another bug with chrome service workers (how surprising)
     - `webRequest.onBeforeRequest` won't trigger when service worker is inactive.
diff --git a/src/js/background/background.js b/src/js/background/background.js
@@ -74,6 +74,12 @@ importScripts("./api/simkl.js");
 importScripts("../common.js");
 
 chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
+  if (!("HandledMessagePorts" in self)) self.HandledMessagePorts = {};
+  let msgIdx = Object.keys(self.HandledMessagePorts).length;
+  self.HandledMessagePorts[msgIdx] = {
+    message,
+    sender,
+  };
   // consoledebug("[SW] Got message:", message, "from:", sender)();
   switch (message.type) {
     case CallType.call:
@@ -86,38 +92,36 @@ chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
         case CallType.oauth.plex.checkTokenValiditiy:
           // consoledebug("[SW] Got message for token validation:", message)();
           __API__.plex.oauth.checkTokenValiditiy(null, message.token);
-          return true;
+          break;
         case CallType.oauth.simkl.oauthStart:
           __API__.simkl.oauth.oauthStart(sendResponse, message.inPopup);
-          // https://stackoverflow.com/a/57608759
           return true;
         case CallType.oauth.simkl.checkTokenValiditiy:
           __API__.simkl.oauth.checkTokenValiditiy(null, message.token);
-          return true;
-
+          break;
         // bg handlers
         case CallType.bg.popupAfterPermissionPrompt:
           chrome.tabs.create({
             url: chrome.runtime.getURL(
               `popup.html?url=${message.plexUrl}#${message.hashRoute}`
             ),
           });
-          return true;
+          break;
         case CallType.bg.sync.start:
           self.aController = new AbortController();
           startBgSync(aController.signal);
-          return true;
+          break;
         case CallType.bg.sync.stop:
           !!self.aController && self.aController.abort();
-          return true;
+          break;
         case CallType.bg.sw.ping:
           let r = {
             action: ActionType.sw.pong,
             type: ActionType.action,
           };
           chrome.runtime.sendMessage(r);
           sendResponse(r);
-          return true;
+          return;
 
         // API methods
         case CallType.apis.plex.getBgUrl:
@@ -136,7 +140,17 @@ chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
       consoledebug("Unknown message type", message.type)();
       break;
   }
-  return true;
+  // consoledebug(
+  //   "[SW] Sending null response back",
+  //   message.type,
+  //   message.method,
+  //   message.action
+  // )();
+  sendResponse();
+  self.HandledMessagePorts[msgIdx] = {
+    ...self.HandledMessagePorts[msgIdx],
+    sendResponse: true,
+  };
 });
 
 // Periodic background sync
diff --git a/src/js/background/sync.js b/src/js/background/sync.js
@@ -726,7 +726,7 @@ const startBgSync = async (signal) => {
       }
     }
 
-    await syncDone(serverTime);
+    syncDone(serverTime);
   } else {
     if (!simklOauthToken) {
       UIEvents.tokenExpired("simkl");
@@ -748,20 +748,20 @@ const startBgSync = async (signal) => {
   }
 };
 
-const syncDone = async (serverTime) => {
+const syncDone = (serverTime) => {
   // sync done
   consoledebug("Saving server time", serverTime);
-  await chrome.storage.local.set({
+  chrome.storage.local.set({
     lastSynced: serverTime,
+    // can set this to true to always do a full sync
+    // when using the sync now button
+    doFullSync: false,
   });
-  // comment this line to make `sync now` do fullsyncs everytime
-  // useful for debugging, don't forget to uncomment this after done
-  await chrome.storage.local.remove("doFullSync");
   let doneMsg = {
     type: ActionType.action,
     action: ActionType.ui.sync.finished,
   };
-  await chrome.runtime.sendMessage(doneMsg);
+  chrome.runtime.sendMessage(doneMsg);
 };
 
 /*
@@ -813,6 +813,7 @@ const simklAnimeIdstoPlexIds = (media) =>
 // unused might required for later
 
 const fetchAniDBTvDBMappings = async (signal) => {
+  return;
   try {
     let resp = await fetch(
       "https://raw.githubusercontent.com/Anime-Lists/anime-lists/master/anime-list.xml",
diff --git a/src/js/ui/plex.js b/src/js/ui/plex.js
@@ -65,11 +65,11 @@ const finishPlexOauth = (message) => {
   consoledebug(message)();
 };
 
-const checkPlexAuthTokenValidity = async () => {
+const checkPlexAuthTokenValidity = () => {
   // Gets plexOauthToken from chrome.storage.sync
   // Checks whether it's valid and request user to login again if not
   // Note: broadcasting to other connected views is not needed for this
-  await chrome.runtime.sendMessage({
+  chrome.runtime.sendMessage({
     type: CallType.call,
     method: CallType.oauth.plex.checkTokenValiditiy,
   });
diff --git a/src/js/ui/popup.js b/src/js/ui/popup.js
@@ -78,16 +78,16 @@ const handleHashRoutes = async () => {
     startPlexOauth();
   } else {
     // request service worker to validate and save plex oauth token
-    await pingServiceWorker();
-    await checkPlexAuthTokenValidity();
+    checkPlexAuthTokenValidity();
+    pingServiceWorker();
   }
   if (loginType == "simkl") {
     startSimklOauth();
   } else {
     // request service worker to validate and save simkl oauth token
     // checkSimklAuthTokenValidity();
-    await checkSimklAuthTokenValidity();
-    await pingServiceWorker();
+    checkSimklAuthTokenValidity();
+    pingServiceWorker();
   }
 };
 
@@ -287,7 +287,7 @@ const onLoad = async () => {
       startNextSyncTimer();
     }
     // service worker healthCheck
-    await pingServiceWorker();
+    pingServiceWorker();
   })();
 
   uiSetPopupViewState();
@@ -299,8 +299,14 @@ window.addEventListener("resize", uiHandleBackgroundImg);
 
 // Registering UI event handlers (actions)
 
-chrome.runtime.onMessage.addListener(async (message, sender) => {
-  // consoledebug("Got message:", message, "from:", sender)();
+chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
+  if (!("HandledMessagePorts" in window)) window.HandledMessagePorts = {};
+  let msgIdx = Object.keys(window.HandledMessagePorts).length;
+  window.HandledMessagePorts[msgIdx] = {
+    message,
+    sender,
+  };
+  // consoledebug("[popup] got message:", message, "from:", sender)();
   switch (message.type) {
     case ActionType.action:
       switch (message.action) {
@@ -398,7 +404,8 @@ chrome.runtime.onMessage.addListener(async (message, sender) => {
         case ActionType.ui.sync.progress:
           // handle earch progress item
           if (message.value <= 0) {
-            return;
+            // don't return here, an sendResponse needs to be called
+            break;
           }
           document.body.classList.add("sync-in-progress-plex");
           document.body.classList.remove("sync-waiting-for-next-sync");
@@ -416,11 +423,13 @@ chrome.runtime.onMessage.addListener(async (message, sender) => {
           window.swPong = message;
           break;
         case ActionType.sw.tabFocus:
-          chrome.tabs.update(
-            (await chrome.tabs.getCurrent()).id,
-            { active: true },
-            (_) => {}
-          );
+          (async () => {
+            chrome.tabs.update(
+              (await chrome.tabs.getCurrent()).id,
+              { active: true },
+              (_) => {}
+            );
+          })();
           break;
         default:
           consoledebug("Unknown action", message)();
@@ -433,8 +442,17 @@ chrome.runtime.onMessage.addListener(async (message, sender) => {
     default:
       consoledebug("Unknown message type", message)();
   }
-  // required if we don't use sendResponse
-  return true;
+  // consoledebug(
+  //   "[popup] Sending null response back",
+  //   message.type,
+  //   message.method,
+  //   message.action
+  // )();
+  sendResponse();
+  window.HandledMessagePorts[msgIdx] = {
+    ...window.HandledMessagePorts[msgIdx],
+    sendResponse: true,
+  };
 });
 
 // TODOO: move this logic to service worker
@@ -454,7 +472,7 @@ const retrySyncWithBackoff = async (
     chrome.storage.local.set({
       failedTries: 0,
     });
-    return true;
+    return;
   }
   let backOffmult = Math.min(Math.pow(2, failedTries), 30);
   restartLibrarySync(
@@ -514,7 +532,7 @@ const startNextSyncTimer = async () => {
   }
 };
 
-const pingServiceWorker = async () => {
+const pingServiceWorker = () => {
   consoledebug("ping service worker")();
   // ping service worker every 2 minutes
   window.pingerHandle && clearInterval(pingerHandle);
@@ -526,7 +544,7 @@ const pingServiceWorker = async () => {
     type: CallType.call,
     method: CallType.bg.sw.ping,
   };
-  await chrome.runtime.sendMessage(m);
+  chrome.runtime.sendMessage(m);
   window.pingerTimeout && clearTimeout(window.pingerTimeout);
   window.pingerTimeout = setTimeout(() => {
     if (window.swPong) {
diff --git a/src/js/ui/simkl.js b/src/js/ui/simkl.js
@@ -64,12 +64,12 @@ const finishSimklOauth = (message) => {
   consoledebug(message)();
 };
 
-const checkSimklAuthTokenValidity = async () => {
+const checkSimklAuthTokenValidity = () => {
   // Gets simklOauthToken from chrome.storage.sync
   // Checks whether it's valid and request user to login again if not
 
   // Note: broadcasting to other connected views is not needed for this
-  await chrome.runtime.sendMessage({
+  chrome.runtime.sendMessage({
     type: CallType.call,
     method: CallType.oauth.simkl.checkTokenValiditiy,
   });
