Skip to content

chore(rivetkit): add debug logging around sleep condition #3336

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 debug logging around sleep condition #3336

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
36 changes: 23 additions & 13 deletions rivetkit-typescript/packages/rivetkit/src/actor/instance.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,14 @@ export type ExtractActorConnState<A extends AnyActorInstance> =
? ConnState
: never;

enum CanSleep {
Yes,
NotReady,
ActiveConns,
ActiveHonoHttpRequests,
ActiveRawWebSockets,
}

export class ActorInstance<S, CP, CS, V, I, DB extends AnyDatabaseProvider> {
// Shared actor context for this instance
actorContext: ActorContext<S, CP, CS, V, I, DB>;
Expand Down Expand Up @@ -1913,7 +1921,7 @@ export class ActorInstance<S, CP, CS, V, I, DB extends AnyDatabaseProvider> {

this.#rLog.debug({
msg: "resetting sleep timer",
canSleep,
canSleep: CanSleep[canSleep],
existingTimeout: !!this.#sleepTimeout,
timeout: this.#config.options.sleepTimeout,
});
Expand All @@ -1926,34 +1934,36 @@ export class ActorInstance<S, CP, CS, V, I, DB extends AnyDatabaseProvider> {
// Don't set a new timer if already sleeping
if (this.#sleepCalled) return;

if (canSleep) {
if (canSleep === CanSleep.Yes) {
this.#sleepTimeout = setTimeout(() => {
this._startSleep();
}, this.#config.options.sleepTimeout);
}
}

/** If this actor can be put in a sleeping state. */
#canSleep(): boolean {
if (!this.#ready) return false;
#canSleep(): CanSleep {
if (!this.#ready) return CanSleep.NotReady;

// Do not sleep if Hono HTTP requests are in-flight
if (this.#activeHonoHttpRequests > 0)
return CanSleep.ActiveHonoHttpRequests;

// TODO: When WS hibernation is ready, update this to only count non-hibernatable websockets
// Do not sleep if there are raw websockets open
if (this.#activeRawWebSockets.size > 0)
return CanSleep.ActiveRawWebSockets;

// Check for active conns. This will also cover active actions, since all actions have a connection.
for (const conn of this.#connections.values()) {
// TODO: Enable this when hibernation is implemented. We're waiting on support for Guard to not auto-wake the actor if it sleeps.
// if (conn.status === "connected" && !conn.isHibernatable)
// return false;

if (conn.status === "connected") return false;
if (conn.status === "connected") return CanSleep.ActiveConns;
}

// Do not sleep if Hono HTTP requests are in-flight
if (this.#activeHonoHttpRequests > 0) return false;

// TODO: When WS hibernation is ready, update this to only count non-hibernatable websockets
// Do not sleep if there are raw websockets open
if (this.#activeRawWebSockets.size > 0) return false;

return true;
return CanSleep.Yes;
}

/**
Expand Down
Loading