@loaders.gl/worker-utils 3.1.0-alpha.3 → 3.1.0-beta.2

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 (198) hide show
  1. package/dist/es5/index.js +160 -0
  2. package/dist/es5/index.js.map +1 -0
  3. package/dist/es5/lib/async-queue/async-queue.js +106 -0
  4. package/dist/es5/lib/async-queue/async-queue.js.map +1 -0
  5. package/dist/es5/lib/env-utils/assert.js +13 -0
  6. package/dist/es5/lib/env-utils/assert.js.map +1 -0
  7. package/dist/es5/lib/env-utils/globals.js +30 -0
  8. package/dist/es5/lib/env-utils/globals.js.map +1 -0
  9. package/dist/es5/lib/env-utils/version.js +14 -0
  10. package/dist/es5/lib/env-utils/version.js.map +1 -0
  11. package/dist/es5/lib/library-utils/library-utils.js +102 -0
  12. package/dist/es5/lib/library-utils/library-utils.js.map +1 -0
  13. package/dist/es5/lib/node/require-utils.node.js +56 -0
  14. package/dist/es5/lib/node/require-utils.node.js.map +1 -0
  15. package/dist/es5/lib/process-utils/child-process-proxy.js +136 -0
  16. package/dist/es5/lib/process-utils/child-process-proxy.js.map +1 -0
  17. package/dist/es5/lib/process-utils/process-utils.js +39 -0
  18. package/dist/es5/lib/process-utils/process-utils.js.map +1 -0
  19. package/dist/es5/lib/worker-api/create-worker.js +119 -0
  20. package/dist/es5/lib/worker-api/create-worker.js.map +1 -0
  21. package/dist/es5/lib/worker-api/get-worker-url.js +44 -0
  22. package/dist/es5/lib/worker-api/get-worker-url.js.map +1 -0
  23. package/dist/es5/lib/worker-api/process-on-worker.js +91 -0
  24. package/dist/es5/lib/worker-api/process-on-worker.js.map +1 -0
  25. package/dist/es5/lib/worker-api/validate-worker-version.js +30 -0
  26. package/dist/es5/lib/worker-api/validate-worker-version.js.map +1 -0
  27. package/dist/es5/lib/worker-farm/worker-body.js +76 -0
  28. package/dist/es5/lib/worker-farm/worker-body.js.map +1 -0
  29. package/dist/es5/lib/worker-farm/worker-farm.js +95 -0
  30. package/dist/es5/lib/worker-farm/worker-farm.js.map +1 -0
  31. package/dist/es5/lib/worker-farm/worker-job.js +61 -0
  32. package/dist/es5/lib/worker-farm/worker-job.js.map +1 -0
  33. package/dist/es5/lib/worker-farm/worker-pool.js +160 -0
  34. package/dist/es5/lib/worker-farm/worker-pool.js.map +1 -0
  35. package/dist/es5/lib/worker-farm/worker-thread.js +111 -0
  36. package/dist/es5/lib/worker-farm/worker-thread.js.map +1 -0
  37. package/dist/es5/lib/worker-utils/get-loadable-worker-url.js +51 -0
  38. package/dist/es5/lib/worker-utils/get-loadable-worker-url.js.map +1 -0
  39. package/dist/es5/lib/worker-utils/get-transfer-list.js +47 -0
  40. package/dist/es5/lib/worker-utils/get-transfer-list.js.map +1 -0
  41. package/dist/es5/lib/worker-utils/remove-nontransferable-options.js +30 -0
  42. package/dist/es5/lib/worker-utils/remove-nontransferable-options.js.map +1 -0
  43. package/dist/es5/types.js +2 -0
  44. package/dist/{types.js.map → es5/types.js.map} +0 -0
  45. package/dist/es5/workers/null-worker.js +8 -0
  46. package/dist/es5/workers/null-worker.js.map +1 -0
  47. package/dist/esm/index.js +26 -0
  48. package/dist/esm/index.js.map +1 -0
  49. package/dist/esm/lib/async-queue/async-queue.js +97 -0
  50. package/dist/esm/lib/async-queue/async-queue.js.map +1 -0
  51. package/dist/esm/lib/env-utils/assert.js +6 -0
  52. package/dist/esm/lib/env-utils/assert.js.map +1 -0
  53. package/dist/esm/lib/env-utils/globals.js +17 -0
  54. package/dist/esm/lib/env-utils/globals.js.map +1 -0
  55. package/dist/esm/lib/env-utils/version.js +7 -0
  56. package/dist/esm/lib/env-utils/version.js.map +1 -0
  57. package/dist/esm/lib/library-utils/library-utils.js +84 -0
  58. package/dist/esm/lib/library-utils/library-utils.js.map +1 -0
  59. package/dist/esm/lib/node/require-utils.node.js +43 -0
  60. package/dist/esm/lib/node/require-utils.node.js.map +1 -0
  61. package/dist/esm/lib/process-utils/child-process-proxy.js +122 -0
  62. package/dist/esm/lib/process-utils/child-process-proxy.js.map +1 -0
  63. package/dist/esm/lib/process-utils/process-utils.js +29 -0
  64. package/dist/esm/lib/process-utils/process-utils.js.map +1 -0
  65. package/dist/esm/lib/worker-api/create-worker.js +99 -0
  66. package/dist/esm/lib/worker-api/create-worker.js.map +1 -0
  67. package/dist/esm/lib/worker-api/get-worker-url.js +32 -0
  68. package/dist/esm/lib/worker-api/get-worker-url.js.map +1 -0
  69. package/dist/esm/lib/worker-api/process-on-worker.js +75 -0
  70. package/dist/esm/lib/worker-api/process-on-worker.js.map +1 -0
  71. package/dist/esm/lib/worker-api/validate-worker-version.js +21 -0
  72. package/dist/esm/lib/worker-api/validate-worker-version.js.map +1 -0
  73. package/dist/esm/lib/worker-farm/worker-body.js +65 -0
  74. package/dist/esm/lib/worker-farm/worker-body.js.map +1 -0
  75. package/dist/esm/lib/worker-farm/worker-farm.js +83 -0
  76. package/dist/esm/lib/worker-farm/worker-farm.js.map +1 -0
  77. package/dist/esm/lib/worker-farm/worker-job.js +54 -0
  78. package/dist/esm/lib/worker-farm/worker-job.js.map +1 -0
  79. package/dist/esm/lib/worker-farm/worker-pool.js +157 -0
  80. package/dist/esm/lib/worker-farm/worker-pool.js.map +1 -0
  81. package/dist/esm/lib/worker-farm/worker-thread.js +105 -0
  82. package/dist/esm/lib/worker-farm/worker-thread.js.map +1 -0
  83. package/dist/esm/lib/worker-utils/get-loadable-worker-url.js +42 -0
  84. package/dist/esm/lib/worker-utils/get-loadable-worker-url.js.map +1 -0
  85. package/dist/esm/lib/worker-utils/get-transfer-list.js +40 -0
  86. package/dist/esm/lib/worker-utils/get-transfer-list.js.map +1 -0
  87. package/dist/esm/lib/worker-utils/remove-nontransferable-options.js +23 -0
  88. package/dist/esm/lib/worker-utils/remove-nontransferable-options.js.map +1 -0
  89. package/dist/esm/types.js +2 -0
  90. package/dist/esm/types.js.map +1 -0
  91. package/dist/esm/workers/null-worker.js +5 -0
  92. package/dist/esm/workers/null-worker.js.map +1 -0
  93. package/dist/index.d.ts +20 -0
  94. package/dist/index.d.ts.map +1 -0
  95. package/dist/index.js +57 -25
  96. package/dist/lib/async-queue/async-queue.d.ts +32 -0
  97. package/dist/lib/async-queue/async-queue.d.ts.map +1 -0
  98. package/dist/lib/async-queue/async-queue.js +81 -91
  99. package/dist/lib/env-utils/assert.d.ts +3 -0
  100. package/dist/lib/env-utils/assert.d.ts.map +1 -0
  101. package/dist/lib/env-utils/assert.js +12 -5
  102. package/dist/lib/env-utils/globals.d.ts +22 -0
  103. package/dist/lib/env-utils/globals.d.ts.map +1 -0
  104. package/dist/lib/env-utils/globals.js +25 -10
  105. package/dist/lib/env-utils/version.d.ts +2 -0
  106. package/dist/lib/env-utils/version.d.ts.map +1 -0
  107. package/dist/lib/env-utils/version.js +10 -5
  108. package/dist/lib/library-utils/library-utils.d.ts +18 -0
  109. package/dist/lib/library-utils/library-utils.d.ts.map +1 -0
  110. package/dist/lib/library-utils/library-utils.js +149 -75
  111. package/dist/lib/node/require-utils.node.d.ts +6 -0
  112. package/dist/lib/node/require-utils.node.d.ts.map +1 -0
  113. package/dist/lib/node/require-utils.node.js +58 -45
  114. package/dist/lib/process-utils/child-process-proxy.d.ts +43 -0
  115. package/dist/lib/process-utils/child-process-proxy.d.ts.map +1 -0
  116. package/dist/lib/process-utils/child-process-proxy.js +122 -113
  117. package/dist/lib/process-utils/process-utils.d.ts +2 -0
  118. package/dist/lib/process-utils/process-utils.d.ts.map +1 -0
  119. package/dist/lib/process-utils/process-utils.js +33 -27
  120. package/dist/lib/worker-api/create-worker.d.ts +9 -0
  121. package/dist/lib/worker-api/create-worker.d.ts.map +1 -0
  122. package/dist/lib/worker-api/create-worker.js +85 -92
  123. package/dist/lib/worker-api/get-worker-url.d.ts +14 -0
  124. package/dist/lib/worker-api/get-worker-url.d.ts.map +1 -0
  125. package/dist/lib/worker-api/get-worker-url.js +45 -29
  126. package/dist/lib/worker-api/process-on-worker.d.ts +20 -0
  127. package/dist/lib/worker-api/process-on-worker.d.ts.map +1 -0
  128. package/dist/lib/worker-api/process-on-worker.js +75 -71
  129. package/dist/lib/worker-api/validate-worker-version.d.ts +9 -0
  130. package/dist/lib/worker-api/validate-worker-version.d.ts.map +1 -0
  131. package/dist/lib/worker-api/validate-worker-version.js +32 -18
  132. package/dist/lib/worker-farm/worker-body.d.ts +16 -0
  133. package/dist/lib/worker-farm/worker-body.d.ts.map +1 -0
  134. package/dist/lib/worker-farm/worker-body.js +60 -58
  135. package/dist/lib/worker-farm/worker-farm.d.ts +55 -0
  136. package/dist/lib/worker-farm/worker-farm.d.ts.map +1 -0
  137. package/dist/lib/worker-farm/worker-farm.js +82 -77
  138. package/dist/lib/worker-farm/worker-job.d.ts +29 -0
  139. package/dist/lib/worker-farm/worker-job.d.ts.map +1 -0
  140. package/dist/lib/worker-farm/worker-job.js +46 -53
  141. package/dist/lib/worker-farm/worker-pool.d.ts +75 -0
  142. package/dist/lib/worker-farm/worker-pool.d.ts.map +1 -0
  143. package/dist/lib/worker-farm/worker-pool.js +142 -148
  144. package/dist/lib/worker-farm/worker-thread.d.ts +42 -0
  145. package/dist/lib/worker-farm/worker-thread.d.ts.map +1 -0
  146. package/dist/lib/worker-farm/worker-thread.js +92 -102
  147. package/dist/lib/worker-utils/get-loadable-worker-url.d.ts +14 -0
  148. package/dist/lib/worker-utils/get-loadable-worker-url.d.ts.map +1 -0
  149. package/dist/lib/worker-utils/get-loadable-worker-url.js +59 -33
  150. package/dist/lib/worker-utils/get-transfer-list.d.ts +10 -0
  151. package/dist/lib/worker-utils/get-transfer-list.d.ts.map +1 -0
  152. package/dist/lib/worker-utils/get-transfer-list.js +57 -36
  153. package/dist/lib/worker-utils/remove-nontransferable-options.d.ts +6 -0
  154. package/dist/lib/worker-utils/remove-nontransferable-options.d.ts.map +1 -0
  155. package/dist/lib/worker-utils/remove-nontransferable-options.js +31 -19
  156. package/dist/null-worker.js +189 -550
  157. package/dist/null-worker.js.map +7 -1
  158. package/dist/types.d.ts +56 -0
  159. package/dist/types.d.ts.map +1 -0
  160. package/dist/types.js +2 -2
  161. package/dist/workers/null-worker.d.ts +2 -0
  162. package/dist/workers/null-worker.d.ts.map +1 -0
  163. package/dist/workers/null-worker.js +6 -4
  164. package/package.json +8 -8
  165. package/src/lib/env-utils/version.ts +1 -1
  166. package/src/lib/library-utils/library-utils.ts +6 -4
  167. package/src/lib/node/{require-utils.node.js → require-utils.node.ts} +13 -9
  168. package/src/lib/process-utils/child-process-proxy.ts +1 -1
  169. package/src/lib/worker-api/create-worker.ts +11 -7
  170. package/src/lib/worker-api/process-on-worker.ts +1 -1
  171. package/src/lib/worker-farm/worker-body.ts +2 -2
  172. package/src/lib/worker-farm/worker-job.ts +2 -2
  173. package/src/lib/worker-farm/worker-thread.ts +2 -2
  174. package/src/lib/worker-utils/get-transfer-list.ts +1 -1
  175. package/src/lib/worker-utils/remove-nontransferable-options.ts +1 -1
  176. package/src/types.ts +1 -1
  177. package/dist/index.js.map +0 -1
  178. package/dist/lib/async-queue/async-queue.js.map +0 -1
  179. package/dist/lib/env-utils/assert.js.map +0 -1
  180. package/dist/lib/env-utils/globals.js.map +0 -1
  181. package/dist/lib/env-utils/version.js.map +0 -1
  182. package/dist/lib/library-utils/library-utils.js.map +0 -1
  183. package/dist/lib/node/require-utils.node.js.map +0 -1
  184. package/dist/lib/process-utils/child-process-proxy.js.map +0 -1
  185. package/dist/lib/process-utils/process-utils.js.map +0 -1
  186. package/dist/lib/worker-api/create-worker.js.map +0 -1
  187. package/dist/lib/worker-api/get-worker-url.js.map +0 -1
  188. package/dist/lib/worker-api/process-on-worker.js.map +0 -1
  189. package/dist/lib/worker-api/validate-worker-version.js.map +0 -1
  190. package/dist/lib/worker-farm/worker-body.js.map +0 -1
  191. package/dist/lib/worker-farm/worker-farm.js.map +0 -1
  192. package/dist/lib/worker-farm/worker-job.js.map +0 -1
  193. package/dist/lib/worker-farm/worker-pool.js.map +0 -1
  194. package/dist/lib/worker-farm/worker-thread.js.map +0 -1
  195. package/dist/lib/worker-utils/get-loadable-worker-url.js.map +0 -1
  196. package/dist/lib/worker-utils/get-transfer-list.js.map +0 -1
  197. package/dist/lib/worker-utils/remove-nontransferable-options.js.map +0 -1
  198. package/dist/workers/null-worker.js.map +0 -1
@@ -1,75 +1,79 @@
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 remove_nontransferable_options_1 = require("../worker-utils/remove-nontransferable-options");
9
+ const get_worker_url_1 = require("./get-worker-url");
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 url = (0, get_worker_url_1.getWorkerURL)(worker, options);
31
+ const workerFarm = worker_farm_1.default.getWorkerFarm(options);
32
+ const workerPool = workerFarm.getWorkerPool({ name, url });
33
+ const jobName = options.jobName || worker.name;
34
+ const job = await workerPool.startJob(jobName,
35
+ // eslint-disable-next-line
36
+ onMessage.bind(null, context));
37
+ // Kick off the processing in the worker
38
+ const transferableOptions = (0, remove_nontransferable_options_1.removeNontransferableOptions)(options);
39
+ job.postMessage('process', { input: data, options: transferableOptions });
40
+ const result = await job.result;
41
+ return result.result;
28
42
  }
29
-
43
+ exports.processOnWorker = processOnWorker;
44
+ /**
45
+ * Job completes when we receive the result
46
+ * @param job
47
+ * @param message
48
+ */
30
49
  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(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 ${type}`);
73
- }
50
+ switch (type) {
51
+ case 'done':
52
+ // Worker is done
53
+ job.done(payload);
54
+ break;
55
+ case 'error':
56
+ // Worker encountered an error
57
+ job.error(new Error(payload.error));
58
+ break;
59
+ case 'process':
60
+ // Worker is asking for us (main thread) to process something
61
+ const { id, input, options } = payload;
62
+ try {
63
+ if (!context.process) {
64
+ job.postMessage('error', { id, error: 'Worker not set up to process on main thread' });
65
+ return;
66
+ }
67
+ const result = await context.process(input, options);
68
+ job.postMessage('done', { id, result });
69
+ }
70
+ catch (error) {
71
+ const message = error instanceof Error ? error.message : 'unknown error';
72
+ job.postMessage('error', { id, error: message });
73
+ }
74
+ break;
75
+ default:
76
+ // eslint-disable-next-line
77
+ console.warn(`process-on-worker: unknown message ${type}`);
78
+ }
74
79
  }
75
- //# sourceMappingURL=process-on-worker.js.map
@@ -0,0 +1,9 @@
1
+ import type { WorkerObject } from '../../types';
2
+ /**
3
+ * Check if worker is compatible with this library version
4
+ * @param worker
5
+ * @param libVersion
6
+ * @returns `true` if the two versions are compatible
7
+ */
8
+ export declare function validateWorkerVersion(worker: WorkerObject, coreVersion?: string): boolean;
9
+ //# sourceMappingURL=validate-worker-version.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"validate-worker-version.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-api/validate-worker-version.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAI9C;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,EACpB,WAAW,GAAE,MAAgB,GAC5B,OAAO,CAmBT"}
@@ -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
@@ -0,0 +1,16 @@
1
+ import type { WorkerMessageType, WorkerMessagePayload } from '../../types';
2
+ /**
3
+ * Type safe wrapper for worker code
4
+ */
5
+ export default class WorkerBody {
6
+ static set onmessage(onMessage: (type: WorkerMessageType, payload: WorkerMessagePayload) => any);
7
+ static addEventListener(onMessage: (type: WorkerMessageType, payload: WorkerMessagePayload) => any): void;
8
+ static removeEventListener(onMessage: (type: WorkerMessageType, payload: WorkerMessagePayload) => any): void;
9
+ /**
10
+ * Send a message from a worker to creating thread (main thread)
11
+ * @param type
12
+ * @param payload
13
+ */
14
+ static postMessage(type: WorkerMessageType, payload: WorkerMessagePayload): void;
15
+ }
16
+ //# sourceMappingURL=worker-body.d.ts.map
@@ -0,0 +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,65 +1,67 @@
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");
2
4
  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;
5
+ /**
6
+ * Type safe wrapper for worker code
7
+ */
8
+ class WorkerBody {
9
+ /*
10
+ * (type: WorkerMessageType, payload: WorkerMessagePayload) => any
11
+ */
12
+ static set onmessage(onMessage) {
13
+ // eslint-disable-next-line no-restricted-globals
14
+ self.onmessage = (message) => {
15
+ if (!isKnownMessage(message)) {
16
+ return;
17
+ }
18
+ // Confusingly the message itself also has a 'type' field which is always set to 'message'
19
+ const { type, payload } = message.data;
20
+ onMessage(type, payload);
21
+ };
22
+ }
23
+ static addEventListener(onMessage) {
24
+ let onMessageWrapper = onMessageWrapperMap.get(onMessage);
25
+ if (!onMessageWrapper) {
26
+ onMessageWrapper = (message) => {
27
+ if (!isKnownMessage(message)) {
28
+ return;
29
+ }
30
+ // Confusingly the message itself also has a 'type' field which is always set to 'message'
31
+ const { type, payload } = message.data;
32
+ onMessage(type, payload);
33
+ };
25
34
  }
26
-
27
- const {
28
- type,
29
- payload
30
- } = message.data;
31
- onMessage(type, payload);
32
- };
35
+ // eslint-disable-next-line no-restricted-globals
36
+ self.addEventListener('message', onMessageWrapper);
37
+ }
38
+ static removeEventListener(onMessage) {
39
+ const onMessageWrapper = onMessageWrapperMap.get(onMessage);
40
+ onMessageWrapperMap.delete(onMessage);
41
+ // eslint-disable-next-line no-restricted-globals
42
+ self.removeEventListener('message', onMessageWrapper);
33
43
  }
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);
44
+ /**
45
+ * Send a message from a worker to creating thread (main thread)
46
+ * @param type
47
+ * @param payload
48
+ */
49
+ static postMessage(type, payload) {
50
+ if (self) {
51
+ const data = { source: 'loaders.gl', type, payload };
52
+ const transferList = (0, get_transfer_list_1.getTransferList)(payload);
53
+ // eslint-disable-next-line no-restricted-globals
54
+ // @ts-ignore
55
+ self.postMessage(data, transferList);
56
+ }
53
57
  }
54
- }
55
-
56
58
  }
57
-
59
+ exports.default = WorkerBody;
60
+ // Filter out noise messages sent to workers
58
61
  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');
62
+ const { type, data } = message;
63
+ return (type === 'message' &&
64
+ data &&
65
+ typeof data.source === 'string' &&
66
+ data.source.startsWith('loaders.gl'));
64
67
  }
65
- //# sourceMappingURL=worker-body.js.map
@@ -0,0 +1,55 @@
1
+ import WorkerPool from './worker-pool';
2
+ /**
3
+ * @param maxConcurrency {number} - max count of workers
4
+ */
5
+ export declare type WorkerFarmProps = {
6
+ maxConcurrency?: number;
7
+ maxMobileConcurrency?: number;
8
+ reuseWorkers?: boolean;
9
+ onDebug?: () => void;
10
+ };
11
+ /**
12
+ * Process multiple jobs with a "farm" of different workers in worker pools.
13
+ */
14
+ export default class WorkerFarm {
15
+ private props;
16
+ private workerPools;
17
+ private static _workerFarm?;
18
+ /** Check if Workers are supported */
19
+ static isSupported(): boolean;
20
+ /** Get the singleton instance of the global worker farm */
21
+ static getWorkerFarm(props?: WorkerFarmProps): WorkerFarm;
22
+ /** get global instance with WorkerFarm.getWorkerFarm() */
23
+ private constructor();
24
+ /**
25
+ * Terminate all workers in the farm
26
+ * @note Can free up significant memory
27
+ */
28
+ destroy(): void;
29
+ /**
30
+ * Set props used when initializing worker pools
31
+ * @param props
32
+ */
33
+ setProps(props: WorkerFarmProps): void;
34
+ /**
35
+ * Returns a worker pool for the specified worker
36
+ * @param options - only used first time for a specific worker name
37
+ * @param options.name - the name of the worker - used to identify worker pool
38
+ * @param options.url -
39
+ * @param options.source -
40
+ * @example
41
+ * const job = WorkerFarm.getWorkerFarm().getWorkerPool({name, url}).startJob(...);
42
+ */
43
+ getWorkerPool(options: {
44
+ name: string;
45
+ source?: string;
46
+ url?: string;
47
+ }): WorkerPool;
48
+ _getWorkerPoolProps(): {
49
+ maxConcurrency: number | undefined;
50
+ maxMobileConcurrency: number | undefined;
51
+ reuseWorkers: boolean | undefined;
52
+ onDebug: (() => void) | undefined;
53
+ };
54
+ }
55
+ //# sourceMappingURL=worker-farm.d.ts.map
@@ -0,0 +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,83 +1,88 @@
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
+ onDebug: () => { },
12
+ reuseWorkers: true
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
+ /** get global instance with WorkerFarm.getWorkerFarm() */
19
+ constructor(props) {
20
+ this.workerPools = new Map();
21
+ this.props = { ...DEFAULT_PROPS };
22
+ this.setProps(props);
23
+ /** @type Map<string, WorkerPool>} */
24
+ this.workerPools = new Map();
25
+ }
26
+ /** Check if Workers are supported */
27
+ static isSupported() {
28
+ return worker_thread_1.default.isSupported();
29
+ }
30
+ /** Get the singleton instance of the global worker farm */
31
+ static getWorkerFarm(props = {}) {
32
+ WorkerFarm._workerFarm = WorkerFarm._workerFarm || new WorkerFarm({});
33
+ WorkerFarm._workerFarm.setProps(props);
34
+ return WorkerFarm._workerFarm;
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
+ }
45
+ /**
46
+ * Set props used when initializing worker pools
47
+ * @param props
48
+ */
49
+ setProps(props) {
50
+ this.props = { ...this.props, ...props };
51
+ // Update worker pool props
52
+ for (const workerPool of this.workerPools.values()) {
53
+ workerPool.setProps(this._getWorkerPoolProps());
54
+ }
37
55
  }
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());
56
+ /**
57
+ * Returns a worker pool for the specified worker
58
+ * @param options - only used first time for a specific worker name
59
+ * @param options.name - the name of the worker - used to identify worker pool
60
+ * @param options.url -
61
+ * @param options.source -
62
+ * @example
63
+ * const job = WorkerFarm.getWorkerFarm().getWorkerPool({name, url}).startJob(...);
64
+ */
65
+ getWorkerPool(options) {
66
+ const { name, source, url } = options;
67
+ let workerPool = this.workerPools.get(name);
68
+ if (!workerPool) {
69
+ workerPool = new worker_pool_1.default({
70
+ name,
71
+ source,
72
+ url
73
+ });
74
+ workerPool.setProps(this._getWorkerPoolProps());
75
+ this.workerPools.set(name, workerPool);
76
+ }
77
+ return workerPool;
47
78
  }
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);
79
+ _getWorkerPoolProps() {
80
+ return {
81
+ maxConcurrency: this.props.maxConcurrency,
82
+ maxMobileConcurrency: this.props.maxMobileConcurrency,
83
+ reuseWorkers: this.props.reuseWorkers,
84
+ onDebug: this.props.onDebug
85
+ };
66
86
  }
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
87
  }
81
-
82
- _defineProperty(WorkerFarm, "_workerFarm", void 0);
83
- //# sourceMappingURL=worker-farm.js.map
88
+ exports.default = WorkerFarm;
@@ -0,0 +1,29 @@
1
+ import type { WorkerMessageType, WorkerMessagePayload } from '../../types';
2
+ import WorkerThread from './worker-thread';
3
+ /**
4
+ * Represents one Job handled by a WorkerPool or WorkerFarm
5
+ */
6
+ export default class WorkerJob {
7
+ readonly name: string;
8
+ readonly workerThread: WorkerThread;
9
+ isRunning: boolean;
10
+ /** Promise that resolves when Job is done */
11
+ readonly result: Promise<any>;
12
+ private _resolve;
13
+ private _reject;
14
+ constructor(jobName: string, workerThread: WorkerThread);
15
+ /**
16
+ * Send a message to the job's worker thread
17
+ * @param data any data structure, ideally consisting mostly of transferrable objects
18
+ */
19
+ postMessage(type: WorkerMessageType, payload: WorkerMessagePayload): void;
20
+ /**
21
+ * Call to resolve the `result` Promise with the supplied value
22
+ */
23
+ done(value: any): void;
24
+ /**
25
+ * Call to reject the `result` Promise with the supplied error
26
+ */
27
+ error(error: Error): void;
28
+ }
29
+ //# sourceMappingURL=worker-job.d.ts.map
@@ -0,0 +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"}