Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 | 20x 98x 98x 98x 98x 98x 98x 98x 98x 98x 133x 1x 132x 132x 132x 132x 1x 1x 1x 132x 1x 1x 132x 130x 130x 130x 130x 129x 129x 129x 129x 1x 1x 1x 1x 132x 23x 23x 23x 23x 22x 22x 22x 22x 5x 5x 9x 9x 4x 2x 2x 18x 1x 17x 17x 17x 17x 17x 17x 17x 9x 5x 4x 4x 4x 4x 4x 4x 4x 2x 2x 2x 1x 1x 5x 2x 3x 20x | import { makePromiseKit } from '@endo/promise-kit';
import { isJsonRpcMessage } from '@metamask/kernel-utils';
import type { JsonRpcMessage } from '@metamask/kernel-utils';
import { Logger } from '@metamask/logger';
import type {
PlatformServices,
VatId,
RemoteMessageHandler,
SendRemoteMessage,
StopRemoteComms,
RemoteCommsOptions,
OnIncarnationChange,
} from '@metamask/ocap-kernel';
import { initTransport } from '@metamask/ocap-kernel';
import { NodeWorkerDuplexStream } from '@metamask/streams';
import type { DuplexStream } from '@metamask/streams';
import { strict as assert } from 'node:assert';
import { Worker as NodeWorker } from 'node:worker_threads';
// Worker file loads from the built dist directory, requires rebuild after change
// Note: Worker runs in same process and may be subject to spectre-style attacks
const DEFAULT_WORKER_FILE = new URL(
'../../dist/vat/vat-worker.mjs',
import.meta.url,
).pathname;
/**
* Node.js implementation of platform services for launching, managing, and
* terminating vat workers, as well as handling network communications.
*/
export class NodejsPlatformServices implements PlatformServices {
readonly #logger: Logger;
#sendRemoteMessageFunc: SendRemoteMessage | null = null;
#stopRemoteCommsFunc: StopRemoteComms | null = null;
#closeConnectionFunc: ((peerId: string) => Promise<void>) | null = null;
#registerLocationHintsFunc:
| ((peerId: string, hints: string[]) => void)
| null = null;
#reconnectPeerFunc:
| ((peerId: string, hints?: string[]) => Promise<void>)
| null = null;
#remoteMessageHandler: RemoteMessageHandler | undefined = undefined;
readonly #workerFilePath: string;
workers = new Map<
VatId,
{ worker: NodeWorker; stream: DuplexStream<JsonRpcMessage, JsonRpcMessage> }
>();
/**
* The vat worker service, intended to be constructed in
* the kernel worker.
*
* @param args - A bag of optional arguments.
* @param args.workerFilePath - An optional path to a file defining the worker's routine. Defaults to 'vat-worker.mjs'.
* @param args.logger - An optional {@link Logger}. Defaults to a new logger labeled '[vat worker client]'.
*/
constructor(args: {
workerFilePath?: string | undefined;
logger?: Logger | undefined;
}) {
this.#workerFilePath = args.workerFilePath ?? DEFAULT_WORKER_FILE;
this.#logger = args.logger ?? new Logger('vat-worker-service');
}
/**
* Launch a new worker with a specific vat id.
*
* @param vatId - The vat id of the worker to launch.
* @returns A promise for a duplex stream connected to the worker
* which rejects if a worker with the given vat id already exists.
*/
async launch(
vatId: VatId,
): Promise<DuplexStream<JsonRpcMessage, JsonRpcMessage>> {
// Check if worker already exists
if (this.workers.has(vatId)) {
throw new Error(
`Worker ${vatId} already exists! Cannot launch duplicate.`,
);
}
this.#logger.debug('launching vat', vatId);
const { promise, resolve, reject } =
makePromiseKit<DuplexStream<JsonRpcMessage, JsonRpcMessage>>();
const worker = new NodeWorker(this.#workerFilePath, {
env: {
NODE_VAT_ID: vatId,
},
});
// Handle worker errors before 'online' event
worker.once('error', (error) => {
worker.removeAllListeners();
// eslint-disable-next-line promise/no-promise-in-callback
worker.terminate().catch(() => {
// Ignore termination errors
});
reject(
new Error(`Worker ${vatId} errored during startup: ${error.message}`),
);
});
// Handle worker exit before 'online' event
worker.once('exit', (code) => {
worker.removeAllListeners();
reject(
new Error(`Worker ${vatId} exited during startup with code ${code}`),
);
});
worker.once('online', () => {
// Remove error and exit listeners now that worker is online
worker.removeAllListeners('error');
worker.removeAllListeners('exit');
const stream = new NodeWorkerDuplexStream<JsonRpcMessage, JsonRpcMessage>(
worker,
isJsonRpcMessage,
);
stream
.synchronize()
.then(() => {
// Only add worker to map after successful synchronization
this.workers.set(vatId, { worker, stream });
resolve(stream);
this.#logger.debug('connected to kernel');
return undefined;
})
.catch(async (error) => {
// Clean up worker if synchronization fails
worker.removeAllListeners();
try {
await worker.terminate();
} catch (terminateError) {
this.#logger.error(
`Error terminating worker ${vatId} after sync failure`,
terminateError,
);
}
reject(error);
});
});
return promise;
}
/**
* Terminate a worker identified by its vat id.
*
* @param vatId - The vat id of the worker to terminate.
* @returns A promise that resolves when the worker has terminated
* or rejects if that worker does not exist.
*/
async terminate(vatId: VatId): Promise<undefined> {
const workerEntry = this.workers.get(vatId);
assert(workerEntry, `No worker found for vatId ${vatId}`);
const { worker, stream } = workerEntry;
await stream.return();
worker.removeAllListeners();
await worker.terminate();
this.workers.delete(vatId);
return undefined;
}
/**
* Terminate all workers managed by the service.
*
* @returns A promise that resolves after all workers have terminated
* or rejects if there was an error during termination.
*/
async terminateAll(): Promise<void> {
const vatIds = Array.from(this.workers.keys());
for (const vatId of vatIds) {
try {
await this.terminate(vatId);
} catch (error) {
this.#logger.error('Error terminating worker', vatId, error);
}
}
}
/**
* Send a remote message to a peer.
*
* @param to - The peer ID to send the message to.
* @param message - The serialized message string to send.
* @returns A promise that resolves when the message has been sent.
*/
async sendRemoteMessage(to: string, message: string): Promise<void> {
if (!this.#sendRemoteMessageFunc) {
throw Error('remote comms not initialized');
}
await this.#sendRemoteMessageFunc(to, message);
}
/**
* Handle a remote message from a peer.
*
* @param from - The peer ID that sent the message.
* @param message - The message received.
* @returns A promise that resolves with the reply message, or null if no reply is needed.
*/
async #handleRemoteMessage(
from: string,
message: string,
): Promise<string | null> {
if (!this.#remoteMessageHandler) {
// This can't actually happen, but TypeScript can't infer it
throw Error('remote comms not initialized');
}
// Return the reply - network layer handles sending it with proper seq/ack
return this.#remoteMessageHandler(from, message);
}
/**
* Initialize network communications.
*
* @param keySeed - The seed for generating this kernel's secret key.
* @param options - Options for remote communications initialization.
* @param options.relays - Array of the peerIDs of relay nodes that can be used to listen for incoming
* connections from other kernels.
* @param options.maxRetryAttempts - Maximum number of reconnection attempts. 0 = infinite (default).
* @param options.maxQueue - Maximum number of messages to queue per peer while reconnecting (default: 200).
* @param remoteMessageHandler - A handler function to receive remote messages.
* @param onRemoteGiveUp - Optional callback to be called when we give up on a remote.
* @param incarnationId - This kernel's incarnation ID for handshake protocol.
* @param onIncarnationChange - Optional callback when a remote peer's incarnation changes.
* @returns A promise that resolves once network access has been established
* or rejects if there is some problem doing so.
*/
async initializeRemoteComms(
keySeed: string,
options: RemoteCommsOptions,
remoteMessageHandler: (
from: string,
message: string,
) => Promise<string | null>,
onRemoteGiveUp?: (peerId: string) => void,
incarnationId?: string,
onIncarnationChange?: OnIncarnationChange,
): Promise<void> {
if (this.#sendRemoteMessageFunc) {
throw Error('remote comms already initialized');
}
this.#remoteMessageHandler = remoteMessageHandler;
const {
sendRemoteMessage,
stop,
closeConnection,
registerLocationHints,
reconnectPeer,
} = await initTransport(
keySeed,
options,
this.#handleRemoteMessage.bind(this),
onRemoteGiveUp,
incarnationId,
onIncarnationChange,
);
this.#sendRemoteMessageFunc = sendRemoteMessage;
this.#stopRemoteCommsFunc = stop;
this.#closeConnectionFunc = closeConnection;
this.#registerLocationHintsFunc = registerLocationHints;
this.#reconnectPeerFunc = reconnectPeer;
}
/**
* Stop network communications.
*
* @returns A promise that resolves when network access has been stopped
* or rejects if there is some problem doing so.
*/
async stopRemoteComms(): Promise<void> {
if (!this.#stopRemoteCommsFunc) {
return;
}
await this.#stopRemoteCommsFunc();
this.#sendRemoteMessageFunc = null;
this.#stopRemoteCommsFunc = null;
this.#closeConnectionFunc = null;
this.#registerLocationHintsFunc = null;
this.#reconnectPeerFunc = null;
}
/**
* Explicitly close a connection to a peer.
* Marks the peer as intentionally closed to prevent automatic reconnection.
*
* @param peerId - The peer ID to close the connection for.
* @returns A promise that resolves when the connection is closed.
*/
async closeConnection(peerId: string): Promise<void> {
if (!this.#closeConnectionFunc) {
throw Error('remote comms not initialized');
}
await this.#closeConnectionFunc(peerId);
}
/**
* Take note of where a peer might be.
*
* @param peerId - The peer ID to which this information applies.
* @param hints - Location hints for the peer.
*/
async registerLocationHints(peerId: string, hints: string[]): Promise<void> {
if (!this.#registerLocationHintsFunc) {
throw Error('remote comms not initialized');
}
this.#registerLocationHintsFunc(peerId, hints);
}
/**
* Manually reconnect to a peer after intentional close.
* Clears the intentional close flag and initiates reconnection.
*
* @param peerId - The peer ID to reconnect to.
* @param hints - Optional hints for reconnection.
* @returns A promise that resolves when reconnection is initiated.
*/
async reconnectPeer(peerId: string, hints: string[] = []): Promise<void> {
if (!this.#reconnectPeerFunc) {
throw Error('remote comms not initialized');
}
await this.#reconnectPeerFunc(peerId, hints);
}
}
harden(NodejsPlatformServices);
|