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

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

@@ -1,102 +1,98 @@
-import { WorkerBody } from '@loaders.gl/worker-utils';
+"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';
 let requestId = 0;
-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:
+/**
+ * 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 (!worker_utils_1.WorkerBody.inWorkerThread()) {
+        return;
     }
-  };
+    worker_utils_1.WorkerBody.onmessage = async (type, payload) => {
+        switch (type) {
+            case 'process':
+                try {
+                    // validateLoaderVersion(loader, data.source.split('@')[1]);
+                    const { input, options = {}, context = {} } = payload;
+                    const result = await parseData({
+                        loader,
+                        arrayBuffer: input,
+                        options,
+                        context: {
+                            ...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:
+        }
+    };
 }
-
+exports.createLoaderWorker = createLoaderWorker;
 function parseOnMainThread(arrayBuffer, options) {
-  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
-    };
-    WorkerBody.postMessage('process', payload);
-  });
+    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);
+    });
 }
-
-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);
+// 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 await parser(data, { ...options }, context, loader);
 }
-//# sourceMappingURL=create-loader-worker.js.map

package/dist/lib/worker-loader-utils/encode-with-worker.d.ts

@@ -0,0 +1,8 @@
+import { Writer, WriterOptions } from '../../types';
+/**
+ * Determines if a loader can parse with worker
+ * @param loader
+ * @param options
+ */
+export declare function canEncodeWithWorker(writer: Writer, options?: WriterOptions): any;
+//# sourceMappingURL=encode-with-worker.d.ts.map

package/dist/lib/worker-loader-utils/encode-with-worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encode-with-worker.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-loader-utils/encode-with-worker.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,MAAM,EAAE,aAAa,EAAC,MAAM,aAAa,CAAC;AAGlD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,OAW1E"}

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

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.canEncodeWithWorker = void 0;
+const worker_utils_1 = require("@loaders.gl/worker-utils");
+const globals_1 = require("../env-utils/globals");
+/**
+ * Determines if a loader can parse with worker
+ * @param loader
+ * @param options
+ */
+function canEncodeWithWorker(writer, options) {
+    if (!worker_utils_1.WorkerFarm.isSupported()) {
+        return false;
+    }
+    // Node workers are still experimental
+    if (!globals_1.isBrowser && !options?._nodeWorkers) {
+        return false;
+    }
+    return writer.worker && options?.worker;
+}
+exports.canEncodeWithWorker = canEncodeWithWorker;

package/dist/lib/worker-loader-utils/parse-with-worker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse-with-worker.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-loader-utils/parse-with-worker.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,MAAM,EAAE,aAAa,EAAE,aAAa,EAAC,MAAM,aAAa,CAAC;AAGtE;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,4BAMzE;AAED;;;GAGG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,EACT,OAAO,CAAC,EAAE,aAAa,EACvB,OAAO,CAAC,EAAE,aAAa,EACvB,iBAAiB,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,gBA2B/F"}
+{"version":3,"file":"parse-with-worker.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-loader-utils/parse-with-worker.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAC,MAAM,EAAE,aAAa,EAAE,aAAa,EAAC,MAAM,aAAa,CAAC;AAGtE;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,4BAWzE;AAED;;;GAGG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,EACT,OAAO,CAAC,EAAE,aAAa,EACvB,OAAO,CAAC,EAAE,aAAa,EACvB,iBAAiB,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,gBA8B/F"}

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

@@ -1,64 +1,81 @@
-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);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseWithWorker = exports.canParseWithWorker = void 0;
+const worker_utils_1 = require("@loaders.gl/worker-utils");
+const worker_utils_2 = require("@loaders.gl/worker-utils");
+/**
+ * Determines if a loader can parse with worker
+ * @param loader
+ * @param options
+ */
+function canParseWithWorker(loader, options) {
+    if (!worker_utils_2.WorkerFarm.isSupported()) {
+        return false;
+    }
+    // Node workers are still experimental
+    if (!worker_utils_1.isBrowser && !options?._nodeWorkers) {
+        return false;
+    }
+    return loader.worker && options?.worker;
 }
-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.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_2.getWorkerURL)(loader, options);
+    const workerFarm = worker_utils_2.WorkerFarm.getWorkerFarm(options);
+    const workerPool = workerFarm.getWorkerPool({ name, url });
+    // options.log object contains functions which cannot be transferred
+    // context.fetch & context.parse functions cannot be transferred
+    // TODO - decide how to handle logging on workers
+    options = JSON.parse(JSON.stringify(options));
+    context = JSON.parse(JSON.stringify(context || {}));
+    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,
+        context
+    });
+    const result = await job.result;
+    // TODO - what is going on here?
+    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':
-      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));
-  }
+    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}`);
+    }
 }
-//# sourceMappingURL=parse-with-worker.js.map