Merge pull request #12802 from Snuffleupagus/FirefoxCom-requestAsync

Add a new `FirefoxCom.requestAsync` method, to simplify the code in `web/firefoxcom.js`

web/firefoxcom.js

@@ -25,18 +25,17 @@ if (typeof PDFJSDev === "undefined" || !PDFJSDev.test("MOZCENTRAL")) {
   );
 }
 
-const FirefoxCom = (function FirefoxComClosure() {
+class FirefoxCom {
-  return {
   /**
    * Creates an event that the extension is listening for and will
    * synchronously respond to.
-     * NOTE: It is reccomended to use request() instead since one day we may not
+   * NOTE: It is recommended to use requestAsync() instead since one day we may
-     * be able to synchronously reply.
+   *       not be able to synchronously reply.
    * @param {string} action - The action to trigger.
-     * @param {string} [data] - The data to send.
+   * @param {Object|string} [data] - The data to send.
    * @returns {*} The response.
    */
-    requestSync(action, data) {
+  static requestSync(action, data) {
     const request = document.createTextNode("");
     document.documentElement.appendChild(request);
 
@@ -51,17 +50,28 @@ const FirefoxCom = (function FirefoxComClosure() {
     request.remove();
 
     return response;
-    },
+  }
 
   /**
    * Creates an event that the extension is listening for and will
-     * asynchronously respond by calling the callback.
+   * asynchronously respond to.
    * @param {string} action - The action to trigger.
-     * @param {string} [data] - The data to send.
+   * @param {Object|string} [data] - The data to send.
-     * @param {Function} [callback] - Response callback that will be called
+   * @returns {Promise<any>} A promise that is resolved with the response data.
-     *   with one data argument.
    */
-    request(action, data, callback) {
+  static requestAsync(action, data) {
+    return new Promise(resolve => {
+      this.request(action, data, resolve);
+    });
+  }
+
+  /**
+   * Creates an event that the extension is listening for and will, optionally,
+   * asynchronously respond to.
+   * @param {string} action - The action to trigger.
+   * @param {Object|string} [data] - The data to send.
+   */
+  static request(action, data, callback = null) {
     const request = document.createTextNode("");
     if (callback) {
       request.addEventListener(
@@ -84,10 +94,9 @@ const FirefoxCom = (function FirefoxComClosure() {
       sync: false,
       responseExpected: !!callback,
     });
-      return request.dispatchEvent(sender);
+    request.dispatchEvent(sender);
-    },
+  }
-  };
+}
-})();
 
 class DownloadManager {
   downloadUrl(url, filename) {
@@ -101,58 +110,42 @@ class DownloadManager {
     const blobUrl = URL.createObjectURL(
       new Blob([data], { type: contentType })
     );
-    const onResponse = err => {
-      URL.revokeObjectURL(blobUrl);
-    };
 
-    FirefoxCom.request(
+    FirefoxCom.requestAsync("download", {
-      "download",
-      {
       blobUrl,
       originalUrl: blobUrl,
       filename,
       isAttachment: true,
-      },
+    }).then(error => {
-      onResponse
+      URL.revokeObjectURL(blobUrl);
-    );
+    });
   }
 
   download(blob, url, filename, sourceEventType = "download") {
     const blobUrl = URL.createObjectURL(blob);
-    const onResponse = err => {
-      if (err && this.onerror) {
-        this.onerror(err);
-      }
-      URL.revokeObjectURL(blobUrl);
-    };
 
-    FirefoxCom.request(
+    FirefoxCom.requestAsync("download", {
-      "download",
-      {
       blobUrl,
       originalUrl: url,
       filename,
       sourceEventType,
-      },
+    }).then(error => {
-      onResponse
+      if (error && this.onerror) {
-    );
+        this.onerror(error);
+      }
+      URL.revokeObjectURL(blobUrl);
+    });
   }
 }
 
 class FirefoxPreferences extends BasePreferences {
   async _writeToStorage(prefObj) {
-    return new Promise(function (resolve) {
+    return FirefoxCom.requestAsync("setPreferences", prefObj);
-      FirefoxCom.request("setPreferences", prefObj, resolve);
-    });
   }
 
   async _readFromStorage(prefObj) {
-    return new Promise(function (resolve) {
+    const prefStr = await FirefoxCom.requestAsync("getPreferences", prefObj);
-      FirefoxCom.request("getPreferences", prefObj, function (prefStr) {
+    return JSON.parse(prefStr);
-        const readPrefs = JSON.parse(prefStr);
-        resolve(readPrefs);
-      });
-    });
   }
 }
 
@@ -258,13 +251,10 @@ class FirefoxComDataRangeTransport extends PDFDataRangeTransport {
 
 class FirefoxScripting {
   static async createSandbox(data) {
-    return new Promise(resolve => {
+    const success = await FirefoxCom.requestAsync("createSandbox", data);
-      FirefoxCom.request("createSandbox", data, resolve);
-    }).then(success => {
     if (!success) {
       throw new Error("Cannot create sandbox.");
     }
-    });
   }
 
   static async dispatchEventInSandbox(event) {
@@ -347,9 +337,7 @@ class FirefoxExternalServices extends DefaultExternalServices {
   }
 
   static async fallback(data) {
-    return new Promise(resolve => {
+    return FirefoxCom.requestAsync("fallback", data);
-      FirefoxCom.request("fallback", data, resolve);
-    });
   }
 
   static reportTelemetry(data) {