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

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 (150) hide show
  1. package/dist/es5/index.js +19 -19
  2. package/dist/es5/index.js.map +1 -1
  3. package/dist/es5/lib/async-queue/async-queue.js +62 -76
  4. package/dist/es5/lib/async-queue/async-queue.js.map +1 -1
  5. package/dist/es5/lib/env-utils/globals.js +10 -15
  6. package/dist/es5/lib/env-utils/globals.js.map +1 -1
  7. package/dist/es5/lib/env-utils/version.js +3 -3
  8. package/dist/es5/lib/env-utils/version.js.map +1 -1
  9. package/dist/es5/lib/library-utils/library-utils.js +29 -127
  10. package/dist/es5/lib/library-utils/library-utils.js.map +1 -1
  11. package/dist/es5/lib/node/require-utils.node.js +18 -67
  12. package/dist/es5/lib/node/require-utils.node.js.map +1 -1
  13. package/dist/es5/lib/process-utils/child-process-proxy.js +90 -199
  14. package/dist/es5/lib/process-utils/child-process-proxy.js.map +1 -1
  15. package/dist/es5/lib/process-utils/process-utils.js +8 -9
  16. package/dist/es5/lib/process-utils/process-utils.js.map +1 -1
  17. package/dist/es5/lib/worker-api/create-worker.js +52 -162
  18. package/dist/es5/lib/worker-api/create-worker.js.map +1 -1
  19. package/dist/es5/lib/worker-api/get-worker-url.js +9 -10
  20. package/dist/es5/lib/worker-api/get-worker-url.js.map +1 -1
  21. package/dist/es5/lib/worker-api/process-on-worker.js +59 -130
  22. package/dist/es5/lib/worker-api/process-on-worker.js.map +1 -1
  23. package/dist/es5/lib/worker-api/validate-worker-version.js +3 -4
  24. package/dist/es5/lib/worker-api/validate-worker-version.js.map +1 -1
  25. package/dist/es5/lib/worker-farm/worker-body.js +46 -58
  26. package/dist/es5/lib/worker-farm/worker-body.js.map +1 -1
  27. package/dist/es5/lib/worker-farm/worker-farm.js +60 -99
  28. package/dist/es5/lib/worker-farm/worker-farm.js.map +1 -1
  29. package/dist/es5/lib/worker-farm/worker-job.js +28 -40
  30. package/dist/es5/lib/worker-farm/worker-job.js.map +1 -1
  31. package/dist/es5/lib/worker-farm/worker-pool.js +108 -204
  32. package/dist/es5/lib/worker-farm/worker-pool.js.map +1 -1
  33. package/dist/es5/lib/worker-farm/worker-thread.js +67 -85
  34. package/dist/es5/lib/worker-farm/worker-thread.js.map +1 -1
  35. package/dist/es5/lib/worker-utils/get-loadable-worker-url.js +4 -4
  36. package/dist/es5/lib/worker-utils/get-loadable-worker-url.js.map +1 -1
  37. package/dist/es5/lib/worker-utils/get-transfer-list.js +4 -10
  38. package/dist/es5/lib/worker-utils/get-transfer-list.js.map +1 -1
  39. package/dist/es5/lib/worker-utils/remove-nontransferable-options.js +3 -7
  40. package/dist/es5/lib/worker-utils/remove-nontransferable-options.js.map +1 -1
  41. package/dist/es5/workers/null-worker.js +3 -26
  42. package/dist/es5/workers/null-worker.js.map +1 -1
  43. package/dist/esm/lib/env-utils/version.js +2 -2
  44. package/dist/esm/lib/env-utils/version.js.map +1 -1
  45. package/dist/esm/lib/library-utils/library-utils.js +5 -5
  46. package/dist/esm/lib/library-utils/library-utils.js.map +1 -1
  47. package/dist/esm/lib/node/require-utils.node.js +6 -10
  48. package/dist/esm/lib/node/require-utils.node.js.map +1 -1
  49. package/dist/esm/lib/process-utils/child-process-proxy.js +5 -5
  50. package/dist/esm/lib/process-utils/child-process-proxy.js.map +1 -1
  51. package/dist/esm/lib/worker-api/create-worker.js +1 -1
  52. package/dist/esm/lib/worker-api/create-worker.js.map +1 -1
  53. package/dist/esm/lib/worker-api/get-worker-url.js +7 -7
  54. package/dist/esm/lib/worker-api/get-worker-url.js.map +1 -1
  55. package/dist/esm/lib/worker-api/process-on-worker.js +2 -2
  56. package/dist/esm/lib/worker-api/process-on-worker.js.map +1 -1
  57. package/dist/esm/lib/worker-farm/worker-body.js.map +1 -1
  58. package/dist/esm/lib/worker-farm/worker-job.js.map +1 -1
  59. package/dist/esm/lib/worker-farm/worker-pool.js +1 -1
  60. package/dist/esm/lib/worker-farm/worker-pool.js.map +1 -1
  61. package/dist/esm/lib/worker-farm/worker-thread.js +3 -3
  62. package/dist/esm/lib/worker-farm/worker-thread.js.map +1 -1
  63. package/dist/esm/lib/worker-utils/get-loadable-worker-url.js +1 -7
  64. package/dist/esm/lib/worker-utils/get-loadable-worker-url.js.map +1 -1
  65. package/dist/esm/lib/worker-utils/get-transfer-list.js.map +1 -1
  66. package/dist/esm/lib/worker-utils/remove-nontransferable-options.js.map +1 -1
  67. package/dist/index.d.ts +20 -0
  68. package/dist/index.d.ts.map +1 -0
  69. package/dist/index.js +58 -0
  70. package/dist/lib/async-queue/async-queue.d.ts +32 -0
  71. package/dist/lib/async-queue/async-queue.d.ts.map +1 -0
  72. package/dist/lib/async-queue/async-queue.js +87 -0
  73. package/dist/lib/env-utils/assert.d.ts +3 -0
  74. package/dist/lib/env-utils/assert.d.ts.map +1 -0
  75. package/dist/lib/env-utils/assert.js +13 -0
  76. package/dist/lib/env-utils/globals.d.ts +22 -0
  77. package/dist/lib/env-utils/globals.d.ts.map +1 -0
  78. package/dist/lib/env-utils/globals.js +32 -0
  79. package/dist/lib/env-utils/version.d.ts +2 -0
  80. package/dist/lib/env-utils/version.d.ts.map +1 -0
  81. package/dist/lib/env-utils/version.js +12 -0
  82. package/dist/lib/library-utils/library-utils.d.ts +18 -0
  83. package/dist/lib/library-utils/library-utils.d.ts.map +1 -0
  84. package/dist/lib/library-utils/library-utils.js +158 -0
  85. package/dist/lib/node/require-utils.node.d.ts +6 -0
  86. package/dist/lib/node/require-utils.node.d.ts.map +1 -0
  87. package/dist/lib/node/require-utils.node.js +60 -0
  88. package/dist/lib/process-utils/child-process-proxy.d.ts +43 -0
  89. package/dist/lib/process-utils/child-process-proxy.d.ts.map +1 -0
  90. package/dist/lib/process-utils/child-process-proxy.js +131 -0
  91. package/dist/lib/process-utils/process-utils.d.ts +2 -0
  92. package/dist/lib/process-utils/process-utils.d.ts.map +1 -0
  93. package/dist/lib/process-utils/process-utils.js +35 -0
  94. package/dist/lib/worker-api/create-worker.d.ts +9 -0
  95. package/dist/lib/worker-api/create-worker.d.ts.map +1 -0
  96. package/dist/lib/worker-api/create-worker.js +92 -0
  97. package/dist/lib/worker-api/get-worker-url.d.ts +14 -0
  98. package/dist/lib/worker-api/get-worker-url.d.ts.map +1 -0
  99. package/dist/lib/worker-api/get-worker-url.js +48 -0
  100. package/dist/lib/worker-api/process-on-worker.d.ts +20 -0
  101. package/dist/lib/worker-api/process-on-worker.d.ts.map +1 -0
  102. package/dist/lib/worker-api/process-on-worker.js +79 -0
  103. package/dist/lib/worker-api/validate-worker-version.d.ts +9 -0
  104. package/dist/lib/worker-api/validate-worker-version.d.ts.map +1 -0
  105. package/dist/lib/worker-api/validate-worker-version.js +35 -0
  106. package/dist/lib/worker-farm/worker-body.d.ts +16 -0
  107. package/dist/lib/worker-farm/worker-body.d.ts.map +1 -0
  108. package/dist/lib/worker-farm/worker-body.js +67 -0
  109. package/dist/lib/worker-farm/worker-farm.d.ts +55 -0
  110. package/dist/lib/worker-farm/worker-farm.d.ts.map +1 -0
  111. package/dist/lib/worker-farm/worker-farm.js +88 -0
  112. package/dist/lib/worker-farm/worker-job.d.ts +29 -0
  113. package/dist/lib/worker-farm/worker-job.d.ts.map +1 -0
  114. package/dist/lib/worker-farm/worker-job.js +47 -0
  115. package/dist/lib/worker-farm/worker-pool.d.ts +75 -0
  116. package/dist/lib/worker-farm/worker-pool.d.ts.map +1 -0
  117. package/dist/lib/worker-farm/worker-pool.js +151 -0
  118. package/dist/lib/worker-farm/worker-thread.d.ts +42 -0
  119. package/dist/lib/worker-farm/worker-thread.d.ts.map +1 -0
  120. package/dist/lib/worker-farm/worker-thread.js +95 -0
  121. package/dist/lib/worker-utils/get-loadable-worker-url.d.ts +14 -0
  122. package/dist/lib/worker-utils/get-loadable-worker-url.d.ts.map +1 -0
  123. package/dist/lib/worker-utils/get-loadable-worker-url.js +74 -0
  124. package/dist/lib/worker-utils/get-transfer-list.d.ts +10 -0
  125. package/dist/lib/worker-utils/get-transfer-list.d.ts.map +1 -0
  126. package/dist/lib/worker-utils/get-transfer-list.js +61 -0
  127. package/dist/lib/worker-utils/remove-nontransferable-options.d.ts +6 -0
  128. package/dist/lib/worker-utils/remove-nontransferable-options.d.ts.map +1 -0
  129. package/dist/lib/worker-utils/remove-nontransferable-options.js +35 -0
  130. package/dist/null-worker.js +189 -550
  131. package/dist/null-worker.js.map +7 -1
  132. package/dist/types.d.ts +56 -0
  133. package/dist/types.d.ts.map +1 -0
  134. package/dist/types.js +2 -0
  135. package/dist/workers/null-worker.d.ts +2 -0
  136. package/dist/workers/null-worker.d.ts.map +1 -0
  137. package/dist/workers/null-worker.js +7 -0
  138. package/package.json +8 -6
  139. package/src/lib/env-utils/version.ts +1 -1
  140. package/src/lib/library-utils/library-utils.ts +6 -4
  141. package/src/lib/node/{require-utils.node.js → require-utils.node.ts} +13 -9
  142. package/src/lib/process-utils/child-process-proxy.ts +1 -1
  143. package/src/lib/worker-api/create-worker.ts +11 -7
  144. package/src/lib/worker-api/process-on-worker.ts +1 -1
  145. package/src/lib/worker-farm/worker-body.ts +2 -2
  146. package/src/lib/worker-farm/worker-job.ts +2 -2
  147. package/src/lib/worker-farm/worker-thread.ts +2 -2
  148. package/src/lib/worker-utils/get-transfer-list.ts +1 -1
  149. package/src/lib/worker-utils/remove-nontransferable-options.ts +1 -1
  150. package/src/types.ts +1 -1
@@ -0,0 +1,79 @@
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;
21
+ }
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;
42
+ }
43
+ exports.processOnWorker = processOnWorker;
44
+ /**
45
+ * Job completes when we receive the result
46
+ * @param job
47
+ * @param message
48
+ */
49
+ async function onMessage(context, job, type, payload) {
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
+ }
79
+ }
@@ -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"}
@@ -0,0 +1,35 @@
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;
28
+ }
29
+ exports.validateWorkerVersion = validateWorkerVersion;
30
+ // @ts-ignore
31
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
32
+ function parseVersion(version) {
33
+ const parts = version.split('.').map(Number);
34
+ return { major: parts[0], minor: parts[1] };
35
+ }
@@ -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"}
@@ -0,0 +1,67 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const get_transfer_list_1 = require("../worker-utils/get-transfer-list");
4
+ const onMessageWrapperMap = new Map();
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
+ };
34
+ }
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);
43
+ }
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
+ }
57
+ }
58
+ }
59
+ exports.default = WorkerBody;
60
+ // Filter out noise messages sent to workers
61
+ function isKnownMessage(message) {
62
+ const { type, data } = message;
63
+ return (type === 'message' &&
64
+ data &&
65
+ typeof data.source === 'string' &&
66
+ data.source.startsWith('loaders.gl'));
67
+ }
@@ -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"}
@@ -0,0 +1,88 @@
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"));
8
+ const DEFAULT_PROPS = {
9
+ maxConcurrency: 3,
10
+ maxMobileConcurrency: 1,
11
+ onDebug: () => { },
12
+ reuseWorkers: true
13
+ };
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
+ }
55
+ }
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;
78
+ }
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
+ };
86
+ }
87
+ }
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"}
@@ -0,0 +1,47 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const assert_1 = require("../env-utils/assert");
4
+ /**
5
+ * Represents one Job handled by a WorkerPool or WorkerFarm
6
+ */
7
+ class WorkerJob {
8
+ constructor(jobName, workerThread) {
9
+ this.name = jobName;
10
+ this.workerThread = workerThread;
11
+ this.isRunning = true;
12
+ this._resolve = () => { };
13
+ this._reject = () => { };
14
+ this.result = new Promise((resolve, reject) => {
15
+ this._resolve = resolve;
16
+ this._reject = reject;
17
+ });
18
+ }
19
+ /**
20
+ * Send a message to the job's worker thread
21
+ * @param data any data structure, ideally consisting mostly of transferrable objects
22
+ */
23
+ postMessage(type, payload) {
24
+ this.workerThread.postMessage({
25
+ source: 'loaders.gl',
26
+ type,
27
+ payload
28
+ });
29
+ }
30
+ /**
31
+ * Call to resolve the `result` Promise with the supplied value
32
+ */
33
+ done(value) {
34
+ (0, assert_1.assert)(this.isRunning);
35
+ this.isRunning = false;
36
+ this._resolve(value);
37
+ }
38
+ /**
39
+ * Call to reject the `result` Promise with the supplied error
40
+ */
41
+ error(error) {
42
+ (0, assert_1.assert)(this.isRunning);
43
+ this.isRunning = false;
44
+ this._reject(error);
45
+ }
46
+ }
47
+ exports.default = WorkerJob;
@@ -0,0 +1,75 @@
1
+ import type { WorkerMessageType, WorkerMessagePayload } from '../../types';
2
+ import WorkerThread from './worker-thread';
3
+ import WorkerJob from './worker-job';
4
+ /** WorkerPool onDebug Callback Parameters */
5
+ declare type OnDebugParameters = {
6
+ message: string;
7
+ worker: string;
8
+ name: string;
9
+ job: string;
10
+ backlog: number;
11
+ workerThread: WorkerThread;
12
+ };
13
+ /** WorkerPool Properties */
14
+ export declare type WorkerPoolProps = {
15
+ name?: string;
16
+ source?: string;
17
+ url?: string;
18
+ maxConcurrency?: number;
19
+ maxMobileConcurrency?: number;
20
+ onDebug?: (options: OnDebugParameters) => any;
21
+ reuseWorkers?: boolean;
22
+ };
23
+ /** Private helper types */
24
+ declare type OnMessage = (job: WorkerJob, type: WorkerMessageType, payload: WorkerMessagePayload) => void;
25
+ declare type OnError = (job: WorkerJob, error: Error) => void;
26
+ /**
27
+ * Process multiple data messages with small pool of identical workers
28
+ */
29
+ export default class WorkerPool {
30
+ name: string;
31
+ source?: string;
32
+ url?: string;
33
+ maxConcurrency: number;
34
+ maxMobileConcurrency: number;
35
+ onDebug: (options: OnDebugParameters) => any;
36
+ reuseWorkers: boolean;
37
+ private props;
38
+ private jobQueue;
39
+ private idleQueue;
40
+ private count;
41
+ private isDestroyed;
42
+ /**
43
+ * @param processor - worker function
44
+ * @param maxConcurrency - max count of workers
45
+ */
46
+ constructor(props: WorkerPoolProps);
47
+ /**
48
+ * Terminates all workers in the pool
49
+ * @note Can free up significant memory
50
+ */
51
+ destroy(): void;
52
+ setProps(props: WorkerPoolProps): void;
53
+ startJob(name: string, onMessage?: OnMessage, onError?: OnError): Promise<WorkerJob>;
54
+ /**
55
+ * Starts first queued job if worker is available or can be created
56
+ * Called when job is started and whenever a worker returns to the idleQueue
57
+ */
58
+ _startQueuedJob(): Promise<void>;
59
+ /**
60
+ * Returns a worker to the idle queue
61
+ * Destroys the worker if
62
+ * - pool is destroyed
63
+ * - if this pool doesn't reuse workers
64
+ * - if maxConcurrency has been lowered
65
+ * @param worker
66
+ */
67
+ returnWorkerToQueue(worker: WorkerThread): void;
68
+ /**
69
+ * Returns idle worker or creates new worker if maxConcurrency has not been reached
70
+ */
71
+ _getAvailableWorker(): WorkerThread | null;
72
+ _getMaxConcurrency(): number;
73
+ }
74
+ export {};
75
+ //# sourceMappingURL=worker-pool.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"worker-pool.d.ts","sourceRoot":"","sources":["../../../src/lib/worker-farm/worker-pool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,iBAAiB,EAAE,oBAAoB,EAAC,MAAM,aAAa,CAAC;AAEzE,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAC3C,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,6CAA6C;AAC7C,aAAK,iBAAiB,GAAG;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,4BAA4B;AAC5B,oBAAY,eAAe,GAAG;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,GAAG,CAAC;IAC9C,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,2BAA2B;AAC3B,aAAK,SAAS,GAAG,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAC;AAClG,aAAK,OAAO,GAAG,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;AAStD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,IAAI,EAAE,MAAM,CAAa;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAK;IAC3B,oBAAoB,EAAE,MAAM,CAAK;IACjC,OAAO,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,GAAG,CAAY;IACxD,YAAY,EAAE,OAAO,CAAQ;IAE7B,OAAO,CAAC,KAAK,CAAuB;IACpC,OAAO,CAAC,QAAQ,CAAmB;IACnC,OAAO,CAAC,SAAS,CAAsB;IACvC,OAAO,CAAC,KAAK,CAAK;IAClB,OAAO,CAAC,WAAW,CAAS;IAE5B;;;OAGG;gBACS,KAAK,EAAE,eAAe;IAMlC;;;OAGG;IACH,OAAO,IAAI,IAAI;IAMf,QAAQ,CAAC,KAAK,EAAE,eAAe;IAoBzB,QAAQ,CACZ,IAAI,EAAE,MAAM,EACZ,SAAS,GAAE,SAA+C,EAC1D,OAAO,GAAE,OAA0C,GAClD,OAAO,CAAC,SAAS,CAAC;IAarB;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAyCtC;;;;;;;OAOG;IACH,mBAAmB,CAAC,MAAM,EAAE,YAAY;IAgBxC;;OAEG;IACH,mBAAmB,IAAI,YAAY,GAAG,IAAI;IAiB1C,kBAAkB;CAGnB"}