@loaders.gl/worker-utils 3.1.0-alpha.3 → 3.1.0-beta.2

package/dist/lib/worker-farm/worker-job.js

@@ -1,54 +1,47 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-import { assert } from '../env-utils/assert';
-export default class WorkerJob {
-  constructor(jobName, workerThread) {
-    _defineProperty(this, "name", void 0);
-
-    _defineProperty(this, "workerThread", void 0);
-
-    _defineProperty(this, "isRunning", void 0);
-
-    _defineProperty(this, "result", void 0);
-
-    _defineProperty(this, "_resolve", void 0);
-
-    _defineProperty(this, "_reject", void 0);
-
-    this.name = jobName;
-    this.workerThread = workerThread;
-    this.isRunning = true;
-
-    this._resolve = () => {};
-
-    this._reject = () => {};
-
-    this.result = new Promise((resolve, reject) => {
-      this._resolve = resolve;
-      this._reject = reject;
-    });
-  }
-
-  postMessage(type, payload) {
-    this.workerThread.postMessage({
-      source: 'loaders.gl',
-      type,
-      payload
-    });
-  }
-
-  done(value) {
-    assert(this.isRunning);
-    this.isRunning = false;
-
-    this._resolve(value);
-  }
-
-  error(error) {
-    assert(this.isRunning);
-    this.isRunning = false;
-
-    this._reject(error);
-  }
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert_1 = require("../env-utils/assert");
+/**
+ * Represents one Job handled by a WorkerPool or WorkerFarm
+ */
+class WorkerJob {
+    constructor(jobName, workerThread) {
+        this.name = jobName;
+        this.workerThread = workerThread;
+        this.isRunning = true;
+        this._resolve = () => { };
+        this._reject = () => { };
+        this.result = new Promise((resolve, reject) => {
+            this._resolve = resolve;
+            this._reject = reject;
+        });
+    }
+    /**
+     * Send a message to the job's worker thread
+     * @param data any data structure, ideally consisting mostly of transferrable objects
+     */
+    postMessage(type, payload) {
+        this.workerThread.postMessage({
+            source: 'loaders.gl',
+            type,
+            payload
+        });
+    }
+    /**
+     * Call to resolve the `result` Promise with the supplied value
+     */
+    done(value) {
+        (0, assert_1.assert)(this.isRunning);
+        this.isRunning = false;
+        this._resolve(value);
+    }
+    /**
+     * Call to reject the `result` Promise with the supplied error
+     */
+    error(error) {
+        (0, assert_1.assert)(this.isRunning);
+        this.isRunning = false;
+        this._reject(error);
+    }
 }
-//# sourceMappingURL=worker-job.js.map
+exports.default = WorkerJob;

package/dist/lib/worker-farm/worker-pool.d.ts

@@ -0,0 +1,75 @@
+import type { WorkerMessageType, WorkerMessagePayload } from '../../types';
+import WorkerThread from './worker-thread';
+import WorkerJob from './worker-job';
+/** WorkerPool onDebug Callback Parameters */
+declare type OnDebugParameters = {
+    message: string;
+    worker: string;
+    name: string;
+    job: string;
+    backlog: number;
+    workerThread: WorkerThread;
+};
+/** WorkerPool Properties */
+export declare type WorkerPoolProps = {
+    name?: string;
+    source?: string;
+    url?: string;
+    maxConcurrency?: number;
+    maxMobileConcurrency?: number;
+    onDebug?: (options: OnDebugParameters) => any;
+    reuseWorkers?: boolean;
+};
+/** Private helper types */
+declare type OnMessage = (job: WorkerJob, type: WorkerMessageType, payload: WorkerMessagePayload) => void;
+declare type OnError = (job: WorkerJob, error: Error) => void;
+/**
+ * Process multiple data messages with small pool of identical workers
+ */
+export default class WorkerPool {
+    name: string;
+    source?: string;
+    url?: string;
+    maxConcurrency: number;
+    maxMobileConcurrency: number;
+    onDebug: (options: OnDebugParameters) => any;
+    reuseWorkers: boolean;
+    private props;
+    private jobQueue;
+    private idleQueue;
+    private count;
+    private isDestroyed;
+    /**
+     * @param processor - worker function
+     * @param maxConcurrency - max count of workers
+     */
+    constructor(props: WorkerPoolProps);
+    /**
+     * Terminates all workers in the pool
+     * @note Can free up significant memory
+     */
+    destroy(): void;
+    setProps(props: WorkerPoolProps): void;
+    startJob(name: string, onMessage?: OnMessage, onError?: OnError): Promise<WorkerJob>;
+    /**
+     * Starts first queued job if worker is available or can be created
+     * Called when job is started and whenever a worker returns to the idleQueue
+     */
+    _startQueuedJob(): Promise<void>;
+    /**
+     * Returns a worker to the idle queue
+     * Destroys the worker if
+     *  - pool is destroyed
+     *  - if this pool doesn't reuse workers
+     *  - if maxConcurrency has been lowered
+     * @param worker
+     */
+    returnWorkerToQueue(worker: WorkerThread): void;
+    /**
+     * Returns idle worker or creates new worker if maxConcurrency has not been reached
+     */
+    _getAvailableWorker(): WorkerThread | null;
+    _getMaxConcurrency(): number;
+}
+export {};
+//# sourceMappingURL=worker-pool.d.ts.map

package/dist/lib/worker-farm/worker-pool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-pool.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-farm/worker-pool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,iBAAiB,EAAE,oBAAoB,EAAC,MAAM,aAAa,CAAC;AAEzE,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAC3C,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,6CAA6C;AAC7C,aAAK,iBAAiB,GAAG;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,4BAA4B;AAC5B,oBAAY,eAAe,GAAG;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,GAAG,CAAC;IAC9C,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,2BAA2B;AAC3B,aAAK,SAAS,GAAG,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAC;AAClG,aAAK,OAAO,GAAG,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;AAStD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,IAAI,EAAE,MAAM,CAAa;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAK;IAC3B,oBAAoB,EAAE,MAAM,CAAK;IACjC,OAAO,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,GAAG,CAAY;IACxD,YAAY,EAAE,OAAO,CAAQ;IAE7B,OAAO,CAAC,KAAK,CAAuB;IACpC,OAAO,CAAC,QAAQ,CAAmB;IACnC,OAAO,CAAC,SAAS,CAAsB;IACvC,OAAO,CAAC,KAAK,CAAK;IAClB,OAAO,CAAC,WAAW,CAAS;IAE5B;;;OAGG;gBACS,KAAK,EAAE,eAAe;IAMlC;;;OAGG;IACH,OAAO,IAAI,IAAI;IAMf,QAAQ,CAAC,KAAK,EAAE,eAAe;IAoBzB,QAAQ,CACZ,IAAI,EAAE,MAAM,EACZ,SAAS,GAAE,SAA+C,EAC1D,OAAO,GAAE,OAA0C,GAClD,OAAO,CAAC,SAAS,CAAC;IAarB;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAyCtC;;;;;;;OAOG;IACH,mBAAmB,CAAC,MAAM,EAAE,YAAY;IAgBxC;;OAEG;IACH,mBAAmB,IAAI,YAAY,GAAG,IAAI;IAiB1C,kBAAkB;CAGnB"}

package/dist/lib/worker-farm/worker-pool.js

@@ -1,157 +1,151 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-import { isMobile } from '../env-utils/globals';
-import WorkerThread from './worker-thread';
-import WorkerJob from './worker-job';
-export default class WorkerPool {
-  constructor(props) {
-    _defineProperty(this, "name", 'unnamed');
-
-    _defineProperty(this, "source", void 0);
-
-    _defineProperty(this, "url", void 0);
-
-    _defineProperty(this, "maxConcurrency", 1);
-
-    _defineProperty(this, "maxMobileConcurrency", 1);
-
-    _defineProperty(this, "onDebug", () => {});
-
-    _defineProperty(this, "reuseWorkers", true);
-
-    _defineProperty(this, "props", {});
-
-    _defineProperty(this, "jobQueue", []);
-
-    _defineProperty(this, "idleQueue", []);
-
-    _defineProperty(this, "count", 0);
-
-    _defineProperty(this, "isDestroyed", false);
-
-    this.source = props.source;
-    this.url = props.url;
-    this.setProps(props);
-  }
-
-  destroy() {
-    this.idleQueue.forEach(worker => worker.destroy());
-    this.isDestroyed = true;
-  }
-
-  setProps(props) {
-    this.props = { ...this.props,
-      ...props
-    };
-
-    if (props.name !== undefined) {
-      this.name = props.name;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("../env-utils/globals");
+const worker_thread_1 = __importDefault(require("./worker-thread"));
+const worker_job_1 = __importDefault(require("./worker-job"));
+/**
+ * Process multiple data messages with small pool of identical workers
+ */
+class WorkerPool {
+    /**
+     * @param processor - worker function
+     * @param maxConcurrency - max count of workers
+     */
+    constructor(props) {
+        this.name = 'unnamed';
+        this.maxConcurrency = 1;
+        this.maxMobileConcurrency = 1;
+        this.onDebug = () => { };
+        this.reuseWorkers = true;
+        this.props = {};
+        this.jobQueue = [];
+        this.idleQueue = [];
+        this.count = 0;
+        this.isDestroyed = false;
+        this.source = props.source;
+        this.url = props.url;
+        this.setProps(props);
     }
-
-    if (props.maxConcurrency !== undefined) {
-      this.maxConcurrency = props.maxConcurrency;
+    /**
+     * Terminates all workers in the pool
+     * @note Can free up significant memory
+     */
+    destroy() {
+        // Destroy idle workers, active Workers will be destroyed on completion
+        this.idleQueue.forEach((worker) => worker.destroy());
+        this.isDestroyed = true;
     }
-
-    if (props.maxMobileConcurrency !== undefined) {
-      this.maxMobileConcurrency = props.maxMobileConcurrency;
+    setProps(props) {
+        this.props = { ...this.props, ...props };
+        if (props.name !== undefined) {
+            this.name = props.name;
+        }
+        if (props.maxConcurrency !== undefined) {
+            this.maxConcurrency = props.maxConcurrency;
+        }
+        if (props.maxMobileConcurrency !== undefined) {
+            this.maxMobileConcurrency = props.maxMobileConcurrency;
+        }
+        if (props.reuseWorkers !== undefined) {
+            this.reuseWorkers = props.reuseWorkers;
+        }
+        if (props.onDebug !== undefined) {
+            this.onDebug = props.onDebug;
+        }
     }
-
-    if (props.reuseWorkers !== undefined) {
-      this.reuseWorkers = props.reuseWorkers;
+    async startJob(name, onMessage = (job, type, data) => job.done(data), onError = (job, error) => job.error(error)) {
+        // Promise resolves when thread starts working on this job
+        const startPromise = new Promise((onStart) => {
+            // Promise resolves when thread completes or fails working on this job
+            this.jobQueue.push({ name, onMessage, onError, onStart });
+            return this;
+        });
+        this._startQueuedJob(); // eslint-disable-line @typescript-eslint/no-floating-promises
+        return await startPromise;
     }
-
-    if (props.onDebug !== undefined) {
-      this.onDebug = props.onDebug;
+    // PRIVATE
+    /**
+     * Starts first queued job if worker is available or can be created
+     * Called when job is started and whenever a worker returns to the idleQueue
+     */
+    async _startQueuedJob() {
+        if (!this.jobQueue.length) {
+            return;
+        }
+        const workerThread = this._getAvailableWorker();
+        if (!workerThread) {
+            return;
+        }
+        // We have a worker, dequeue and start the job
+        const queuedJob = this.jobQueue.shift();
+        if (queuedJob) {
+            // Emit a debug event
+            // @ts-ignore
+            this.onDebug({
+                message: 'Starting job',
+                name: queuedJob.name,
+                workerThread,
+                backlog: this.jobQueue.length
+            });
+            // Create a worker job to let the app access thread and manage job completion
+            const job = new worker_job_1.default(queuedJob.name, workerThread);
+            // Set the worker thread's message handlers
+            workerThread.onMessage = (data) => queuedJob.onMessage(job, data.type, data.payload);
+            workerThread.onError = (error) => queuedJob.onError(job, error);
+            // Resolve the start promise so that the app can start sending messages to worker
+            queuedJob.onStart(job);
+            // Wait for the app to signal that the job is complete, then return worker to queue
+            try {
+                await job.result;
+            }
+            finally {
+                this.returnWorkerToQueue(workerThread);
+            }
+        }
     }
-  }
-
-  async startJob(name, onMessage = (job, type, data) => job.done(data), onError = (job, error) => job.error(error)) {
-    const startPromise = new Promise(onStart => {
-      this.jobQueue.push({
-        name,
-        onMessage,
-        onError,
-        onStart
-      });
-      return this;
-    });
-
-    this._startQueuedJob();
-
-    return await startPromise;
-  }
-
-  async _startQueuedJob() {
-    if (!this.jobQueue.length) {
-      return;
+    /**
+     * Returns a worker to the idle queue
+     * Destroys the worker if
+     *  - pool is destroyed
+     *  - if this pool doesn't reuse workers
+     *  - if maxConcurrency has been lowered
+     * @param worker
+     */
+    returnWorkerToQueue(worker) {
+        const shouldDestroyWorker = this.isDestroyed || !this.reuseWorkers || this.count > this._getMaxConcurrency();
+        if (shouldDestroyWorker) {
+            worker.destroy();
+            this.count--;
+        }
+        else {
+            this.idleQueue.push(worker);
+        }
+        if (!this.isDestroyed) {
+            this._startQueuedJob(); // eslint-disable-line @typescript-eslint/no-floating-promises
+        }
     }
-
-    const workerThread = this._getAvailableWorker();
-
-    if (!workerThread) {
-      return;
+    /**
+     * Returns idle worker or creates new worker if maxConcurrency has not been reached
+     */
+    _getAvailableWorker() {
+        // If a worker has completed and returned to the queue, it can be used
+        if (this.idleQueue.length > 0) {
+            return this.idleQueue.shift() || null;
+        }
+        // Create fresh worker if we haven't yet created the max amount of worker threads for this worker source
+        if (this.count < this._getMaxConcurrency()) {
+            this.count++;
+            const name = `${this.name.toLowerCase()} (#${this.count} of ${this.maxConcurrency})`;
+            return new worker_thread_1.default({ name, source: this.source, url: this.url });
+        }
+        // No worker available, have to wait
+        return null;
     }
-
-    const queuedJob = this.jobQueue.shift();
-
-    if (queuedJob) {
-      this.onDebug({
-        message: 'Starting job',
-        name: queuedJob.name,
-        workerThread,
-        backlog: this.jobQueue.length
-      });
-      const job = new WorkerJob(queuedJob.name, workerThread);
-
-      workerThread.onMessage = data => queuedJob.onMessage(job, data.type, data.payload);
-
-      workerThread.onError = error => queuedJob.onError(job, error);
-
-      queuedJob.onStart(job);
-
-      try {
-        await job.result;
-      } finally {
-        this.returnWorkerToQueue(workerThread);
-      }
+    _getMaxConcurrency() {
+        return globals_1.isMobile ? this.maxMobileConcurrency : this.maxConcurrency;
     }
-  }
-
-  returnWorkerToQueue(worker) {
-    const shouldDestroyWorker = this.isDestroyed || !this.reuseWorkers || this.count > this._getMaxConcurrency();
-
-    if (shouldDestroyWorker) {
-      worker.destroy();
-      this.count--;
-    } else {
-      this.idleQueue.push(worker);
-    }
-
-    if (!this.isDestroyed) {
-      this._startQueuedJob();
-    }
-  }
-
-  _getAvailableWorker() {
-    if (this.idleQueue.length > 0) {
-      return this.idleQueue.shift() || null;
-    }
-
-    if (this.count < this._getMaxConcurrency()) {
-      this.count++;
-      const name = `${this.name.toLowerCase()} (#${this.count} of ${this.maxConcurrency})`;
-      return new WorkerThread({
-        name,
-        source: this.source,
-        url: this.url
-      });
-    }
-
-    return null;
-  }
-
-  _getMaxConcurrency() {
-    return isMobile ? this.maxMobileConcurrency : this.maxConcurrency;
-  }
-
 }
-//# sourceMappingURL=worker-pool.js.map
+exports.default = WorkerPool;

package/dist/lib/worker-farm/worker-thread.d.ts

@@ -0,0 +1,42 @@
+export declare type WorkerThreadProps = {
+    name: string;
+    source?: string;
+    url?: string;
+};
+/**
+ * Represents one worker thread
+ */
+export default class WorkerThread {
+    readonly name: string;
+    readonly source: string | undefined;
+    readonly url: string | undefined;
+    terminated: boolean;
+    worker: Worker;
+    onMessage: (message: any) => void;
+    onError: (error: Error) => void;
+    private _loadableURL;
+    static isSupported(): boolean;
+    constructor(props: WorkerThreadProps);
+    /**
+     * Terminate this worker thread
+     * @note Can free up significant memory
+     */
+    destroy(): void;
+    get isRunning(): boolean;
+    /**
+     * Send a message to this worker thread
+     * @param data any data structure, ideally consisting mostly of transferrable objects
+     * @param transferList If not supplied, calculated automatically by traversing data
+     */
+    postMessage(data: any, transferList?: any[]): void;
+    /**
+     * Generate a standard Error from an ErrorEvent
+     * @param {ErrorEvent} event
+     */
+    _getErrorFromErrorEvent(event: ErrorEvent): Error;
+    /**
+     * Creates a worker thread on the browser
+     */
+    _createBrowserWorker(): Worker;
+}
+//# sourceMappingURL=worker-thread.d.ts.map

package/dist/lib/worker-farm/worker-thread.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-thread.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-farm/worker-thread.ts"],"names":[],"mappings":"AAMA,oBAAY,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,UAAU,EAAE,OAAO,CAAS;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,CAAC;IAClC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAEhC,OAAO,CAAC,YAAY,CAAc;IAElC,MAAM,CAAC,WAAW,IAAI,OAAO;gBAIjB,KAAK,EAAE,iBAAiB;IAYpC;;;OAGG;IACH,OAAO,IAAI,IAAI;IAQf,IAAI,SAAS,YAEZ;IAED;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,YAAY,CAAC,EAAE,GAAG,EAAE,GAAG,IAAI;IAQlD;;;OAGG;IACH,uBAAuB,CAAC,KAAK,EAAE,UAAU,GAAG,KAAK;IAiBjD;;OAEG;IACH,oBAAoB;CAqBrB"}