mirror of
https://github.com/stablyai/orca.git
synced 2026-11-01 01:27:35 +00:00
* chore: audit preload root comments and track repository coverage * docs: track repository comment audit coverage * chore: keep comment audit tracker local * chore: shorten preload API contract comments --------- Co-authored-by: OrcaWin <293788423+OrcaWin@users.noreply.github.com>
163 lines
5.7 KiB
TypeScript
163 lines
5.7 KiB
TypeScript
import type { RuntimeRpcResponse } from '../shared/runtime-rpc-envelope'
|
|
|
|
type RuntimeEnvironmentSubscribeArgs = {
|
|
subscriptionId?: string
|
|
selector: string
|
|
method: string
|
|
params?: unknown
|
|
timeoutMs?: number
|
|
expectedEnvironmentPairingRevision?: number
|
|
expectedEnvironmentRuntimeId?: string
|
|
}
|
|
|
|
type RuntimeEnvironmentSubscriptionCallbacks = {
|
|
onResponse: (response: RuntimeRpcResponse<unknown>) => void
|
|
onBinary?: (bytes: Uint8Array<ArrayBufferLike>) => void
|
|
onError?: (error: { code: string; message: string }) => void
|
|
onClose?: () => void
|
|
}
|
|
|
|
export type RuntimeEnvironmentSubscriptionHandle = {
|
|
unsubscribe: () => void
|
|
sendBinary: (bytes: Uint8Array<ArrayBufferLike>) => void
|
|
}
|
|
|
|
type RuntimeEnvironmentSubscriptionEvent =
|
|
| { subscriptionId: string; type: 'response'; response: RuntimeRpcResponse<unknown> }
|
|
| { subscriptionId: string; type: 'binary'; bytes: Uint8Array<ArrayBufferLike> }
|
|
| { subscriptionId: string; type: 'error'; code: string; message: string }
|
|
| { subscriptionId: string; type: 'close' }
|
|
|
|
type RuntimeEnvironmentSubscriptionIpc = {
|
|
invoke: (channel: string, args: unknown) => Promise<unknown>
|
|
send: (channel: string, args: unknown) => void
|
|
on: (
|
|
channel: string,
|
|
listener: (event: unknown, payload: RuntimeEnvironmentSubscriptionEvent) => void
|
|
) => void
|
|
removeListener: (
|
|
channel: string,
|
|
listener: (event: unknown, payload: RuntimeEnvironmentSubscriptionEvent) => void
|
|
) => void
|
|
}
|
|
|
|
const SUBSCRIPTION_EVENT_CHANNEL = 'runtimeEnvironments:subscriptionEvent'
|
|
|
|
// Share one IPC listener so reconnects cannot accumulate listeners retaining renderer state.
|
|
type RuntimeEnvironmentSubscriptionDispatcher = {
|
|
callbacks: Map<string, RuntimeEnvironmentSubscriptionCallbacks>
|
|
listener: (event: unknown, payload: RuntimeEnvironmentSubscriptionEvent) => void
|
|
}
|
|
|
|
const subscriptionDispatchers = new WeakMap<
|
|
RuntimeEnvironmentSubscriptionIpc,
|
|
RuntimeEnvironmentSubscriptionDispatcher
|
|
>()
|
|
|
|
function releaseIdleDispatcher(
|
|
ipc: RuntimeEnvironmentSubscriptionIpc,
|
|
callbacks: Map<string, RuntimeEnvironmentSubscriptionCallbacks>,
|
|
listener: RuntimeEnvironmentSubscriptionDispatcher['listener']
|
|
): void {
|
|
if (callbacks.size > 0) {
|
|
return
|
|
}
|
|
ipc.removeListener(SUBSCRIPTION_EVENT_CHANNEL, listener)
|
|
subscriptionDispatchers.delete(ipc)
|
|
}
|
|
|
|
function releaseSubscription(
|
|
ipc: RuntimeEnvironmentSubscriptionIpc,
|
|
dispatcher: RuntimeEnvironmentSubscriptionDispatcher,
|
|
subscriptionId: string
|
|
): void {
|
|
if (!dispatcher.callbacks.delete(subscriptionId)) {
|
|
return
|
|
}
|
|
releaseIdleDispatcher(ipc, dispatcher.callbacks, dispatcher.listener)
|
|
}
|
|
|
|
function getOrCreateDispatcher(
|
|
ipc: RuntimeEnvironmentSubscriptionIpc
|
|
): RuntimeEnvironmentSubscriptionDispatcher {
|
|
const existing = subscriptionDispatchers.get(ipc)
|
|
if (existing) {
|
|
return existing
|
|
}
|
|
const callbacks = new Map<string, RuntimeEnvironmentSubscriptionCallbacks>()
|
|
const listener = (_event: unknown, event: RuntimeEnvironmentSubscriptionEvent): void => {
|
|
const subscriptionCallbacks = callbacks.get(event.subscriptionId)
|
|
if (!subscriptionCallbacks) {
|
|
return
|
|
}
|
|
if (event.type === 'response') {
|
|
subscriptionCallbacks.onResponse(event.response)
|
|
} else if (event.type === 'binary') {
|
|
subscriptionCallbacks.onBinary?.(event.bytes)
|
|
} else if (event.type === 'error') {
|
|
// Shared-control subscriptions survive errors and reconnects.
|
|
subscriptionCallbacks.onError?.({ code: event.code, message: event.message })
|
|
} else {
|
|
// Release first so a throwing or reentrant callback cannot retain renderer state.
|
|
callbacks.delete(event.subscriptionId)
|
|
releaseIdleDispatcher(ipc, callbacks, listener)
|
|
subscriptionCallbacks.onClose?.()
|
|
}
|
|
}
|
|
const dispatcher: RuntimeEnvironmentSubscriptionDispatcher = { callbacks, listener }
|
|
subscriptionDispatchers.set(ipc, dispatcher)
|
|
ipc.on(SUBSCRIPTION_EVENT_CHANNEL, listener)
|
|
return dispatcher
|
|
}
|
|
|
|
function createRuntimeEnvironmentSubscriptionId(): string {
|
|
const randomUuid = globalThis.crypto?.randomUUID
|
|
if (typeof randomUuid === 'function') {
|
|
return randomUuid.call(globalThis.crypto)
|
|
}
|
|
return `sub-${Date.now()}-${Math.random().toString(36).slice(2)}`
|
|
}
|
|
|
|
export async function subscribeRuntimeEnvironmentFromPreload(
|
|
ipc: RuntimeEnvironmentSubscriptionIpc,
|
|
args: RuntimeEnvironmentSubscribeArgs,
|
|
callbacks: RuntimeEnvironmentSubscriptionCallbacks,
|
|
createSubscriptionId = createRuntimeEnvironmentSubscriptionId
|
|
): Promise<RuntimeEnvironmentSubscriptionHandle> {
|
|
const subscriptionId = args.subscriptionId ?? createSubscriptionId()
|
|
// Route before invoking: streaming RPCs can emit frames before the subscribe reply.
|
|
const dispatcher = getOrCreateDispatcher(ipc)
|
|
if (dispatcher.callbacks.has(subscriptionId)) {
|
|
throw new Error('Runtime environment subscription id already exists')
|
|
}
|
|
dispatcher.callbacks.set(subscriptionId, callbacks)
|
|
const releaseCurrentSubscription = (): void => {
|
|
if (dispatcher.callbacks.get(subscriptionId) === callbacks) {
|
|
releaseSubscription(ipc, dispatcher, subscriptionId)
|
|
}
|
|
}
|
|
try {
|
|
const result = (await ipc.invoke('runtimeEnvironments:subscribe', {
|
|
...args,
|
|
subscriptionId
|
|
})) as { subscriptionId: string; requestId: string }
|
|
if (result.subscriptionId !== subscriptionId) {
|
|
releaseCurrentSubscription()
|
|
throw new Error('Runtime environment subscription id mismatch')
|
|
}
|
|
} catch (error) {
|
|
releaseCurrentSubscription()
|
|
throw error
|
|
}
|
|
|
|
return {
|
|
unsubscribe: () => {
|
|
releaseCurrentSubscription()
|
|
void ipc.invoke('runtimeEnvironments:unsubscribe', { subscriptionId })
|
|
},
|
|
sendBinary: (bytes) => {
|
|
ipc.send('runtimeEnvironments:subscriptionBinary', { subscriptionId, bytes })
|
|
}
|
|
}
|
|
}
|