@math.gl/tasks 0.0.0-stage → 5.0.0-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +147 -0
- package/LOADERS-GL-LICENSE.txt +52 -0
- package/README.md +26 -2
- package/THIRD-PARTY-NOTICES.md +5 -0
- package/dist/index.cjs +3454 -0
- package/dist/index.cjs.map +6 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +5 -0
- package/dist/index.js.map +1 -0
- package/dist/tasks/index.d.ts +9 -0
- package/dist/tasks/index.d.ts.map +1 -0
- package/dist/tasks/index.js +9 -0
- package/dist/tasks/index.js.map +1 -0
- package/dist/tasks/task-channel.d.ts +48 -0
- package/dist/tasks/task-channel.d.ts.map +1 -0
- package/dist/tasks/task-channel.js +166 -0
- package/dist/tasks/task-channel.js.map +1 -0
- package/dist/tasks/task-operation-queue.d.ts +26 -0
- package/dist/tasks/task-operation-queue.d.ts.map +1 -0
- package/dist/tasks/task-operation-queue.js +106 -0
- package/dist/tasks/task-operation-queue.js.map +1 -0
- package/dist/tasks/task-preload.d.ts +13 -0
- package/dist/tasks/task-preload.d.ts.map +1 -0
- package/dist/tasks/task-preload.js +96 -0
- package/dist/tasks/task-preload.js.map +1 -0
- package/dist/tasks/task-runner.d.ts +74 -0
- package/dist/tasks/task-runner.d.ts.map +1 -0
- package/dist/tasks/task-runner.js +811 -0
- package/dist/tasks/task-runner.js.map +1 -0
- package/dist/tasks/task-runtime.d.ts +27 -0
- package/dist/tasks/task-runtime.d.ts.map +1 -0
- package/dist/tasks/task-runtime.js +216 -0
- package/dist/tasks/task-runtime.js.map +1 -0
- package/dist/tasks/task-sync.d.ts +4 -0
- package/dist/tasks/task-sync.d.ts.map +1 -0
- package/dist/tasks/task-sync.js +95 -0
- package/dist/tasks/task-sync.js.map +1 -0
- package/dist/tasks/task-worker-channel.d.ts +11 -0
- package/dist/tasks/task-worker-channel.d.ts.map +1 -0
- package/dist/tasks/task-worker-channel.js +34 -0
- package/dist/tasks/task-worker-channel.js.map +1 -0
- package/dist/tasks/task.d.ts +132 -0
- package/dist/tasks/task.d.ts.map +1 -0
- package/dist/tasks/task.js +5 -0
- package/dist/tasks/task.js.map +1 -0
- package/dist/tasks/typed-task-dispatch.d.ts +30 -0
- package/dist/tasks/typed-task-dispatch.d.ts.map +1 -0
- package/dist/tasks/typed-task-dispatch.js +12 -0
- package/dist/tasks/typed-task-dispatch.js.map +1 -0
- package/dist/worker-utils/index.d.ts +25 -0
- package/dist/worker-utils/index.d.ts.map +1 -0
- package/dist/worker-utils/index.js +46 -0
- package/dist/worker-utils/index.js.map +1 -0
- package/dist/worker-utils/lib/async-queue/async-queue.d.ts +32 -0
- package/dist/worker-utils/lib/async-queue/async-queue.d.ts.map +1 -0
- package/dist/worker-utils/lib/async-queue/async-queue.js +88 -0
- package/dist/worker-utils/lib/async-queue/async-queue.js.map +1 -0
- package/dist/worker-utils/lib/env-utils/assert.d.ts +3 -0
- package/dist/worker-utils/lib/env-utils/assert.d.ts.map +1 -0
- package/dist/worker-utils/lib/env-utils/assert.js +13 -0
- package/dist/worker-utils/lib/env-utils/assert.js.map +1 -0
- package/dist/worker-utils/lib/env-utils/globals.d.ts +22 -0
- package/dist/worker-utils/lib/env-utils/globals.d.ts.map +1 -0
- package/dist/worker-utils/lib/env-utils/globals.js +30 -0
- package/dist/worker-utils/lib/env-utils/globals.js.map +1 -0
- package/dist/worker-utils/lib/env-utils/version.d.ts +3 -0
- package/dist/worker-utils/lib/env-utils/version.d.ts.map +1 -0
- package/dist/worker-utils/lib/env-utils/version.js +11 -0
- package/dist/worker-utils/lib/env-utils/version.js.map +1 -0
- package/dist/worker-utils/lib/library-utils/library-utils.d.ts +42 -0
- package/dist/worker-utils/lib/library-utils/library-utils.d.ts.map +1 -0
- package/dist/worker-utils/lib/library-utils/library-utils.js +251 -0
- package/dist/worker-utils/lib/library-utils/library-utils.js.map +1 -0
- package/dist/worker-utils/lib/node/worker_threads-browser.d.ts +15 -0
- package/dist/worker-utils/lib/node/worker_threads-browser.d.ts.map +1 -0
- package/dist/worker-utils/lib/node/worker_threads-browser.js +23 -0
- package/dist/worker-utils/lib/node/worker_threads-browser.js.map +1 -0
- package/dist/worker-utils/lib/node/worker_threads.d.ts +16 -0
- package/dist/worker-utils/lib/node/worker_threads.d.ts.map +1 -0
- package/dist/worker-utils/lib/node/worker_threads.js +7 -0
- package/dist/worker-utils/lib/node/worker_threads.js.map +1 -0
- package/dist/worker-utils/lib/npm-tag.d.ts +2 -0
- package/dist/worker-utils/lib/npm-tag.d.ts.map +1 -0
- package/dist/worker-utils/lib/npm-tag.js +5 -0
- package/dist/worker-utils/lib/npm-tag.js.map +1 -0
- package/dist/worker-utils/lib/process-utils/child-process-proxy.browser.d.ts +8 -0
- package/dist/worker-utils/lib/process-utils/child-process-proxy.browser.d.ts.map +1 -0
- package/dist/worker-utils/lib/process-utils/child-process-proxy.browser.js +18 -0
- package/dist/worker-utils/lib/process-utils/child-process-proxy.browser.js.map +1 -0
- package/dist/worker-utils/lib/process-utils/child-process-proxy.d.ts +45 -0
- package/dist/worker-utils/lib/process-utils/child-process-proxy.d.ts.map +1 -0
- package/dist/worker-utils/lib/process-utils/child-process-proxy.js +128 -0
- package/dist/worker-utils/lib/process-utils/child-process-proxy.js.map +1 -0
- package/dist/worker-utils/lib/process-utils/process-utils.d.ts +2 -0
- package/dist/worker-utils/lib/process-utils/process-utils.d.ts.map +1 -0
- package/dist/worker-utils/lib/process-utils/process-utils.js +32 -0
- package/dist/worker-utils/lib/process-utils/process-utils.js.map +1 -0
- package/dist/worker-utils/lib/worker-api/create-worker.d.ts +9 -0
- package/dist/worker-utils/lib/worker-api/create-worker.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-api/create-worker.js +229 -0
- package/dist/worker-utils/lib/worker-api/create-worker.js.map +1 -0
- package/dist/worker-utils/lib/worker-api/get-worker-url.d.ts +29 -0
- package/dist/worker-utils/lib/worker-api/get-worker-url.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-api/get-worker-url.js +101 -0
- package/dist/worker-utils/lib/worker-api/get-worker-url.js.map +1 -0
- package/dist/worker-utils/lib/worker-api/process-on-worker.d.ts +67 -0
- package/dist/worker-utils/lib/worker-api/process-on-worker.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-api/process-on-worker.js +429 -0
- package/dist/worker-utils/lib/worker-api/process-on-worker.js.map +1 -0
- package/dist/worker-utils/lib/worker-api/shared-state.d.ts +34 -0
- package/dist/worker-utils/lib/worker-api/shared-state.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-api/shared-state.js +105 -0
- package/dist/worker-utils/lib/worker-api/shared-state.js.map +1 -0
- package/dist/worker-utils/lib/worker-api/validate-output-ownership.d.ts +3 -0
- package/dist/worker-utils/lib/worker-api/validate-output-ownership.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-api/validate-output-ownership.js +10 -0
- package/dist/worker-utils/lib/worker-api/validate-output-ownership.js.map +1 -0
- package/dist/worker-utils/lib/worker-api/validate-worker-version.d.ts +9 -0
- package/dist/worker-utils/lib/worker-api/validate-worker-version.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-api/validate-worker-version.js +35 -0
- package/dist/worker-utils/lib/worker-api/validate-worker-version.js.map +1 -0
- package/dist/worker-utils/lib/worker-api/worker-resource.d.ts +33 -0
- package/dist/worker-utils/lib/worker-api/worker-resource.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-api/worker-resource.js +156 -0
- package/dist/worker-utils/lib/worker-api/worker-resource.js.map +1 -0
- package/dist/worker-utils/lib/worker-farm/worker-body.d.ts +20 -0
- package/dist/worker-utils/lib/worker-farm/worker-body.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-farm/worker-body.js +134 -0
- package/dist/worker-utils/lib/worker-farm/worker-body.js.map +1 -0
- package/dist/worker-utils/lib/worker-farm/worker-farm.d.ts +73 -0
- package/dist/worker-utils/lib/worker-farm/worker-farm.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-farm/worker-farm.js +135 -0
- package/dist/worker-utils/lib/worker-farm/worker-farm.js.map +1 -0
- package/dist/worker-utils/lib/worker-farm/worker-job.d.ts +47 -0
- package/dist/worker-utils/lib/worker-farm/worker-job.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-farm/worker-job.js +124 -0
- package/dist/worker-utils/lib/worker-farm/worker-job.js.map +1 -0
- package/dist/worker-utils/lib/worker-farm/worker-pool.d.ts +152 -0
- package/dist/worker-utils/lib/worker-farm/worker-pool.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-farm/worker-pool.js +584 -0
- package/dist/worker-utils/lib/worker-farm/worker-pool.js.map +1 -0
- package/dist/worker-utils/lib/worker-farm/worker-thread.d.ts +77 -0
- package/dist/worker-utils/lib/worker-farm/worker-thread.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-farm/worker-thread.js +215 -0
- package/dist/worker-utils/lib/worker-farm/worker-thread.js.map +1 -0
- package/dist/worker-utils/lib/worker-utils/get-input-byte-length.d.ts +5 -0
- package/dist/worker-utils/lib/worker-utils/get-input-byte-length.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-utils/get-input-byte-length.js +39 -0
- package/dist/worker-utils/lib/worker-utils/get-input-byte-length.js.map +1 -0
- package/dist/worker-utils/lib/worker-utils/get-loadable-worker-url.d.ts +15 -0
- package/dist/worker-utils/lib/worker-utils/get-loadable-worker-url.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-utils/get-loadable-worker-url.js +84 -0
- package/dist/worker-utils/lib/worker-utils/get-loadable-worker-url.js.map +1 -0
- package/dist/worker-utils/lib/worker-utils/get-transfer-list.d.ts +16 -0
- package/dist/worker-utils/lib/worker-utils/get-transfer-list.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-utils/get-transfer-list.js +127 -0
- package/dist/worker-utils/lib/worker-utils/get-transfer-list.js.map +1 -0
- package/dist/worker-utils/lib/worker-utils/remove-nontransferable-options.d.ts +6 -0
- package/dist/worker-utils/lib/worker-utils/remove-nontransferable-options.d.ts.map +1 -0
- package/dist/worker-utils/lib/worker-utils/remove-nontransferable-options.js +27 -0
- package/dist/worker-utils/lib/worker-utils/remove-nontransferable-options.js.map +1 -0
- package/dist/worker-utils/types.d.ts +165 -0
- package/dist/worker-utils/types.d.ts.map +1 -0
- package/dist/worker-utils/types.js +5 -0
- package/dist/worker-utils/types.js.map +1 -0
- package/dist/worker-utils/workers/null-worker.d.ts +2 -0
- package/dist/worker-utils/workers/null-worker.d.ts.map +1 -0
- package/dist/worker-utils/workers/null-worker.js +17 -0
- package/dist/worker-utils/workers/null-worker.js.map +1 -0
- package/package.json +43 -4
- package/src/index.ts +5 -0
- package/src/tasks/index.ts +33 -0
- package/src/tasks/task-channel.ts +191 -0
- package/src/tasks/task-operation-queue.ts +109 -0
- package/src/tasks/task-preload.ts +107 -0
- package/src/tasks/task-runner.ts +933 -0
- package/src/tasks/task-runtime.ts +244 -0
- package/src/tasks/task-sync.ts +100 -0
- package/src/tasks/task-worker-channel.ts +44 -0
- package/src/tasks/task.ts +168 -0
- package/src/tasks/typed-task-dispatch.ts +44 -0
- package/src/worker-utils/index.ts +105 -0
- package/src/worker-utils/lib/async-queue/async-queue.ts +100 -0
- package/src/worker-utils/lib/env-utils/assert.ts +14 -0
- package/src/worker-utils/lib/env-utils/globals.ts +40 -0
- package/src/worker-utils/lib/env-utils/version.ts +15 -0
- package/src/worker-utils/lib/library-utils/library-utils.ts +305 -0
- package/src/worker-utils/lib/node/worker_threads-browser.ts +44 -0
- package/src/worker-utils/lib/node/worker_threads.ts +21 -0
- package/src/worker-utils/lib/npm-tag.ts +5 -0
- package/src/worker-utils/lib/process-utils/child-process-proxy.browser.ts +23 -0
- package/src/worker-utils/lib/process-utils/child-process-proxy.ts +172 -0
- package/src/worker-utils/lib/process-utils/process-utils.ts +34 -0
- package/src/worker-utils/lib/worker-api/create-worker.ts +271 -0
- package/src/worker-utils/lib/worker-api/get-worker-url.ts +130 -0
- package/src/worker-utils/lib/worker-api/process-on-worker.ts +596 -0
- package/src/worker-utils/lib/worker-api/shared-state.ts +135 -0
- package/src/worker-utils/lib/worker-api/validate-output-ownership.ts +10 -0
- package/src/worker-utils/lib/worker-api/validate-worker-version.ts +44 -0
- package/src/worker-utils/lib/worker-api/worker-resource.ts +203 -0
- package/src/worker-utils/lib/worker-farm/worker-body.ts +154 -0
- package/src/worker-utils/lib/worker-farm/worker-farm.ts +172 -0
- package/src/worker-utils/lib/worker-farm/worker-job.ts +148 -0
- package/src/worker-utils/lib/worker-farm/worker-pool.ts +719 -0
- package/src/worker-utils/lib/worker-farm/worker-thread.ts +260 -0
- package/src/worker-utils/lib/worker-utils/get-input-byte-length.ts +34 -0
- package/src/worker-utils/lib/worker-utils/get-loadable-worker-url.ts +96 -0
- package/src/worker-utils/lib/worker-utils/get-transfer-list.ts +125 -0
- package/src/worker-utils/lib/worker-utils/remove-nontransferable-options.ts +27 -0
- package/src/worker-utils/types.ts +224 -0
- package/src/worker-utils/workers/null-worker.ts +20 -0
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
// math.gl
|
|
2
|
+
// SPDX-License-Identifier: MIT
|
|
3
|
+
// SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
|
|
4
|
+
|
|
5
|
+
import WorkerThread from '../worker-farm/worker-thread';
|
|
6
|
+
import {isBrowser} from '../env-utils/globals';
|
|
7
|
+
|
|
8
|
+
export type WorkerCapabilities = {
|
|
9
|
+
workers: boolean;
|
|
10
|
+
sharedMemory: boolean;
|
|
11
|
+
crossOriginIsolated: boolean | undefined;
|
|
12
|
+
sharedMemoryUnavailableReason?: 'cross-origin-isolation' | 'unsupported' | 'blocked';
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
/** Probe the actual realm; browser sharing requires COOP/COEP isolation (Node does not). */
|
|
16
|
+
export function getWorkerCapabilities(): WorkerCapabilities {
|
|
17
|
+
const isolated =
|
|
18
|
+
typeof globalThis.crossOriginIsolated === 'boolean'
|
|
19
|
+
? globalThis.crossOriginIsolated
|
|
20
|
+
: undefined;
|
|
21
|
+
const capabilities: WorkerCapabilities = {
|
|
22
|
+
workers: WorkerThread.isSupported(),
|
|
23
|
+
sharedMemory: false,
|
|
24
|
+
crossOriginIsolated: isolated
|
|
25
|
+
};
|
|
26
|
+
if (isBrowser && isolated !== true) {
|
|
27
|
+
capabilities.sharedMemoryUnavailableReason = 'cross-origin-isolation';
|
|
28
|
+
} else if (
|
|
29
|
+
typeof SharedArrayBuffer === 'undefined' ||
|
|
30
|
+
typeof Atomics === 'undefined' ||
|
|
31
|
+
typeof structuredClone !== 'function'
|
|
32
|
+
) {
|
|
33
|
+
capabilities.sharedMemoryUnavailableReason = 'unsupported';
|
|
34
|
+
} else {
|
|
35
|
+
try {
|
|
36
|
+
const buffer = new SharedArrayBuffer(4);
|
|
37
|
+
const cloned = structuredClone(buffer);
|
|
38
|
+
Atomics.store(new Int32Array(buffer), 0, 17);
|
|
39
|
+
capabilities.sharedMemory = Atomics.load(new Int32Array(cloned), 0) === 17;
|
|
40
|
+
if (!capabilities.sharedMemory) capabilities.sharedMemoryUnavailableReason = 'blocked';
|
|
41
|
+
} catch {
|
|
42
|
+
capabilities.sharedMemoryUnavailableReason = 'blocked';
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
return capabilities;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
export type SharedWorkerSnapshot = {
|
|
49
|
+
cancelled: boolean;
|
|
50
|
+
completed: number;
|
|
51
|
+
/** -1 means unknown. */
|
|
52
|
+
total: number;
|
|
53
|
+
revision: number;
|
|
54
|
+
};
|
|
55
|
+
|
|
56
|
+
/** Same-version, single-job atomic control state. Each field is atomic; snapshots are not transactions. */
|
|
57
|
+
export class SharedWorkerState {
|
|
58
|
+
readonly buffer: SharedArrayBuffer;
|
|
59
|
+
private values: Int32Array;
|
|
60
|
+
|
|
61
|
+
constructor(buffer: SharedArrayBuffer) {
|
|
62
|
+
if (
|
|
63
|
+
typeof SharedArrayBuffer === 'undefined' ||
|
|
64
|
+
!(buffer instanceof SharedArrayBuffer) ||
|
|
65
|
+
buffer.byteLength !== 16
|
|
66
|
+
)
|
|
67
|
+
throw new Error('Expected a 16-byte shared worker control buffer');
|
|
68
|
+
this.buffer = buffer;
|
|
69
|
+
this.values = new Int32Array(buffer);
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
get snapshot(): SharedWorkerSnapshot {
|
|
73
|
+
return {
|
|
74
|
+
cancelled: Atomics.load(this.values, 0) !== 0,
|
|
75
|
+
completed: Atomics.load(this.values, 1),
|
|
76
|
+
total: Atomics.load(this.values, 2),
|
|
77
|
+
revision: Atomics.load(this.values, 3)
|
|
78
|
+
};
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
cancel(): void {
|
|
82
|
+
Atomics.store(this.values, 0, 1);
|
|
83
|
+
Atomics.add(this.values, 3, 1);
|
|
84
|
+
Atomics.notify(this.values, 0);
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
throwIfCancelled(): void {
|
|
88
|
+
if (Atomics.load(this.values, 0) !== 0) {
|
|
89
|
+
const error = new Error('Shared worker task was cancelled');
|
|
90
|
+
error.name = 'AbortError';
|
|
91
|
+
throw error;
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
/** Integer counters for application-defined work; messages still carry phase names and units. */
|
|
96
|
+
setProgress(completed: number, total = -1): void {
|
|
97
|
+
if (
|
|
98
|
+
!Number.isInteger(completed) ||
|
|
99
|
+
completed < 0 ||
|
|
100
|
+
completed > 0x7fffffff ||
|
|
101
|
+
!Number.isInteger(total) ||
|
|
102
|
+
total < -1 ||
|
|
103
|
+
total > 0x7fffffff
|
|
104
|
+
) {
|
|
105
|
+
throw new RangeError('Shared progress requires nonnegative int32 counts (or total -1)');
|
|
106
|
+
}
|
|
107
|
+
Atomics.store(this.values, 1, completed);
|
|
108
|
+
Atomics.store(this.values, 2, total);
|
|
109
|
+
Atomics.add(this.values, 3, 1);
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
/** Returns null when unavailable, leaving message-based cancellation/progress usable. */
|
|
114
|
+
export function createSharedWorkerState(): SharedWorkerState | null {
|
|
115
|
+
if (!getWorkerCapabilities().sharedMemory) return null;
|
|
116
|
+
const state = new SharedWorkerState(new SharedArrayBuffer(16));
|
|
117
|
+
state.setProgress(0);
|
|
118
|
+
return state;
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
/** Caller-side setup: opt into shared control automatically for cooperative jobs when available. */
|
|
122
|
+
export function prepareSharedState<
|
|
123
|
+
T extends {cancellationMode?: string; sharedState?: SharedArrayBuffer | false}
|
|
124
|
+
>(options: T): T {
|
|
125
|
+
if (options.sharedState === undefined && options.cancellationMode === 'cooperative') {
|
|
126
|
+
const state = createSharedWorkerState();
|
|
127
|
+
return state ? {...options, sharedState: state.buffer} : options;
|
|
128
|
+
}
|
|
129
|
+
if (options.sharedState) {
|
|
130
|
+
if (!getWorkerCapabilities().sharedMemory)
|
|
131
|
+
throw new Error('Shared worker memory is unavailable');
|
|
132
|
+
new SharedWorkerState(options.sharedState).throwIfCancelled();
|
|
133
|
+
}
|
|
134
|
+
return options;
|
|
135
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
// math.gl
|
|
2
|
+
// SPDX-License-Identifier: MIT
|
|
3
|
+
// SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
|
|
4
|
+
|
|
5
|
+
/** Reject unknown output ownership modes before dispatch or processing. */
|
|
6
|
+
export function validateOutputOwnership(ownership: unknown): void {
|
|
7
|
+
if (ownership !== undefined && ownership !== 'copy' && ownership !== 'transfer') {
|
|
8
|
+
throw new Error('Invalid worker output ownership');
|
|
9
|
+
}
|
|
10
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
// loaders.gl
|
|
2
|
+
// SPDX-License-Identifier: MIT
|
|
3
|
+
// SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
|
|
4
|
+
|
|
5
|
+
import type {WorkerObject} from '../../types';
|
|
6
|
+
import {assert} from '../env-utils/assert';
|
|
7
|
+
import {VERSION} from '../env-utils/version';
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Check if worker is compatible with this library version
|
|
11
|
+
* @param worker
|
|
12
|
+
* @param libVersion
|
|
13
|
+
* @returns `true` if the two versions are compatible
|
|
14
|
+
*/
|
|
15
|
+
export function validateWorkerVersion(
|
|
16
|
+
worker: WorkerObject,
|
|
17
|
+
coreVersion: string = VERSION
|
|
18
|
+
): boolean {
|
|
19
|
+
assert(worker, 'no worker provided');
|
|
20
|
+
|
|
21
|
+
const workerVersion = worker.version;
|
|
22
|
+
if (!coreVersion || !workerVersion) {
|
|
23
|
+
return false;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
// TODO enable when fix the __version__ injection
|
|
27
|
+
// const coreVersions = parseVersion(coreVersion);
|
|
28
|
+
// const workerVersions = parseVersion(workerVersion);
|
|
29
|
+
// assert(
|
|
30
|
+
// coreVersion.major === workerVersion.major && coreVersion.minor <= workerVersion.minor,
|
|
31
|
+
// `worker: ${worker.name} is not compatible. ${coreVersion.major}.${
|
|
32
|
+
// coreVersion.minor
|
|
33
|
+
// }+ is required.`
|
|
34
|
+
// );
|
|
35
|
+
|
|
36
|
+
return true;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
// @ts-ignore
|
|
40
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
41
|
+
function _parseVersion(version) {
|
|
42
|
+
const parts = version.split('.').map(Number);
|
|
43
|
+
return {major: parts[0], minor: parts[1]};
|
|
44
|
+
}
|
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
// math.gl
|
|
2
|
+
// SPDX-License-Identifier: MIT
|
|
3
|
+
// SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
|
|
4
|
+
|
|
5
|
+
import type {WorkerObject, WorkerContext, WorkerOptions} from '../../types';
|
|
6
|
+
import WorkerPool from '../worker-farm/worker-pool';
|
|
7
|
+
import type WorkerThread from '../worker-farm/worker-thread';
|
|
8
|
+
import {getWorkerName} from './get-worker-url';
|
|
9
|
+
import {getWorkerPoolTarget, validateSharedInput} from './process-on-worker';
|
|
10
|
+
import {getTransferListForWriter} from '../worker-utils/get-transfer-list';
|
|
11
|
+
import {getInputByteLength} from '../worker-utils/get-input-byte-length';
|
|
12
|
+
import {prepareSharedState, SharedWorkerState} from './shared-state';
|
|
13
|
+
import {createWorker} from './create-worker';
|
|
14
|
+
import {validateOutputOwnership} from './validate-output-ownership';
|
|
15
|
+
|
|
16
|
+
export type ResourceRequest<Init, Input> =
|
|
17
|
+
| {operation: 'initialize'; input: Init}
|
|
18
|
+
| {operation: 'run'; input: Input}
|
|
19
|
+
| {operation: 'dispose'};
|
|
20
|
+
export type WorkerResourceObject<Init, Input, Output> = WorkerObject<
|
|
21
|
+
ResourceRequest<Init, Input>,
|
|
22
|
+
{value?: Output}
|
|
23
|
+
>;
|
|
24
|
+
/** Per-call controls; pool configuration belongs to createWorkerResource. */
|
|
25
|
+
export type WorkerResourceRunOptions = Pick<
|
|
26
|
+
WorkerOptions,
|
|
27
|
+
| 'inputOwnership'
|
|
28
|
+
| 'outputOwnership'
|
|
29
|
+
| 'signal'
|
|
30
|
+
| 'onProgress'
|
|
31
|
+
| 'priority'
|
|
32
|
+
| 'cancellationMode'
|
|
33
|
+
| 'cancellationTimeout'
|
|
34
|
+
| 'sharedState'
|
|
35
|
+
>;
|
|
36
|
+
export type WorkerResource<Input, Output> = {
|
|
37
|
+
run(input: Input, options?: WorkerResourceRunOptions): Promise<Output>;
|
|
38
|
+
/** Stops accepting calls, drains submitted work, disposes state, then terminates the worker. */
|
|
39
|
+
destroy(options?: {timeout?: number}): Promise<void>;
|
|
40
|
+
readonly stats: WorkerPool['stats'];
|
|
41
|
+
};
|
|
42
|
+
|
|
43
|
+
/** Installs a typed stateful processor. State never crosses the structured-clone boundary. */
|
|
44
|
+
export function createResourceWorker<State, Init, Input, Output>(handlers: {
|
|
45
|
+
initialize: (input: Init, context: WorkerContext) => State | Promise<State>;
|
|
46
|
+
run: (state: State, input: Input, context: WorkerContext) => Output | Promise<Output>;
|
|
47
|
+
dispose?: (state: State) => void | Promise<void>;
|
|
48
|
+
}): Promise<void> {
|
|
49
|
+
let initialized = false;
|
|
50
|
+
let state: State;
|
|
51
|
+
return createWorker(async (request: ResourceRequest<Init, Input>, _options, context) => {
|
|
52
|
+
if (request.operation === 'initialize') {
|
|
53
|
+
if (initialized) throw new Error('Worker resource is already initialized');
|
|
54
|
+
state = await handlers.initialize(request.input, context);
|
|
55
|
+
initialized = true;
|
|
56
|
+
return {};
|
|
57
|
+
}
|
|
58
|
+
if (!initialized) throw new Error('Worker resource is not initialized');
|
|
59
|
+
if (request.operation === 'dispose') {
|
|
60
|
+
initialized = false;
|
|
61
|
+
await handlers.dispose?.(state);
|
|
62
|
+
state = undefined;
|
|
63
|
+
return {};
|
|
64
|
+
}
|
|
65
|
+
return {value: await handlers.run(state, request.input, context)};
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
/** Creates a resource pinned to one worker incarnation; crashes and hard aborts invalidate it. */
|
|
70
|
+
export async function createWorkerResource<Init, Input, Output>(
|
|
71
|
+
worker: WorkerResourceObject<Init, Input, Output>,
|
|
72
|
+
initialization: Init,
|
|
73
|
+
options: WorkerOptions = {}
|
|
74
|
+
): Promise<WorkerResource<Input, Output>> {
|
|
75
|
+
const pool = new WorkerPool({
|
|
76
|
+
maxQueuedJobs: 32,
|
|
77
|
+
...options,
|
|
78
|
+
...getWorkerPoolTarget(worker, options, getWorkerName(worker)),
|
|
79
|
+
maxConcurrency: 1,
|
|
80
|
+
maxMobileConcurrency: 1,
|
|
81
|
+
reuseWorkers: true
|
|
82
|
+
});
|
|
83
|
+
let incarnation: WorkerThread | undefined;
|
|
84
|
+
let closed = false;
|
|
85
|
+
let disposal: Promise<void> | undefined;
|
|
86
|
+
const pending = new Set<Promise<unknown>>();
|
|
87
|
+
const invoke = async (request: ResourceRequest<Init, Input>, callOptions: WorkerOptions) => {
|
|
88
|
+
if (incarnation?.terminated)
|
|
89
|
+
throw new Error('Worker resource was invalidated; create a new resource');
|
|
90
|
+
// Creation-time signals and control buffers apply only to initialization.
|
|
91
|
+
// Preserve false as a resource-wide opt-out, but never reuse an operation's control buffer.
|
|
92
|
+
const prepared = prepareSharedState({
|
|
93
|
+
...options,
|
|
94
|
+
signal: undefined,
|
|
95
|
+
sharedState: options.sharedState === false ? false : undefined,
|
|
96
|
+
...callOptions
|
|
97
|
+
});
|
|
98
|
+
const {signal, onProgress, onMetrics, ...serializable} = prepared;
|
|
99
|
+
validateOutputOwnership(prepared.outputOwnership);
|
|
100
|
+
validateSharedInput(serializable, [request, serializable]);
|
|
101
|
+
const {sharedState: _controlBuffer, ...inputOptions} = serializable;
|
|
102
|
+
const job = await pool.startJob(
|
|
103
|
+
worker.name,
|
|
104
|
+
(active, type, payload) => {
|
|
105
|
+
if (type === 'done') active.done(payload);
|
|
106
|
+
else if (type === 'error') {
|
|
107
|
+
const error = new Error(payload.error);
|
|
108
|
+
error.name = payload.errorName || 'Error';
|
|
109
|
+
active.error(error);
|
|
110
|
+
} else if (type === 'progress' && !active.isCancelled) {
|
|
111
|
+
try {
|
|
112
|
+
onProgress?.(payload.progress);
|
|
113
|
+
} catch (error) {
|
|
114
|
+
active.abort(error);
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
},
|
|
118
|
+
undefined,
|
|
119
|
+
signal,
|
|
120
|
+
{
|
|
121
|
+
sharedState: prepared.sharedState ? new SharedWorkerState(prepared.sharedState) : undefined,
|
|
122
|
+
inputBytes: getInputByteLength([request, inputOptions]),
|
|
123
|
+
priority: callOptions.priority,
|
|
124
|
+
cancellationMode: callOptions.cancellationMode ?? options.cancellationMode,
|
|
125
|
+
cancellationTimeout: callOptions.cancellationTimeout ?? options.cancellationTimeout
|
|
126
|
+
}
|
|
127
|
+
);
|
|
128
|
+
if (incarnation && incarnation !== job.workerThread) {
|
|
129
|
+
const error = new Error('Worker resource was invalidated; create a new resource');
|
|
130
|
+
job.error(error);
|
|
131
|
+
pool.destroy(error);
|
|
132
|
+
throw error;
|
|
133
|
+
}
|
|
134
|
+
incarnation = job.workerThread;
|
|
135
|
+
try {
|
|
136
|
+
job.postMessage(
|
|
137
|
+
'process',
|
|
138
|
+
{input: request, options: getTransferListForWriter(serializable)},
|
|
139
|
+
serializable.inputOwnership === 'copy' || serializable.inputOwnership === 'share'
|
|
140
|
+
? []
|
|
141
|
+
: undefined
|
|
142
|
+
);
|
|
143
|
+
return (await job.result).result as {value?: Output};
|
|
144
|
+
} catch (error) {
|
|
145
|
+
if (!job.isCancelled && job.isRunning) job.abort(error);
|
|
146
|
+
throw error;
|
|
147
|
+
}
|
|
148
|
+
};
|
|
149
|
+
try {
|
|
150
|
+
await invoke({operation: 'initialize', input: initialization}, options);
|
|
151
|
+
} catch (error) {
|
|
152
|
+
pool.destroy(error);
|
|
153
|
+
throw error;
|
|
154
|
+
}
|
|
155
|
+
return {
|
|
156
|
+
get stats() {
|
|
157
|
+
return pool.stats;
|
|
158
|
+
},
|
|
159
|
+
run(input, callOptions = {}) {
|
|
160
|
+
if (closed) return Promise.reject(new Error('Worker resource was destroyed'));
|
|
161
|
+
const result = invoke({operation: 'run', input}, callOptions).then(
|
|
162
|
+
response => response.value as Output
|
|
163
|
+
);
|
|
164
|
+
pending.add(result);
|
|
165
|
+
void result.then(
|
|
166
|
+
() => pending.delete(result),
|
|
167
|
+
() => pending.delete(result)
|
|
168
|
+
);
|
|
169
|
+
return result;
|
|
170
|
+
},
|
|
171
|
+
destroy(destroyOptions = {}) {
|
|
172
|
+
if (disposal) return disposal;
|
|
173
|
+
const timeout = destroyOptions.timeout ?? 1000;
|
|
174
|
+
if (!Number.isFinite(timeout) || timeout < 0) {
|
|
175
|
+
return Promise.reject(
|
|
176
|
+
new RangeError('Resource destroy timeout must be finite and nonnegative')
|
|
177
|
+
);
|
|
178
|
+
}
|
|
179
|
+
closed = true;
|
|
180
|
+
disposal = (async () => {
|
|
181
|
+
let timedOut = false;
|
|
182
|
+
const timeoutError = new Error('Worker resource destruction timed out');
|
|
183
|
+
const timer = setTimeout(() => {
|
|
184
|
+
timedOut = true;
|
|
185
|
+
void pool.destroy(timeoutError);
|
|
186
|
+
}, timeout);
|
|
187
|
+
try {
|
|
188
|
+
await Promise.allSettled([...pending]);
|
|
189
|
+
if (!incarnation?.terminated)
|
|
190
|
+
await invoke(
|
|
191
|
+
{operation: 'dispose'},
|
|
192
|
+
{signal: undefined, onProgress: undefined, sharedState: false}
|
|
193
|
+
);
|
|
194
|
+
if (timedOut) throw timeoutError;
|
|
195
|
+
} finally {
|
|
196
|
+
clearTimeout(timer);
|
|
197
|
+
await pool.destroy();
|
|
198
|
+
}
|
|
199
|
+
})();
|
|
200
|
+
return disposal;
|
|
201
|
+
}
|
|
202
|
+
};
|
|
203
|
+
}
|
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
// loaders.gl
|
|
2
|
+
// SPDX-License-Identifier: MIT
|
|
3
|
+
// SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
|
|
4
|
+
|
|
5
|
+
import type {WorkerMessageData, WorkerMessageType, WorkerMessagePayload} from '../../types';
|
|
6
|
+
import {getTransferList} from '../worker-utils/get-transfer-list';
|
|
7
|
+
// import type {TransferListItem} from '../node/worker_threads';
|
|
8
|
+
import {parentPort} from '../node/worker_threads';
|
|
9
|
+
|
|
10
|
+
type TransferListItem = any;
|
|
11
|
+
type WorkerMessageEvent = MessageEvent<WorkerMessageData> | WorkerMessageData;
|
|
12
|
+
type WorkerMessageListener = (type: WorkerMessageType, payload: WorkerMessagePayload) => any;
|
|
13
|
+
|
|
14
|
+
/** Vile hack to defeat over-zealous bundlers from stripping out the require */
|
|
15
|
+
async function getParentPort() {
|
|
16
|
+
// const isNode = globalThis.process;
|
|
17
|
+
// let parentPort;
|
|
18
|
+
// try {
|
|
19
|
+
// // biome-ignore format: preserve intentional fixture layout
|
|
20
|
+
// eval('globalThis.parentPort = require(\'worker_threads\').parentPort'); // eslint-disable-line no-eval
|
|
21
|
+
// parentPort = globalThis.parentPort;
|
|
22
|
+
// } catch {
|
|
23
|
+
// try {
|
|
24
|
+
// // biome-ignore format: preserve intentional fixture layout
|
|
25
|
+
// eval('globalThis.workerThreadsPromise = import(\'worker_threads\')'); // eslint-disable-line no-eval
|
|
26
|
+
// const workerThreads = await globalThis.workerThreadsPromise;
|
|
27
|
+
// parentPort = workerThreads.parentPort;
|
|
28
|
+
// } catch (error) {
|
|
29
|
+
// console.error((error as Error).message); // eslint-disable-line no-console
|
|
30
|
+
// }
|
|
31
|
+
// }
|
|
32
|
+
return parentPort;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
const onMessageWrapperMap = new Map<WorkerMessageListener, (message: WorkerMessageEvent) => void>();
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Type safe wrapper for worker code
|
|
39
|
+
*/
|
|
40
|
+
export default class WorkerBody {
|
|
41
|
+
/** Check that we are actually in a worker thread */
|
|
42
|
+
static async inWorkerThread(): Promise<boolean> {
|
|
43
|
+
const workerGlobalScope = (globalThis as any).WorkerGlobalScope;
|
|
44
|
+
return (
|
|
45
|
+
(typeof workerGlobalScope === 'function' && globalThis instanceof workerGlobalScope) ||
|
|
46
|
+
Boolean(await getParentPort())
|
|
47
|
+
);
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/*
|
|
51
|
+
* (type: WorkerMessageType, payload: WorkerMessagePayload) => any
|
|
52
|
+
*/
|
|
53
|
+
static set onmessage(onMessage: (type: WorkerMessageType, payload: WorkerMessagePayload) => any) {
|
|
54
|
+
async function handleMessage(message) {
|
|
55
|
+
const parentPort = await getParentPort();
|
|
56
|
+
// Confusingly the message itself also has a 'type' field which is always set to 'message'
|
|
57
|
+
const {type, payload} = parentPort ? message : message.data;
|
|
58
|
+
// if (!isKnownMessage(message)) {
|
|
59
|
+
// return;
|
|
60
|
+
// }
|
|
61
|
+
onMessage(type, payload);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
getParentPort().then(parentPort => {
|
|
65
|
+
if (parentPort) {
|
|
66
|
+
parentPort.on('message', message => {
|
|
67
|
+
handleMessage(message);
|
|
68
|
+
});
|
|
69
|
+
// if (message == 'exit') { parentPort.unref(); }
|
|
70
|
+
// eslint-disable-next-line
|
|
71
|
+
// biome-ignore lint/suspicious/noConsole: Preserve upstream worker diagnostics.
|
|
72
|
+
parentPort.on('exit', () => console.debug('Node worker closing'));
|
|
73
|
+
} else {
|
|
74
|
+
// eslint-disable-next-line no-restricted-globals
|
|
75
|
+
globalThis.onmessage = handleMessage;
|
|
76
|
+
}
|
|
77
|
+
});
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
static async addEventListener(onMessage: WorkerMessageListener) {
|
|
81
|
+
let onMessageWrapper = onMessageWrapperMap.get(onMessage);
|
|
82
|
+
|
|
83
|
+
if (!onMessageWrapper) {
|
|
84
|
+
onMessageWrapper = (message: WorkerMessageEvent) => {
|
|
85
|
+
const messageData = getWorkerMessageData(message);
|
|
86
|
+
if (!messageData) {
|
|
87
|
+
return;
|
|
88
|
+
}
|
|
89
|
+
onMessage(messageData.type, messageData.payload);
|
|
90
|
+
};
|
|
91
|
+
onMessageWrapperMap.set(onMessage, onMessageWrapper);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
const parentPort = await getParentPort();
|
|
95
|
+
if (parentPort) {
|
|
96
|
+
parentPort.on('message', onMessageWrapper);
|
|
97
|
+
} else {
|
|
98
|
+
globalThis.addEventListener('message', onMessageWrapper);
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
static async removeEventListener(onMessage: WorkerMessageListener) {
|
|
103
|
+
const onMessageWrapper = onMessageWrapperMap.get(onMessage);
|
|
104
|
+
onMessageWrapperMap.delete(onMessage);
|
|
105
|
+
if (!onMessageWrapper) {
|
|
106
|
+
return;
|
|
107
|
+
}
|
|
108
|
+
const parentPort = await getParentPort();
|
|
109
|
+
if (parentPort) {
|
|
110
|
+
parentPort.off('message', onMessageWrapper);
|
|
111
|
+
} else {
|
|
112
|
+
globalThis.removeEventListener('message', onMessageWrapper);
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* Send a message from a worker to creating thread (main thread)
|
|
118
|
+
* @param type
|
|
119
|
+
* @param payload
|
|
120
|
+
*/
|
|
121
|
+
static async postMessage(
|
|
122
|
+
type: WorkerMessageType,
|
|
123
|
+
payload: WorkerMessagePayload,
|
|
124
|
+
copy = false
|
|
125
|
+
): Promise<void> {
|
|
126
|
+
const data: WorkerMessageData = {source: 'loaders.gl', type, payload};
|
|
127
|
+
// console.log('posting message', data);
|
|
128
|
+
|
|
129
|
+
// Cast to Node compatible transfer list
|
|
130
|
+
const transferList = copy ? [] : (getTransferList(payload) as TransferListItem[]);
|
|
131
|
+
|
|
132
|
+
const parentPort = await getParentPort();
|
|
133
|
+
if (parentPort) {
|
|
134
|
+
parentPort.postMessage(data, transferList);
|
|
135
|
+
// console.log('posted message', data);
|
|
136
|
+
} else {
|
|
137
|
+
// @ts-expect-error Outside of worker scopes this call has a third parameter
|
|
138
|
+
globalThis.postMessage(data, transferList);
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
// Filter out noise messages sent to workers
|
|
144
|
+
function getWorkerMessageData(message: WorkerMessageEvent): WorkerMessageData | null {
|
|
145
|
+
if (!message || typeof message !== 'object') {
|
|
146
|
+
return null;
|
|
147
|
+
}
|
|
148
|
+
const messageData = 'data' in message && message.type === 'message' ? message.data : message;
|
|
149
|
+
return messageData &&
|
|
150
|
+
typeof messageData.source === 'string' &&
|
|
151
|
+
messageData.source.startsWith('loaders.gl')
|
|
152
|
+
? messageData
|
|
153
|
+
: null;
|
|
154
|
+
}
|