@loaders.gl/worker-utils 4.2.0-alpha.3 → 4.2.0-alpha.5

package/dist/lib/node/require-utils.node.js

@@ -1,54 +1,83 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+// Fork of https://github.com/floatdrop/require-from-string/blob/master/index.js
+// Copyright (c) Vsevolod Strukchinsky <floatdrop@gmail.com> (github.com/floatdrop)
+// MIT license
+// this file is not visible to webpack (it is excluded in the package.json "browser" field).
 import Module from 'module';
 import * as path from 'path';
 import * as fs from 'fs';
+/**
+ * Load a file from local file system
+ * @param filename
+ * @returns
+ */
 export async function readFileAsArrayBuffer(filename) {
-  if (filename.startsWith('http')) {
-    const response = await fetch(filename);
-    return await response.arrayBuffer();
-  }
-  const buffer = fs.readFileSync(filename);
-  return buffer.buffer;
+    if (filename.startsWith('http')) {
+        const response = await fetch(filename);
+        return await response.arrayBuffer();
+    }
+    const buffer = fs.readFileSync(filename);
+    return buffer.buffer;
 }
+/**
+ * Load a file from local file system
+ * @param filename
+ * @returns
+ */
 export async function readFileAsText(filename) {
-  if (filename.startsWith('http')) {
-    const response = await fetch(filename);
-    return await response.text();
-  }
-  const text = fs.readFileSync(filename, 'utf8');
-  return text;
+    if (filename.startsWith('http')) {
+        const response = await fetch(filename);
+        return await response.text();
+    }
+    const text = fs.readFileSync(filename, 'utf8');
+    return text;
 }
+// Node.js Dynamically require from file
+// Relative names are resolved relative to cwd
+// This indirect function is provided because webpack will try to bundle `module.require`.
+// this file is not visible to webpack (it is excluded in the package.json "browser" field).
 export async function requireFromFile(filename) {
-  if (filename.startsWith('http')) {
-    const response = await fetch(filename);
-    const code = await response.text();
+    if (filename.startsWith('http')) {
+        const response = await fetch(filename);
+        const code = await response.text();
+        return requireFromString(code);
+    }
+    if (!filename.startsWith('/')) {
+        filename = `${process.cwd()}/${filename}`;
+    }
+    const code = await fs.promises.readFile(filename, 'utf8');
     return requireFromString(code);
-  }
-  if (!filename.startsWith('/')) {
-    filename = `${process.cwd()}/${filename}`;
-  }
-  const code = await fs.promises.readFile(filename, 'utf8');
-  return requireFromString(code);
 }
-export function requireFromString(code) {
-  var _module, _options, _options2;
-  let filename = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
-  let options = arguments.length > 2 ? arguments[2] : undefined;
-  if (typeof filename === 'object') {
-    options = filename;
-    filename = '';
-  }
-  if (typeof code !== 'string') {
-    throw new Error(`code must be a string, not ${typeof code}`);
-  }
-  const paths = Module._nodeModulePaths(path.dirname(filename));
-  const parent = typeof module !== 'undefined' && ((_module = module) === null || _module === void 0 ? void 0 : _module.parent);
-  const newModule = new Module(filename, parent);
-  newModule.filename = filename;
-  newModule.paths = [].concat(((_options = options) === null || _options === void 0 ? void 0 : _options.prependPaths) || []).concat(paths).concat(((_options2 = options) === null || _options2 === void 0 ? void 0 : _options2.appendPaths) || []);
-  newModule._compile(code, filename);
-  if (parent && parent.children) {
-    parent.children.splice(parent.children.indexOf(newModule), 1);
-  }
-  return newModule.exports;
+// Dynamically require from string
+// - `code` - Required - Type: string - Module code.
+// - `filename` - Type: string - Default: '' - Optional filename.
+// - `options.appendPaths` Type: Array List of paths, that will be appended to module paths.
+// Useful, when you want to be able require modules from these paths.
+// - `options.prependPaths` Type: Array Same as appendPaths, but paths will be prepended.
+export function requireFromString(code, filename = '', options) {
+    if (typeof filename === 'object') {
+        options = filename;
+        filename = '';
+    }
+    if (typeof code !== 'string') {
+        throw new Error(`code must be a string, not ${typeof code}`);
+    }
+    // @ts-ignore
+    const paths = Module._nodeModulePaths(path.dirname(filename));
+    const parent = typeof module !== 'undefined' && module?.parent;
+    // @ts-ignore
+    const newModule = new Module(filename, parent);
+    newModule.filename = filename;
+    newModule.paths = []
+        .concat(options?.prependPaths || [])
+        .concat(paths)
+        .concat(options?.appendPaths || []);
+    // @ts-ignore
+    newModule._compile(code, filename);
+    if (parent && parent.children) {
+        parent.children.splice(parent.children.indexOf(newModule), 1);
+    }
+    return newModule.exports;
 }
-//# sourceMappingURL=require-utils.node.js.map

package/dist/lib/node/worker_threads-browser.js

@@ -1,5 +1,12 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+/** Browser polyfill for Node.js built-in `worker_threads` module.
+ * These fills are non-functional, and just intended to ensure that
+ * `import 'worker_threads` doesn't break browser builds.
+ * The replacement is done in package.json browser field
+ */
 export class NodeWorker {
-  terminate() {}
+    terminate() { }
 }
 export const parentPort = null;
-//# sourceMappingURL=worker_threads-browser.js.map

package/dist/lib/node/worker_threads.js

@@ -1,5 +1,7 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import * as WorkerThreads from 'worker_threads';
 export * from 'worker_threads';
-export const parentPort = WorkerThreads === null || WorkerThreads === void 0 ? void 0 : WorkerThreads.parentPort;
+export const parentPort = WorkerThreads?.parentPort;
 export const NodeWorker = WorkerThreads.Worker;
-//# sourceMappingURL=worker_threads.js.map

package/dist/lib/process-utils/child-process-proxy.js

@@ -1,105 +1,113 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+/* eslint-disable no-console */
+// Avoid using named imports for Node builtins to help with "empty" resolution
+// for bundlers targeting browser environments. Access imports & types
+// through the `ChildProcess` object (e.g. `ChildProcess.spawn`, `ChildProcess.ChildProcess`).
 import * as ChildProcess from 'child_process';
 import { getAvailablePort } from "./process-utils.js";
 const DEFAULT_PROPS = {
-  command: '',
-  arguments: [],
-  port: 5000,
-  autoPort: true,
-  wait: 2000,
-  onSuccess: processProxy => {
-    console.log(`Started ${processProxy.props.command}`);
-  }
+    command: '',
+    arguments: [],
+    port: 5000,
+    autoPort: true,
+    wait: 2000,
+    onSuccess: (processProxy) => {
+        console.log(`Started ${processProxy.props.command}`);
+    }
 };
+/**
+ * Manager for a Node.js child process
+ * Prepares arguments, starts, stops and tracks output
+ */
 export default class ChildProcessProxy {
-  constructor() {
-    let {
-      id = 'browser-driver'
-    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    this.id = void 0;
-    this.props = {
-      ...DEFAULT_PROPS
-    };
-    this.childProcess = null;
-    this.port = 0;
-    this.successTimer = void 0;
-    this.id = id;
-  }
-  async start(props) {
-    props = {
-      ...DEFAULT_PROPS,
-      ...props
-    };
-    this.props = props;
-    const args = [...props.arguments];
-    this.port = Number(props.port);
-    if (props.portArg) {
-      if (props.autoPort) {
-        this.port = await getAvailablePort(props.port);
-      }
-      args.push(props.portArg, String(this.port));
+    // constructor(props?: {id?: string});
+    constructor({ id = 'browser-driver' } = {}) {
+        this.props = { ...DEFAULT_PROPS };
+        this.childProcess = null;
+        this.port = 0;
+        this.id = id;
     }
-    return await new Promise((resolve, reject) => {
-      try {
-        this._setTimeout(() => {
-          if (props.onSuccess) {
-            props.onSuccess(this);
-          }
-          resolve({});
-        });
-        console.log(`Spawning ${props.command} ${props.arguments.join(' ')}`);
-        const childProcess = ChildProcess.spawn(props.command, args, props.spawn);
-        this.childProcess = childProcess;
-        childProcess.stdout.on('data', data => {
-          console.log(data.toString());
-        });
-        childProcess.stderr.on('data', data => {
-          console.log(`Child process wrote to stderr: "${data}".`);
-          if (!props.ignoreStderr) {
-            this._clearTimeout();
-            reject(new Error(data));
-          }
+    /** Starts a child process with the provided props */
+    async start(props) {
+        props = { ...DEFAULT_PROPS, ...props };
+        this.props = props;
+        const args = [...props.arguments];
+        // If portArg is set, we can look up an available port
+        this.port = Number(props.port);
+        if (props.portArg) {
+            if (props.autoPort) {
+                this.port = await getAvailablePort(props.port);
+            }
+            args.push(props.portArg, String(this.port));
+        }
+        return await new Promise((resolve, reject) => {
+            try {
+                this._setTimeout(() => {
+                    if (props.onSuccess) {
+                        props.onSuccess(this);
+                    }
+                    resolve({});
+                });
+                console.log(`Spawning ${props.command} ${props.arguments.join(' ')}`);
+                const childProcess = ChildProcess.spawn(props.command, args, props.spawn);
+                this.childProcess = childProcess;
+                childProcess.stdout.on('data', (data) => {
+                    console.log(data.toString());
+                });
+                childProcess.stderr.on('data', (data) => {
+                    console.log(`Child process wrote to stderr: "${data}".`);
+                    if (!props.ignoreStderr) {
+                        this._clearTimeout();
+                        reject(new Error(data));
+                    }
+                });
+                childProcess.on('error', (error) => {
+                    console.log(`Child process errored with ${error}`);
+                    this._clearTimeout();
+                    reject(error);
+                });
+                childProcess.on('close', (code) => {
+                    console.log(`Child process exited with ${code}`);
+                    this.childProcess = null;
+                    this._clearTimeout();
+                    resolve({});
+                });
+            }
+            catch (error) {
+                reject(error);
+            }
         });
-        childProcess.on('error', error => {
-          console.log(`Child process errored with ${error}`);
-          this._clearTimeout();
-          reject(error);
-        });
-        childProcess.on('close', code => {
-          console.log(`Child process exited with ${code}`);
-          this.childProcess = null;
-          this._clearTimeout();
-          resolve({});
-        });
-      } catch (error) {
-        reject(error);
-      }
-    });
-  }
-  async stop() {
-    if (this.childProcess) {
-      this.childProcess.kill();
-      this.childProcess = null;
     }
-  }
-  async exit() {
-    let statusCode = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
-    try {
-      await this.stop();
-      process.exit(statusCode);
-    } catch (error) {
-      console.error(error.message || error);
-      process.exit(1);
+    /** Stops a running child process */
+    async stop() {
+        if (this.childProcess) {
+            this.childProcess.kill();
+            this.childProcess = null;
+        }
+    }
+    /** Exits this process */
+    async exit(statusCode = 0) {
+        try {
+            await this.stop();
+            // eslint-disable-next-line no-process-exit
+            process.exit(statusCode);
+        }
+        catch (error) {
+            console.error(error.message || error);
+            // eslint-disable-next-line no-process-exit
+            process.exit(1);
+        }
     }
-  }
-  _setTimeout(callback) {
-    if (Number(this.props.wait) > 0) {
-      this.successTimer = setTimeout(callback, this.props.wait);
+    _setTimeout(callback) {
+        if (Number(this.props.wait) > 0) {
+            this.successTimer = setTimeout(callback, this.props.wait);
+        }
     }
-  }
-  _clearTimeout() {
-    if (this.successTimer) {
-      clearTimeout(this.successTimer);
+    _clearTimeout() {
+        if (this.successTimer) {
+            clearTimeout(this.successTimer);
+        }
     }
-  }
 }
-//# sourceMappingURL=child-process-proxy.js.map

package/dist/lib/process-utils/process-utils.js

@@ -1,26 +1,31 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import ChildProcess from 'child_process';
-export function getAvailablePort() {
-  let defaultPort = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 3000;
-  return new Promise(resolve => {
-    ChildProcess.exec('lsof -i -P -n | grep LISTEN', (error, stdout) => {
-      if (error) {
-        resolve(defaultPort);
-        return;
-      }
-      const portsInUse = [];
-      const regex = /:(\d+) \(LISTEN\)/;
-      stdout.split('\n').forEach(line => {
-        const match = regex.exec(line);
-        if (match) {
-          portsInUse.push(Number(match[1]));
-        }
-      });
-      let port = defaultPort;
-      while (portsInUse.includes(port)) {
-        port++;
-      }
-      resolve(port);
+// Get an available port
+// Works on Unix systems
+export function getAvailablePort(defaultPort = 3000) {
+    return new Promise((resolve) => {
+        // Get a list of all ports in use
+        ChildProcess.exec('lsof -i -P -n | grep LISTEN', (error, stdout) => {
+            if (error) {
+                // likely no permission, e.g. CI
+                resolve(defaultPort);
+                return;
+            }
+            const portsInUse = [];
+            const regex = /:(\d+) \(LISTEN\)/;
+            stdout.split('\n').forEach((line) => {
+                const match = regex.exec(line);
+                if (match) {
+                    portsInUse.push(Number(match[1]));
+                }
+            });
+            let port = defaultPort;
+            while (portsInUse.includes(port)) {
+                port++;
+            }
+            resolve(port);
+        });
     });
-  });
 }
-//# sourceMappingURL=process-utils.js.map

package/dist/lib/worker-api/create-worker.d.ts

@@ -1,4 +1,4 @@
-import type { WorkerContext, Process, ProcessInBatches } from '../../types';
+import type { WorkerContext, Process, ProcessInBatches } from "../../types.js";
 export type ProcessOnMainThread = (data: any, options?: {
     [key: string]: any;
 }, context?: WorkerContext) => any;

package/dist/lib/worker-api/create-worker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-worker.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-api/create-worker.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAGV,aAAa,EACb,OAAO,EACP,gBAAgB,EACjB,MAAM,aAAa,CAAC;AAUrB,MAAM,MAAM,mBAAmB,GAAG,CAChC,IAAI,EAAE,GAAG,EACT,OAAO,CAAC,EAAE;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC,EAC9B,OAAO,CAAC,EAAE,aAAa,KACpB,GAAG,CAAC;AAET;;GAEG;AACH,wBAAsB,YAAY,CAChC,OAAO,EAAE,OAAO,EAChB,gBAAgB,CAAC,EAAE,gBAAgB,GAClC,OAAO,CAAC,IAAI,CAAC,CAiDf"}
+{"version":3,"file":"create-worker.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-api/create-worker.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAGV,aAAa,EACb,OAAO,EACP,gBAAgB,EACjB,uBAAoB;AAUrB,MAAM,MAAM,mBAAmB,GAAG,CAChC,IAAI,EAAE,GAAG,EACT,OAAO,CAAC,EAAE;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC,EAC9B,OAAO,CAAC,EAAE,aAAa,KACpB,GAAG,CAAC;AAET;;GAEG;AACH,wBAAsB,YAAY,CAChC,OAAO,EAAE,OAAO,EAChB,gBAAgB,CAAC,EAAE,gBAAgB,GAClC,OAAO,CAAC,IAAI,CAAC,CAiDf"}

package/dist/lib/worker-api/create-worker.js

@@ -1,84 +1,87 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import AsyncQueue from "../async-queue/async-queue.js";
 import WorkerBody from "../worker-farm/worker-body.js";
+// import {validateWorkerVersion} from './validate-worker-version';
+/** Counter for jobs */
 let requestId = 0;
 let inputBatches;
 let options;
+/**
+ * Set up a WebWorkerGlobalScope to talk with the main thread
+ */
 export async function createWorker(process, processInBatches) {
-  if (!(await WorkerBody.inWorkerThread())) {
-    return;
-  }
-  const context = {
-    process: processOnMainThread
-  };
-  WorkerBody.onmessage = async (type, payload) => {
-    try {
-      switch (type) {
-        case 'process':
-          if (!process) {
-            throw new Error('Worker does not support atomic processing');
-          }
-          const result = await process(payload.input, payload.options || {}, context);
-          WorkerBody.postMessage('done', {
-            result
-          });
-          break;
-        case 'process-in-batches':
-          if (!processInBatches) {
-            throw new Error('Worker does not support batched processing');
-          }
-          inputBatches = new AsyncQueue();
-          options = payload.options || {};
-          const resultIterator = processInBatches(inputBatches, options, context);
-          for await (const batch of resultIterator) {
-            WorkerBody.postMessage('output-batch', {
-              result: batch
-            });
-          }
-          WorkerBody.postMessage('done', {});
-          break;
-        case 'input-batch':
-          inputBatches.push(payload.input);
-          break;
-        case 'input-done':
-          inputBatches.close();
-          break;
-        default:
-      }
-    } catch (error) {
-      const message = error instanceof Error ? error.message : '';
-      WorkerBody.postMessage('error', {
-        error: message
-      });
-    }
-  };
-}
-function processOnMainThread(arrayBuffer) {
-  let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  return new Promise((resolve, reject) => {
-    const id = requestId++;
-    const onMessage = (type, payload) => {
-      if (payload.id !== id) {
+    if (!(await WorkerBody.inWorkerThread())) {
         return;
-      }
-      switch (type) {
-        case 'done':
-          WorkerBody.removeEventListener(onMessage);
-          resolve(payload.result);
-          break;
-        case 'error':
-          WorkerBody.removeEventListener(onMessage);
-          reject(payload.error);
-          break;
-        default:
-      }
+    }
+    const context = {
+        process: processOnMainThread
     };
-    WorkerBody.addEventListener(onMessage);
-    const payload = {
-      id,
-      input: arrayBuffer,
-      options
+    // eslint-disable-next-line complexity
+    WorkerBody.onmessage = async (type, payload) => {
+        try {
+            switch (type) {
+                case 'process':
+                    if (!process) {
+                        throw new Error('Worker does not support atomic processing');
+                    }
+                    const result = await process(payload.input, payload.options || {}, context);
+                    WorkerBody.postMessage('done', { result });
+                    break;
+                case 'process-in-batches':
+                    if (!processInBatches) {
+                        throw new Error('Worker does not support batched processing');
+                    }
+                    inputBatches = new AsyncQueue();
+                    options = payload.options || {};
+                    const resultIterator = processInBatches(inputBatches, options, context);
+                    for await (const batch of resultIterator) {
+                        WorkerBody.postMessage('output-batch', { result: batch });
+                    }
+                    WorkerBody.postMessage('done', {});
+                    break;
+                case 'input-batch':
+                    inputBatches.push(payload.input);
+                    break;
+                case 'input-done':
+                    inputBatches.close();
+                    break;
+                default:
+            }
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : '';
+            WorkerBody.postMessage('error', { error: message });
+        }
     };
-    WorkerBody.postMessage('process', payload);
-  });
 }
-//# sourceMappingURL=create-worker.js.map
+function processOnMainThread(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':
+                    WorkerBody.removeEventListener(onMessage);
+                    resolve(payload.result);
+                    break;
+                case 'error':
+                    WorkerBody.removeEventListener(onMessage);
+                    reject(payload.error);
+                    break;
+                default:
+                // ignore
+            }
+        };
+        WorkerBody.addEventListener(onMessage);
+        // Ask the main thread to decode data
+        const payload = { id, input: arrayBuffer, options };
+        WorkerBody.postMessage('process', payload);
+    });
+}

package/dist/lib/worker-api/get-worker-url.d.ts

@@ -1,4 +1,4 @@
-import type { WorkerObject, WorkerOptions } from '../../types';
+import type { WorkerObject, WorkerOptions } from "../../types.js";
 /**
  * Gets worker object's name (for debugging in Chrome thread inspector window)
  */

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

@@ -1 +1 @@
-{"version":3,"file":"get-worker-url.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-api/get-worker-url.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAC,YAAY,EAAE,aAAa,EAAC,MAAM,aAAa,CAAC;AAK7D;;GAEG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAG1D;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,GAAE,aAAkB,GAAG,MAAM,CA6CtF"}
+{"version":3,"file":"get-worker-url.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-api/get-worker-url.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAC,YAAY,EAAE,aAAa,EAAC,uBAAoB;AAK7D;;GAEG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAG1D;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,GAAE,aAAkB,GAAG,MAAM,CA6CtF"}