Merge pull request #13813 from Snuffleupagus/rm-closure-API

Remove a couple of closures in the `src/display/api.js` file

src/display/api.js

@@ -524,41 +524,12 @@ function _fetchDocument(worker, source, pdfDataRangeTransport, docId) {
  * The loading task controls the operations required to load a PDF document
  * (such as network requests) and provides a way to listen for completion,
  * after which individual pages can be rendered.
- *
- * @typedef {Object} PDFDocumentLoadingTask
- * @property {string} docId - Unique identifier for the document loading task.
- * @property {boolean} destroyed - Whether the loading task is destroyed or not.
- * @property {function} [onPassword] - Callback to request a password if a wrong
- *   or no password was provided. The callback receives two parameters: a
- *   function that should be called with the new password, and a reason (see
- *   {@link PasswordResponses}).
- * @property {function} [onProgress] - Callback to be able to monitor the
- *   loading progress of the PDF file (necessary to implement e.g. a loading
- *   bar). The callback receives an {@link OnProgressParameters} argument.
- * @property {function} [onUnsupportedFeature] - Callback for when an
- *   unsupported feature is used in the PDF document. The callback receives an
- *   {@link UNSUPPORTED_FEATURES} argument.
- * @property {Promise<PDFDocumentProxy>} promise - Promise for document loading
- *   task completion.
- * @property {function} destroy - Abort all network requests and destroy
- *   the worker. Returns a promise that is resolved when destruction is
- *   completed.
  */
-
-/**
- * @type {any}
- * @ignore
- */
-const PDFDocumentLoadingTask = (function PDFDocumentLoadingTaskClosure() {
-  let nextDocumentId = 0;
-
-  /**
-   * The loading task controls the operations required to load a PDF document
-   * (such as network requests) and provides a way to listen for completion,
-   * after which individual pages can be rendered.
-   */
-  // eslint-disable-next-line no-shadow
 class PDFDocumentLoadingTask {
+  static get idCounters() {
+    return shadow(this, "idCounters", { doc: 0 });
+  }
+
   constructor() {
     this._capability = createPromiseCapability();
     this._transport = null;
@@ -568,7 +539,7 @@ const PDFDocumentLoadingTask = (function PDFDocumentLoadingTaskClosure() {
      * Unique identifier for the document loading task.
      * @type {string}
      */
-      this.docId = "d" + nextDocumentId++;
+    this.docId = `d${PDFDocumentLoadingTask.idCounters.doc++}`;
 
     /**
      * Whether the loading task is destroyed or not.
@@ -609,6 +580,7 @@ const PDFDocumentLoadingTask = (function PDFDocumentLoadingTaskClosure() {
   }
 
   /**
+   * Abort all network requests and destroy the worker.
    * @returns {Promise<void>} A promise that is resolved when destruction is
    *   completed.
    */
@@ -627,8 +599,6 @@ const PDFDocumentLoadingTask = (function PDFDocumentLoadingTaskClosure() {
     });
   }
 }
-  return PDFDocumentLoadingTask;
-})();
 
 /**
  * Abstract class to support range requests file loading.
@@ -1935,8 +1905,8 @@ class LoopbackPort {
  * @typedef {Object} PDFWorkerParameters
  * @property {string} [name] - The name of the worker.
  * @property {Object} [port] - The `workerPort` object.
- * @property {number} [verbosity] - Controls the logging level; the
- *   constants from {@link VerbosityLevel} should be used.
+ * @property {number} [verbosity] - Controls the logging level;
+ *   the constants from {@link VerbosityLevel} should be used.
  */
 
 /** @type {any} */
@@ -1953,13 +1923,11 @@ const PDFWorker = (function PDFWorkerClosure() {
       // Workers aren't supported in Node.js, force-disabling them there.
       isWorkerDisabled = true;
 
-      if (typeof PDFJSDev !== "undefined" && PDFJSDev.test("LIB")) {
-        fallbackWorkerSrc = "../pdf.worker.js";
-      } else {
-        fallbackWorkerSrc = "./pdf.worker.js";
-      }
-    } else if (typeof document === "object" && "currentScript" in document) {
-      const pdfjsFilePath = document.currentScript?.src;
+      fallbackWorkerSrc = PDFJSDev.test("LIB")
+        ? "../pdf.worker.js"
+        : "./pdf.worker.js";
+    } else if (typeof document === "object") {
+      const pdfjsFilePath = document?.currentScript?.src;
       if (pdfjsFilePath) {
         fallbackWorkerSrc = pdfjsFilePath.replace(
           /(\.(?:min\.)?js)(\?.*)?$/i,
@@ -1983,16 +1951,14 @@ const PDFWorker = (function PDFWorkerClosure() {
   }
 
   function getMainThreadWorkerMessageHandler() {
-    let mainWorkerMessageHandler;
     try {
-      mainWorkerMessageHandler = globalThis.pdfjsWorker?.WorkerMessageHandler;
+      return globalThis.pdfjsWorker?.WorkerMessageHandler || null;
     } catch (ex) {
-      /* Ignore errors. */
+      return null;
     }
-    return mainWorkerMessageHandler || null;
   }
 
-  // Loads worker code into main thread.
+  // Loads worker code into main-thread.
   function setupFakeWorkerGlobal() {
     if (fakeWorkerCapability) {
       return fakeWorkerCapability.promise;
@@ -3093,11 +3059,11 @@ class RenderTask {
  * For internal use only.
  * @ignore
  */
-const InternalRenderTask = (function InternalRenderTaskClosure() {
-  const canvasInRendering = new WeakSet();
-
-  // eslint-disable-next-line no-shadow
 class InternalRenderTask {
+  static get canvasInUse() {
+    return shadow(this, "canvasInUse", new WeakSet());
+  }
+
   constructor({
     callback,
     params,
@@ -3147,14 +3113,14 @@ const InternalRenderTask = (function InternalRenderTaskClosure() {
       return;
     }
     if (this._canvas) {
-        if (canvasInRendering.has(this._canvas)) {
+      if (InternalRenderTask.canvasInUse.has(this._canvas)) {
         throw new Error(
           "Cannot use the same canvas during multiple render() operations. " +
             "Use different canvas or ensure previous operations were " +
             "cancelled or completed."
         );
       }
-        canvasInRendering.add(this._canvas);
+      InternalRenderTask.canvasInUse.add(this._canvas);
     }
 
     if (this._pdfBug && globalThis.StepperManager?.enabled) {
@@ -3193,7 +3159,7 @@ const InternalRenderTask = (function InternalRenderTaskClosure() {
       this.gfx.endDrawing();
     }
     if (this._canvas) {
-        canvasInRendering.delete(this._canvas);
+      InternalRenderTask.canvasInUse.delete(this._canvas);
     }
     this.callback(
       error ||
@@ -3259,15 +3225,13 @@ const InternalRenderTask = (function InternalRenderTaskClosure() {
       if (this.operatorList.lastChunk) {
         this.gfx.endDrawing();
         if (this._canvas) {
-            canvasInRendering.delete(this._canvas);
+          InternalRenderTask.canvasInUse.delete(this._canvas);
         }
         this.callback();
       }
     }
   }
 }
-  return InternalRenderTask;
-})();
 
 /** @type {string} */
 const version =

test/unit/api_spec.js

@@ -385,6 +385,26 @@ describe("api", function () {
 
       await loadingTask.destroy();
     });
+
+    it("checks that `docId`s are unique and increasing", async function () {
+      const loadingTask1 = getDocument(basicApiGetDocumentParams);
+      await loadingTask1.promise;
+      const docId1 = loadingTask1.docId;
+
+      const loadingTask2 = getDocument(basicApiGetDocumentParams);
+      await loadingTask2.promise;
+      const docId2 = loadingTask2.docId;
+
+      expect(docId1).not.toEqual(docId2);
+
+      const docIdRegExp = /^d(\d)+$/,
+        docNum1 = docIdRegExp.exec(docId1)?.[1],
+        docNum2 = docIdRegExp.exec(docId2)?.[1];
+
+      expect(+docNum1).toBeLessThan(+docNum2);
+
+      await Promise.all([loadingTask1.destroy(), loadingTask2.destroy()]);
+    });
   });
 
   describe("PDFWorker", function () {