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

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

@@ -1,105 +1,95 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-import { assert } from '../env-utils/assert';
-import { getLoadableWorkerURL } from '../worker-utils/get-loadable-worker-url';
-import { getTransferList } from '../worker-utils/get-transfer-list';
-
-const NOOP = () => {};
-
-export default class WorkerThread {
-  static isSupported() {
-    return typeof Worker !== 'undefined';
-  }
-
-  constructor(props) {
-    _defineProperty(this, "name", void 0);
-
-    _defineProperty(this, "source", void 0);
-
-    _defineProperty(this, "url", void 0);
-
-    _defineProperty(this, "terminated", false);
-
-    _defineProperty(this, "worker", void 0);
-
-    _defineProperty(this, "onMessage", void 0);
-
-    _defineProperty(this, "onError", void 0);
-
-    _defineProperty(this, "_loadableURL", '');
-
-    const {
-      name,
-      source,
-      url
-    } = props;
-    assert(source || url);
-    this.name = name;
-    this.source = source;
-    this.url = url;
-    this.onMessage = NOOP;
-
-    this.onError = error => console.log(error);
-
-    this.worker = this._createBrowserWorker();
-  }
-
-  destroy() {
-    this.onMessage = NOOP;
-    this.onError = NOOP;
-    this.worker.terminate();
-    this.terminated = true;
-  }
-
-  get isRunning() {
-    return Boolean(this.onMessage);
-  }
-
-  postMessage(data, transferList) {
-    transferList = transferList || getTransferList(data);
-    this.worker.postMessage(data, transferList);
-  }
-
-  _getErrorFromErrorEvent(event) {
-    let message = 'Failed to load ';
-    message += `worker ${this.name} from ${this.url}. `;
-
-    if (event.message) {
-      message += `${event.message} in `;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert_1 = require("../env-utils/assert");
+const get_loadable_worker_url_1 = require("../worker-utils/get-loadable-worker-url");
+const get_transfer_list_1 = require("../worker-utils/get-transfer-list");
+const NOOP = () => { };
+/**
+ * Represents one worker thread
+ */
+class WorkerThread {
+    constructor(props) {
+        this.terminated = false;
+        this._loadableURL = '';
+        const { name, source, url } = props;
+        (0, assert_1.assert)(source || url); // Either source or url must be defined
+        this.name = name;
+        this.source = source;
+        this.url = url;
+        this.onMessage = NOOP;
+        this.onError = (error) => console.log(error); // eslint-disable-line
+        this.worker = this._createBrowserWorker();
     }
-
-    if (event.lineno) {
-      message += `:${event.lineno}:${event.colno}`;
+    static isSupported() {
+        return typeof Worker !== 'undefined';
+    }
+    /**
+     * Terminate this worker thread
+     * @note Can free up significant memory
+     */
+    destroy() {
+        this.onMessage = NOOP;
+        this.onError = NOOP;
+        // @ts-ignore
+        this.worker.terminate();
+        this.terminated = true;
+    }
+    get isRunning() {
+        return Boolean(this.onMessage);
+    }
+    /**
+     * 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, transferList) {
+        transferList = transferList || (0, get_transfer_list_1.getTransferList)(data);
+        // @ts-ignore
+        this.worker.postMessage(data, transferList);
+    }
+    // PRIVATE
+    /**
+     * Generate a standard Error from an ErrorEvent
+     * @param {ErrorEvent} event
+     */
+    _getErrorFromErrorEvent(event) {
+        // Note Error object does not have the expected fields if loading failed completely
+        // https://developer.mozilla.org/en-US/docs/Web/API/Worker#Event_handlers
+        // https://developer.mozilla.org/en-US/docs/Web/API/ErrorEvent
+        let message = 'Failed to load ';
+        message += `worker ${this.name} from ${this.url}. `;
+        if (event.message) {
+            message += `${event.message} in `;
+        }
+        // const hasFilename = event.filename && !event.filename.startsWith('blob:');
+        // message += hasFilename ? event.filename : this.source.slice(0, 100);
+        if (event.lineno) {
+            message += `:${event.lineno}:${event.colno}`;
+        }
+        return new Error(message);
+    }
+    /**
+     * Creates a worker thread on the browser
+     */
+    _createBrowserWorker() {
+        this._loadableURL = (0, get_loadable_worker_url_1.getLoadableWorkerURL)({ source: this.source, url: this.url });
+        const worker = new Worker(this._loadableURL, { name: this.name });
+        worker.onmessage = (event) => {
+            if (!event.data) {
+                this.onError(new Error('No data received'));
+            }
+            else {
+                this.onMessage(event.data);
+            }
+        };
+        // This callback represents an uncaught exception in the worker thread
+        worker.onerror = (error) => {
+            this.onError(this._getErrorFromErrorEvent(error));
+            this.terminated = true;
+        };
+        // TODO - not clear when this would be called, for now just log in case it happens
+        worker.onmessageerror = (event) => console.error(event); // eslint-disable-line
+        return worker;
     }
-
-    return new Error(message);
-  }
-
-  _createBrowserWorker() {
-    this._loadableURL = getLoadableWorkerURL({
-      source: this.source,
-      url: this.url
-    });
-    const worker = new Worker(this._loadableURL, {
-      name: this.name
-    });
-
-    worker.onmessage = event => {
-      if (!event.data) {
-        this.onError(new Error('No data received'));
-      } else {
-        this.onMessage(event.data);
-      }
-    };
-
-    worker.onerror = error => {
-      this.onError(this._getErrorFromErrorEvent(error));
-      this.terminated = true;
-    };
-
-    worker.onmessageerror = event => console.error(event);
-
-    return worker;
-  }
-
 }
-//# sourceMappingURL=worker-thread.js.map
+exports.default = WorkerThread;

package/dist/lib/worker-utils/get-loadable-worker-url.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Creates a loadable URL from worker source or URL
+ * that can be used to create `Worker` instances.
+ * Due to CORS issues it may be necessary to wrap a URL in a small importScripts
+ * @param props
+ * @param props.source Worker source
+ * @param props.url Worker URL
+ * @returns loadable url
+ */
+export declare function getLoadableWorkerURL(props: {
+    source?: string;
+    url?: string;
+}): any;
+//# sourceMappingURL=get-loadable-worker-url.d.ts.map

package/dist/lib/worker-utils/get-loadable-worker-url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-loadable-worker-url.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-utils/get-loadable-worker-url.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAC,OAmB1E"}

package/dist/lib/worker-utils/get-loadable-worker-url.js

@@ -1,43 +1,70 @@
-import { assert } from '../env-utils/assert';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLoadableWorkerURL = void 0;
+const assert_1 = require("../env-utils/assert");
 const workerURLCache = new Map();
-export function getLoadableWorkerURL(props) {
-  assert(props.source && !props.url || !props.source && props.url);
-  let workerURL = workerURLCache.get(props.source || props.url);
-
-  if (!workerURL) {
-    if (props.url) {
-      workerURL = getLoadableWorkerURLFromURL(props.url);
-      workerURLCache.set(props.url, workerURL);
+/**
+ * Creates a loadable URL from worker source or URL
+ * that can be used to create `Worker` instances.
+ * Due to CORS issues it may be necessary to wrap a URL in a small importScripts
+ * @param props
+ * @param props.source Worker source
+ * @param props.url Worker URL
+ * @returns loadable url
+ */
+function getLoadableWorkerURL(props) {
+    (0, assert_1.assert)((props.source && !props.url) || (!props.source && props.url)); // Either source or url must be defined
+    let workerURL = workerURLCache.get(props.source || props.url);
+    if (!workerURL) {
+        // Differentiate worker urls from worker source code
+        if (props.url) {
+            workerURL = getLoadableWorkerURLFromURL(props.url);
+            workerURLCache.set(props.url, workerURL);
+        }
+        if (props.source) {
+            workerURL = getLoadableWorkerURLFromSource(props.source);
+            workerURLCache.set(props.source, workerURL);
+        }
     }
-
-    if (props.source) {
-      workerURL = getLoadableWorkerURLFromSource(props.source);
-      workerURLCache.set(props.source, workerURL);
-    }
-  }
-
-  assert(workerURL);
-  return workerURL;
+    (0, assert_1.assert)(workerURL);
+    return workerURL;
 }
-
+exports.getLoadableWorkerURL = getLoadableWorkerURL;
+/**
+ * Build a loadable worker URL from worker URL
+ * @param url
+ * @returns loadable URL
+ */
 function getLoadableWorkerURLFromURL(url) {
-  if (!url.startsWith('http')) {
-    return url;
-  }
-
-  const workerSource = buildScriptSource(url);
-  return getLoadableWorkerURLFromSource(workerSource);
+    // A local script url, we can use it to initialize a Worker directly
+    if (!url.startsWith('http')) {
+        return url;
+    }
+    // A remote script, we need to use `importScripts` to load from different origin
+    const workerSource = buildScriptSource(url);
+    return getLoadableWorkerURLFromSource(workerSource);
 }
-
+/**
+ * Build a loadable worker URL from worker source
+ * @param workerSource
+ * @returns loadable url
+ */
 function getLoadableWorkerURLFromSource(workerSource) {
-  const blob = new Blob([workerSource], {
-    type: 'application/javascript'
-  });
-  return URL.createObjectURL(blob);
+    // NOTE: webworkify was previously used
+    // const blob = webworkify(workerSource, {bare: true});
+    const blob = new Blob([workerSource], { type: 'application/javascript' });
+    return URL.createObjectURL(blob);
 }
-
+/**
+ * Per spec, worker cannot be initialized with a script from a different origin
+ * However a local worker script can still import scripts from other origins,
+ * so we simply build a wrapper script.
+ *
+ * @param workerUrl
+ * @returns source
+ */
 function buildScriptSource(workerUrl) {
-  return `\
+    return `\
 try {
   importScripts('${workerUrl}');
 } catch (error) {
@@ -45,4 +72,3 @@ try {
   throw error;
 }`;
 }
-//# sourceMappingURL=get-loadable-worker-url.js.map

package/dist/lib/worker-utils/get-transfer-list.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Returns an array of Transferrable objects that can be used with postMessage
+ * https://developer.mozilla.org/en-US/docs/Web/API/Worker/postMessage
+ * @param object data to be sent via postMessage
+ * @param recursive - not for application use
+ * @param transfers - not for application use
+ * @returns a transfer list that can be passed to postMessage
+ */
+export declare function getTransferList(object: any, recursive?: boolean, transfers?: Set<any>): Transferable[];
+//# sourceMappingURL=get-transfer-list.d.ts.map

package/dist/lib/worker-utils/get-transfer-list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-transfer-list.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-utils/get-transfer-list.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,GAAG,EACX,SAAS,GAAE,OAAc,EACzB,SAAS,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,GACnB,YAAY,EAAE,CAwBhB"}

package/dist/lib/worker-utils/get-transfer-list.js

@@ -1,40 +1,61 @@
-export function getTransferList(object, recursive = true, transfers) {
-  const transfersSet = transfers || new Set();
-
-  if (!object) {} else if (isTransferable(object)) {
-    transfersSet.add(object);
-  } else if (isTransferable(object.buffer)) {
-    transfersSet.add(object.buffer);
-  } else if (ArrayBuffer.isView(object)) {} else if (recursive && typeof object === 'object') {
-    for (const key in object) {
-      getTransferList(object[key], recursive, transfersSet);
-    }
-  }
-
-  return transfers === undefined ? Array.from(transfersSet) : [];
+"use strict";
+// NOTE - there is a copy of this function is both in core and loader-utils
+// core does not need all the utils in loader-utils, just this one.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTransferList = void 0;
+/**
+ * Returns an array of Transferrable objects that can be used with postMessage
+ * https://developer.mozilla.org/en-US/docs/Web/API/Worker/postMessage
+ * @param object data to be sent via postMessage
+ * @param recursive - not for application use
+ * @param transfers - not for application use
+ * @returns a transfer list that can be passed to postMessage
+ */
+function getTransferList(object, recursive = true, transfers) {
+    // Make sure that items in the transfer list is unique
+    const transfersSet = transfers || new Set();
+    if (!object) {
+        // ignore
+    }
+    else if (isTransferable(object)) {
+        transfersSet.add(object);
+    }
+    else if (isTransferable(object.buffer)) {
+        // Typed array
+        transfersSet.add(object.buffer);
+    }
+    else if (ArrayBuffer.isView(object)) {
+        // object is a TypeArray viewing into a SharedArrayBuffer (not transferable)
+        // Do not iterate through the content in this case
+    }
+    else if (recursive && typeof object === 'object') {
+        for (const key in object) {
+            // Avoid perf hit - only go one level deep
+            getTransferList(object[key], recursive, transfersSet);
+        }
+    }
+    // If transfers is defined, is internal recursive call
+    // Otherwise it's called by the user
+    return transfers === undefined ? Array.from(transfersSet) : [];
 }
-
+exports.getTransferList = getTransferList;
+// https://developer.mozilla.org/en-US/docs/Web/API/Transferable
 function isTransferable(object) {
-  if (!object) {
+    if (!object) {
+        return false;
+    }
+    if (object instanceof ArrayBuffer) {
+        return true;
+    }
+    if (typeof MessagePort !== 'undefined' && object instanceof MessagePort) {
+        return true;
+    }
+    if (typeof ImageBitmap !== 'undefined' && object instanceof ImageBitmap) {
+        return true;
+    }
+    // @ts-ignore
+    if (typeof OffscreenCanvas !== 'undefined' && object instanceof OffscreenCanvas) {
+        return true;
+    }
     return false;
-  }
-
-  if (object instanceof ArrayBuffer) {
-    return true;
-  }
-
-  if (typeof MessagePort !== 'undefined' && object instanceof MessagePort) {
-    return true;
-  }
-
-  if (typeof ImageBitmap !== 'undefined' && object instanceof ImageBitmap) {
-    return true;
-  }
-
-  if (typeof OffscreenCanvas !== 'undefined' && object instanceof OffscreenCanvas) {
-    return true;
-  }
-
-  return false;
 }
-//# sourceMappingURL=get-transfer-list.js.map

package/dist/lib/worker-utils/remove-nontransferable-options.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Safely stringify JSON (drop non serializable values like functions and regexps)
+ * @param value
+ */
+export declare function removeNontransferableOptions(object: object): object;
+//# sourceMappingURL=remove-nontransferable-options.d.ts.map

package/dist/lib/worker-utils/remove-nontransferable-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove-nontransferable-options.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-utils/remove-nontransferable-options.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAKnE"}

package/dist/lib/worker-utils/remove-nontransferable-options.js

@@ -1,23 +1,35 @@
-export function removeNontransferableOptions(object) {
-  return JSON.parse(stringifyJSON(object));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeNontransferableOptions = void 0;
+/**
+ * Safely stringify JSON (drop non serializable values like functions and regexps)
+ * @param value
+ */
+function removeNontransferableOptions(object) {
+    // options.log object contains functions which cannot be transferred
+    // TODO - decide how to handle logging on workers
+    // TODO - warn if options stringification is long
+    return JSON.parse(stringifyJSON(object));
 }
-
+exports.removeNontransferableOptions = removeNontransferableOptions;
 function stringifyJSON(v) {
-  const cache = new Set();
-  return JSON.stringify(v, (key, value) => {
-    if (typeof value === 'object' && value !== null) {
-      if (cache.has(value)) {
-        try {
-          return JSON.parse(JSON.stringify(value));
-        } catch (err) {
-          return undefined;
+    const cache = new Set();
+    return JSON.stringify(v, (key, value) => {
+        if (typeof value === 'object' && value !== null) {
+            if (cache.has(value)) {
+                // Circular reference found
+                try {
+                    // If this value does not reference a parent it can be deduped
+                    return JSON.parse(JSON.stringify(value));
+                }
+                catch (err) {
+                    // discard key if value cannot be deduped
+                    return undefined;
+                }
+            }
+            // Store value in our set
+            cache.add(value);
         }
-      }
-
-      cache.add(value);
-    }
-
-    return value;
-  });
+        return value;
+    });
 }
-//# sourceMappingURL=remove-nontransferable-options.js.map