@loaders.gl/worker-utils 4.0.0-alpha.5 → 4.0.0-alpha.6

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 (196) hide show
  1. package/dist/es5/index.js +148 -0
  2. package/dist/es5/index.js.map +1 -0
  3. package/dist/es5/lib/async-queue/async-queue.js +100 -0
  4. package/dist/es5/lib/async-queue/async-queue.js.map +1 -0
  5. package/dist/es5/lib/env-utils/assert.js +12 -0
  6. package/dist/es5/lib/env-utils/assert.js.map +1 -0
  7. package/dist/es5/lib/env-utils/globals.js +32 -0
  8. package/dist/es5/lib/env-utils/globals.js.map +1 -0
  9. package/dist/es5/lib/env-utils/version.js +13 -0
  10. package/dist/es5/lib/env-utils/version.js.map +1 -0
  11. package/dist/es5/lib/library-utils/library-utils.js +154 -0
  12. package/dist/es5/lib/library-utils/library-utils.js.map +1 -0
  13. package/dist/es5/lib/node/require-utils.node.js +71 -0
  14. package/dist/es5/lib/node/require-utils.node.js.map +1 -0
  15. package/dist/es5/lib/node/worker_threads-browser.js +23 -0
  16. package/dist/es5/lib/node/worker_threads-browser.js.map +1 -0
  17. package/dist/es5/lib/node/worker_threads.js +27 -0
  18. package/dist/es5/lib/node/worker_threads.js.map +1 -0
  19. package/dist/es5/lib/process-utils/child-process-proxy.js +193 -0
  20. package/dist/es5/lib/process-utils/child-process-proxy.js.map +1 -0
  21. package/dist/es5/lib/process-utils/process-utils.js +33 -0
  22. package/dist/es5/lib/process-utils/process-utils.js.map +1 -0
  23. package/dist/es5/lib/worker-api/create-worker.js +166 -0
  24. package/dist/es5/lib/worker-api/create-worker.js.map +1 -0
  25. package/dist/es5/lib/worker-api/get-worker-url.js +38 -0
  26. package/dist/es5/lib/worker-api/get-worker-url.js.map +1 -0
  27. package/dist/es5/lib/worker-api/process-on-worker.js +137 -0
  28. package/dist/es5/lib/worker-api/process-on-worker.js.map +1 -0
  29. package/dist/es5/lib/worker-api/validate-worker-version.js +25 -0
  30. package/dist/es5/lib/worker-api/validate-worker-version.js.map +1 -0
  31. package/dist/es5/lib/worker-farm/worker-body.js +109 -0
  32. package/dist/es5/lib/worker-farm/worker-body.js.map +1 -0
  33. package/dist/es5/lib/worker-farm/worker-farm.js +113 -0
  34. package/dist/es5/lib/worker-farm/worker-farm.js.map +1 -0
  35. package/dist/es5/lib/worker-farm/worker-job.js +56 -0
  36. package/dist/es5/lib/worker-farm/worker-job.js.map +1 -0
  37. package/dist/es5/lib/worker-farm/worker-pool.js +211 -0
  38. package/dist/es5/lib/worker-farm/worker-pool.js.map +1 -0
  39. package/dist/es5/lib/worker-farm/worker-thread.js +136 -0
  40. package/dist/es5/lib/worker-farm/worker-thread.js.map +1 -0
  41. package/dist/es5/lib/worker-utils/get-loadable-worker-url.js +41 -0
  42. package/dist/es5/lib/worker-utils/get-loadable-worker-url.js.map +1 -0
  43. package/dist/es5/lib/worker-utils/get-transfer-list.js +59 -0
  44. package/dist/es5/lib/worker-utils/get-transfer-list.js.map +1 -0
  45. package/dist/es5/lib/worker-utils/remove-nontransferable-options.js +25 -0
  46. package/dist/es5/lib/worker-utils/remove-nontransferable-options.js.map +1 -0
  47. package/dist/es5/types.js +2 -0
  48. package/dist/es5/types.js.map +1 -0
  49. package/dist/es5/workers/null-worker.js +23 -0
  50. package/dist/es5/workers/null-worker.js.map +1 -0
  51. package/dist/esm/index.js +26 -0
  52. package/dist/esm/index.js.map +1 -0
  53. package/dist/esm/lib/async-queue/async-queue.js +76 -0
  54. package/dist/esm/lib/async-queue/async-queue.js.map +1 -0
  55. package/dist/esm/lib/env-utils/assert.js +6 -0
  56. package/dist/esm/lib/env-utils/assert.js.map +1 -0
  57. package/dist/esm/lib/env-utils/globals.js +17 -0
  58. package/dist/esm/lib/env-utils/globals.js.map +1 -0
  59. package/dist/esm/lib/env-utils/version.js +6 -0
  60. package/dist/esm/lib/env-utils/version.js.map +1 -0
  61. package/dist/esm/lib/library-utils/library-utils.js +74 -0
  62. package/dist/esm/lib/library-utils/library-utils.js.map +1 -0
  63. package/dist/esm/lib/node/require-utils.node.js +36 -0
  64. package/dist/esm/lib/node/require-utils.node.js.map +1 -0
  65. package/dist/esm/lib/node/worker_threads-browser.js +7 -0
  66. package/dist/esm/lib/node/worker_threads-browser.js.map +1 -0
  67. package/dist/esm/lib/node/worker_threads.js +4 -0
  68. package/dist/esm/lib/node/worker_threads.js.map +1 -0
  69. package/dist/esm/lib/process-utils/child-process-proxy.js +104 -0
  70. package/dist/esm/lib/process-utils/child-process-proxy.js.map +1 -0
  71. package/dist/esm/lib/process-utils/process-utils.js +26 -0
  72. package/dist/esm/lib/process-utils/process-utils.js.map +1 -0
  73. package/dist/esm/lib/worker-api/create-worker.js +84 -0
  74. package/dist/esm/lib/worker-api/create-worker.js.map +1 -0
  75. package/dist/esm/lib/worker-api/get-worker-url.js +31 -0
  76. package/dist/esm/lib/worker-api/get-worker-url.js.map +1 -0
  77. package/dist/esm/lib/worker-api/process-on-worker.js +75 -0
  78. package/dist/esm/lib/worker-api/process-on-worker.js.map +1 -0
  79. package/dist/esm/lib/worker-api/validate-worker-version.js +19 -0
  80. package/dist/esm/lib/worker-api/validate-worker-version.js.map +1 -0
  81. package/dist/esm/lib/worker-farm/worker-body.js +86 -0
  82. package/dist/esm/lib/worker-farm/worker-body.js.map +1 -0
  83. package/dist/esm/lib/worker-farm/worker-farm.js +72 -0
  84. package/dist/esm/lib/worker-farm/worker-farm.js.map +1 -0
  85. package/dist/esm/lib/worker-farm/worker-job.js +36 -0
  86. package/dist/esm/lib/worker-farm/worker-job.js.map +1 -0
  87. package/dist/esm/lib/worker-farm/worker-pool.js +124 -0
  88. package/dist/esm/lib/worker-farm/worker-pool.js.map +1 -0
  89. package/dist/esm/lib/worker-farm/worker-thread.js +105 -0
  90. package/dist/esm/lib/worker-farm/worker-thread.js.map +1 -0
  91. package/dist/esm/lib/worker-utils/get-loadable-worker-url.js +35 -0
  92. package/dist/esm/lib/worker-utils/get-loadable-worker-url.js.map +1 -0
  93. package/dist/esm/lib/worker-utils/get-transfer-list.js +50 -0
  94. package/dist/esm/lib/worker-utils/get-transfer-list.js.map +1 -0
  95. package/dist/esm/lib/worker-utils/remove-nontransferable-options.js +17 -0
  96. package/dist/esm/lib/worker-utils/remove-nontransferable-options.js.map +1 -0
  97. package/dist/esm/types.js +2 -0
  98. package/dist/esm/types.js.map +1 -0
  99. package/dist/esm/workers/null-worker.js +5 -0
  100. package/dist/esm/workers/null-worker.js.map +1 -0
  101. package/dist/index.d.ts +1 -1
  102. package/dist/index.d.ts.map +1 -1
  103. package/dist/index.js +58 -25
  104. package/dist/lib/async-queue/async-queue.js +81 -91
  105. package/dist/lib/env-utils/assert.js +12 -5
  106. package/dist/lib/env-utils/globals.js +25 -10
  107. package/dist/lib/env-utils/version.js +10 -5
  108. package/dist/lib/library-utils/library-utils.d.ts.map +1 -1
  109. package/dist/lib/library-utils/library-utils.js +161 -79
  110. package/dist/lib/node/require-utils.node.js +58 -41
  111. package/dist/lib/node/worker_threads-browser.d.ts +7 -0
  112. package/dist/lib/node/worker_threads-browser.d.ts.map +1 -0
  113. package/dist/lib/node/worker_threads-browser.js +15 -0
  114. package/dist/lib/node/worker_threads.d.ts +6 -0
  115. package/dist/lib/node/worker_threads.d.ts.map +1 -0
  116. package/dist/lib/node/worker_threads.js +33 -0
  117. package/dist/lib/process-utils/child-process-proxy.d.ts +1 -1
  118. package/dist/lib/process-utils/child-process-proxy.d.ts.map +1 -1
  119. package/dist/lib/process-utils/child-process-proxy.js +126 -113
  120. package/dist/lib/process-utils/process-utils.js +33 -27
  121. package/dist/lib/worker-api/create-worker.d.ts +1 -1
  122. package/dist/lib/worker-api/create-worker.d.ts.map +1 -1
  123. package/dist/lib/worker-api/create-worker.js +84 -92
  124. package/dist/lib/worker-api/get-worker-url.d.ts.map +1 -1
  125. package/dist/lib/worker-api/get-worker-url.js +55 -33
  126. package/dist/lib/worker-api/process-on-worker.d.ts +1 -1
  127. package/dist/lib/worker-api/process-on-worker.d.ts.map +1 -1
  128. package/dist/lib/worker-api/process-on-worker.js +79 -71
  129. package/dist/lib/worker-api/validate-worker-version.js +32 -18
  130. package/dist/lib/worker-farm/worker-body.d.ts +2 -0
  131. package/dist/lib/worker-farm/worker-body.d.ts.map +1 -1
  132. package/dist/lib/worker-farm/worker-body.js +104 -58
  133. package/dist/lib/worker-farm/worker-farm.d.ts +7 -3
  134. package/dist/lib/worker-farm/worker-farm.d.ts.map +1 -1
  135. package/dist/lib/worker-farm/worker-farm.js +83 -77
  136. package/dist/lib/worker-farm/worker-job.d.ts.map +1 -1
  137. package/dist/lib/worker-farm/worker-job.js +46 -53
  138. package/dist/lib/worker-farm/worker-pool.d.ts +6 -4
  139. package/dist/lib/worker-farm/worker-pool.d.ts.map +1 -1
  140. package/dist/lib/worker-farm/worker-pool.js +145 -147
  141. package/dist/lib/worker-farm/worker-thread.d.ts +10 -3
  142. package/dist/lib/worker-farm/worker-thread.d.ts.map +1 -1
  143. package/dist/lib/worker-farm/worker-thread.js +128 -102
  144. package/dist/lib/worker-utils/get-loadable-worker-url.js +63 -33
  145. package/dist/lib/worker-utils/get-transfer-list.d.ts +5 -0
  146. package/dist/lib/worker-utils/get-transfer-list.d.ts.map +1 -1
  147. package/dist/lib/worker-utils/get-transfer-list.js +83 -36
  148. package/dist/lib/worker-utils/remove-nontransferable-options.d.ts +3 -3
  149. package/dist/lib/worker-utils/remove-nontransferable-options.d.ts.map +1 -1
  150. package/dist/lib/worker-utils/remove-nontransferable-options.js +25 -21
  151. package/dist/null-worker.js +45 -14
  152. package/dist/null-worker.js.map +2 -2
  153. package/dist/types.d.ts +16 -11
  154. package/dist/types.d.ts.map +1 -1
  155. package/dist/types.js +2 -2
  156. package/dist/workers/null-worker.js +6 -4
  157. package/package.json +8 -4
  158. package/src/index.ts +1 -1
  159. package/src/lib/library-utils/library-utils.ts +4 -1
  160. package/src/lib/node/worker_threads-browser.ts +13 -0
  161. package/src/lib/node/worker_threads.ts +6 -0
  162. package/src/lib/worker-api/create-worker.ts +1 -2
  163. package/src/lib/worker-api/get-worker-url.ts +3 -1
  164. package/src/lib/worker-api/process-on-worker.ts +8 -4
  165. package/src/lib/worker-farm/worker-body.ts +61 -19
  166. package/src/lib/worker-farm/worker-farm.ts +10 -5
  167. package/src/lib/worker-farm/worker-job.ts +3 -6
  168. package/src/lib/worker-farm/worker-pool.ts +5 -0
  169. package/src/lib/worker-farm/worker-thread.ts +45 -7
  170. package/src/lib/worker-utils/get-loadable-worker-url.ts +0 -2
  171. package/src/lib/worker-utils/get-transfer-list.ts +28 -0
  172. package/src/lib/worker-utils/remove-nontransferable-options.ts +17 -25
  173. package/src/types.ts +3 -2
  174. package/dist/index.js.map +0 -1
  175. package/dist/lib/async-queue/async-queue.js.map +0 -1
  176. package/dist/lib/env-utils/assert.js.map +0 -1
  177. package/dist/lib/env-utils/globals.js.map +0 -1
  178. package/dist/lib/env-utils/version.js.map +0 -1
  179. package/dist/lib/library-utils/library-utils.js.map +0 -1
  180. package/dist/lib/node/require-utils.node.js.map +0 -1
  181. package/dist/lib/process-utils/child-process-proxy.js.map +0 -1
  182. package/dist/lib/process-utils/process-utils.js.map +0 -1
  183. package/dist/lib/worker-api/create-worker.js.map +0 -1
  184. package/dist/lib/worker-api/get-worker-url.js.map +0 -1
  185. package/dist/lib/worker-api/process-on-worker.js.map +0 -1
  186. package/dist/lib/worker-api/validate-worker-version.js.map +0 -1
  187. package/dist/lib/worker-farm/worker-body.js.map +0 -1
  188. package/dist/lib/worker-farm/worker-farm.js.map +0 -1
  189. package/dist/lib/worker-farm/worker-job.js.map +0 -1
  190. package/dist/lib/worker-farm/worker-pool.js.map +0 -1
  191. package/dist/lib/worker-farm/worker-thread.js.map +0 -1
  192. package/dist/lib/worker-utils/get-loadable-worker-url.js.map +0 -1
  193. package/dist/lib/worker-utils/get-transfer-list.js.map +0 -1
  194. package/dist/lib/worker-utils/remove-nontransferable-options.js.map +0 -1
  195. package/dist/types.js.map +0 -1
  196. package/dist/workers/null-worker.js.map +0 -1
@@ -1,75 +1,83 @@
1
- import WorkerFarm from '../worker-farm/worker-farm';
2
- import { removeNontransferableOptions } from '../worker-utils/remove-nontransferable-options';
3
- import { getWorkerURL, getWorkerName } from './get-worker-url';
4
- export function canProcessOnWorker(worker, options) {
5
- if (!WorkerFarm.isSupported()) {
6
- return false;
7
- }
8
-
9
- return worker.worker && (options === null || options === void 0 ? void 0 : options.worker);
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.processOnWorker = exports.canProcessOnWorker = void 0;
7
+ const worker_farm_1 = __importDefault(require("../worker-farm/worker-farm"));
8
+ const get_worker_url_1 = require("./get-worker-url");
9
+ const get_transfer_list_1 = require("../worker-utils/get-transfer-list");
10
+ /**
11
+ * Determines if we can parse with worker
12
+ * @param loader
13
+ * @param data
14
+ * @param options
15
+ */
16
+ function canProcessOnWorker(worker, options) {
17
+ if (!worker_farm_1.default.isSupported()) {
18
+ return false;
19
+ }
20
+ return worker.worker && options?.worker;
10
21
  }
11
- export async function processOnWorker(worker, data, options = {}, context = {}) {
12
- const name = getWorkerName(worker);
13
- const url = getWorkerURL(worker, options);
14
- const workerFarm = WorkerFarm.getWorkerFarm(options);
15
- const workerPool = workerFarm.getWorkerPool({
16
- name,
17
- url
18
- });
19
- const jobName = options.jobName || worker.name;
20
- const job = await workerPool.startJob(jobName, onMessage.bind(null, context));
21
- const transferableOptions = removeNontransferableOptions(options);
22
- job.postMessage('process', {
23
- input: data,
24
- options: transferableOptions
25
- });
26
- const result = await job.result;
27
- return result.result;
22
+ exports.canProcessOnWorker = canProcessOnWorker;
23
+ /**
24
+ * This function expects that the worker thread sends certain messages,
25
+ * Creating such a worker can be automated if the worker is wrapper by a call to
26
+ * createWorker in @loaders.gl/worker-utils.
27
+ */
28
+ async function processOnWorker(worker, data, options = {}, context = {}) {
29
+ const name = (0, get_worker_url_1.getWorkerName)(worker);
30
+ const workerFarm = worker_farm_1.default.getWorkerFarm(options);
31
+ const { source } = options;
32
+ const workerPoolProps = { name, source };
33
+ if (!source) {
34
+ workerPoolProps.url = (0, get_worker_url_1.getWorkerURL)(worker, options);
35
+ }
36
+ const workerPool = workerFarm.getWorkerPool(workerPoolProps);
37
+ const jobName = options.jobName || worker.name;
38
+ const job = await workerPool.startJob(jobName,
39
+ // eslint-disable-next-line
40
+ onMessage.bind(null, context));
41
+ // Kick off the processing in the worker
42
+ const transferableOptions = (0, get_transfer_list_1.getTransferListForWriter)(options);
43
+ job.postMessage('process', { input: data, options: transferableOptions });
44
+ const result = await job.result;
45
+ return result.result;
28
46
  }
29
-
47
+ exports.processOnWorker = processOnWorker;
48
+ /**
49
+ * Job completes when we receive the result
50
+ * @param job
51
+ * @param message
52
+ */
30
53
  async function onMessage(context, job, type, payload) {
31
- switch (type) {
32
- case 'done':
33
- job.done(payload);
34
- break;
35
-
36
- case 'error':
37
- job.error(new Error(payload.error));
38
- break;
39
-
40
- case 'process':
41
- const {
42
- id,
43
- input,
44
- options
45
- } = payload;
46
-
47
- try {
48
- if (!context.process) {
49
- job.postMessage('error', {
50
- id,
51
- error: 'Worker not set up to process on main thread'
52
- });
53
- return;
54
- }
55
-
56
- const result = await context.process(input, options);
57
- job.postMessage('done', {
58
- id,
59
- result
60
- });
61
- } catch (error) {
62
- const message = error instanceof Error ? error.message : 'unknown error';
63
- job.postMessage('error', {
64
- id,
65
- error: message
66
- });
67
- }
68
-
69
- break;
70
-
71
- default:
72
- console.warn("process-on-worker: unknown message ".concat(type));
73
- }
54
+ switch (type) {
55
+ case 'done':
56
+ // Worker is done
57
+ job.done(payload);
58
+ break;
59
+ case 'error':
60
+ // Worker encountered an error
61
+ job.error(new Error(payload.error));
62
+ break;
63
+ case 'process':
64
+ // Worker is asking for us (main thread) to process something
65
+ const { id, input, options } = payload;
66
+ try {
67
+ if (!context.process) {
68
+ job.postMessage('error', { id, error: 'Worker not set up to process on main thread' });
69
+ return;
70
+ }
71
+ const result = await context.process(input, options);
72
+ job.postMessage('done', { id, result });
73
+ }
74
+ catch (error) {
75
+ const message = error instanceof Error ? error.message : 'unknown error';
76
+ job.postMessage('error', { id, error: message });
77
+ }
78
+ break;
79
+ default:
80
+ // eslint-disable-next-line
81
+ console.warn(`process-on-worker: unknown message ${type}`);
82
+ }
74
83
  }
75
- //# sourceMappingURL=process-on-worker.js.map
@@ -1,21 +1,35 @@
1
- import { assert } from '../env-utils/assert';
2
- import { VERSION } from '../env-utils/version';
3
- export function validateWorkerVersion(worker, coreVersion = VERSION) {
4
- assert(worker, 'no worker provided');
5
- const workerVersion = worker.version;
6
-
7
- if (!coreVersion || !workerVersion) {
8
- return false;
9
- }
10
-
11
- return true;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateWorkerVersion = void 0;
4
+ const assert_1 = require("../env-utils/assert");
5
+ const version_1 = require("../env-utils/version");
6
+ /**
7
+ * Check if worker is compatible with this library version
8
+ * @param worker
9
+ * @param libVersion
10
+ * @returns `true` if the two versions are compatible
11
+ */
12
+ function validateWorkerVersion(worker, coreVersion = version_1.VERSION) {
13
+ (0, assert_1.assert)(worker, 'no worker provided');
14
+ const workerVersion = worker.version;
15
+ if (!coreVersion || !workerVersion) {
16
+ return false;
17
+ }
18
+ // TODO enable when fix the __version__ injection
19
+ // const coreVersions = parseVersion(coreVersion);
20
+ // const workerVersions = parseVersion(workerVersion);
21
+ // assert(
22
+ // coreVersion.major === workerVersion.major && coreVersion.minor <= workerVersion.minor,
23
+ // `worker: ${worker.name} is not compatible. ${coreVersion.major}.${
24
+ // coreVersion.minor
25
+ // }+ is required.`
26
+ // );
27
+ return true;
12
28
  }
13
-
29
+ exports.validateWorkerVersion = validateWorkerVersion;
30
+ // @ts-ignore
31
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
14
32
  function parseVersion(version) {
15
- const parts = version.split('.').map(Number);
16
- return {
17
- major: parts[0],
18
- minor: parts[1]
19
- };
33
+ const parts = version.split('.').map(Number);
34
+ return { major: parts[0], minor: parts[1] };
20
35
  }
21
- //# sourceMappingURL=validate-worker-version.js.map
@@ -3,6 +3,8 @@ import type { WorkerMessageType, WorkerMessagePayload } from '../../types';
3
3
  * Type safe wrapper for worker code
4
4
  */
5
5
  export default class WorkerBody {
6
+ /** Check that we are actually in a worker thread */
7
+ static inWorkerThread(): boolean;
6
8
  static set onmessage(onMessage: (type: WorkerMessageType, payload: WorkerMessagePayload) => any);
7
9
  static addEventListener(onMessage: (type: WorkerMessageType, payload: WorkerMessagePayload) => any): void;
8
10
  static removeEventListener(onMessage: (type: WorkerMessageType, payload: WorkerMessagePayload) => any): void;
@@ -1 +1 @@
1
- {"version":3,"file":"worker-body.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-farm/worker-body.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAoB,iBAAiB,EAAE,oBAAoB,EAAC,MAAM,aAAa,CAAC;AAK5F;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAI7B,MAAM,KAAK,SAAS,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,oBAAoB,KAAK,GAAG,EAW9F;IAED,MAAM,CAAC,gBAAgB,CACrB,SAAS,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,oBAAoB,KAAK,GAAG;IAoB5E,MAAM,CAAC,mBAAmB,CACxB,SAAS,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,oBAAoB,KAAK,GAAG;IAQ5E;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,oBAAoB,GAAG,IAAI;CASjF"}
1
+ {"version":3,"file":"worker-body.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-farm/worker-body.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAoB,iBAAiB,EAAE,oBAAoB,EAAC,MAAM,aAAa,CAAC;AAkB5F;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,oDAAoD;IACpD,MAAM,CAAC,cAAc,IAAI,OAAO;IAOhC,MAAM,KAAK,SAAS,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,oBAAoB,KAAK,GAAG,EAqB9F;IAED,MAAM,CAAC,gBAAgB,CACrB,SAAS,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,oBAAoB,KAAK,GAAG;IAyB5E,MAAM,CAAC,mBAAmB,CACxB,SAAS,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,oBAAoB,KAAK,GAAG;IAY5E;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,oBAAoB,GAAG,IAAI;CAcjF"}
@@ -1,65 +1,111 @@
1
- import { getTransferList } from '../worker-utils/get-transfer-list';
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const get_transfer_list_1 = require("../worker-utils/get-transfer-list");
4
+ /** Vile hack to defeat over-zealous bundlers from stripping out the require */
5
+ function getParentPort() {
6
+ // const isNode = globalThis.process;
7
+ let parentPort;
8
+ try {
9
+ // prettier-ignore
10
+ eval('globalThis.parentPort = require(\'worker_threads\').parentPort'); // eslint-disable-line no-eval
11
+ parentPort = globalThis.parentPort;
12
+ // eslint-disable-next-line no-empty
13
+ }
14
+ catch { }
15
+ return parentPort;
16
+ }
2
17
  const onMessageWrapperMap = new Map();
3
- export default class WorkerBody {
4
- static set onmessage(onMessage) {
5
- self.onmessage = message => {
6
- if (!isKnownMessage(message)) {
7
- return;
8
- }
9
-
10
- const {
11
- type,
12
- payload
13
- } = message.data;
14
- onMessage(type, payload);
15
- };
16
- }
17
-
18
- static addEventListener(onMessage) {
19
- let onMessageWrapper = onMessageWrapperMap.get(onMessage);
20
-
21
- if (!onMessageWrapper) {
22
- onMessageWrapper = message => {
23
- if (!isKnownMessage(message)) {
24
- return;
18
+ /**
19
+ * Type safe wrapper for worker code
20
+ */
21
+ class WorkerBody {
22
+ /** Check that we are actually in a worker thread */
23
+ static inWorkerThread() {
24
+ return typeof self !== 'undefined' || Boolean(getParentPort());
25
+ }
26
+ /*
27
+ * (type: WorkerMessageType, payload: WorkerMessagePayload) => any
28
+ */
29
+ static set onmessage(onMessage) {
30
+ function handleMessage(message) {
31
+ // Confusingly the message itself also has a 'type' field which is always set to 'message'
32
+ const parentPort = getParentPort();
33
+ const { type, payload } = parentPort ? message : message.data;
34
+ // if (!isKnownMessage(message)) {
35
+ // return;
36
+ // }
37
+ onMessage(type, payload);
38
+ }
39
+ const parentPort = getParentPort();
40
+ if (parentPort) {
41
+ parentPort.on('message', handleMessage);
42
+ // if (message == 'exit') { parentPort.unref(); }
43
+ // eslint-disable-next-line
44
+ parentPort.on('exit', () => console.debug('Node worker closing'));
45
+ }
46
+ else {
47
+ // eslint-disable-next-line no-restricted-globals
48
+ globalThis.onmessage = handleMessage;
49
+ }
50
+ }
51
+ static addEventListener(onMessage) {
52
+ let onMessageWrapper = onMessageWrapperMap.get(onMessage);
53
+ if (!onMessageWrapper) {
54
+ onMessageWrapper = (message) => {
55
+ if (!isKnownMessage(message)) {
56
+ return;
57
+ }
58
+ // Confusingly in the browser, the message itself also has a 'type' field which is always set to 'message'
59
+ const parentPort = getParentPort();
60
+ const { type, payload } = parentPort ? message : message.data;
61
+ onMessage(type, payload);
62
+ };
63
+ }
64
+ const parentPort = getParentPort();
65
+ if (parentPort) {
66
+ console.error('not implemented'); // eslint-disable-line
67
+ }
68
+ else {
69
+ globalThis.addEventListener('message', onMessageWrapper);
25
70
  }
26
-
27
- const {
28
- type,
29
- payload
30
- } = message.data;
31
- onMessage(type, payload);
32
- };
33
71
  }
34
-
35
- self.addEventListener('message', onMessageWrapper);
36
- }
37
-
38
- static removeEventListener(onMessage) {
39
- const onMessageWrapper = onMessageWrapperMap.get(onMessage);
40
- onMessageWrapperMap.delete(onMessage);
41
- self.removeEventListener('message', onMessageWrapper);
42
- }
43
-
44
- static postMessage(type, payload) {
45
- if (self) {
46
- const data = {
47
- source: 'loaders.gl',
48
- type,
49
- payload
50
- };
51
- const transferList = getTransferList(payload);
52
- self.postMessage(data, transferList);
72
+ static removeEventListener(onMessage) {
73
+ const onMessageWrapper = onMessageWrapperMap.get(onMessage);
74
+ onMessageWrapperMap.delete(onMessage);
75
+ const parentPort = getParentPort();
76
+ if (parentPort) {
77
+ console.error('not implemented'); // eslint-disable-line
78
+ }
79
+ else {
80
+ globalThis.removeEventListener('message', onMessageWrapper);
81
+ }
82
+ }
83
+ /**
84
+ * Send a message from a worker to creating thread (main thread)
85
+ * @param type
86
+ * @param payload
87
+ */
88
+ static postMessage(type, payload) {
89
+ const data = { source: 'loaders.gl', type, payload };
90
+ // console.log('posting message', data);
91
+ const transferList = (0, get_transfer_list_1.getTransferList)(payload);
92
+ const parentPort = getParentPort();
93
+ if (parentPort) {
94
+ parentPort.postMessage(data, transferList);
95
+ // console.log('posted message', data);
96
+ }
97
+ else {
98
+ // @ts-ignore
99
+ globalThis.postMessage(data, transferList);
100
+ }
53
101
  }
54
- }
55
-
56
102
  }
57
-
103
+ exports.default = WorkerBody;
104
+ // Filter out noise messages sent to workers
58
105
  function isKnownMessage(message) {
59
- const {
60
- type,
61
- data
62
- } = message;
63
- return type === 'message' && data && typeof data.source === 'string' && data.source.startsWith('loaders.gl');
106
+ const { type, data } = message;
107
+ return (type === 'message' &&
108
+ data &&
109
+ typeof data.source === 'string' &&
110
+ data.source.startsWith('loaders.gl'));
64
111
  }
65
- //# sourceMappingURL=worker-body.js.map
@@ -1,8 +1,12 @@
1
1
  import WorkerPool from './worker-pool';
2
2
  /**
3
- * @param maxConcurrency {number} - max count of workers
3
+ * @param maxConcurrency - max count of workers
4
+ * @param maxMobileConcurrency - max count of workers on mobile
5
+ * @param maxConcurrency - max count of workers
6
+ * @param reuseWorkers - if false, destroys workers when task is completed
7
+ * @param onDebug - callback intended to allow application to log worker pool activity
4
8
  */
5
- export declare type WorkerFarmProps = {
9
+ export type WorkerFarmProps = {
6
10
  maxConcurrency?: number;
7
11
  maxMobileConcurrency?: number;
8
12
  reuseWorkers?: boolean;
@@ -15,7 +19,7 @@ export default class WorkerFarm {
15
19
  private props;
16
20
  private workerPools;
17
21
  private static _workerFarm?;
18
- /** Check if Workers are supported */
22
+ /** Checks if workers are supported on this platform */
19
23
  static isSupported(): boolean;
20
24
  /** Get the singleton instance of the global worker farm */
21
25
  static getWorkerFarm(props?: WorkerFarmProps): WorkerFarm;
@@ -1 +1 @@
1
- {"version":3,"file":"worker-farm.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-farm/worker-farm.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,eAAe,CAAC;AAGvC;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB,CAAC;AASF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,CAAC,KAAK,CAAkB;IAC/B,OAAO,CAAC,WAAW,CAAiC;IAEpD,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAa;IAExC,qCAAqC;IACrC,MAAM,CAAC,WAAW,IAAI,OAAO;IAI7B,2DAA2D;IAC3D,MAAM,CAAC,aAAa,CAAC,KAAK,GAAE,eAAoB,GAAG,UAAU;IAM7D,0DAA0D;IAC1D,OAAO;IAOP;;;OAGG;IACH,OAAO,IAAI,IAAI;IAMf;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI;IAQtC;;;;;;;;OAQG;IACH,aAAa,CAAC,OAAO,EAAE;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,UAAU;IAejF,mBAAmB;;;;;;CAQpB"}
1
+ {"version":3,"file":"worker-farm.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-farm/worker-farm.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,eAAe,CAAC;AAGvC;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB,CAAC;AASF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,CAAC,KAAK,CAAkB;IAC/B,OAAO,CAAC,WAAW,CAAiC;IAEpD,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAa;IAExC,uDAAuD;IACvD,MAAM,CAAC,WAAW,IAAI,OAAO;IAI7B,2DAA2D;IAC3D,MAAM,CAAC,aAAa,CAAC,KAAK,GAAE,eAAoB,GAAG,UAAU;IAM7D,0DAA0D;IAC1D,OAAO;IAOP;;;OAGG;IACH,OAAO,IAAI,IAAI;IAOf;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI;IAQtC;;;;;;;;OAQG;IACH,aAAa,CAAC,OAAO,EAAE;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,UAAU;IAejF,mBAAmB;;;;;;CAQpB"}
@@ -1,83 +1,89 @@
1
- import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
2
- import WorkerPool from './worker-pool';
3
- import WorkerThread from './worker-thread';
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const worker_pool_1 = __importDefault(require("./worker-pool"));
7
+ const worker_thread_1 = __importDefault(require("./worker-thread"));
4
8
  const DEFAULT_PROPS = {
5
- maxConcurrency: 3,
6
- maxMobileConcurrency: 1,
7
- onDebug: () => {},
8
- reuseWorkers: true
9
+ maxConcurrency: 3,
10
+ maxMobileConcurrency: 1,
11
+ reuseWorkers: true,
12
+ onDebug: () => { }
9
13
  };
10
- export default class WorkerFarm {
11
- static isSupported() {
12
- return WorkerThread.isSupported();
13
- }
14
-
15
- static getWorkerFarm(props = {}) {
16
- WorkerFarm._workerFarm = WorkerFarm._workerFarm || new WorkerFarm({});
17
-
18
- WorkerFarm._workerFarm.setProps(props);
19
-
20
- return WorkerFarm._workerFarm;
21
- }
22
-
23
- constructor(props) {
24
- _defineProperty(this, "props", void 0);
25
-
26
- _defineProperty(this, "workerPools", new Map());
27
-
28
- this.props = { ...DEFAULT_PROPS
29
- };
30
- this.setProps(props);
31
- this.workerPools = new Map();
32
- }
33
-
34
- destroy() {
35
- for (const workerPool of this.workerPools.values()) {
36
- workerPool.destroy();
14
+ /**
15
+ * Process multiple jobs with a "farm" of different workers in worker pools.
16
+ */
17
+ class WorkerFarm {
18
+ /** Checks if workers are supported on this platform */
19
+ static isSupported() {
20
+ return worker_thread_1.default.isSupported();
21
+ }
22
+ /** Get the singleton instance of the global worker farm */
23
+ static getWorkerFarm(props = {}) {
24
+ WorkerFarm._workerFarm = WorkerFarm._workerFarm || new WorkerFarm({});
25
+ WorkerFarm._workerFarm.setProps(props);
26
+ return WorkerFarm._workerFarm;
27
+ }
28
+ /** get global instance with WorkerFarm.getWorkerFarm() */
29
+ constructor(props) {
30
+ this.workerPools = new Map();
31
+ this.props = { ...DEFAULT_PROPS };
32
+ this.setProps(props);
33
+ /** @type Map<string, WorkerPool>} */
34
+ this.workerPools = new Map();
35
+ }
36
+ /**
37
+ * Terminate all workers in the farm
38
+ * @note Can free up significant memory
39
+ */
40
+ destroy() {
41
+ for (const workerPool of this.workerPools.values()) {
42
+ workerPool.destroy();
43
+ }
44
+ this.workerPools = new Map();
45
+ }
46
+ /**
47
+ * Set props used when initializing worker pools
48
+ * @param props
49
+ */
50
+ setProps(props) {
51
+ this.props = { ...this.props, ...props };
52
+ // Update worker pool props
53
+ for (const workerPool of this.workerPools.values()) {
54
+ workerPool.setProps(this._getWorkerPoolProps());
55
+ }
37
56
  }
38
- }
39
-
40
- setProps(props) {
41
- this.props = { ...this.props,
42
- ...props
43
- };
44
-
45
- for (const workerPool of this.workerPools.values()) {
46
- workerPool.setProps(this._getWorkerPoolProps());
57
+ /**
58
+ * Returns a worker pool for the specified worker
59
+ * @param options - only used first time for a specific worker name
60
+ * @param options.name - the name of the worker - used to identify worker pool
61
+ * @param options.url -
62
+ * @param options.source -
63
+ * @example
64
+ * const job = WorkerFarm.getWorkerFarm().getWorkerPool({name, url}).startJob(...);
65
+ */
66
+ getWorkerPool(options) {
67
+ const { name, source, url } = options;
68
+ let workerPool = this.workerPools.get(name);
69
+ if (!workerPool) {
70
+ workerPool = new worker_pool_1.default({
71
+ name,
72
+ source,
73
+ url
74
+ });
75
+ workerPool.setProps(this._getWorkerPoolProps());
76
+ this.workerPools.set(name, workerPool);
77
+ }
78
+ return workerPool;
47
79
  }
48
- }
49
-
50
- getWorkerPool(options) {
51
- const {
52
- name,
53
- source,
54
- url
55
- } = options;
56
- let workerPool = this.workerPools.get(name);
57
-
58
- if (!workerPool) {
59
- workerPool = new WorkerPool({
60
- name,
61
- source,
62
- url
63
- });
64
- workerPool.setProps(this._getWorkerPoolProps());
65
- this.workerPools.set(name, workerPool);
80
+ _getWorkerPoolProps() {
81
+ return {
82
+ maxConcurrency: this.props.maxConcurrency,
83
+ maxMobileConcurrency: this.props.maxMobileConcurrency,
84
+ reuseWorkers: this.props.reuseWorkers,
85
+ onDebug: this.props.onDebug
86
+ };
66
87
  }
67
-
68
- return workerPool;
69
- }
70
-
71
- _getWorkerPoolProps() {
72
- return {
73
- maxConcurrency: this.props.maxConcurrency,
74
- maxMobileConcurrency: this.props.maxMobileConcurrency,
75
- reuseWorkers: this.props.reuseWorkers,
76
- onDebug: this.props.onDebug
77
- };
78
- }
79
-
80
88
  }
81
-
82
- _defineProperty(WorkerFarm, "_workerFarm", void 0);
83
- //# sourceMappingURL=worker-farm.js.map
89
+ exports.default = WorkerFarm;
@@ -1 +1 @@
1
- {"version":3,"file":"worker-job.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-farm/worker-job.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,iBAAiB,EAAE,oBAAoB,EAAC,MAAM,aAAa,CAAC;AACzE,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAG3C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,SAAS,EAAE,OAAO,CAAC;IACnB,6CAA6C;IAC7C,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IAE9B,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,CAAC,OAAO,CAAyB;gBAE5B,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY;IAYvD;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,oBAAoB,GAAG,IAAI;IAQzE;;OAEG;IACH,IAAI,CAAC,KAAK,EAAE,GAAG,GAAG,IAAI;IAMtB;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;CAK1B"}
1
+ {"version":3,"file":"worker-job.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-farm/worker-job.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,iBAAiB,EAAE,oBAAoB,EAAC,MAAM,aAAa,CAAC;AACzE,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAG3C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,SAAS,EAAE,OAAO,CAAQ;IAC1B,6CAA6C;IAC7C,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IAE9B,OAAO,CAAC,QAAQ,CAAkC;IAClD,OAAO,CAAC,OAAO,CAAoC;gBAEvC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY;IASvD;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,oBAAoB,GAAG,IAAI;IAQzE;;OAEG;IACH,IAAI,CAAC,KAAK,EAAE,GAAG,GAAG,IAAI;IAMtB;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;CAK1B"}