Skip to content

chore(rivetkit): add runner sse ping interval #3362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

chore(rivetkit): add runner sse ping interval #3362

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions rivetkit-typescript/packages/rivetkit/src/drivers/engine/actor-driver.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ import {
import { KEYS } from "./kv";
import { logger } from "./log";

const RUNNER_SSE_PING_INTERVAL = 1000;

interface ActorHandler {
actor?: AnyActorInstance;
actorStartPromise?: ReturnType<typeof promiseWithResolvers<void>>;
Expand All @@ -75,6 +77,7 @@ export class EngineActorDriver implements ActorDriver {

#runnerStarted: PromiseWithResolvers<undefined> = promiseWithResolvers();
#runnerStopped: PromiseWithResolvers<undefined> = promiseWithResolvers();
#isRunnerStopped: boolean = false;

// WebSocket message acknowledgment debouncing
#wsAckQueue: Map<
Expand Down Expand Up @@ -150,6 +153,7 @@ export class EngineActorDriver implements ActorDriver {
},
onShutdown: () => {
this.#runnerStopped.resolve(undefined);
this.#isRunnerStopped = true;
},
fetch: this.#runnerFetch.bind(this),
websocket: this.#runnerWebSocket.bind(this),
Expand Down Expand Up @@ -652,6 +656,29 @@ export class EngineActorDriver implements ActorDriver {
invariant(payload, "runnerId not set");
await stream.writeSSE({ data: payload });

// Send ping every second to keep the connection alive
while (true) {
if (this.#isRunnerStopped) {
logger().debug({
msg: "runner is stopped",
});
break;
}

if (stream.closed || stream.aborted) {
logger().debug({
msg: "runner sse stream closed",
closed: stream.closed,
aborted: stream.aborted,
});
break;
}

await stream.writeSSE({ event: "ping", data: "" });
await stream.sleep(RUNNER_SSE_PING_INTERVAL);
}

// Wait for the runner to stop if the SSE stream aborted early for any reason
await this.#runnerStopped.promise;
});
}
Expand Down
Loading