@math.gl/tasks 0.0.0-stage → 5.0.0-beta.5

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.
Files changed (212) hide show
  1. package/LICENSE +147 -0
  2. package/LOADERS-GL-LICENSE.txt +52 -0
  3. package/README.md +26 -2
  4. package/THIRD-PARTY-NOTICES.md +5 -0
  5. package/dist/index.cjs +3454 -0
  6. package/dist/index.cjs.map +6 -0
  7. package/dist/index.d.ts +2 -0
  8. package/dist/index.d.ts.map +1 -0
  9. package/dist/index.js +5 -0
  10. package/dist/index.js.map +1 -0
  11. package/dist/tasks/index.d.ts +9 -0
  12. package/dist/tasks/index.d.ts.map +1 -0
  13. package/dist/tasks/index.js +9 -0
  14. package/dist/tasks/index.js.map +1 -0
  15. package/dist/tasks/task-channel.d.ts +48 -0
  16. package/dist/tasks/task-channel.d.ts.map +1 -0
  17. package/dist/tasks/task-channel.js +166 -0
  18. package/dist/tasks/task-channel.js.map +1 -0
  19. package/dist/tasks/task-operation-queue.d.ts +26 -0
  20. package/dist/tasks/task-operation-queue.d.ts.map +1 -0
  21. package/dist/tasks/task-operation-queue.js +106 -0
  22. package/dist/tasks/task-operation-queue.js.map +1 -0
  23. package/dist/tasks/task-preload.d.ts +13 -0
  24. package/dist/tasks/task-preload.d.ts.map +1 -0
  25. package/dist/tasks/task-preload.js +96 -0
  26. package/dist/tasks/task-preload.js.map +1 -0
  27. package/dist/tasks/task-runner.d.ts +74 -0
  28. package/dist/tasks/task-runner.d.ts.map +1 -0
  29. package/dist/tasks/task-runner.js +811 -0
  30. package/dist/tasks/task-runner.js.map +1 -0
  31. package/dist/tasks/task-runtime.d.ts +27 -0
  32. package/dist/tasks/task-runtime.d.ts.map +1 -0
  33. package/dist/tasks/task-runtime.js +216 -0
  34. package/dist/tasks/task-runtime.js.map +1 -0
  35. package/dist/tasks/task-sync.d.ts +4 -0
  36. package/dist/tasks/task-sync.d.ts.map +1 -0
  37. package/dist/tasks/task-sync.js +95 -0
  38. package/dist/tasks/task-sync.js.map +1 -0
  39. package/dist/tasks/task-worker-channel.d.ts +11 -0
  40. package/dist/tasks/task-worker-channel.d.ts.map +1 -0
  41. package/dist/tasks/task-worker-channel.js +34 -0
  42. package/dist/tasks/task-worker-channel.js.map +1 -0
  43. package/dist/tasks/task.d.ts +132 -0
  44. package/dist/tasks/task.d.ts.map +1 -0
  45. package/dist/tasks/task.js +5 -0
  46. package/dist/tasks/task.js.map +1 -0
  47. package/dist/tasks/typed-task-dispatch.d.ts +30 -0
  48. package/dist/tasks/typed-task-dispatch.d.ts.map +1 -0
  49. package/dist/tasks/typed-task-dispatch.js +12 -0
  50. package/dist/tasks/typed-task-dispatch.js.map +1 -0
  51. package/dist/worker-utils/index.d.ts +25 -0
  52. package/dist/worker-utils/index.d.ts.map +1 -0
  53. package/dist/worker-utils/index.js +46 -0
  54. package/dist/worker-utils/index.js.map +1 -0
  55. package/dist/worker-utils/lib/async-queue/async-queue.d.ts +32 -0
  56. package/dist/worker-utils/lib/async-queue/async-queue.d.ts.map +1 -0
  57. package/dist/worker-utils/lib/async-queue/async-queue.js +88 -0
  58. package/dist/worker-utils/lib/async-queue/async-queue.js.map +1 -0
  59. package/dist/worker-utils/lib/env-utils/assert.d.ts +3 -0
  60. package/dist/worker-utils/lib/env-utils/assert.d.ts.map +1 -0
  61. package/dist/worker-utils/lib/env-utils/assert.js +13 -0
  62. package/dist/worker-utils/lib/env-utils/assert.js.map +1 -0
  63. package/dist/worker-utils/lib/env-utils/globals.d.ts +22 -0
  64. package/dist/worker-utils/lib/env-utils/globals.d.ts.map +1 -0
  65. package/dist/worker-utils/lib/env-utils/globals.js +30 -0
  66. package/dist/worker-utils/lib/env-utils/globals.js.map +1 -0
  67. package/dist/worker-utils/lib/env-utils/version.d.ts +3 -0
  68. package/dist/worker-utils/lib/env-utils/version.d.ts.map +1 -0
  69. package/dist/worker-utils/lib/env-utils/version.js +11 -0
  70. package/dist/worker-utils/lib/env-utils/version.js.map +1 -0
  71. package/dist/worker-utils/lib/library-utils/library-utils.d.ts +42 -0
  72. package/dist/worker-utils/lib/library-utils/library-utils.d.ts.map +1 -0
  73. package/dist/worker-utils/lib/library-utils/library-utils.js +251 -0
  74. package/dist/worker-utils/lib/library-utils/library-utils.js.map +1 -0
  75. package/dist/worker-utils/lib/node/worker_threads-browser.d.ts +15 -0
  76. package/dist/worker-utils/lib/node/worker_threads-browser.d.ts.map +1 -0
  77. package/dist/worker-utils/lib/node/worker_threads-browser.js +23 -0
  78. package/dist/worker-utils/lib/node/worker_threads-browser.js.map +1 -0
  79. package/dist/worker-utils/lib/node/worker_threads.d.ts +16 -0
  80. package/dist/worker-utils/lib/node/worker_threads.d.ts.map +1 -0
  81. package/dist/worker-utils/lib/node/worker_threads.js +7 -0
  82. package/dist/worker-utils/lib/node/worker_threads.js.map +1 -0
  83. package/dist/worker-utils/lib/npm-tag.d.ts +2 -0
  84. package/dist/worker-utils/lib/npm-tag.d.ts.map +1 -0
  85. package/dist/worker-utils/lib/npm-tag.js +5 -0
  86. package/dist/worker-utils/lib/npm-tag.js.map +1 -0
  87. package/dist/worker-utils/lib/process-utils/child-process-proxy.browser.d.ts +8 -0
  88. package/dist/worker-utils/lib/process-utils/child-process-proxy.browser.d.ts.map +1 -0
  89. package/dist/worker-utils/lib/process-utils/child-process-proxy.browser.js +18 -0
  90. package/dist/worker-utils/lib/process-utils/child-process-proxy.browser.js.map +1 -0
  91. package/dist/worker-utils/lib/process-utils/child-process-proxy.d.ts +45 -0
  92. package/dist/worker-utils/lib/process-utils/child-process-proxy.d.ts.map +1 -0
  93. package/dist/worker-utils/lib/process-utils/child-process-proxy.js +128 -0
  94. package/dist/worker-utils/lib/process-utils/child-process-proxy.js.map +1 -0
  95. package/dist/worker-utils/lib/process-utils/process-utils.d.ts +2 -0
  96. package/dist/worker-utils/lib/process-utils/process-utils.d.ts.map +1 -0
  97. package/dist/worker-utils/lib/process-utils/process-utils.js +32 -0
  98. package/dist/worker-utils/lib/process-utils/process-utils.js.map +1 -0
  99. package/dist/worker-utils/lib/worker-api/create-worker.d.ts +9 -0
  100. package/dist/worker-utils/lib/worker-api/create-worker.d.ts.map +1 -0
  101. package/dist/worker-utils/lib/worker-api/create-worker.js +229 -0
  102. package/dist/worker-utils/lib/worker-api/create-worker.js.map +1 -0
  103. package/dist/worker-utils/lib/worker-api/get-worker-url.d.ts +29 -0
  104. package/dist/worker-utils/lib/worker-api/get-worker-url.d.ts.map +1 -0
  105. package/dist/worker-utils/lib/worker-api/get-worker-url.js +101 -0
  106. package/dist/worker-utils/lib/worker-api/get-worker-url.js.map +1 -0
  107. package/dist/worker-utils/lib/worker-api/process-on-worker.d.ts +67 -0
  108. package/dist/worker-utils/lib/worker-api/process-on-worker.d.ts.map +1 -0
  109. package/dist/worker-utils/lib/worker-api/process-on-worker.js +429 -0
  110. package/dist/worker-utils/lib/worker-api/process-on-worker.js.map +1 -0
  111. package/dist/worker-utils/lib/worker-api/shared-state.d.ts +34 -0
  112. package/dist/worker-utils/lib/worker-api/shared-state.d.ts.map +1 -0
  113. package/dist/worker-utils/lib/worker-api/shared-state.js +105 -0
  114. package/dist/worker-utils/lib/worker-api/shared-state.js.map +1 -0
  115. package/dist/worker-utils/lib/worker-api/validate-output-ownership.d.ts +3 -0
  116. package/dist/worker-utils/lib/worker-api/validate-output-ownership.d.ts.map +1 -0
  117. package/dist/worker-utils/lib/worker-api/validate-output-ownership.js +10 -0
  118. package/dist/worker-utils/lib/worker-api/validate-output-ownership.js.map +1 -0
  119. package/dist/worker-utils/lib/worker-api/validate-worker-version.d.ts +9 -0
  120. package/dist/worker-utils/lib/worker-api/validate-worker-version.d.ts.map +1 -0
  121. package/dist/worker-utils/lib/worker-api/validate-worker-version.js +35 -0
  122. package/dist/worker-utils/lib/worker-api/validate-worker-version.js.map +1 -0
  123. package/dist/worker-utils/lib/worker-api/worker-resource.d.ts +33 -0
  124. package/dist/worker-utils/lib/worker-api/worker-resource.d.ts.map +1 -0
  125. package/dist/worker-utils/lib/worker-api/worker-resource.js +156 -0
  126. package/dist/worker-utils/lib/worker-api/worker-resource.js.map +1 -0
  127. package/dist/worker-utils/lib/worker-farm/worker-body.d.ts +20 -0
  128. package/dist/worker-utils/lib/worker-farm/worker-body.d.ts.map +1 -0
  129. package/dist/worker-utils/lib/worker-farm/worker-body.js +134 -0
  130. package/dist/worker-utils/lib/worker-farm/worker-body.js.map +1 -0
  131. package/dist/worker-utils/lib/worker-farm/worker-farm.d.ts +73 -0
  132. package/dist/worker-utils/lib/worker-farm/worker-farm.d.ts.map +1 -0
  133. package/dist/worker-utils/lib/worker-farm/worker-farm.js +135 -0
  134. package/dist/worker-utils/lib/worker-farm/worker-farm.js.map +1 -0
  135. package/dist/worker-utils/lib/worker-farm/worker-job.d.ts +47 -0
  136. package/dist/worker-utils/lib/worker-farm/worker-job.d.ts.map +1 -0
  137. package/dist/worker-utils/lib/worker-farm/worker-job.js +124 -0
  138. package/dist/worker-utils/lib/worker-farm/worker-job.js.map +1 -0
  139. package/dist/worker-utils/lib/worker-farm/worker-pool.d.ts +152 -0
  140. package/dist/worker-utils/lib/worker-farm/worker-pool.d.ts.map +1 -0
  141. package/dist/worker-utils/lib/worker-farm/worker-pool.js +584 -0
  142. package/dist/worker-utils/lib/worker-farm/worker-pool.js.map +1 -0
  143. package/dist/worker-utils/lib/worker-farm/worker-thread.d.ts +77 -0
  144. package/dist/worker-utils/lib/worker-farm/worker-thread.d.ts.map +1 -0
  145. package/dist/worker-utils/lib/worker-farm/worker-thread.js +215 -0
  146. package/dist/worker-utils/lib/worker-farm/worker-thread.js.map +1 -0
  147. package/dist/worker-utils/lib/worker-utils/get-input-byte-length.d.ts +5 -0
  148. package/dist/worker-utils/lib/worker-utils/get-input-byte-length.d.ts.map +1 -0
  149. package/dist/worker-utils/lib/worker-utils/get-input-byte-length.js +39 -0
  150. package/dist/worker-utils/lib/worker-utils/get-input-byte-length.js.map +1 -0
  151. package/dist/worker-utils/lib/worker-utils/get-loadable-worker-url.d.ts +15 -0
  152. package/dist/worker-utils/lib/worker-utils/get-loadable-worker-url.d.ts.map +1 -0
  153. package/dist/worker-utils/lib/worker-utils/get-loadable-worker-url.js +84 -0
  154. package/dist/worker-utils/lib/worker-utils/get-loadable-worker-url.js.map +1 -0
  155. package/dist/worker-utils/lib/worker-utils/get-transfer-list.d.ts +16 -0
  156. package/dist/worker-utils/lib/worker-utils/get-transfer-list.d.ts.map +1 -0
  157. package/dist/worker-utils/lib/worker-utils/get-transfer-list.js +127 -0
  158. package/dist/worker-utils/lib/worker-utils/get-transfer-list.js.map +1 -0
  159. package/dist/worker-utils/lib/worker-utils/remove-nontransferable-options.d.ts +6 -0
  160. package/dist/worker-utils/lib/worker-utils/remove-nontransferable-options.d.ts.map +1 -0
  161. package/dist/worker-utils/lib/worker-utils/remove-nontransferable-options.js +27 -0
  162. package/dist/worker-utils/lib/worker-utils/remove-nontransferable-options.js.map +1 -0
  163. package/dist/worker-utils/types.d.ts +165 -0
  164. package/dist/worker-utils/types.d.ts.map +1 -0
  165. package/dist/worker-utils/types.js +5 -0
  166. package/dist/worker-utils/types.js.map +1 -0
  167. package/dist/worker-utils/workers/null-worker.d.ts +2 -0
  168. package/dist/worker-utils/workers/null-worker.d.ts.map +1 -0
  169. package/dist/worker-utils/workers/null-worker.js +17 -0
  170. package/dist/worker-utils/workers/null-worker.js.map +1 -0
  171. package/package.json +42 -4
  172. package/src/index.ts +5 -0
  173. package/src/tasks/index.ts +33 -0
  174. package/src/tasks/task-channel.ts +191 -0
  175. package/src/tasks/task-operation-queue.ts +109 -0
  176. package/src/tasks/task-preload.ts +107 -0
  177. package/src/tasks/task-runner.ts +933 -0
  178. package/src/tasks/task-runtime.ts +244 -0
  179. package/src/tasks/task-sync.ts +100 -0
  180. package/src/tasks/task-worker-channel.ts +44 -0
  181. package/src/tasks/task.ts +168 -0
  182. package/src/tasks/typed-task-dispatch.ts +44 -0
  183. package/src/worker-utils/index.ts +105 -0
  184. package/src/worker-utils/lib/async-queue/async-queue.ts +100 -0
  185. package/src/worker-utils/lib/env-utils/assert.ts +14 -0
  186. package/src/worker-utils/lib/env-utils/globals.ts +40 -0
  187. package/src/worker-utils/lib/env-utils/version.ts +15 -0
  188. package/src/worker-utils/lib/library-utils/library-utils.ts +305 -0
  189. package/src/worker-utils/lib/node/worker_threads-browser.ts +44 -0
  190. package/src/worker-utils/lib/node/worker_threads.ts +21 -0
  191. package/src/worker-utils/lib/npm-tag.ts +5 -0
  192. package/src/worker-utils/lib/process-utils/child-process-proxy.browser.ts +23 -0
  193. package/src/worker-utils/lib/process-utils/child-process-proxy.ts +172 -0
  194. package/src/worker-utils/lib/process-utils/process-utils.ts +34 -0
  195. package/src/worker-utils/lib/worker-api/create-worker.ts +271 -0
  196. package/src/worker-utils/lib/worker-api/get-worker-url.ts +130 -0
  197. package/src/worker-utils/lib/worker-api/process-on-worker.ts +596 -0
  198. package/src/worker-utils/lib/worker-api/shared-state.ts +135 -0
  199. package/src/worker-utils/lib/worker-api/validate-output-ownership.ts +10 -0
  200. package/src/worker-utils/lib/worker-api/validate-worker-version.ts +44 -0
  201. package/src/worker-utils/lib/worker-api/worker-resource.ts +203 -0
  202. package/src/worker-utils/lib/worker-farm/worker-body.ts +154 -0
  203. package/src/worker-utils/lib/worker-farm/worker-farm.ts +172 -0
  204. package/src/worker-utils/lib/worker-farm/worker-job.ts +148 -0
  205. package/src/worker-utils/lib/worker-farm/worker-pool.ts +719 -0
  206. package/src/worker-utils/lib/worker-farm/worker-thread.ts +260 -0
  207. package/src/worker-utils/lib/worker-utils/get-input-byte-length.ts +34 -0
  208. package/src/worker-utils/lib/worker-utils/get-loadable-worker-url.ts +96 -0
  209. package/src/worker-utils/lib/worker-utils/get-transfer-list.ts +125 -0
  210. package/src/worker-utils/lib/worker-utils/remove-nontransferable-options.ts +27 -0
  211. package/src/worker-utils/types.ts +224 -0
  212. package/src/worker-utils/workers/null-worker.ts +20 -0
@@ -0,0 +1,260 @@
1
+ // loaders.gl
2
+ // SPDX-License-Identifier: MIT
3
+ // SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
4
+
5
+ import type {LoadWorker} from '../../types';
6
+ import {NodeWorker, type NodeWorkerType} from '../node/worker_threads';
7
+ import {isBrowser} from '../env-utils/globals';
8
+ import {assert} from '../env-utils/assert';
9
+ import {getLoadableWorkerURL} from '../worker-utils/get-loadable-worker-url';
10
+ import {getTransferList} from '../worker-utils/get-transfer-list';
11
+
12
+ const NOOP = () => {};
13
+
14
+ export type WorkerThreadProps = {
15
+ /** Human-readable worker name. */
16
+ name: string;
17
+ /** Inline worker source. */
18
+ source?: string;
19
+ /** Worker script URL. */
20
+ url?: string;
21
+ workerType?: 'classic' | 'module';
22
+ /** Lazily resolves the classic worker URL used as a fallback. */
23
+ getUrl?: () => string;
24
+ /** Creates a browser Worker directly. */
25
+ loadWorker?: LoadWorker;
26
+ };
27
+
28
+ /**
29
+ * Represents one worker thread
30
+ */
31
+ export default class WorkerThread {
32
+ readonly name: string;
33
+ readonly source: string | undefined;
34
+ readonly url: string | undefined;
35
+ readonly workerType: 'classic' | 'module';
36
+ /** Lazily resolves the classic worker URL used as a fallback. */
37
+ readonly getUrl: (() => string) | undefined;
38
+ /** Creates a browser Worker directly. */
39
+ readonly loadWorker: LoadWorker | undefined;
40
+ terminated: boolean = false;
41
+ readonly creationTimeMs: number;
42
+ startupTimeMs?: number;
43
+ private termination?: Promise<void>;
44
+ private createdAt = performance.now();
45
+ worker: Worker | NodeWorkerType;
46
+ onMessage: (message: any) => void;
47
+ onError: (error: Error) => void;
48
+
49
+ private _loadableURL: string = '';
50
+ /** Per-thread module shim, including URLs resolved through lazy factory fallbacks. */
51
+ private ownedModuleWorkerURL?: string;
52
+
53
+ /** Checks if workers are supported on this platform */
54
+ static isSupported(): boolean {
55
+ return (
56
+ (typeof Worker !== 'undefined' && isBrowser) ||
57
+ (typeof NodeWorker !== 'undefined' && !isBrowser)
58
+ );
59
+ }
60
+
61
+ constructor(props: WorkerThreadProps) {
62
+ const {name, source, url, getUrl, loadWorker} = props;
63
+ assert(source || url || getUrl || loadWorker);
64
+ this.name = name;
65
+ this.source = source;
66
+ this.url = url;
67
+ this.workerType = props.workerType ?? 'classic';
68
+ this.getUrl = getUrl;
69
+ this.loadWorker = loadWorker;
70
+ this.onMessage = NOOP;
71
+ // biome-ignore lint/suspicious/noConsole: Preserve upstream worker diagnostics.
72
+ this.onError = error => console.log(error); // eslint-disable-line
73
+
74
+ const startedAt = performance.now();
75
+ this.worker = isBrowser ? this._createBrowserWorker() : this._createNodeWorker();
76
+ this.creationTimeMs = performance.now() - startedAt;
77
+ }
78
+
79
+ /**
80
+ * Terminate this worker thread
81
+ * @note Can free up significant memory
82
+ */
83
+ destroy(): Promise<void> {
84
+ this.onMessage = NOOP;
85
+ this.onError = NOOP;
86
+ if (this.terminated) return this.termination ?? Promise.resolve();
87
+ this.terminated = true;
88
+ this.termination = Promise.resolve(this.worker.terminate())
89
+ .then(() => undefined)
90
+ .finally(() => this.releaseModuleWorkerURL());
91
+ void this.termination.catch(() => undefined);
92
+ return this.termination;
93
+ }
94
+
95
+ /** Keeps this worker from preventing Node.js process exit while idle. */
96
+ unref(): void {
97
+ if (!isBrowser && typeof (this.worker as NodeWorkerType).unref === 'function') {
98
+ (this.worker as NodeWorkerType).unref();
99
+ }
100
+ }
101
+
102
+ /** Keeps this worker alive while it is actively processing a job. */
103
+ ref(): void {
104
+ if (!isBrowser && typeof (this.worker as NodeWorkerType).ref === 'function') {
105
+ (this.worker as NodeWorkerType).ref();
106
+ }
107
+ }
108
+
109
+ get isRunning() {
110
+ return Boolean(this.onMessage);
111
+ }
112
+
113
+ /**
114
+ * Send a message to this worker thread
115
+ * @param data any data structure, ideally consisting mostly of transferrable objects
116
+ * @param transferList If not supplied, calculated automatically by traversing data
117
+ */
118
+ postMessage(data: any, transferList?: any[]): void {
119
+ transferList = transferList || getTransferList(data);
120
+ // @ts-ignore
121
+ this.worker.postMessage(data, transferList);
122
+ }
123
+
124
+ // PRIVATE
125
+
126
+ /**
127
+ * Generate a standard Error from an ErrorEvent
128
+ * @param event
129
+ */
130
+ _getErrorFromErrorEvent(event: ErrorEvent): Error {
131
+ // Note Error object does not have the expected fields if loading failed completely
132
+ // https://developer.mozilla.org/en-US/docs/Web/API/Worker#Event_handlers
133
+ // https://developer.mozilla.org/en-US/docs/Web/API/ErrorEvent
134
+ let message = 'Failed to load ';
135
+ message += `worker ${this.name} from ${this.url || 'built-in worker factory'}. `;
136
+ if (event.message) {
137
+ message += `${event.message} in `;
138
+ }
139
+ // const hasFilename = event.filename && !event.filename.startsWith('blob:');
140
+ // message += hasFilename ? event.filename : this.source.slice(0, 100);
141
+ if (event.lineno) {
142
+ message += `:${event.lineno}:${event.colno}`;
143
+ }
144
+ return new Error(message);
145
+ }
146
+
147
+ /**
148
+ * Creates a worker thread on the browser
149
+ */
150
+ _createBrowserWorker(): Worker {
151
+ if (this.loadWorker) {
152
+ try {
153
+ const worker = this.loadWorker();
154
+ if (worker) {
155
+ return this._initializeBrowserWorker(worker);
156
+ }
157
+ } catch (error) {
158
+ if (!this.source && !this.url && !this.getUrl) {
159
+ throw error;
160
+ }
161
+ }
162
+ }
163
+
164
+ const url = this.url || this.getUrl?.();
165
+ this._loadableURL = getLoadableWorkerURL({
166
+ source: this.source,
167
+ url,
168
+ workerType: this.workerType
169
+ });
170
+ if (
171
+ this.workerType === 'module' &&
172
+ url &&
173
+ this._loadableURL !== url &&
174
+ this._loadableURL.startsWith('blob:')
175
+ )
176
+ this.ownedModuleWorkerURL = this._loadableURL;
177
+ try {
178
+ const worker = new Worker(this._loadableURL, {name: this.name, type: this.workerType});
179
+ return this._initializeBrowserWorker(worker);
180
+ } catch (error) {
181
+ this.releaseModuleWorkerURL();
182
+ throw error;
183
+ }
184
+ }
185
+
186
+ /** Releases only the module shim owned by this worker, never caller-owned blob URLs. */
187
+ private releaseModuleWorkerURL(): void {
188
+ if (this.ownedModuleWorkerURL) {
189
+ URL.revokeObjectURL(this.ownedModuleWorkerURL);
190
+ this.ownedModuleWorkerURL = undefined;
191
+ }
192
+ }
193
+
194
+ /** Attaches protocol handlers to a browser worker. */
195
+ _initializeBrowserWorker(worker: Worker): Worker {
196
+ worker.onmessage = event => {
197
+ if (!event.data) {
198
+ this.onError(new Error('No data received'));
199
+ } else if (event.data.type === 'ready') {
200
+ this.startupTimeMs = performance.now() - this.createdAt;
201
+ } else {
202
+ this.onMessage(event.data);
203
+ }
204
+ };
205
+ // This callback represents an uncaught exception in the worker thread
206
+ worker.onerror = (error: ErrorEvent): void => {
207
+ const onError = this.onError;
208
+ const reason = this._getErrorFromErrorEvent(error);
209
+ this.destroy();
210
+ onError(reason);
211
+ };
212
+ // TODO - not clear when this would be called, for now just log in case it happens
213
+ // biome-ignore lint/suspicious/noConsole: Preserve upstream worker diagnostics.
214
+ worker.onmessageerror = () => {
215
+ const onError = this.onError;
216
+ this.destroy();
217
+ onError(new Error('Worker message could not be deserialized'));
218
+ }; // eslint-disable-line
219
+
220
+ return worker;
221
+ }
222
+
223
+ /**
224
+ * Creates a worker thread in node.js
225
+ * @todo https://nodejs.org/api/async_hooks.html#async-resource-worker-pool
226
+ */
227
+ _createNodeWorker(): NodeWorkerType {
228
+ let worker: NodeWorkerType;
229
+ if (this.url) {
230
+ // Make sure relative URLs start with './'
231
+ const absolute = this.url.includes(':/') || this.url.startsWith('/');
232
+ const url = absolute ? this.url : `./${this.url}`;
233
+ const workerUrl = url.startsWith('file:') ? new URL(url) : url;
234
+ const type = this.url.endsWith('.ts') || this.url.endsWith('.mjs') ? 'module' : 'commonjs';
235
+ // console.log('Starting work from', url);
236
+ // @ts-ignore type is not known
237
+ worker = new NodeWorker(workerUrl, {eval: false, type});
238
+ } else if (this.source) {
239
+ worker = new NodeWorker(this.source, {eval: true});
240
+ } else {
241
+ throw new Error('no worker');
242
+ }
243
+ worker.on('message', data => {
244
+ if (data?.type === 'ready') this.startupTimeMs = performance.now() - this.createdAt;
245
+ else this.onMessage(data);
246
+ });
247
+ worker.on('error', error => {
248
+ this.terminated = true;
249
+ this.onError(error as Error);
250
+ });
251
+ this.termination = new Promise(resolve => worker.on('exit', () => resolve()));
252
+ worker.on('exit', code => {
253
+ if (!this.terminated) {
254
+ this.terminated = true;
255
+ this.onError(new Error(`Worker ${this.name} exited unexpectedly (code ${code})`));
256
+ }
257
+ });
258
+ return worker;
259
+ }
260
+ }
@@ -0,0 +1,34 @@
1
+ // math.gl
2
+ // SPDX-License-Identifier: MIT
3
+ // SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
4
+
5
+ /** Counts retained backing buffers once, including shared buffers and entire subview buffers.
6
+ * This is an input-buffer budget, not an estimate of total JavaScript heap usage.
7
+ */
8
+ export function getInputByteLength(input: unknown): number {
9
+ const seen = new Set<object>();
10
+ let bytes = 0;
11
+ function visit(value: any): void {
12
+ if (!value || typeof value !== 'object' || seen.has(value)) return;
13
+ seen.add(value);
14
+ if (ArrayBuffer.isView(value)) {
15
+ visit(value.buffer);
16
+ } else if (
17
+ value instanceof ArrayBuffer ||
18
+ (typeof SharedArrayBuffer !== 'undefined' && value instanceof SharedArrayBuffer)
19
+ ) {
20
+ bytes += value.byteLength;
21
+ } else if (value instanceof Map) {
22
+ for (const [key, item] of value) {
23
+ visit(key);
24
+ visit(item);
25
+ }
26
+ } else if (value instanceof Set) {
27
+ for (const item of value) visit(item);
28
+ } else {
29
+ for (const key of Object.keys(value)) visit(value[key]);
30
+ }
31
+ }
32
+ visit(input);
33
+ return bytes;
34
+ }
@@ -0,0 +1,96 @@
1
+ // loaders.gl
2
+ // SPDX-License-Identifier: MIT
3
+ // SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
4
+
5
+ import {assert} from '../env-utils/assert';
6
+
7
+ const workerURLCache = new Map();
8
+
9
+ /**
10
+ * Creates a loadable URL from worker source or URL
11
+ * that can be used to create `Worker` instances.
12
+ * Due to CORS issues it may be necessary to wrap a URL in a small importScripts
13
+ * @param props
14
+ * @param props.source Worker source
15
+ * @param props.url Worker URL
16
+ * @returns loadable url
17
+ */
18
+ export function getLoadableWorkerURL(props: {
19
+ source?: string;
20
+ url?: string;
21
+ workerType?: 'classic' | 'module';
22
+ }) {
23
+ assert((props.source && !props.url) || (!props.source && props.url)); // Either source or url must be defined
24
+
25
+ if (props.url && props.workerType === 'module') {
26
+ const baseUrl = globalThis.document?.baseURI ?? globalThis.location?.href;
27
+ if (!baseUrl) return props.url;
28
+ const resolved = new URL(props.url, baseUrl);
29
+ const origin = globalThis.location?.origin;
30
+ if (/^https?:$/.test(resolved.protocol) && resolved.origin !== origin) {
31
+ // Module imports preserve the remote module's own relative import resolution.
32
+ return getLoadableWorkerURLFromSource(`import ${JSON.stringify(resolved.href)};`);
33
+ }
34
+ return props.url;
35
+ }
36
+ let workerURL = workerURLCache.get(props.source || props.url);
37
+ if (!workerURL) {
38
+ // Differentiate worker urls from worker source code
39
+ if (props.url) {
40
+ workerURL = getLoadableWorkerURLFromURL(props.url);
41
+ workerURLCache.set(props.url, workerURL);
42
+ }
43
+
44
+ if (props.source) {
45
+ workerURL = getLoadableWorkerURLFromSource(props.source);
46
+ workerURLCache.set(props.source, workerURL);
47
+ }
48
+ }
49
+
50
+ assert(workerURL);
51
+ return workerURL;
52
+ }
53
+
54
+ /**
55
+ * Build a loadable worker URL from worker URL
56
+ * @param url
57
+ * @returns loadable URL
58
+ */
59
+ function getLoadableWorkerURLFromURL(url: string): string {
60
+ // A local script url, we can use it to initialize a Worker directly
61
+ if (!url.startsWith('http')) {
62
+ return url;
63
+ }
64
+
65
+ // A remote script, we need to use `importScripts` to load from different origin
66
+ const workerSource = buildScriptSource(url);
67
+ return getLoadableWorkerURLFromSource(workerSource);
68
+ }
69
+
70
+ /**
71
+ * Build a loadable worker URL from worker source
72
+ * @param workerSource
73
+ * @returns loadable url
74
+ */
75
+ function getLoadableWorkerURLFromSource(workerSource: string): string {
76
+ const blob = new Blob([workerSource], {type: 'application/javascript'});
77
+ return URL.createObjectURL(blob);
78
+ }
79
+
80
+ /**
81
+ * Per spec, worker cannot be initialized with a script from a different origin
82
+ * However a local worker script can still import scripts from other origins,
83
+ * so we simply build a wrapper script.
84
+ *
85
+ * @param workerUrl
86
+ * @returns source
87
+ */
88
+ function buildScriptSource(workerUrl: string): string {
89
+ return `\
90
+ try {
91
+ importScripts('${workerUrl}');
92
+ } catch (error) {
93
+ console.error(error);
94
+ throw error;
95
+ }`;
96
+ }
@@ -0,0 +1,125 @@
1
+ // loaders.gl
2
+ // SPDX-License-Identifier: MIT
3
+ // SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
4
+
5
+ // NOTE - there is a copy of this function is both in core and loader-utils
6
+ // core does not need all the utils in loader-utils, just this one.
7
+
8
+ /**
9
+ * Returns an array of transferable objects that can be used with postMessage.
10
+ * Recursive discovery includes both ports of a MessageChannel, but not the channel itself.
11
+ * https://developer.mozilla.org/en-US/docs/Web/API/Worker/postMessage
12
+ * @param object data to be sent via postMessage
13
+ * @param recursive - not for application use
14
+ * @param transfers - not for application use
15
+ * @returns a transfer list that can be passed to postMessage
16
+ */
17
+ export function getTransferList(
18
+ object: any,
19
+ recursive: boolean = true,
20
+ transfers?: Set<any>
21
+ ): Transferable[] {
22
+ // Make sure that items in the transfer list is unique
23
+ const transfersSet = transfers || new Set();
24
+
25
+ const seen = new Set<object>();
26
+ function visit(value: any): void {
27
+ if (!value || typeof value !== 'object' || seen.has(value)) return;
28
+ seen.add(value);
29
+ if (isTransferable(value)) transfersSet.add(value);
30
+ else if (ArrayBuffer.isView(value)) {
31
+ if (isTransferable(value.buffer)) transfersSet.add(value.buffer);
32
+ } else if (
33
+ recursive &&
34
+ typeof MessageChannel !== 'undefined' &&
35
+ value instanceof MessageChannel
36
+ ) {
37
+ // Browser channel ports are prototype accessors, not own enumerable properties.
38
+ visit(value.port1);
39
+ visit(value.port2);
40
+ } else if (recursive && value instanceof Map) {
41
+ for (const [key, item] of value) {
42
+ visit(key);
43
+ visit(item);
44
+ }
45
+ } else if (recursive && value instanceof Set) {
46
+ for (const item of value) visit(item);
47
+ } else if (recursive) {
48
+ for (const key of Object.keys(value)) visit(value[key]);
49
+ }
50
+ }
51
+ visit(object);
52
+
53
+ // If transfers is defined, is internal recursive call
54
+ // Otherwise it's called by the user
55
+ return transfers === undefined ? Array.from(transfersSet) : [];
56
+ }
57
+
58
+ // https://developer.mozilla.org/en-US/docs/Web/API/Transferable
59
+ function isTransferable(object: unknown) {
60
+ if (!object) {
61
+ return false;
62
+ }
63
+ if (object instanceof ArrayBuffer) {
64
+ return true;
65
+ }
66
+ if (typeof MessagePort !== 'undefined' && object instanceof MessagePort) {
67
+ return true;
68
+ }
69
+ if (typeof ImageBitmap !== 'undefined' && object instanceof ImageBitmap) {
70
+ return true;
71
+ }
72
+ // @ts-ignore
73
+ if (typeof OffscreenCanvas !== 'undefined' && object instanceof OffscreenCanvas) {
74
+ return true;
75
+ }
76
+ return false;
77
+ }
78
+
79
+ /**
80
+ * Recursively drop non serializable values like functions and regexps.
81
+ * @param object
82
+ */
83
+ export function getTransferListForWriter(object: object | null): object {
84
+ const seen = new Map<object, any>();
85
+ function clone(value: any): any {
86
+ if (typeof value === 'function' || value instanceof RegExp) return {};
87
+ if (!value || typeof value !== 'object') return value;
88
+ if (seen.has(value)) return seen.get(value);
89
+ // Preserve structured-clone built-ins and backing-buffer identity.
90
+ if (
91
+ ArrayBuffer.isView(value) ||
92
+ value instanceof ArrayBuffer ||
93
+ (typeof SharedArrayBuffer !== 'undefined' && value instanceof SharedArrayBuffer) ||
94
+ value instanceof Date ||
95
+ (typeof WebAssembly !== 'undefined' && value instanceof WebAssembly.Module) ||
96
+ isTransferable(value)
97
+ )
98
+ return value;
99
+ const result: any =
100
+ value instanceof Map
101
+ ? new Map()
102
+ : value instanceof Set
103
+ ? new Set()
104
+ : Array.isArray(value)
105
+ ? []
106
+ : {};
107
+ seen.set(value, result);
108
+ if (value instanceof Map) {
109
+ for (const [key, item] of value) result.set(clone(key), clone(item));
110
+ } else if (value instanceof Set) {
111
+ for (const item of value) result.add(clone(item));
112
+ } else {
113
+ for (const key of Object.keys(value)) {
114
+ Object.defineProperty(result, key, {
115
+ value: clone(value[key]),
116
+ enumerable: true,
117
+ writable: true,
118
+ configurable: true
119
+ });
120
+ }
121
+ }
122
+ return result;
123
+ }
124
+ return object === null ? {} : clone(object);
125
+ }
@@ -0,0 +1,27 @@
1
+ // loaders.gl
2
+ // SPDX-License-Identifier: MIT
3
+ // SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
4
+
5
+ /**
6
+ * Recursively drop non serializable values like functions and regexps.
7
+ * @param object
8
+ */
9
+ export function removeNontransferableOptions(object: object | null): object {
10
+ if (object === null) {
11
+ return {};
12
+ }
13
+ const clone = Object.assign({}, object);
14
+
15
+ Object.keys(clone).forEach(key => {
16
+ // Checking if it is an object and not a typed array.
17
+ if (typeof object[key] === 'object' && !ArrayBuffer.isView(object[key])) {
18
+ clone[key] = removeNontransferableOptions(object[key]);
19
+ } else if (typeof clone[key] === 'function' || clone[key] instanceof RegExp) {
20
+ clone[key] = {};
21
+ } else {
22
+ clone[key] = object[key];
23
+ }
24
+ });
25
+
26
+ return clone;
27
+ }