@metamask/snaps-execution-environments 6.8.0 → 6.9.1

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 (34) hide show
  1. package/CHANGELOG.md +17 -1
  2. package/dist/browserify/iframe/bundle.js +1 -1
  3. package/dist/browserify/node-process/bundle.js +1 -1
  4. package/dist/browserify/node-thread/bundle.js +1 -1
  5. package/dist/browserify/webview/index.html +1 -1
  6. package/dist/browserify/worker-executor/bundle.js +1 -1
  7. package/dist/browserify/worker-pool/bundle.js +1 -1
  8. package/dist/common/BaseSnapExecutor.cjs +58 -58
  9. package/dist/common/BaseSnapExecutor.cjs.map +1 -1
  10. package/dist/common/BaseSnapExecutor.mjs +58 -58
  11. package/dist/common/BaseSnapExecutor.mjs.map +1 -1
  12. package/dist/common/endowments/network.cjs +52 -39
  13. package/dist/common/endowments/network.cjs.map +1 -1
  14. package/dist/common/endowments/network.mjs +52 -39
  15. package/dist/common/endowments/network.mjs.map +1 -1
  16. package/dist/common/utils.cjs +0 -1
  17. package/dist/common/utils.cjs.map +1 -1
  18. package/dist/common/utils.d.cts.map +1 -1
  19. package/dist/common/utils.d.mts.map +1 -1
  20. package/dist/common/utils.mjs +0 -1
  21. package/dist/common/utils.mjs.map +1 -1
  22. package/dist/proxy/ProxySnapExecutor.cjs +69 -72
  23. package/dist/proxy/ProxySnapExecutor.cjs.map +1 -1
  24. package/dist/proxy/ProxySnapExecutor.mjs +68 -71
  25. package/dist/proxy/ProxySnapExecutor.mjs.map +1 -1
  26. package/dist/webview/WebViewExecutorStream.cjs +22 -9
  27. package/dist/webview/WebViewExecutorStream.cjs.map +1 -1
  28. package/dist/webview/WebViewExecutorStream.mjs +22 -9
  29. package/dist/webview/WebViewExecutorStream.mjs.map +1 -1
  30. package/dist/webworker/pool/WebWorkerPool.cjs +130 -133
  31. package/dist/webworker/pool/WebWorkerPool.cjs.map +1 -1
  32. package/dist/webworker/pool/WebWorkerPool.mjs +129 -132
  33. package/dist/webworker/pool/WebWorkerPool.mjs.map +1 -1
  34. package/package.json +3 -3
@@ -1,3 +1,15 @@
1
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
2
+ if (kind === "m") throw new TypeError("Private method is not writable");
3
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
4
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
5
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
6
+ };
7
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
8
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
9
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
10
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
11
+ };
12
+ var _WebWorkerPool_instances, _WebWorkerPool_poolSize, _WebWorkerPool_stream, _WebWorkerPool_url, _WebWorkerPool_workerSourceURL, _WebWorkerPool_onData, _WebWorkerPool_initializeJob, _WebWorkerPool_terminateJob, _WebWorkerPool_getWorker, _WebWorkerPool_updatePool, _WebWorkerPool_createWorker, _WebWorkerPool_getWorkerURL;
1
13
  import $metamaskpostmessagestream from "@metamask/post-message-stream";
2
14
  const { WebWorkerParentPostMessageStream, WindowPostMessageStream } = $metamaskpostmessagestream;
3
15
  import { logError } from "@metamask/snaps-utils";
@@ -12,12 +24,6 @@ import { nanoid } from "nanoid/non-secure";
12
24
  * executing the snap.
13
25
  */
14
26
  export class WebWorkerPool {
15
- #poolSize;
16
- #stream;
17
- #url;
18
- pool = [];
19
- jobs = new Map();
20
- #workerSourceURL;
21
27
  /* istanbul ignore next - Constructor arguments. */
22
28
  static initialize(stream = new WindowPostMessageStream({
23
29
  name: 'child',
@@ -28,141 +34,132 @@ export class WebWorkerPool {
28
34
  return new WebWorkerPool(stream, url, poolSize);
29
35
  }
30
36
  constructor(stream, url, poolSize = 3) {
31
- this.#stream = stream;
32
- this.#url = url;
33
- this.#poolSize = poolSize;
34
- this.#stream.on('data', this.#onData.bind(this));
37
+ _WebWorkerPool_instances.add(this);
38
+ _WebWorkerPool_poolSize.set(this, void 0);
39
+ _WebWorkerPool_stream.set(this, void 0);
40
+ _WebWorkerPool_url.set(this, void 0);
41
+ this.pool = [];
42
+ this.jobs = new Map();
43
+ _WebWorkerPool_workerSourceURL.set(this, void 0);
44
+ __classPrivateFieldSet(this, _WebWorkerPool_stream, stream, "f");
45
+ __classPrivateFieldSet(this, _WebWorkerPool_url, url, "f");
46
+ __classPrivateFieldSet(this, _WebWorkerPool_poolSize, poolSize, "f");
47
+ __classPrivateFieldGet(this, _WebWorkerPool_stream, "f").on('data', __classPrivateFieldGet(this, _WebWorkerPool_instances, "m", _WebWorkerPool_onData).bind(this));
35
48
  }
36
- /**
37
- * Handle an incoming message from the `WebWorkerExecutionService`. This
38
- * assumes that the message contains a `jobId` property, and a JSON-RPC
39
- * request in the `data` property.
40
- *
41
- * @param data - The message data.
42
- * @param data.data - The JSON-RPC request.
43
- * @param data.jobId - The job ID.
44
- */
45
- #onData(data) {
46
- const { jobId, data: request } = data;
47
- const job = this.jobs.get(jobId);
48
- if (!job) {
49
- // This ensures that a job is initialized before it is used. To avoid
50
- // code duplication, we call the `#onData` method again, which will
51
- // run the rest of the logic after initialization.
52
- this.#initializeJob(jobId)
53
- .then(() => {
54
- this.#onData(data);
55
- })
56
- .catch((error) => {
57
- logError('[Worker] Error initializing job:', error.toString());
58
- this.#stream.write({
59
- jobId,
49
+ }
50
+ _WebWorkerPool_poolSize = new WeakMap(), _WebWorkerPool_stream = new WeakMap(), _WebWorkerPool_url = new WeakMap(), _WebWorkerPool_workerSourceURL = new WeakMap(), _WebWorkerPool_instances = new WeakSet(), _WebWorkerPool_onData = function _WebWorkerPool_onData(data) {
51
+ const { jobId, data: request } = data;
52
+ const job = this.jobs.get(jobId);
53
+ if (!job) {
54
+ // This ensures that a job is initialized before it is used. To avoid
55
+ // code duplication, we call the `#onData` method again, which will
56
+ // run the rest of the logic after initialization.
57
+ __classPrivateFieldGet(this, _WebWorkerPool_instances, "m", _WebWorkerPool_initializeJob).call(this, jobId)
58
+ .then(() => {
59
+ __classPrivateFieldGet(this, _WebWorkerPool_instances, "m", _WebWorkerPool_onData).call(this, data);
60
+ })
61
+ .catch((error) => {
62
+ logError('[Worker] Error initializing job:', error.toString());
63
+ __classPrivateFieldGet(this, _WebWorkerPool_stream, "f").write({
64
+ jobId,
65
+ data: {
66
+ name: 'command',
60
67
  data: {
61
- name: 'command',
62
- data: {
63
- jsonrpc: '2.0',
64
- id: request.id ?? null,
65
- error: {
66
- code: -32000,
67
- message: 'Internal error',
68
- },
68
+ jsonrpc: '2.0',
69
+ id: request.id ?? null,
70
+ error: {
71
+ code: -32000,
72
+ message: 'Internal error',
69
73
  },
70
74
  },
71
- });
75
+ },
72
76
  });
73
- return;
74
- }
75
- // This is a method specific to the `WebWorkerPool`, as the service itself
76
- // does not have access to the workers directly.
77
- if (request.method === 'terminateJob') {
78
- this.#terminateJob(jobId);
79
- return;
80
- }
81
- job.stream.write(request);
82
- }
83
- /**
84
- * Create a new worker and set up a stream to communicate with it.
85
- *
86
- * @param jobId - The job ID.
87
- * @returns The job.
88
- */
89
- async #initializeJob(jobId) {
90
- const worker = await this.#getWorker();
91
- const jobStream = new WebWorkerParentPostMessageStream({
92
- worker,
93
- });
94
- // Write messages from the worker to the parent, wrapped with the job ID.
95
- jobStream.on('data', (data) => {
96
- this.#stream.write({ data, jobId });
97
77
  });
98
- const job = { id: jobId, worker, stream: jobStream };
99
- this.jobs.set(jobId, job);
100
- return job;
78
+ return;
101
79
  }
102
- /**
103
- * Terminate the job with the given ID. This will close the worker and delete
104
- * the job from the internal job map.
105
- *
106
- * @param jobId - The job ID.
107
- */
108
- #terminateJob(jobId) {
109
- const job = this.jobs.get(jobId);
110
- assert(job, `Job "${jobId}" not found.`);
111
- job.stream.destroy();
112
- job.worker.terminate();
113
- this.jobs.delete(jobId);
80
+ // This is a method specific to the `WebWorkerPool`, as the service itself
81
+ // does not have access to the workers directly.
82
+ if (request.method === 'terminateJob') {
83
+ __classPrivateFieldGet(this, _WebWorkerPool_instances, "m", _WebWorkerPool_terminateJob).call(this, jobId);
84
+ return;
114
85
  }
115
- /**
116
- * Get a worker from the pool. A new worker will be created automatically.
117
- *
118
- * @returns The worker.
119
- */
120
- async #getWorker() {
121
- // Lazily create the pool of workers.
122
- if (this.pool.length === 0) {
123
- await this.#updatePool();
124
- }
125
- const worker = this.pool.shift();
126
- assert(worker, 'Worker not found.');
127
- await this.#updatePool();
128
- return worker;
129
- }
130
- /**
131
- * Update the pool of workers. This will create new workers if the pool is
132
- * below the minimum size.
133
- */
134
- async #updatePool() {
135
- while (this.pool.length < this.#poolSize) {
136
- const worker = await this.#createWorker();
137
- this.pool.push(worker);
138
- }
86
+ job.stream.write(request);
87
+ }, _WebWorkerPool_initializeJob =
88
+ /**
89
+ * Create a new worker and set up a stream to communicate with it.
90
+ *
91
+ * @param jobId - The job ID.
92
+ * @returns The job.
93
+ */
94
+ async function _WebWorkerPool_initializeJob(jobId) {
95
+ const worker = await __classPrivateFieldGet(this, _WebWorkerPool_instances, "m", _WebWorkerPool_getWorker).call(this);
96
+ const jobStream = new WebWorkerParentPostMessageStream({
97
+ worker,
98
+ });
99
+ // Write messages from the worker to the parent, wrapped with the job ID.
100
+ jobStream.on('data', (data) => {
101
+ __classPrivateFieldGet(this, _WebWorkerPool_stream, "f").write({ data, jobId });
102
+ });
103
+ const job = { id: jobId, worker, stream: jobStream };
104
+ this.jobs.set(jobId, job);
105
+ return job;
106
+ }, _WebWorkerPool_terminateJob = function _WebWorkerPool_terminateJob(jobId) {
107
+ const job = this.jobs.get(jobId);
108
+ assert(job, `Job "${jobId}" not found.`);
109
+ job.stream.destroy();
110
+ job.worker.terminate();
111
+ this.jobs.delete(jobId);
112
+ }, _WebWorkerPool_getWorker =
113
+ /**
114
+ * Get a worker from the pool. A new worker will be created automatically.
115
+ *
116
+ * @returns The worker.
117
+ */
118
+ async function _WebWorkerPool_getWorker() {
119
+ // Lazily create the pool of workers.
120
+ if (this.pool.length === 0) {
121
+ await __classPrivateFieldGet(this, _WebWorkerPool_instances, "m", _WebWorkerPool_updatePool).call(this);
139
122
  }
140
- /**
141
- * Create a new worker. This will fetch the worker source if it has not
142
- * already been fetched.
143
- *
144
- * @returns The worker.
145
- */
146
- async #createWorker() {
147
- return new Worker(await this.#getWorkerURL(), {
148
- name: `worker-${nanoid()}`,
149
- });
123
+ const worker = this.pool.shift();
124
+ assert(worker, 'Worker not found.');
125
+ await __classPrivateFieldGet(this, _WebWorkerPool_instances, "m", _WebWorkerPool_updatePool).call(this);
126
+ return worker;
127
+ }, _WebWorkerPool_updatePool =
128
+ /**
129
+ * Update the pool of workers. This will create new workers if the pool is
130
+ * below the minimum size.
131
+ */
132
+ async function _WebWorkerPool_updatePool() {
133
+ while (this.pool.length < __classPrivateFieldGet(this, _WebWorkerPool_poolSize, "f")) {
134
+ const worker = await __classPrivateFieldGet(this, _WebWorkerPool_instances, "m", _WebWorkerPool_createWorker).call(this);
135
+ this.pool.push(worker);
150
136
  }
151
- /**
152
- * Get the URL of the worker source. This will fetch the worker source if it
153
- * has not already been fetched.
154
- *
155
- * @returns The worker source URL, as a `blob:` URL.
156
- */
157
- async #getWorkerURL() {
158
- if (this.#workerSourceURL) {
159
- return this.#workerSourceURL;
160
- }
161
- const blob = await fetch(this.#url)
162
- .then(async (response) => response.blob())
163
- .then(URL.createObjectURL.bind(URL));
164
- this.#workerSourceURL = blob;
165
- return blob;
137
+ }, _WebWorkerPool_createWorker =
138
+ /**
139
+ * Create a new worker. This will fetch the worker source if it has not
140
+ * already been fetched.
141
+ *
142
+ * @returns The worker.
143
+ */
144
+ async function _WebWorkerPool_createWorker() {
145
+ return new Worker(await __classPrivateFieldGet(this, _WebWorkerPool_instances, "m", _WebWorkerPool_getWorkerURL).call(this), {
146
+ name: `worker-${nanoid()}`,
147
+ });
148
+ }, _WebWorkerPool_getWorkerURL =
149
+ /**
150
+ * Get the URL of the worker source. This will fetch the worker source if it
151
+ * has not already been fetched.
152
+ *
153
+ * @returns The worker source URL, as a `blob:` URL.
154
+ */
155
+ async function _WebWorkerPool_getWorkerURL() {
156
+ if (__classPrivateFieldGet(this, _WebWorkerPool_workerSourceURL, "f")) {
157
+ return __classPrivateFieldGet(this, _WebWorkerPool_workerSourceURL, "f");
166
158
  }
167
- }
159
+ const blob = await fetch(__classPrivateFieldGet(this, _WebWorkerPool_url, "f"))
160
+ .then(async (response) => response.blob())
161
+ .then(URL.createObjectURL.bind(URL));
162
+ __classPrivateFieldSet(this, _WebWorkerPool_workerSourceURL, blob, "f");
163
+ return blob;
164
+ };
168
165
  //# sourceMappingURL=WebWorkerPool.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"WebWorkerPool.mjs","sourceRoot":"","sources":["../../../src/webworker/pool/WebWorkerPool.ts"],"names":[],"mappings":";;AAKA,OAAO,EAAE,QAAQ,EAAE,8BAA8B;AAEjD,OAAO,EAAE,MAAM,EAAE,wBAAwB;AACzC,OAAO,EAAE,MAAM,EAAE,0BAA0B;AAQ3C;;;;;;;GAOG;AACH,MAAM,OAAO,aAAa;IACf,SAAS,CAAC;IAEV,OAAO,CAAwB;IAE/B,IAAI,CAAS;IAEb,IAAI,GAAa,EAAE,CAAC;IAEpB,IAAI,GAA6B,IAAI,GAAG,EAAE,CAAC;IAEpD,gBAAgB,CAAU;IAE1B,mDAAmD;IACnD,MAAM,CAAC,UAAU,CACf,SAAgC,IAAI,uBAAuB,CAAC;QAC1D,IAAI,EAAE,OAAO;QACb,MAAM,EAAE,QAAQ;QAChB,YAAY,EAAE,IAAI,CAAC,MAAM;QACzB,YAAY,EAAE,GAAG;KAClB,CAAC,EACF,GAAG,GAAG,uBAAuB,EAC7B,QAAiB;QAEjB,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,YAAY,MAA6B,EAAE,GAAW,EAAE,QAAQ,GAAG,CAAC;QAClE,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE1B,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,IAA6C;QACnD,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAEtC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,qEAAqE;YACrE,mEAAmE;YACnE,kDAAkD;YAClD,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC;iBACvB,IAAI,CAAC,GAAG,EAAE;gBACT,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACrB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,QAAQ,CAAC,kCAAkC,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAE/D,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;oBACjB,KAAK;oBACL,IAAI,EAAE;wBACJ,IAAI,EAAE,SAAS;wBACf,IAAI,EAAE;4BACJ,OAAO,EAAE,KAAK;4BACd,EAAE,EAAE,OAAO,CAAC,EAAE,IAAI,IAAI;4BACtB,KAAK,EAAE;gCACL,IAAI,EAAE,CAAC,KAAK;gCACZ,OAAO,EAAE,gBAAgB;6BAC1B;yBACF;qBACF;iBACF,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEL,OAAO;QACT,CAAC;QAED,0EAA0E;QAC1E,gDAAgD;QAChD,IAAI,OAAO,CAAC,MAAM,KAAK,cAAc,EAAE,CAAC;YACtC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC1B,OAAO;QACT,CAAC;QAED,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,KAAa;QAChC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACvC,MAAM,SAAS,GAAG,IAAI,gCAAgC,CAAC;YACrD,MAAM;SACP,CAAC,CAAC;QAEH,yEAAyE;QACzE,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YAC5B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,MAAM,GAAG,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;QACrD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC1B,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,KAAa;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,CAAC,GAAG,EAAE,QAAQ,KAAK,cAAc,CAAC,CAAC;QAEzC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACrB,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;QAEvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU;QACd,qCAAqC;QACrC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAC3B,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QACjC,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAEpC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAEzB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC1C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa;QACjB,OAAO,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,aAAa,EAAE,EAAE;YAC5C,IAAI,EAAE,UAAU,MAAM,EAAE,EAAE;SAC3B,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa;QACjB,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,gBAAgB,CAAC;QAC/B,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;aAChC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;aACzC,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAEvC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;CACF","sourcesContent":["import type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport {\n WebWorkerParentPostMessageStream,\n WindowPostMessageStream,\n} from '@metamask/post-message-stream';\nimport { logError } from '@metamask/snaps-utils';\nimport type { JsonRpcRequest } from '@metamask/utils';\nimport { assert } from '@metamask/utils';\nimport { nanoid } from 'nanoid/non-secure';\n\ntype ExecutorJob = {\n id: string;\n worker: Worker;\n stream: WebWorkerParentPostMessageStream;\n};\n\n/**\n * A snap executor using the WebWorker API.\n *\n * This is not a traditional snap executor, as it does not execute snaps itself.\n * Instead, it creates a pool of webworkers for each snap execution, and sends\n * the snap execution request to the webworker. The webworker is responsible for\n * executing the snap.\n */\nexport class WebWorkerPool {\n readonly #poolSize;\n\n readonly #stream: BasePostMessageStream;\n\n readonly #url: string;\n\n readonly pool: Worker[] = [];\n\n readonly jobs: Map<string, ExecutorJob> = new Map();\n\n #workerSourceURL?: string;\n\n /* istanbul ignore next - Constructor arguments. */\n static initialize(\n stream: BasePostMessageStream = new WindowPostMessageStream({\n name: 'child',\n target: 'parent',\n targetWindow: self.parent,\n targetOrigin: '*',\n }),\n url = '../executor/bundle.js',\n poolSize?: number,\n ) {\n return new WebWorkerPool(stream, url, poolSize);\n }\n\n constructor(stream: BasePostMessageStream, url: string, poolSize = 3) {\n this.#stream = stream;\n this.#url = url;\n this.#poolSize = poolSize;\n\n this.#stream.on('data', this.#onData.bind(this));\n }\n\n /**\n * Handle an incoming message from the `WebWorkerExecutionService`. This\n * assumes that the message contains a `jobId` property, and a JSON-RPC\n * request in the `data` property.\n *\n * @param data - The message data.\n * @param data.data - The JSON-RPC request.\n * @param data.jobId - The job ID.\n */\n #onData(data: { data: JsonRpcRequest; jobId: string }) {\n const { jobId, data: request } = data;\n\n const job = this.jobs.get(jobId);\n if (!job) {\n // This ensures that a job is initialized before it is used. To avoid\n // code duplication, we call the `#onData` method again, which will\n // run the rest of the logic after initialization.\n this.#initializeJob(jobId)\n .then(() => {\n this.#onData(data);\n })\n .catch((error) => {\n logError('[Worker] Error initializing job:', error.toString());\n\n this.#stream.write({\n jobId,\n data: {\n name: 'command',\n data: {\n jsonrpc: '2.0',\n id: request.id ?? null,\n error: {\n code: -32000,\n message: 'Internal error',\n },\n },\n },\n });\n });\n\n return;\n }\n\n // This is a method specific to the `WebWorkerPool`, as the service itself\n // does not have access to the workers directly.\n if (request.method === 'terminateJob') {\n this.#terminateJob(jobId);\n return;\n }\n\n job.stream.write(request);\n }\n\n /**\n * Create a new worker and set up a stream to communicate with it.\n *\n * @param jobId - The job ID.\n * @returns The job.\n */\n async #initializeJob(jobId: string): Promise<ExecutorJob> {\n const worker = await this.#getWorker();\n const jobStream = new WebWorkerParentPostMessageStream({\n worker,\n });\n\n // Write messages from the worker to the parent, wrapped with the job ID.\n jobStream.on('data', (data) => {\n this.#stream.write({ data, jobId });\n });\n\n const job = { id: jobId, worker, stream: jobStream };\n this.jobs.set(jobId, job);\n return job;\n }\n\n /**\n * Terminate the job with the given ID. This will close the worker and delete\n * the job from the internal job map.\n *\n * @param jobId - The job ID.\n */\n #terminateJob(jobId: string) {\n const job = this.jobs.get(jobId);\n assert(job, `Job \"${jobId}\" not found.`);\n\n job.stream.destroy();\n job.worker.terminate();\n\n this.jobs.delete(jobId);\n }\n\n /**\n * Get a worker from the pool. A new worker will be created automatically.\n *\n * @returns The worker.\n */\n async #getWorker() {\n // Lazily create the pool of workers.\n if (this.pool.length === 0) {\n await this.#updatePool();\n }\n\n const worker = this.pool.shift();\n assert(worker, 'Worker not found.');\n\n await this.#updatePool();\n\n return worker;\n }\n\n /**\n * Update the pool of workers. This will create new workers if the pool is\n * below the minimum size.\n */\n async #updatePool() {\n while (this.pool.length < this.#poolSize) {\n const worker = await this.#createWorker();\n this.pool.push(worker);\n }\n }\n\n /**\n * Create a new worker. This will fetch the worker source if it has not\n * already been fetched.\n *\n * @returns The worker.\n */\n async #createWorker() {\n return new Worker(await this.#getWorkerURL(), {\n name: `worker-${nanoid()}`,\n });\n }\n\n /**\n * Get the URL of the worker source. This will fetch the worker source if it\n * has not already been fetched.\n *\n * @returns The worker source URL, as a `blob:` URL.\n */\n async #getWorkerURL() {\n if (this.#workerSourceURL) {\n return this.#workerSourceURL;\n }\n\n const blob = await fetch(this.#url)\n .then(async (response) => response.blob())\n .then(URL.createObjectURL.bind(URL));\n\n this.#workerSourceURL = blob;\n return blob;\n }\n}\n"]}
1
+ {"version":3,"file":"WebWorkerPool.mjs","sourceRoot":"","sources":["../../../src/webworker/pool/WebWorkerPool.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAKA,OAAO,EAAE,QAAQ,EAAE,8BAA8B;AAEjD,OAAO,EAAE,MAAM,EAAE,wBAAwB;AACzC,OAAO,EAAE,MAAM,EAAE,0BAA0B;AAQ3C;;;;;;;GAOG;AACH,MAAM,OAAO,aAAa;IAaxB,mDAAmD;IACnD,MAAM,CAAC,UAAU,CACf,SAAgC,IAAI,uBAAuB,CAAC;QAC1D,IAAI,EAAE,OAAO;QACb,MAAM,EAAE,QAAQ;QAChB,YAAY,EAAE,IAAI,CAAC,MAAM;QACzB,YAAY,EAAE,GAAG;KAClB,CAAC,EACF,GAAG,GAAG,uBAAuB,EAC7B,QAAiB;QAEjB,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,YAAY,MAA6B,EAAE,GAAW,EAAE,QAAQ,GAAG,CAAC;;QA1B3D,0CAAU;QAEV,wCAA+B;QAE/B,qCAAa;QAEb,SAAI,GAAa,EAAE,CAAC;QAEpB,SAAI,GAA6B,IAAI,GAAG,EAAE,CAAC;QAEpD,iDAA0B;QAiBxB,uBAAA,IAAI,yBAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,sBAAQ,GAAG,MAAA,CAAC;QAChB,uBAAA,IAAI,2BAAa,QAAQ,MAAA,CAAC;QAE1B,uBAAA,IAAI,6BAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,uBAAA,IAAI,uDAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,CAAC;CAyJF;qQA9IS,IAA6C;IACnD,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAEtC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACjC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,qEAAqE;QACrE,mEAAmE;QACnE,kDAAkD;QAClD,uBAAA,IAAI,8DAAe,MAAnB,IAAI,EAAgB,KAAK,CAAC;aACvB,IAAI,CAAC,GAAG,EAAE;YACT,uBAAA,IAAI,uDAAQ,MAAZ,IAAI,EAAS,IAAI,CAAC,CAAC;QACrB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,QAAQ,CAAC,kCAAkC,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE/D,uBAAA,IAAI,6BAAQ,CAAC,KAAK,CAAC;gBACjB,KAAK;gBACL,IAAI,EAAE;oBACJ,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE;wBACJ,OAAO,EAAE,KAAK;wBACd,EAAE,EAAE,OAAO,CAAC,EAAE,IAAI,IAAI;wBACtB,KAAK,EAAE;4BACL,IAAI,EAAE,CAAC,KAAK;4BACZ,OAAO,EAAE,gBAAgB;yBAC1B;qBACF;iBACF;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEL,OAAO;IACT,CAAC;IAED,0EAA0E;IAC1E,gDAAgD;IAChD,IAAI,OAAO,CAAC,MAAM,KAAK,cAAc,EAAE,CAAC;QACtC,uBAAA,IAAI,6DAAc,MAAlB,IAAI,EAAe,KAAK,CAAC,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;GAKG;AACH,KAAK,uCAAgB,KAAa;IAChC,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,0DAAW,MAAf,IAAI,CAAa,CAAC;IACvC,MAAM,SAAS,GAAG,IAAI,gCAAgC,CAAC;QACrD,MAAM;KACP,CAAC,CAAC;IAEH,yEAAyE;IACzE,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;QAC5B,uBAAA,IAAI,6BAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IACrD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC1B,OAAO,GAAG,CAAC;AACb,CAAC,qEAQa,KAAa;IACzB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,CAAC,GAAG,EAAE,QAAQ,KAAK,cAAc,CAAC,CAAC;IAEzC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IACrB,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;IAEvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC;AAED;;;;GAIG;AACH,KAAK;IACH,qCAAqC;IACrC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,uBAAA,IAAI,2DAAY,MAAhB,IAAI,CAAc,CAAC;IAC3B,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;IACjC,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAEpC,MAAM,uBAAA,IAAI,2DAAY,MAAhB,IAAI,CAAc,CAAC;IAEzB,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,KAAK;IACH,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,uBAAA,IAAI,+BAAU,EAAE,CAAC;QACzC,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,6DAAc,MAAlB,IAAI,CAAgB,CAAC;QAC1C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,KAAK;IACH,OAAO,IAAI,MAAM,CAAC,MAAM,uBAAA,IAAI,6DAAc,MAAlB,IAAI,CAAgB,EAAE;QAC5C,IAAI,EAAE,UAAU,MAAM,EAAE,EAAE;KAC3B,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,KAAK;IACH,IAAI,uBAAA,IAAI,sCAAiB,EAAE,CAAC;QAC1B,OAAO,uBAAA,IAAI,sCAAiB,CAAC;IAC/B,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,uBAAA,IAAI,0BAAK,CAAC;SAChC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;SACzC,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAEvC,uBAAA,IAAI,kCAAoB,IAAI,MAAA,CAAC;IAC7B,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["import type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport {\n WebWorkerParentPostMessageStream,\n WindowPostMessageStream,\n} from '@metamask/post-message-stream';\nimport { logError } from '@metamask/snaps-utils';\nimport type { JsonRpcRequest } from '@metamask/utils';\nimport { assert } from '@metamask/utils';\nimport { nanoid } from 'nanoid/non-secure';\n\ntype ExecutorJob = {\n id: string;\n worker: Worker;\n stream: WebWorkerParentPostMessageStream;\n};\n\n/**\n * A snap executor using the WebWorker API.\n *\n * This is not a traditional snap executor, as it does not execute snaps itself.\n * Instead, it creates a pool of webworkers for each snap execution, and sends\n * the snap execution request to the webworker. The webworker is responsible for\n * executing the snap.\n */\nexport class WebWorkerPool {\n readonly #poolSize;\n\n readonly #stream: BasePostMessageStream;\n\n readonly #url: string;\n\n readonly pool: Worker[] = [];\n\n readonly jobs: Map<string, ExecutorJob> = new Map();\n\n #workerSourceURL?: string;\n\n /* istanbul ignore next - Constructor arguments. */\n static initialize(\n stream: BasePostMessageStream = new WindowPostMessageStream({\n name: 'child',\n target: 'parent',\n targetWindow: self.parent,\n targetOrigin: '*',\n }),\n url = '../executor/bundle.js',\n poolSize?: number,\n ) {\n return new WebWorkerPool(stream, url, poolSize);\n }\n\n constructor(stream: BasePostMessageStream, url: string, poolSize = 3) {\n this.#stream = stream;\n this.#url = url;\n this.#poolSize = poolSize;\n\n this.#stream.on('data', this.#onData.bind(this));\n }\n\n /**\n * Handle an incoming message from the `WebWorkerExecutionService`. This\n * assumes that the message contains a `jobId` property, and a JSON-RPC\n * request in the `data` property.\n *\n * @param data - The message data.\n * @param data.data - The JSON-RPC request.\n * @param data.jobId - The job ID.\n */\n #onData(data: { data: JsonRpcRequest; jobId: string }) {\n const { jobId, data: request } = data;\n\n const job = this.jobs.get(jobId);\n if (!job) {\n // This ensures that a job is initialized before it is used. To avoid\n // code duplication, we call the `#onData` method again, which will\n // run the rest of the logic after initialization.\n this.#initializeJob(jobId)\n .then(() => {\n this.#onData(data);\n })\n .catch((error) => {\n logError('[Worker] Error initializing job:', error.toString());\n\n this.#stream.write({\n jobId,\n data: {\n name: 'command',\n data: {\n jsonrpc: '2.0',\n id: request.id ?? null,\n error: {\n code: -32000,\n message: 'Internal error',\n },\n },\n },\n });\n });\n\n return;\n }\n\n // This is a method specific to the `WebWorkerPool`, as the service itself\n // does not have access to the workers directly.\n if (request.method === 'terminateJob') {\n this.#terminateJob(jobId);\n return;\n }\n\n job.stream.write(request);\n }\n\n /**\n * Create a new worker and set up a stream to communicate with it.\n *\n * @param jobId - The job ID.\n * @returns The job.\n */\n async #initializeJob(jobId: string): Promise<ExecutorJob> {\n const worker = await this.#getWorker();\n const jobStream = new WebWorkerParentPostMessageStream({\n worker,\n });\n\n // Write messages from the worker to the parent, wrapped with the job ID.\n jobStream.on('data', (data) => {\n this.#stream.write({ data, jobId });\n });\n\n const job = { id: jobId, worker, stream: jobStream };\n this.jobs.set(jobId, job);\n return job;\n }\n\n /**\n * Terminate the job with the given ID. This will close the worker and delete\n * the job from the internal job map.\n *\n * @param jobId - The job ID.\n */\n #terminateJob(jobId: string) {\n const job = this.jobs.get(jobId);\n assert(job, `Job \"${jobId}\" not found.`);\n\n job.stream.destroy();\n job.worker.terminate();\n\n this.jobs.delete(jobId);\n }\n\n /**\n * Get a worker from the pool. A new worker will be created automatically.\n *\n * @returns The worker.\n */\n async #getWorker() {\n // Lazily create the pool of workers.\n if (this.pool.length === 0) {\n await this.#updatePool();\n }\n\n const worker = this.pool.shift();\n assert(worker, 'Worker not found.');\n\n await this.#updatePool();\n\n return worker;\n }\n\n /**\n * Update the pool of workers. This will create new workers if the pool is\n * below the minimum size.\n */\n async #updatePool() {\n while (this.pool.length < this.#poolSize) {\n const worker = await this.#createWorker();\n this.pool.push(worker);\n }\n }\n\n /**\n * Create a new worker. This will fetch the worker source if it has not\n * already been fetched.\n *\n * @returns The worker.\n */\n async #createWorker() {\n return new Worker(await this.#getWorkerURL(), {\n name: `worker-${nanoid()}`,\n });\n }\n\n /**\n * Get the URL of the worker source. This will fetch the worker source if it\n * has not already been fetched.\n *\n * @returns The worker source URL, as a `blob:` URL.\n */\n async #getWorkerURL() {\n if (this.#workerSourceURL) {\n return this.#workerSourceURL;\n }\n\n const blob = await fetch(this.#url)\n .then(async (response) => response.blob())\n .then(URL.createObjectURL.bind(URL));\n\n this.#workerSourceURL = blob;\n return blob;\n }\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@metamask/snaps-execution-environments",
3
- "version": "6.8.0",
3
+ "version": "6.9.1",
4
4
  "description": "Snap sandbox environments for executing SES javascript",
5
5
  "keywords": [
6
6
  "MetaMask",
@@ -69,8 +69,8 @@
69
69
  "@metamask/post-message-stream": "^8.1.1",
70
70
  "@metamask/providers": "^17.1.2",
71
71
  "@metamask/rpc-errors": "^6.3.1",
72
- "@metamask/snaps-sdk": "^6.6.0",
73
- "@metamask/snaps-utils": "^8.2.0",
72
+ "@metamask/snaps-sdk": "^6.8.0",
73
+ "@metamask/snaps-utils": "^8.4.0",
74
74
  "@metamask/superstruct": "^3.1.0",
75
75
  "@metamask/utils": "^9.2.1",
76
76
  "nanoid": "^3.1.31",