@loaders.gl/loader-utils 3.1.3 → 4.0.0-alpha.5

package/dist/lib/request-utils/request-scheduler.js

@@ -1,142 +1,146 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const stats_1 = require("@probe.gl/stats");
+import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
+import { Stats } from '@probe.gl/stats';
 const STAT_QUEUED_REQUESTS = 'Queued Requests';
 const STAT_ACTIVE_REQUESTS = 'Active Requests';
 const STAT_CANCELLED_REQUESTS = 'Cancelled Requests';
 const STAT_QUEUED_REQUESTS_EVER = 'Queued Requests Ever';
 const STAT_ACTIVE_REQUESTS_EVER = 'Active Requests Ever';
 const DEFAULT_PROPS = {
-    id: 'request-scheduler',
-    // Specifies if the request scheduler should throttle incoming requests, mainly for comparative testing
-    throttleRequests: true,
-    // The maximum number of simultaneous active requests. Un-throttled requests do not observe this limit.
-    maxRequests: 6
+  id: 'request-scheduler',
+  throttleRequests: true,
+  maxRequests: 6
 };
-/**
- * Used to issue a request, without having them "deeply queued" by the browser.
- * @todo - Track requests globally, across multiple servers
- */
-class RequestScheduler {
-    constructor(props = {}) {
-        this.activeRequestCount = 0;
-        /** Tracks the number of active requests and prioritizes/cancels queued requests. */
-        this.requestQueue = [];
-        this.requestMap = new Map();
-        this.deferredUpdate = null;
-        this.props = { ...DEFAULT_PROPS, ...props };
-        // Returns the statistics used by the request scheduler.
-        this.stats = new stats_1.Stats({ id: this.props.id });
-        this.stats.get(STAT_QUEUED_REQUESTS);
-        this.stats.get(STAT_ACTIVE_REQUESTS);
-        this.stats.get(STAT_CANCELLED_REQUESTS);
-        this.stats.get(STAT_QUEUED_REQUESTS_EVER);
-        this.stats.get(STAT_ACTIVE_REQUESTS_EVER);
+export default class RequestScheduler {
+  constructor(props = {}) {
+    _defineProperty(this, "props", void 0);
+
+    _defineProperty(this, "stats", void 0);
+
+    _defineProperty(this, "activeRequestCount", 0);
+
+    _defineProperty(this, "requestQueue", []);
+
+    _defineProperty(this, "requestMap", new Map());
+
+    _defineProperty(this, "deferredUpdate", null);
+
+    this.props = { ...DEFAULT_PROPS,
+      ...props
+    };
+    this.stats = new Stats({
+      id: this.props.id
+    });
+    this.stats.get(STAT_QUEUED_REQUESTS);
+    this.stats.get(STAT_ACTIVE_REQUESTS);
+    this.stats.get(STAT_CANCELLED_REQUESTS);
+    this.stats.get(STAT_QUEUED_REQUESTS_EVER);
+    this.stats.get(STAT_ACTIVE_REQUESTS_EVER);
+  }
+
+  scheduleRequest(handle, getPriority = () => 0) {
+    if (!this.props.throttleRequests) {
+      return Promise.resolve({
+        done: () => {}
+      });
     }
-    /**
-     * Called by an application that wants to issue a request, without having it deeply queued by the browser
-     *
-     * When the returned promise resolved, it is OK for the application to issue a request.
-     * The promise resolves to an object that contains a `done` method.
-     * When the application's request has completed (or failed), the application must call the `done` function
-     *
-     * @param handle
-     * @param getPriority will be called when request "slots" open up,
-     *    allowing the caller to update priority or cancel the request
-     *    Highest priority executes first, priority < 0 cancels the request
-     * @returns a promise
-     *   - resolves to a object (with a `done` field) when the request can be issued without queueing,
-     *   - resolves to `null` if the request has been cancelled (by the callback return < 0).
-     *     In this case the application should not issue the request
-     */
-    scheduleRequest(handle, getPriority = () => 0) {
-        // Allows throttling to be disabled
-        if (!this.props.throttleRequests) {
-            return Promise.resolve({ done: () => { } });
-        }
-        // dedupe
-        if (this.requestMap.has(handle)) {
-            return this.requestMap.get(handle);
-        }
-        const request = { handle, priority: 0, getPriority };
-        const promise = new Promise((resolve) => {
-            // @ts-ignore
-            request.resolve = resolve;
-            return request;
-        });
-        this.requestQueue.push(request);
-        this.requestMap.set(handle, promise);
-        this._issueNewRequests();
-        return promise;
+
+    if (this.requestMap.has(handle)) {
+      return this.requestMap.get(handle);
     }
-    // PRIVATE
-    _issueRequest(request) {
-        const { handle, resolve } = request;
-        let isDone = false;
-        const done = () => {
-            // can only be called once
-            if (!isDone) {
-                isDone = true;
-                // Stop tracking a request - it has completed, failed, cancelled etc
-                this.requestMap.delete(handle);
-                this.activeRequestCount--;
-                // A slot just freed up, see if any queued requests are waiting
-                this._issueNewRequests();
-            }
-        };
-        // Track this request
-        this.activeRequestCount++;
-        return resolve ? resolve({ done }) : Promise.resolve({ done });
+
+    const request = {
+      handle,
+      priority: 0,
+      getPriority
+    };
+    const promise = new Promise(resolve => {
+      request.resolve = resolve;
+      return request;
+    });
+    this.requestQueue.push(request);
+    this.requestMap.set(handle, promise);
+
+    this._issueNewRequests();
+
+    return promise;
+  }
+
+  _issueRequest(request) {
+    const {
+      handle,
+      resolve
+    } = request;
+    let isDone = false;
+
+    const done = () => {
+      if (!isDone) {
+        isDone = true;
+        this.requestMap.delete(handle);
+        this.activeRequestCount--;
+
+        this._issueNewRequests();
+      }
+    };
+
+    this.activeRequestCount++;
+    return resolve ? resolve({
+      done
+    }) : Promise.resolve({
+      done
+    });
+  }
+
+  _issueNewRequests() {
+    if (!this.deferredUpdate) {
+      this.deferredUpdate = setTimeout(() => this._issueNewRequestsAsync(), 0);
     }
-    /** We check requests asynchronously, to prevent multiple updates */
-    _issueNewRequests() {
-        if (!this.deferredUpdate) {
-            this.deferredUpdate = setTimeout(() => this._issueNewRequestsAsync(), 0);
-        }
+  }
+
+  _issueNewRequestsAsync() {
+    this.deferredUpdate = null;
+    const freeSlots = Math.max(this.props.maxRequests - this.activeRequestCount, 0);
+
+    if (freeSlots === 0) {
+      return;
     }
-    /** Refresh all requests  */
-    _issueNewRequestsAsync() {
-        // TODO - shouldn't we clear the timeout?
-        this.deferredUpdate = null;
-        const freeSlots = Math.max(this.props.maxRequests - this.activeRequestCount, 0);
-        if (freeSlots === 0) {
-            return;
-        }
-        this._updateAllRequests();
-        // Resolve pending promises for the top-priority requests
-        for (let i = 0; i < freeSlots; ++i) {
-            const request = this.requestQueue.shift();
-            if (request) {
-                this._issueRequest(request); // eslint-disable-line @typescript-eslint/no-floating-promises
-            }
-        }
-        // Uncomment to debug
-        // console.log(`${freeSlots} free slots, ${this.requestQueue.length} queued requests`);
+
+    this._updateAllRequests();
+
+    for (let i = 0; i < freeSlots; ++i) {
+      const request = this.requestQueue.shift();
+
+      if (request) {
+        this._issueRequest(request);
+      }
     }
-    /** Ensure all requests have updated priorities, and that no longer valid requests are cancelled */
-    _updateAllRequests() {
-        const requestQueue = this.requestQueue;
-        for (let i = 0; i < requestQueue.length; ++i) {
-            const request = requestQueue[i];
-            if (!this._updateRequest(request)) {
-                // Remove the element and make sure to adjust the counter to account for shortened array
-                requestQueue.splice(i, 1);
-                this.requestMap.delete(request.handle);
-                i--;
-            }
-        }
-        // Sort the remaining requests based on priority
-        requestQueue.sort((a, b) => a.priority - b.priority);
+  }
+
+  _updateAllRequests() {
+    const requestQueue = this.requestQueue;
+
+    for (let i = 0; i < requestQueue.length; ++i) {
+      const request = requestQueue[i];
+
+      if (!this._updateRequest(request)) {
+        requestQueue.splice(i, 1);
+        this.requestMap.delete(request.handle);
+        i--;
+      }
     }
-    /** Update a single request by calling the callback */
-    _updateRequest(request) {
-        request.priority = request.getPriority(request.handle); // eslint-disable-line callback-return
-        // by returning a negative priority, the callback cancels the request
-        if (request.priority < 0) {
-            request.resolve(null);
-            return false;
-        }
-        return true;
+
+    requestQueue.sort((a, b) => a.priority - b.priority);
+  }
+
+  _updateRequest(request) {
+    request.priority = request.getPriority(request.handle);
+
+    if (request.priority < 0) {
+      request.resolve(null);
+      return false;
     }
+
+    return true;
+  }
+
 }
-exports.default = RequestScheduler;
+//# sourceMappingURL=request-scheduler.js.map

package/dist/lib/request-utils/request-scheduler.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/request-utils/request-scheduler.ts"],"names":["Stats","STAT_QUEUED_REQUESTS","STAT_ACTIVE_REQUESTS","STAT_CANCELLED_REQUESTS","STAT_QUEUED_REQUESTS_EVER","STAT_ACTIVE_REQUESTS_EVER","DEFAULT_PROPS","id","throttleRequests","maxRequests","RequestScheduler","constructor","props","Map","stats","get","scheduleRequest","handle","getPriority","Promise","resolve","done","requestMap","has","request","priority","promise","requestQueue","push","set","_issueNewRequests","_issueRequest","isDone","delete","activeRequestCount","deferredUpdate","setTimeout","_issueNewRequestsAsync","freeSlots","Math","max","_updateAllRequests","i","shift","length","_updateRequest","splice","sort","a","b"],"mappings":";AAAA,SAAQA,KAAR,QAAoB,iBAApB;AAgBA,MAAMC,oBAAoB,GAAG,iBAA7B;AACA,MAAMC,oBAAoB,GAAG,iBAA7B;AACA,MAAMC,uBAAuB,GAAG,oBAAhC;AACA,MAAMC,yBAAyB,GAAG,sBAAlC;AACA,MAAMC,yBAAyB,GAAG,sBAAlC;AAEA,MAAMC,aAA8C,GAAG;AACrDC,EAAAA,EAAE,EAAE,mBADiD;AAGrDC,EAAAA,gBAAgB,EAAE,IAHmC;AAKrDC,EAAAA,WAAW,EAAE;AALwC,CAAvD;AAoBA,eAAe,MAAMC,gBAAN,CAAuB;AAUpCC,EAAAA,WAAW,CAACC,KAA4B,GAAG,EAAhC,EAAoC;AAAA;;AAAA;;AAAA,gDAPlB,CAOkB;;AAAA,0CAJb,EAIa;;AAAA,wCAHW,IAAIC,GAAJ,EAGX;;AAAA,4CAFjB,IAEiB;;AAC7C,SAAKD,KAAL,GAAa,EAAC,GAAGN,aAAJ;AAAmB,SAAGM;AAAtB,KAAb;AAGA,SAAKE,KAAL,GAAa,IAAId,KAAJ,CAAU;AAACO,MAAAA,EAAE,EAAE,KAAKK,KAAL,CAAWL;AAAhB,KAAV,CAAb;AACA,SAAKO,KAAL,CAAWC,GAAX,CAAed,oBAAf;AACA,SAAKa,KAAL,CAAWC,GAAX,CAAeb,oBAAf;AACA,SAAKY,KAAL,CAAWC,GAAX,CAAeZ,uBAAf;AACA,SAAKW,KAAL,CAAWC,GAAX,CAAeX,yBAAf;AACA,SAAKU,KAAL,CAAWC,GAAX,CAAeV,yBAAf;AACD;;AAkBDW,EAAAA,eAAe,CACbC,MADa,EAEbC,WAAgC,GAAG,MAAM,CAF5B,EAGW;AAExB,QAAI,CAAC,KAAKN,KAAL,CAAWJ,gBAAhB,EAAkC;AAChC,aAAOW,OAAO,CAACC,OAAR,CAAgB;AAACC,QAAAA,IAAI,EAAE,MAAM,CAAE;AAAf,OAAhB,CAAP;AACD;;AAGD,QAAI,KAAKC,UAAL,CAAgBC,GAAhB,CAAoBN,MAApB,CAAJ,EAAiC;AAC/B,aAAO,KAAKK,UAAL,CAAgBP,GAAhB,CAAoBE,MAApB,CAAP;AACD;;AAED,UAAMO,OAAgB,GAAG;AAACP,MAAAA,MAAD;AAASQ,MAAAA,QAAQ,EAAE,CAAnB;AAAsBP,MAAAA;AAAtB,KAAzB;AACA,UAAMQ,OAAO,GAAG,IAAIP,OAAJ,CAA4BC,OAAD,IAAa;AAEtDI,MAAAA,OAAO,CAACJ,OAAR,GAAkBA,OAAlB;AACA,aAAOI,OAAP;AACD,KAJe,CAAhB;AAMA,SAAKG,YAAL,CAAkBC,IAAlB,CAAuBJ,OAAvB;AACA,SAAKF,UAAL,CAAgBO,GAAhB,CAAoBZ,MAApB,EAA4BS,OAA5B;;AACA,SAAKI,iBAAL;;AACA,WAAOJ,OAAP;AACD;;AAIDK,EAAAA,aAAa,CAACP,OAAD,EAAiC;AAC5C,UAAM;AAACP,MAAAA,MAAD;AAASG,MAAAA;AAAT,QAAoBI,OAA1B;AACA,QAAIQ,MAAM,GAAG,KAAb;;AAEA,UAAMX,IAAI,GAAG,MAAM;AAEjB,UAAI,CAACW,MAAL,EAAa;AACXA,QAAAA,MAAM,GAAG,IAAT;AAGA,aAAKV,UAAL,CAAgBW,MAAhB,CAAuBhB,MAAvB;AACA,aAAKiB,kBAAL;;AAEA,aAAKJ,iBAAL;AACD;AACF,KAXD;;AAcA,SAAKI,kBAAL;AAEA,WAAOd,OAAO,GAAGA,OAAO,CAAC;AAACC,MAAAA;AAAD,KAAD,CAAV,GAAqBF,OAAO,CAACC,OAAR,CAAgB;AAACC,MAAAA;AAAD,KAAhB,CAAnC;AACD;;AAGDS,EAAAA,iBAAiB,GAAS;AACxB,QAAI,CAAC,KAAKK,cAAV,EAA0B;AACxB,WAAKA,cAAL,GAAsBC,UAAU,CAAC,MAAM,KAAKC,sBAAL,EAAP,EAAsC,CAAtC,CAAhC;AACD;AACF;;AAGDA,EAAAA,sBAAsB,GAAG;AAEvB,SAAKF,cAAL,GAAsB,IAAtB;AAEA,UAAMG,SAAS,GAAGC,IAAI,CAACC,GAAL,CAAS,KAAK5B,KAAL,CAAWH,WAAX,GAAyB,KAAKyB,kBAAvC,EAA2D,CAA3D,CAAlB;;AAEA,QAAII,SAAS,KAAK,CAAlB,EAAqB;AACnB;AACD;;AAED,SAAKG,kBAAL;;AAGA,SAAK,IAAIC,CAAC,GAAG,CAAb,EAAgBA,CAAC,GAAGJ,SAApB,EAA+B,EAAEI,CAAjC,EAAoC;AAClC,YAAMlB,OAAO,GAAG,KAAKG,YAAL,CAAkBgB,KAAlB,EAAhB;;AACA,UAAInB,OAAJ,EAAa;AACX,aAAKO,aAAL,CAAmBP,OAAnB;AACD;AACF;AAIF;;AAGDiB,EAAAA,kBAAkB,GAAG;AACnB,UAAMd,YAAY,GAAG,KAAKA,YAA1B;;AACA,SAAK,IAAIe,CAAC,GAAG,CAAb,EAAgBA,CAAC,GAAGf,YAAY,CAACiB,MAAjC,EAAyC,EAAEF,CAA3C,EAA8C;AAC5C,YAAMlB,OAAO,GAAGG,YAAY,CAACe,CAAD,CAA5B;;AACA,UAAI,CAAC,KAAKG,cAAL,CAAoBrB,OAApB,CAAL,EAAmC;AAEjCG,QAAAA,YAAY,CAACmB,MAAb,CAAoBJ,CAApB,EAAuB,CAAvB;AACA,aAAKpB,UAAL,CAAgBW,MAAhB,CAAuBT,OAAO,CAACP,MAA/B;AACAyB,QAAAA,CAAC;AACF;AACF;;AAGDf,IAAAA,YAAY,CAACoB,IAAb,CAAkB,CAACC,CAAD,EAAIC,CAAJ,KAAUD,CAAC,CAACvB,QAAF,GAAawB,CAAC,CAACxB,QAA3C;AACD;;AAGDoB,EAAAA,cAAc,CAACrB,OAAD,EAAU;AACtBA,IAAAA,OAAO,CAACC,QAAR,GAAmBD,OAAO,CAACN,WAAR,CAAoBM,OAAO,CAACP,MAA5B,CAAnB;;AAGA,QAAIO,OAAO,CAACC,QAAR,GAAmB,CAAvB,EAA0B;AACxBD,MAAAA,OAAO,CAACJ,OAAR,CAAgB,IAAhB;AACA,aAAO,KAAP;AACD;;AACD,WAAO,IAAP;AACD;;AArJmC","sourcesContent":["import {Stats} from '@probe.gl/stats';\n\ntype Handle = any;\ntype DoneFunction = () => any;\ntype GetPriorityFunction = () => number;\ntype RequestResult = {\n  done: DoneFunction;\n} | null;\n\n/** RequestScheduler Options */\nexport type RequestSchedulerProps = {\n  id?: string;\n  throttleRequests?: boolean;\n  maxRequests?: number;\n};\n\nconst STAT_QUEUED_REQUESTS = 'Queued Requests';\nconst STAT_ACTIVE_REQUESTS = 'Active Requests';\nconst STAT_CANCELLED_REQUESTS = 'Cancelled Requests';\nconst STAT_QUEUED_REQUESTS_EVER = 'Queued Requests Ever';\nconst STAT_ACTIVE_REQUESTS_EVER = 'Active Requests Ever';\n\nconst DEFAULT_PROPS: Required<RequestSchedulerProps> = {\n  id: 'request-scheduler',\n  // Specifies if the request scheduler should throttle incoming requests, mainly for comparative testing\n  throttleRequests: true,\n  // The maximum number of simultaneous active requests. Un-throttled requests do not observe this limit.\n  maxRequests: 6\n};\n\n/** Tracks one request */\ntype Request = {\n  handle: Handle;\n  priority: number;\n  getPriority: GetPriorityFunction;\n  resolve?: (value: any) => any;\n};\n\n/**\n * Used to issue a request, without having them \"deeply queued\" by the browser.\n * @todo - Track requests globally, across multiple servers\n */\nexport default class RequestScheduler {\n  readonly props: Required<RequestSchedulerProps>;\n  readonly stats: Stats;\n  activeRequestCount: number = 0;\n\n  /** Tracks the number of active requests and prioritizes/cancels queued requests. */\n  private requestQueue: Request[] = [];\n  private requestMap: Map<Handle, Promise<RequestResult>> = new Map();\n  private deferredUpdate: any = null;\n\n  constructor(props: RequestSchedulerProps = {}) {\n    this.props = {...DEFAULT_PROPS, ...props};\n\n    // Returns the statistics used by the request scheduler.\n    this.stats = new Stats({id: this.props.id});\n    this.stats.get(STAT_QUEUED_REQUESTS);\n    this.stats.get(STAT_ACTIVE_REQUESTS);\n    this.stats.get(STAT_CANCELLED_REQUESTS);\n    this.stats.get(STAT_QUEUED_REQUESTS_EVER);\n    this.stats.get(STAT_ACTIVE_REQUESTS_EVER);\n  }\n\n  /**\n   * Called by an application that wants to issue a request, without having it deeply queued by the browser\n   *\n   * When the returned promise resolved, it is OK for the application to issue a request.\n   * The promise resolves to an object that contains a `done` method.\n   * When the application's request has completed (or failed), the application must call the `done` function\n   *\n   * @param handle\n   * @param getPriority will be called when request \"slots\" open up,\n   *    allowing the caller to update priority or cancel the request\n   *    Highest priority executes first, priority < 0 cancels the request\n   * @returns a promise\n   *   - resolves to a object (with a `done` field) when the request can be issued without queueing,\n   *   - resolves to `null` if the request has been cancelled (by the callback return < 0).\n   *     In this case the application should not issue the request\n   */\n  scheduleRequest(\n    handle: Handle,\n    getPriority: GetPriorityFunction = () => 0\n  ): Promise<RequestResult> {\n    // Allows throttling to be disabled\n    if (!this.props.throttleRequests) {\n      return Promise.resolve({done: () => {}});\n    }\n\n    // dedupe\n    if (this.requestMap.has(handle)) {\n      return this.requestMap.get(handle) as Promise<any>;\n    }\n\n    const request: Request = {handle, priority: 0, getPriority};\n    const promise = new Promise<RequestResult>((resolve) => {\n      // @ts-ignore\n      request.resolve = resolve;\n      return request;\n    });\n\n    this.requestQueue.push(request);\n    this.requestMap.set(handle, promise);\n    this._issueNewRequests();\n    return promise;\n  }\n\n  // PRIVATE\n\n  _issueRequest(request: Request): Promise<any> {\n    const {handle, resolve} = request;\n    let isDone = false;\n\n    const done = () => {\n      // can only be called once\n      if (!isDone) {\n        isDone = true;\n\n        // Stop tracking a request - it has completed, failed, cancelled etc\n        this.requestMap.delete(handle);\n        this.activeRequestCount--;\n        // A slot just freed up, see if any queued requests are waiting\n        this._issueNewRequests();\n      }\n    };\n\n    // Track this request\n    this.activeRequestCount++;\n\n    return resolve ? resolve({done}) : Promise.resolve({done});\n  }\n\n  /** We check requests asynchronously, to prevent multiple updates */\n  _issueNewRequests(): void {\n    if (!this.deferredUpdate) {\n      this.deferredUpdate = setTimeout(() => this._issueNewRequestsAsync(), 0);\n    }\n  }\n\n  /** Refresh all requests  */\n  _issueNewRequestsAsync() {\n    // TODO - shouldn't we clear the timeout?\n    this.deferredUpdate = null;\n\n    const freeSlots = Math.max(this.props.maxRequests - this.activeRequestCount, 0);\n\n    if (freeSlots === 0) {\n      return;\n    }\n\n    this._updateAllRequests();\n\n    // Resolve pending promises for the top-priority requests\n    for (let i = 0; i < freeSlots; ++i) {\n      const request = this.requestQueue.shift();\n      if (request) {\n        this._issueRequest(request); // eslint-disable-line @typescript-eslint/no-floating-promises\n      }\n    }\n\n    // Uncomment to debug\n    // console.log(`${freeSlots} free slots, ${this.requestQueue.length} queued requests`);\n  }\n\n  /** Ensure all requests have updated priorities, and that no longer valid requests are cancelled */\n  _updateAllRequests() {\n    const requestQueue = this.requestQueue;\n    for (let i = 0; i < requestQueue.length; ++i) {\n      const request = requestQueue[i];\n      if (!this._updateRequest(request)) {\n        // Remove the element and make sure to adjust the counter to account for shortened array\n        requestQueue.splice(i, 1);\n        this.requestMap.delete(request.handle);\n        i--;\n      }\n    }\n\n    // Sort the remaining requests based on priority\n    requestQueue.sort((a, b) => a.priority - b.priority);\n  }\n\n  /** Update a single request by calling the callback */\n  _updateRequest(request) {\n    request.priority = request.getPriority(request.handle); // eslint-disable-line callback-return\n\n    // by returning a negative priority, the callback cancels the request\n    if (request.priority < 0) {\n      request.resolve(null);\n      return false;\n    }\n    return true;\n  }\n}\n"],"file":"request-scheduler.js"}

package/dist/lib/worker-loader-utils/create-loader-worker.js

@@ -1,97 +1,102 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createLoaderWorker = void 0;
-const worker_utils_1 = require("@loaders.gl/worker-utils");
-// import {validateLoaderVersion} from './validate-loader-version.js';
+import { WorkerBody } from '@loaders.gl/worker-utils';
 let requestId = 0;
-/**
- * Set up a WebWorkerGlobalScope to talk with the main thread
- * @param loader
- */
-function createLoaderWorker(loader) {
-    // Check that we are actually in a worker thread
-    if (typeof self === 'undefined') {
-        return;
-    }
-    worker_utils_1.WorkerBody.onmessage = async (type, payload) => {
-        switch (type) {
-            case 'process':
-                try {
-                    // validateLoaderVersion(loader, data.source.split('@')[1]);
-                    const { input, options = {} } = payload;
-                    const result = await parseData({
-                        loader,
-                        arrayBuffer: input,
-                        options,
-                        context: {
-                            parse: parseOnMainThread
-                        }
-                    });
-                    worker_utils_1.WorkerBody.postMessage('done', { result });
-                }
-                catch (error) {
-                    const message = error instanceof Error ? error.message : '';
-                    worker_utils_1.WorkerBody.postMessage('error', { error: message });
-                }
-                break;
-            default:
+export function createLoaderWorker(loader) {
+  if (typeof self === 'undefined') {
+    return;
+  }
+
+  WorkerBody.onmessage = async (type, payload) => {
+    switch (type) {
+      case 'process':
+        try {
+          const {
+            input,
+            options = {}
+          } = payload;
+          const result = await parseData({
+            loader,
+            arrayBuffer: input,
+            options,
+            context: {
+              parse: parseOnMainThread
+            }
+          });
+          WorkerBody.postMessage('done', {
+            result
+          });
+        } catch (error) {
+          const message = error instanceof Error ? error.message : '';
+          WorkerBody.postMessage('error', {
+            error: message
+          });
         }
-    };
+
+        break;
+
+      default:
+    }
+  };
 }
-exports.createLoaderWorker = createLoaderWorker;
+
 function parseOnMainThread(arrayBuffer, options) {
-    return new Promise((resolve, reject) => {
-        const id = requestId++;
-        /**
-         */
-        const onMessage = (type, payload) => {
-            if (payload.id !== id) {
-                // not ours
-                return;
-            }
-            switch (type) {
-                case 'done':
-                    worker_utils_1.WorkerBody.removeEventListener(onMessage);
-                    resolve(payload.result);
-                    break;
-                case 'error':
-                    worker_utils_1.WorkerBody.removeEventListener(onMessage);
-                    reject(payload.error);
-                    break;
-                default:
-                // ignore
-            }
-        };
-        worker_utils_1.WorkerBody.addEventListener(onMessage);
-        // Ask the main thread to decode data
-        const payload = { id, input: arrayBuffer, options };
-        worker_utils_1.WorkerBody.postMessage('process', payload);
-    });
-}
-// TODO - Support byteOffset and byteLength (enabling parsing of embedded binaries without copies)
-// TODO - Why not support async loader.parse* funcs here?
-// TODO - Why not reuse a common function instead of reimplementing loader.parse* selection logic? Keeping loader small?
-// TODO - Lack of appropriate parser functions can be detected when we create worker, no need to wait until parse
-async function parseData({ loader, arrayBuffer, options, context }) {
-    let data;
-    let parser;
-    if (loader.parseSync || loader.parse) {
-        data = arrayBuffer;
-        parser = loader.parseSync || loader.parse;
-    }
-    else if (loader.parseTextSync) {
-        const textDecoder = new TextDecoder();
-        data = textDecoder.decode(arrayBuffer);
-        parser = loader.parseTextSync;
-    }
-    else {
-        throw new Error(`Could not load data with ${loader.name} loader`);
-    }
-    // TODO - proper merge in of loader options...
-    options = {
-        ...options,
-        modules: (loader && loader.options && loader.options.modules) || {},
-        worker: false
+  return new Promise((resolve, reject) => {
+    const id = requestId++;
+
+    const onMessage = (type, payload) => {
+      if (payload.id !== id) {
+        return;
+      }
+
+      switch (type) {
+        case 'done':
+          WorkerBody.removeEventListener(onMessage);
+          resolve(payload.result);
+          break;
+
+        case 'error':
+          WorkerBody.removeEventListener(onMessage);
+          reject(payload.error);
+          break;
+
+        default:
+      }
+    };
+
+    WorkerBody.addEventListener(onMessage);
+    const payload = {
+      id,
+      input: arrayBuffer,
+      options
     };
-    return await parser(data, { ...options }, context, loader);
+    WorkerBody.postMessage('process', payload);
+  });
+}
+
+async function parseData({
+  loader,
+  arrayBuffer,
+  options,
+  context
+}) {
+  let data;
+  let parser;
+
+  if (loader.parseSync || loader.parse) {
+    data = arrayBuffer;
+    parser = loader.parseSync || loader.parse;
+  } else if (loader.parseTextSync) {
+    const textDecoder = new TextDecoder();
+    data = textDecoder.decode(arrayBuffer);
+    parser = loader.parseTextSync;
+  } else {
+    throw new Error("Could not load data with ".concat(loader.name, " loader"));
+  }
+
+  options = { ...options,
+    modules: loader && loader.options && loader.options.modules || {},
+    worker: false
+  };
+  return await parser(data, { ...options
+  }, context, loader);
 }
+//# sourceMappingURL=create-loader-worker.js.map

package/dist/lib/worker-loader-utils/create-loader-worker.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/worker-loader-utils/create-loader-worker.ts"],"names":["WorkerBody","requestId","createLoaderWorker","loader","self","onmessage","type","payload","input","options","result","parseData","arrayBuffer","context","parse","parseOnMainThread","postMessage","error","message","Error","Promise","resolve","reject","id","onMessage","removeEventListener","addEventListener","data","parser","parseSync","parseTextSync","textDecoder","TextDecoder","decode","name","modules","worker"],"mappings":"AAEA,SAAQA,UAAR,QAAyB,0BAAzB;AAGA,IAAIC,SAAS,GAAG,CAAhB;AAMA,OAAO,SAASC,kBAAT,CAA4BC,MAA5B,EAAsD;AAE3D,MAAI,OAAOC,IAAP,KAAgB,WAApB,EAAiC;AAC/B;AACD;;AAEDJ,EAAAA,UAAU,CAACK,SAAX,GAAuB,OAAOC,IAAP,EAAaC,OAAb,KAAyB;AAC9C,YAAQD,IAAR;AACE,WAAK,SAAL;AACE,YAAI;AAGF,gBAAM;AAACE,YAAAA,KAAD;AAAQC,YAAAA,OAAO,GAAG;AAAlB,cAAwBF,OAA9B;AAEA,gBAAMG,MAAM,GAAG,MAAMC,SAAS,CAAC;AAC7BR,YAAAA,MAD6B;AAE7BS,YAAAA,WAAW,EAAEJ,KAFgB;AAG7BC,YAAAA,OAH6B;AAI7BI,YAAAA,OAAO,EAAE;AACPC,cAAAA,KAAK,EAAEC;AADA;AAJoB,WAAD,CAA9B;AAQAf,UAAAA,UAAU,CAACgB,WAAX,CAAuB,MAAvB,EAA+B;AAACN,YAAAA;AAAD,WAA/B;AACD,SAdD,CAcE,OAAOO,KAAP,EAAc;AACd,gBAAMC,OAAO,GAAGD,KAAK,YAAYE,KAAjB,GAAyBF,KAAK,CAACC,OAA/B,GAAyC,EAAzD;AACAlB,UAAAA,UAAU,CAACgB,WAAX,CAAuB,OAAvB,EAAgC;AAACC,YAAAA,KAAK,EAAEC;AAAR,WAAhC;AACD;;AACD;;AACF;AArBF;AAuBD,GAxBD;AAyBD;;AAED,SAASH,iBAAT,CAA2BH,WAA3B,EAAqDH,OAArD,EAAmG;AACjG,SAAO,IAAIW,OAAJ,CAAY,CAACC,OAAD,EAAUC,MAAV,KAAqB;AACtC,UAAMC,EAAE,GAAGtB,SAAS,EAApB;;AAIA,UAAMuB,SAAS,GAAG,CAAClB,IAAD,EAAOC,OAAP,KAAmB;AACnC,UAAIA,OAAO,CAACgB,EAAR,KAAeA,EAAnB,EAAuB;AAErB;AACD;;AAED,cAAQjB,IAAR;AACE,aAAK,MAAL;AACEN,UAAAA,UAAU,CAACyB,mBAAX,CAA+BD,SAA/B;AACAH,UAAAA,OAAO,CAACd,OAAO,CAACG,MAAT,CAAP;AACA;;AAEF,aAAK,OAAL;AACEV,UAAAA,UAAU,CAACyB,mBAAX,CAA+BD,SAA/B;AACAF,UAAAA,MAAM,CAACf,OAAO,CAACU,KAAT,CAAN;AACA;;AAEF;AAXF;AAcD,KApBD;;AAsBAjB,IAAAA,UAAU,CAAC0B,gBAAX,CAA4BF,SAA5B;AAGA,UAAMjB,OAAO,GAAG;AAACgB,MAAAA,EAAD;AAAKf,MAAAA,KAAK,EAAEI,WAAZ;AAAyBH,MAAAA;AAAzB,KAAhB;AACAT,IAAAA,UAAU,CAACgB,WAAX,CAAuB,SAAvB,EAAkCT,OAAlC;AACD,GAhCM,CAAP;AAiCD;;AAMD,eAAeI,SAAf,CAAyB;AAACR,EAAAA,MAAD;AAASS,EAAAA,WAAT;AAAsBH,EAAAA,OAAtB;AAA+BI,EAAAA;AAA/B,CAAzB,EAAkE;AAChE,MAAIc,IAAJ;AACA,MAAIC,MAAJ;;AACA,MAAIzB,MAAM,CAAC0B,SAAP,IAAoB1B,MAAM,CAACW,KAA/B,EAAsC;AACpCa,IAAAA,IAAI,GAAGf,WAAP;AACAgB,IAAAA,MAAM,GAAGzB,MAAM,CAAC0B,SAAP,IAAoB1B,MAAM,CAACW,KAApC;AACD,GAHD,MAGO,IAAIX,MAAM,CAAC2B,aAAX,EAA0B;AAC/B,UAAMC,WAAW,GAAG,IAAIC,WAAJ,EAApB;AACAL,IAAAA,IAAI,GAAGI,WAAW,CAACE,MAAZ,CAAmBrB,WAAnB,CAAP;AACAgB,IAAAA,MAAM,GAAGzB,MAAM,CAAC2B,aAAhB;AACD,GAJM,MAIA;AACL,UAAM,IAAIX,KAAJ,oCAAsChB,MAAM,CAAC+B,IAA7C,aAAN;AACD;;AAGDzB,EAAAA,OAAO,GAAG,EACR,GAAGA,OADK;AAER0B,IAAAA,OAAO,EAAGhC,MAAM,IAAIA,MAAM,CAACM,OAAjB,IAA4BN,MAAM,CAACM,OAAP,CAAe0B,OAA5C,IAAwD,EAFzD;AAGRC,IAAAA,MAAM,EAAE;AAHA,GAAV;AAMA,SAAO,MAAMR,MAAM,CAACD,IAAD,EAAO,EAAC,GAAGlB;AAAJ,GAAP,EAAqBI,OAArB,EAA8BV,MAA9B,CAAnB;AACD","sourcesContent":["/* eslint-disable no-restricted-globals */\nimport type {LoaderWithParser} from '../../types';\nimport {WorkerBody} from '@loaders.gl/worker-utils';\n// import {validateLoaderVersion} from './validate-loader-version';\n\nlet requestId = 0;\n\n/**\n * Set up a WebWorkerGlobalScope to talk with the main thread\n * @param loader\n */\nexport function createLoaderWorker(loader: LoaderWithParser) {\n  // Check that we are actually in a worker thread\n  if (typeof self === 'undefined') {\n    return;\n  }\n\n  WorkerBody.onmessage = async (type, payload) => {\n    switch (type) {\n      case 'process':\n        try {\n          // validateLoaderVersion(loader, data.source.split('@')[1]);\n\n          const {input, options = {}} = payload;\n\n          const result = await parseData({\n            loader,\n            arrayBuffer: input,\n            options,\n            context: {\n              parse: parseOnMainThread\n            }\n          });\n          WorkerBody.postMessage('done', {result});\n        } catch (error) {\n          const message = error instanceof Error ? error.message : '';\n          WorkerBody.postMessage('error', {error: message});\n        }\n        break;\n      default:\n    }\n  };\n}\n\nfunction parseOnMainThread(arrayBuffer: ArrayBuffer, options: {[key: string]: any}): Promise<void> {\n  return new Promise((resolve, reject) => {\n    const id = requestId++;\n\n    /**\n     */\n    const onMessage = (type, payload) => {\n      if (payload.id !== id) {\n        // not ours\n        return;\n      }\n\n      switch (type) {\n        case 'done':\n          WorkerBody.removeEventListener(onMessage);\n          resolve(payload.result);\n          break;\n\n        case 'error':\n          WorkerBody.removeEventListener(onMessage);\n          reject(payload.error);\n          break;\n\n        default:\n        // ignore\n      }\n    };\n\n    WorkerBody.addEventListener(onMessage);\n\n    // Ask the main thread to decode data\n    const payload = {id, input: arrayBuffer, options};\n    WorkerBody.postMessage('process', payload);\n  });\n}\n\n// TODO - Support byteOffset and byteLength (enabling parsing of embedded binaries without copies)\n// TODO - Why not support async loader.parse* funcs here?\n// TODO - Why not reuse a common function instead of reimplementing loader.parse* selection logic? Keeping loader small?\n// TODO - Lack of appropriate parser functions can be detected when we create worker, no need to wait until parse\nasync function parseData({loader, arrayBuffer, options, context}) {\n  let data;\n  let parser;\n  if (loader.parseSync || loader.parse) {\n    data = arrayBuffer;\n    parser = loader.parseSync || loader.parse;\n  } else if (loader.parseTextSync) {\n    const textDecoder = new TextDecoder();\n    data = textDecoder.decode(arrayBuffer);\n    parser = loader.parseTextSync;\n  } else {\n    throw new Error(`Could not load data with ${loader.name} loader`);\n  }\n\n  // TODO - proper merge in of loader options...\n  options = {\n    ...options,\n    modules: (loader && loader.options && loader.options.modules) || {},\n    worker: false\n  };\n\n  return await parser(data, {...options}, context, loader);\n}\n"],"file":"create-loader-worker.js"}

package/dist/lib/worker-loader-utils/parse-with-worker.js

@@ -1,73 +1,64 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseWithWorker = exports.canParseWithWorker = void 0;
-const worker_utils_1 = require("@loaders.gl/worker-utils");
-/**
- * Determines if a loader can parse with worker
- * @param loader
- * @param options
- */
-function canParseWithWorker(loader, options) {
-    if (!worker_utils_1.WorkerFarm.isSupported()) {
-        return false;
-    }
-    return loader.worker && options?.worker;
+import { WorkerFarm, getWorkerURL } from '@loaders.gl/worker-utils';
+export function canParseWithWorker(loader, options) {
+  if (!WorkerFarm.isSupported()) {
+    return false;
+  }
+
+  return loader.worker && (options === null || options === void 0 ? void 0 : options.worker);
 }
-exports.canParseWithWorker = canParseWithWorker;
-/**
- * this function expects that the worker function sends certain messages,
- * this can be automated if the worker is wrapper by a call to createLoaderWorker in @loaders.gl/loader-utils.
- */
-async function parseWithWorker(loader, data, options, context, parseOnMainThread) {
-    const name = loader.id; // TODO
-    const url = (0, worker_utils_1.getWorkerURL)(loader, options);
-    const workerFarm = worker_utils_1.WorkerFarm.getWorkerFarm(options);
-    const workerPool = workerFarm.getWorkerPool({ name, url });
-    // options.log object contains functions which cannot be transferred
-    // TODO - decide how to handle logging on workers
-    options = JSON.parse(JSON.stringify(options));
-    const job = await workerPool.startJob('process-on-worker', 
-    // @ts-expect-error
-    onMessage.bind(null, parseOnMainThread) // eslint-disable-line @typescript-eslint/no-misused-promises
-    );
-    job.postMessage('process', {
-        // @ts-ignore
-        input: data,
-        options
-    });
-    const result = await job.result;
-    // TODO - what is going on here?
-    return await result.result;
+export async function parseWithWorker(loader, data, options, context, parseOnMainThread) {
+  const name = loader.id;
+  const url = getWorkerURL(loader, options);
+  const workerFarm = WorkerFarm.getWorkerFarm(options);
+  const workerPool = workerFarm.getWorkerPool({
+    name,
+    url
+  });
+  options = JSON.parse(JSON.stringify(options));
+  const job = await workerPool.startJob('process-on-worker', onMessage.bind(null, parseOnMainThread));
+  job.postMessage('process', {
+    input: data,
+    options
+  });
+  const result = await job.result;
+  return await result.result;
 }
-exports.parseWithWorker = parseWithWorker;
-/**
- * Handle worker's responses to the main thread
- * @param job
- * @param type
- * @param payload
- */
+
 async function onMessage(parseOnMainThread, job, type, payload) {
-    switch (type) {
-        case 'done':
-            job.done(payload);
-            break;
-        case 'error':
-            job.error(new Error(payload.error));
-            break;
-        case 'process':
-            // Worker is asking for main thread to parseO
-            const { id, input, options } = payload;
-            try {
-                const result = await parseOnMainThread(input, options);
-                job.postMessage('done', { id, result });
-            }
-            catch (error) {
-                const message = error instanceof Error ? error.message : 'unknown error';
-                job.postMessage('error', { id, error: message });
-            }
-            break;
-        default:
-            // eslint-disable-next-line
-            console.warn(`parse-with-worker unknown message ${type}`);
-    }
+  switch (type) {
+    case 'done':
+      job.done(payload);
+      break;
+
+    case 'error':
+      job.error(new Error(payload.error));
+      break;
+
+    case 'process':
+      const {
+        id,
+        input,
+        options
+      } = payload;
+
+      try {
+        const result = await parseOnMainThread(input, options);
+        job.postMessage('done', {
+          id,
+          result
+        });
+      } catch (error) {
+        const message = error instanceof Error ? error.message : 'unknown error';
+        job.postMessage('error', {
+          id,
+          error: message
+        });
+      }
+
+      break;
+
+    default:
+      console.warn("parse-with-worker unknown message ".concat(type));
+  }
 }
+//# sourceMappingURL=parse-with-worker.js.map