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 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 | 31x 31x 31x 31x 31x 31x 31x 18x 18x 4x 18x 31x 31x 1x 1x 1x 4x 3x 3x 1x 2x 2x 1x 1x 6x 6x 6x 6x 8x 1x 1x 1x 1x 2x 2x 1x 1x 2x 1x 2x 23x 25x 20x 20x 20x 1x 1x 19x 4x 15x 1x 19x 5x 5x 5x 5x 5x 3x 2x 3x | import { RpcClient, RpcService } from '@metamask/kernel-rpc-methods';
import type { JsonRpcMessage } from '@metamask/kernel-utils';
import { isJsonRpcMessage, stringify } from '@metamask/kernel-utils';
import { Logger } from '@metamask/logger';
import type {
PlatformServices,
RemoteMessageHandler,
VatId,
VatConfig,
RemoteCommsOptions,
OnIncarnationChange,
} from '@metamask/ocap-kernel';
import {
platformServicesMethodSpecs,
kernelRemoteHandlers,
} from '@metamask/ocap-kernel/rpc';
import { serializeError } from '@metamask/rpc-errors';
import type { DuplexStream } from '@metamask/streams';
import {
MessagePortDuplexStream,
PostMessageDuplexStream,
} from '@metamask/streams/browser';
import type {
PostMessageEnvelope,
PostMessageTarget,
} from '@metamask/streams/browser';
import { isJsonRpcResponse, isJsonRpcRequest } from '@metamask/utils';
import type { JsonRpcId } from '@metamask/utils';
// Appears in the docs.
// eslint-disable-next-line @typescript-eslint/no-unused-vars
import type { PlatformServicesServer } from './PlatformServicesServer.ts';
export type PlatformServicesClientStream = PostMessageDuplexStream<
MessageEvent<JsonRpcMessage>,
PostMessageEnvelope<JsonRpcMessage>
>;
/**
* The client end of the platform services, intended to be constructed in
* the kernel worker. Sends launch and terminate worker requests to the
* server and wraps the launch response in a DuplexStream for consumption
* by the kernel, and provides network connectivity.
*
* @see {@link PlatformServicesServer} for the other end of the service.
*
* @param stream - The stream to use for communication with the server.
* @param logger - An optional {@link Logger}. Defaults to a new logger labeled '[platform services client]'.
* @returns A new {@link PlatformServicesClient}.
*/
export class PlatformServicesClient implements PlatformServices {
readonly #logger: Logger;
readonly #stream: PlatformServicesClientStream;
readonly #rpcClient: RpcClient<typeof platformServicesMethodSpecs>;
readonly #rpcServer: RpcService<typeof kernelRemoteHandlers>;
readonly #portMap: Map<JsonRpcId, MessagePort | undefined>;
#remoteMessageHandler: RemoteMessageHandler | undefined = undefined;
#remoteGiveUpHandler: ((peerId: string) => void) | undefined = undefined;
#remoteIncarnationChangeHandler: OnIncarnationChange | undefined = undefined;
/**
* **ATTN:** Prefer {@link PlatformServicesClient.make} over constructing
* this class directly.
*
* The client end of the platform services, intended to be constructed in
* the kernel worker. Sends launch and terminate worker requests to the
* server and wraps the launch response in a DuplexStream for consumption
* by the kernel, and provides network connectivity.
*
* @see {@link PlatformServicesServer} for the other end of the service.
*
* @param stream - The stream to use for communication with the server.
* @param logger - An optional {@link Logger}. Defaults to a new logger labeled '[platform services client]'.
*/
constructor(stream: PlatformServicesClientStream, logger?: Logger) {
this.#stream = stream;
this.#portMap = new Map();
this.#logger = logger ?? new Logger('platform-services-client');
this.#rpcClient = new RpcClient(
platformServicesMethodSpecs,
async (request) => {
Eif ('id' in request) {
if (request.method === 'launch') {
this.#portMap.set(request.id, undefined);
}
}
await this.#sendMessage(request);
},
'm',
this.#logger,
);
this.#rpcServer = new RpcService(kernelRemoteHandlers, {
remoteDeliver: this.#remoteDeliver.bind(this),
remoteGiveUp: this.#remoteGiveUp.bind(this),
remoteIncarnationChange: this.#remoteIncarnationChange.bind(this),
});
// Start draining messages immediately after construction
// This runs for the lifetime of the client
this.#stream
.drain(this.#handleMessage.bind(this))
.catch((error: unknown) => {
this.#logger.error('Error draining stream:', error);
});
}
/**
* Create and initialize a new {@link PlatformServicesClient}.
* The client will be ready to handle vat launches after this completes.
*
* @param messageTarget - The target to use for posting and receiving messages.
* @param logger - An optional {@link Logger}.
* @returns A new {@link PlatformServicesClient}.
*/
static async make(
messageTarget: PostMessageTarget,
logger?: Logger,
): Promise<PlatformServicesClient> {
const stream: PlatformServicesClientStream = new PostMessageDuplexStream({
messageTarget,
messageEventMode: 'event',
validateInput: (
message: unknown,
): message is MessageEvent<JsonRpcMessage> =>
message instanceof MessageEvent && isJsonRpcMessage(message.data),
});
// Synchronize the stream before creating the client
await stream.synchronize();
// Now create the client which will start draining immediately
return new PlatformServicesClient(stream, logger);
}
/**
* Launch a new worker with a specific vat id.
*
* @param vatId - The vat id of the worker to launch.
* @param vatConfig - The configuration for the worker.
* @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,
vatConfig: VatConfig,
): Promise<DuplexStream<JsonRpcMessage, JsonRpcMessage>> {
const [id] = await this.#rpcClient.callAndGetId('launch', {
vatId,
vatConfig,
});
const port = this.#portMap.get(id);
if (!port) {
throw new Error(
`No port found for launch of: ${stringify({ vatId, vatConfig })}`,
);
}
this.#portMap.delete(id);
return await MessagePortDuplexStream.make<JsonRpcMessage, JsonRpcMessage>(
port,
isJsonRpcMessage,
);
}
/**
* 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<void> {
await this.#rpcClient.call('terminate', { vatId });
}
/**
* 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> {
await this.#rpcClient.call('terminateAll', []);
}
/**
* 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 - Unique identifier for this kernel instance.
* @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> {
this.#remoteMessageHandler = remoteMessageHandler;
this.#remoteGiveUpHandler = onRemoteGiveUp;
this.#remoteIncarnationChangeHandler = onIncarnationChange;
await this.#rpcClient.call('initializeRemoteComms', {
keySeed,
...Object.fromEntries(
Object.entries(options).filter(([, value]) => value !== undefined),
),
...(incarnationId !== undefined && { incarnationId }),
});
}
/**
* 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> {
await this.#rpcClient.call('stopRemoteComms', []);
}
/**
* 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> {
await this.#rpcClient.call('sendRemoteMessage', { to, message });
}
/**
* 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> {
await this.#rpcClient.call('closeConnection', { peerId });
}
/**
* Take note of where a peer might be.
*
* @param peerId - The peer ID to whom this information applies.
* @param hints - An array of location hint strings.
*/
async registerLocationHints(peerId: string, hints: string[]): Promise<void> {
await this.#rpcClient.call('registerLocationHints', { 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> {
await this.#rpcClient.call('reconnectPeer', { peerId, hints });
}
/**
* 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 #remoteDeliver(from: string, message: string): Promise<string | null> {
if (this.#remoteMessageHandler) {
return await this.#remoteMessageHandler(from, message);
}
throw Error(`remote message handler not set`);
}
/**
* Handle a remote give up notification from the server.
*
* @param peerId - The peer ID of the remote we're giving up on.
* @returns A promise that resolves when handling is complete.
*/
async #remoteGiveUp(peerId: string): Promise<null> {
if (this.#remoteGiveUpHandler) {
this.#remoteGiveUpHandler(peerId);
}
return null;
}
/**
* Handle a remote incarnation change notification from the server.
*
* @param peerId - The peer ID of the remote that restarted.
* @returns A promise that resolves when handling is complete.
*/
async #remoteIncarnationChange(peerId: string): Promise<null> {
if (this.#remoteIncarnationChangeHandler) {
this.#remoteIncarnationChangeHandler(peerId);
}
return null;
}
/**
* Send a message to the server.
*
* @param payload - The message to send.
* @returns A promise that resolves when the message has been sent.
*/
async #sendMessage(payload: JsonRpcMessage): Promise<void> {
await this.#stream.write({
payload,
transfer: [],
});
}
/**
* Handle a message from the server.
*
* @param event - The message event.
* @returns A promise that resolves when the message has been sent.
*/
async #handleMessage(event: MessageEvent<JsonRpcMessage>): Promise<void> {
if (isJsonRpcResponse(event.data)) {
const { id } = event.data;
const port = event.ports.at(0);
if (typeof id !== 'string') {
this.#logger.error(
'Received response with unexpected id:',
stringify(event.data),
);
return;
}
if (this.#portMap.has(id)) {
this.#portMap.set(id, port);
} else if (port !== undefined) {
this.#logger.error(
'Received message with unexpected port:',
stringify(event.data),
);
}
this.#rpcClient.handleResponse(id, event.data);
E} else if (isJsonRpcRequest(event.data)) {
const { id, method, params } = event.data;
try {
this.#rpcServer.assertHasMethod(method);
const result = await this.#rpcServer.execute(method, params);
await this.#sendMessage({
id,
result,
jsonrpc: '2.0',
});
} catch (error) {
await this.#sendMessage({
id,
error: serializeError(error),
jsonrpc: '2.0',
});
}
}
}
}
harden(PlatformServicesClient);
|