Issue 4579 - Ignore runtime.lastError caused by wrapper

polyfill.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 25 matching lines @@
     "tabs.query",
     "tabs.reload",
     "tabs.sendMessage",
     "tabs.update",
     "webNavigation.getAllFrames",
     "webRequest.handlerBehaviorChanged",
     "windows.create",
     "windows.update"
   ];
 
-  // Errors that occur only when we show an interest in the response from an
-  // API call.
-  const noFulfillmentErrors = [
-    "The message port closed before a response was received."
-  ];
-
-  const fulfillmentInterestFlag = Symbol();

[Manish Jethani, 2017/10/19 01:59:46]

We use a symbol here so it becomes like a private property.

-
-  function SpecialPromise(...args)
-  {
-    return Reflect.construct(Promise, args, SpecialPromise);

[Manish Jethani, 2017/10/19 01:59:46]

Essentially an extended promise.

-  }
-
-  SpecialPromise.prototype = Object.create(
-    Object.assign({}, Promise.prototype, {
-      then(...args)
-      {
-        // Set this flag to indicate that there is interest in the fulfillment
-        // of this promise.
-        this[fulfillmentInterestFlag] = true;
-
-        return Promise.prototype.then.apply(this, args);
-      }
-    })
-  );
+  // Since we add a callback for all messaging API calls in our wrappers,
+  // Chrome assumes we're interested in the response; when there's no response,
+  // it sets runtime.lastError
+  const portClosedBeforeResponseError =
+    // Older versions of Chrome have a typo:
+    // https://crrev.com/c33f51726eacdcc1a487b21a13611f7eab580d6d
+    /^The message port closed before a res?ponse was received\.$/;
 
   function wrapAPI(api)
   {
     let object = browser;
     let path = api.split(".");
     let name = path.pop();
 
     for (let node of path)
     {
       object = object[node];
 
       if (!object)
         return;
     }
 
     let func = object[name];
     object[name] = function(...args)
     {
+      let callStack = new Error().stack;
+
       if (typeof args[args.length - 1] == "function")
         return func.apply(object, args);
 
       // If the last argument is undefined, we drop it from the list assuming
       // it stands for the optional callback. We must do this, because we have
       // to replace it with our own callback. If we simply append our own
       // callback to the list, it won't match the signature of the function and
       // will cause an exception.
       if (typeof args[args.length - 1] == "undefined")
         args.pop();
 
-      let promise = new SpecialPromise((resolve, reject) =>
+      return new Promise((resolve, reject) =>
       {
         func.call(object, ...args, result =>
         {
           let error = browser.runtime.lastError;
-          if (error)
+          if (error && !portClosedBeforeResponseError.test(error.message))
           {
-            // If is this an error we got only because we passed in a callback
-            // and there's no actual interest in the response, ignore the
-            // error.
-            if (noFulfillmentErrors.includes(error.message) &&
-                !promise[fulfillmentInterestFlag])
+            // runtime.lastError is already an Error instance on Edge, while on
+            // Chrome it is a plain object with only a message property.
+            if (!(error instanceof Error))
             {
-              return;
+              error = new Error(error.message);
+
+              // Add a more helpful stack trace.
+              error.stack = callStack;
             }
 
             reject(error);
           }
           else
           {
             resolve(result);
           }
         });
       });
-
-      return promise;
     };
   }
 
   function shouldWrapAPIs()
   {
     try
     {
       return !(browser.storage.local.get([]) instanceof Promise);
     }
     catch (error)
@@ skipping 17 matching lines @@
 
   // Workaround since HTMLCollection, NodeList, StyleSheetList, and CSSRuleList
   // didn't have iterator support before Chrome 51.
   // https://bugs.chromium.org/p/chromium/issues/detail?id=401699
   for (let object of [HTMLCollection, NodeList, StyleSheetList, CSSRuleList])
   {
     if (!(Symbol.iterator in object.prototype))
       object.prototype[Symbol.iterator] = Array.prototype[Symbol.iterator];
   }
 }