mirror of
https://github.com/getpaseo/paseo.git
synced 2026-11-02 22:52:58 +00:00
Mohamed Boudra
c689b5626e
Plugins can declare a subscription with defineSubscription, handle it with
server.handle(contract, (input, { push, signal })), and listen from a surface
with useSubscription or client.subscribe. A top-level Uint8Array in an event,
an RPC output, or an RPC input crosses the wire as a binary frame (opcodes
0x20-0x2f) without JSON or base64; a nested one fails validation on the sender.
Each subscriber runs its own handler, owned by the session that subscribed,
so release, disconnect, plugin stop and reload need no plugin code. The
runtime buffers pushes until the subscribe response has gone out, so a client
never sees an event for a subscription it does not know yet.
Gated on server_info.features.pluginSubscriptions; binary outputs reach only
clients that advertise plugin_binary_payloads.
53 lines
1.9 KiB
TypeScript
53 lines
1.9 KiB
TypeScript
import type { DaemonClient } from "@getpaseo/client/internal/daemon-client";
|
|
import type { PluginSubscribe } from "@getpaseo/plugin/client/host";
|
|
|
|
/**
|
|
* Plugin subscriptions on the installation's client. The client re-subscribes after a reconnect;
|
|
* the installation's lifetime releases whatever its surfaces left open.
|
|
*/
|
|
export function createPluginSubscribe(input: {
|
|
client: Pick<DaemonClient, "observePluginRpc">;
|
|
pluginId: string;
|
|
lifetime: AbortSignal;
|
|
}): PluginSubscribe {
|
|
const { client, pluginId, lifetime } = input;
|
|
return (method, subscriptionInput, observer) => {
|
|
const controller = new AbortController();
|
|
const abort = () => controller.abort();
|
|
lifetime.addEventListener("abort", abort, { once: true });
|
|
controller.signal.addEventListener(
|
|
"abort",
|
|
() => lifetime.removeEventListener("abort", abort),
|
|
{ once: true },
|
|
);
|
|
if (lifetime.aborted) controller.abort();
|
|
const subscription = client.observePluginRpc(pluginId, method, subscriptionInput, {
|
|
signal: controller.signal,
|
|
});
|
|
subscription.subscribe({
|
|
snapshot: () => undefined,
|
|
update: (message) => {
|
|
if (message.type === "plugin.rpc.event") observer.event(message.payload.event);
|
|
else if (message.type === "plugin.rpc.closed") {
|
|
controller.abort();
|
|
const error = message.payload.error;
|
|
observer.closed(error === undefined ? undefined : new Error(error));
|
|
}
|
|
},
|
|
binary: (payload) => observer.event(payload),
|
|
error: (error) => {
|
|
controller.abort();
|
|
observer.closed(error instanceof Error ? error : new Error(String(error)));
|
|
},
|
|
});
|
|
const release = () => {
|
|
controller.abort();
|
|
return subscription.release();
|
|
};
|
|
return Object.assign(() => void release().catch(() => undefined), {
|
|
ready: subscription.ready.then(() => undefined),
|
|
release,
|
|
});
|
|
};
|
|
}
|