chore(rivetkit): rename onstart/onstop to onwake/onsleep

NathanFlurry · NathanFlurry · commit c298cf640147 · 2025-11-08T21:09:50.000-08:00
diff --git a/examples/crdt/src/backend/registry.ts b/examples/crdt/src/backend/registry.ts
diff --git a/examples/game/src/backend/registry.ts b/examples/game/src/backend/registry.ts
diff --git a/examples/kitchen-sink/SPEC.md b/examples/kitchen-sink/SPEC.md
diff --git a/examples/kitchen-sink/src/backend/actors/demo.ts b/examples/kitchen-sink/src/backend/actors/demo.ts
diff --git a/rivetkit-typescript/packages/rivetkit/fixtures/driver-test-suite/lifecycle.ts b/rivetkit-typescript/packages/rivetkit/fixtures/driver-test-suite/lifecycle.ts
@@ -10,8 +10,8 @@ export const counterWithLifecycle = actor({
 	createConnState: (c, opts, params: ConnParams) => ({
 		joinTime: Date.now(),
 	}),
-	onStart: (c) => {
-		c.state.events.push("onStart");
+	onWake: (c) => {
+		c.state.events.push("onWake");
 	},
 	onBeforeConnect: (c, opts, params: ConnParams) => {
 		if (params?.trackLifecycle) c.state.events.push("onBeforeConnect");
diff --git a/rivetkit-typescript/packages/rivetkit/fixtures/driver-test-suite/metadata.ts b/rivetkit-typescript/packages/rivetkit/fixtures/driver-test-suite/metadata.ts
@@ -11,7 +11,7 @@ export const metadataActor = actor({
 		storedTags: {} as Record<string, string>,
 		storedRegion: null as string | null,
 	},
-	onStart: (c) => {
+	onWake: (c) => {
 		// Store the actor name during initialization
 		c.state.actorName = c.name;
 	},
@@ -62,7 +62,7 @@ export const metadataActor = actor({
 			return c.state.storedRegion;
 		},
 
-		// Get the stored actor name (from onStart)
+		// Get the stored actor name (from onWake)
 		getStoredActorName: (c) => {
 			return c.state.actorName;
 		},
diff --git a/rivetkit-typescript/packages/rivetkit/fixtures/driver-test-suite/sleep.ts b/rivetkit-typescript/packages/rivetkit/fixtures/driver-test-suite/sleep.ts
@@ -5,10 +5,10 @@ export const SLEEP_TIMEOUT = 1000;
 
 export const sleep = actor({
 	state: { startCount: 0, sleepCount: 0 },
-	onStart: (c) => {
+	onWake: (c) => {
 		c.state.startCount += 1;
 	},
-	onStop: (c) => {
+	onSleep: (c) => {
 		c.state.sleepCount += 1;
 	},
 	actions: {
@@ -37,10 +37,10 @@ export const sleepWithLongRpc = actor({
 	state: { startCount: 0, sleepCount: 0 },
 	createVars: () =>
 		({}) as { longRunningResolve: PromiseWithResolvers<void> },
-	onStart: (c) => {
+	onWake: (c) => {
 		c.state.startCount += 1;
 	},
-	onStop: (c) => {
+	onSleep: (c) => {
 		c.state.sleepCount += 1;
 	},
 	actions: {
@@ -66,10 +66,10 @@ export const sleepWithLongRpc = actor({
 
 export const sleepWithRawHttp = actor({
 	state: { startCount: 0, sleepCount: 0, requestCount: 0 },
-	onStart: (c) => {
+	onWake: (c) => {
 		c.state.startCount += 1;
 	},
-	onStop: (c) => {
+	onSleep: (c) => {
 		c.state.sleepCount += 1;
 	},
 	onFetch: async (c, request) => {
@@ -106,10 +106,10 @@ export const sleepWithRawHttp = actor({
 
 export const sleepWithRawWebSocket = actor({
 	state: { startCount: 0, sleepCount: 0, connectionCount: 0 },
-	onStart: (c) => {
+	onWake: (c) => {
 		c.state.startCount += 1;
 	},
-	onStop: (c) => {
+	onSleep: (c) => {
 		c.state.sleepCount += 1;
 	},
 	onWebSocket: (c, websocket: UniversalWebSocket, opts) => {
@@ -175,10 +175,10 @@ export const sleepWithRawWebSocket = actor({
 
 export const sleepWithNoSleepOption = actor({
 	state: { startCount: 0, sleepCount: 0 },
-	onStart: (c) => {
+	onWake: (c) => {
 		c.state.startCount += 1;
 	},
-	onStop: (c) => {
+	onSleep: (c) => {
 		c.state.sleepCount += 1;
 	},
 	actions: {
diff --git a/rivetkit-typescript/packages/rivetkit/src/actor/config.ts b/rivetkit-typescript/packages/rivetkit/src/actor/config.ts
@@ -38,8 +38,8 @@ export interface ActorTypes<
 export const ActorConfigSchema = z
 	.object({
 		onCreate: z.function().optional(),
-		onStart: z.function().optional(),
-		onStop: z.function().optional(),
+		onWake: z.function().optional(),
+		onSleep: z.function().optional(),
 		onStateChange: z.function().optional(),
 		onBeforeConnect: z.function().optional(),
 		onConnect: z.function().optional(),
@@ -255,7 +255,7 @@ interface BaseActorConfig<
 	 *
 	 * @returns Void or a Promise that resolves when startup is complete
 	 */
-	onStart?: (
+	onWake?: (
 		c: ActorContext<
 			TState,
 			TConnParams,
@@ -276,7 +276,7 @@ interface BaseActorConfig<
 	 *
 	 * @returns Void or a Promise that resolves when shutdown is complete
 	 */
-	onStop?: (
+	onSleep?: (
 		c: ActorContext<
 			TState,
 			TConnParams,
@@ -471,7 +471,7 @@ export type ActorConfig<
 	z.infer<typeof ActorConfigSchema>,
 	| "actions"
 	| "onCreate"
-	| "onStart"
+	| "onWake"
 	| "onStateChange"
 	| "onBeforeConnect"
 	| "onConnect"
@@ -530,8 +530,8 @@ export type ActorConfigInput<
 	z.input<typeof ActorConfigSchema>,
 	| "actions"
 	| "onCreate"
-	| "onStart"
-	| "onStop"
+	| "onWake"
+	| "onSleep"
 	| "onStateChange"
 	| "onBeforeConnect"
 	| "onConnect"
diff --git a/rivetkit-typescript/packages/rivetkit/src/actor/instance/mod.ts b/rivetkit-typescript/packages/rivetkit/src/actor/instance/mod.ts
@@ -864,19 +864,19 @@ export class ActorInstance<S, CP, CS, V, I, DB extends AnyDatabaseProvider> {
 
 	async #callOnStart() {
 		this.#rLog.info({ msg: "actor starting" });
-		if (this.#config.onStart) {
-			const result = this.#config.onStart(this.actorContext);
+		if (this.#config.onWake) {
+			const result = this.#config.onWake(this.actorContext);
 			if (result instanceof Promise) {
 				await result;
 			}
 		}
 	}
 
 	async #callOnStop() {
-		if (this.#config.onStop) {
+		if (this.#config.onSleep) {
 			try {
 				this.#rLog.debug({ msg: "calling onStop" });
-				const result = this.#config.onStop(this.actorContext);
+				const result = this.#config.onSleep(this.actorContext);
 				if (result instanceof Promise) {
 					await deadline(result, this.#config.options.onStopTimeout);
 				}
diff --git a/rivetkit-typescript/packages/rivetkit/src/driver-test-suite/tests/actor-conn.ts b/rivetkit-typescript/packages/rivetkit/src/driver-test-suite/tests/actor-conn.ts
@@ -261,7 +261,7 @@ export function runActorConnTests(driverTestConfig: DriverTestConfig) {
 				// Verify lifecycle events were triggered
 				const events = await connection.getEvents();
 				expect(events).toEqual([
-					"onStart",
+					"onWake",
 					"onBeforeConnect",
 					"onConnect",
 				]);
@@ -279,18 +279,18 @@ export function runActorConnTests(driverTestConfig: DriverTestConfig) {
 						expect(finalEvents).toBeOneOf([
 							// Still active
 							[
-								"onStart",
+								"onWake",
 								"onBeforeConnect",
 								"onConnect",
 								"onDisconnect",
 							],
 							// Went to sleep and woke back up
 							[
-								"onStart",
+								"onWake",
 								"onBeforeConnect",
 								"onConnect",
 								"onDisconnect",
-								"onStart",
+								"onWake",
 							],
 						]);
 					},
diff --git a/rivetkit-typescript/packages/rivetkit/src/driver-test-suite/tests/actor-handle.ts b/rivetkit-typescript/packages/rivetkit/src/driver-test-suite/tests/actor-handle.ts
@@ -183,25 +183,25 @@ export function runActorHandleTests(driverTestConfig: DriverTestConfig) {
 			test("should trigger lifecycle hooks on actor creation", async (c) => {
 				const { client } = await setupDriverTest(c, driverTestConfig);
 
-				// Get or create a new actor - this should trigger onStart
+				// Get or create a new actor - this should trigger onWake
 				const handle = client.counterWithLifecycle.getOrCreate([
 					"test-lifecycle-handle",
 				]);
 
-				// Verify onStart was triggered
+				// Verify onWake was triggered
 				const initialEvents = await handle.getEvents();
-				expect(initialEvents).toContain("onStart");
+				expect(initialEvents).toContain("onWake");
 
 				// Create a separate handle to the same actor
 				const sameHandle = client.counterWithLifecycle.getOrCreate([
 					"test-lifecycle-handle",
 				]);
 
-				// Verify events still include onStart but don't duplicate it
-				// (onStart should only be called once when the actor is first created)
+				// Verify events still include onWake but don't duplicate it
+				// (onWake should only be called once when the actor is first created)
 				const events = await sameHandle.getEvents();
-				expect(events).toContain("onStart");
-				expect(events.filter((e) => e === "onStart").length).toBe(1);
+				expect(events).toContain("onWake");
+				expect(events.filter((e) => e === "onWake").length).toBe(1);
 			});
 
 			test("should trigger lifecycle hooks for each Action call", async (c) => {
@@ -212,9 +212,9 @@ export function runActorHandleTests(driverTestConfig: DriverTestConfig) {
 					"test-lifecycle-action",
 				]);
 
-				// Initial state should only have onStart
+				// Initial state should only have onWake
 				const initialEvents = await viewHandle.getEvents();
-				expect(initialEvents).toContain("onStart");
+				expect(initialEvents).toContain("onWake");
 				expect(initialEvents).not.toContain("onBeforeConnect");
 				expect(initialEvents).not.toContain("onConnect");
 				expect(initialEvents).not.toContain("onDisconnect");
@@ -297,8 +297,8 @@ export function runActorHandleTests(driverTestConfig: DriverTestConfig) {
 				// Check lifecycle hooks
 				const events = await viewHandle.getEvents();
 
-				// Should have 1 onStart, 2 each of onBeforeConnect, onConnect, and onDisconnect
-				expect(events.filter((e) => e === "onStart").length).toBe(1);
+				// Should have 1 onWake, 2 each of onBeforeConnect, onConnect, and onDisconnect
+				expect(events.filter((e) => e === "onWake").length).toBe(1);
 				expect(
 					events.filter((e) => e === "onBeforeConnect").length,
 				).toBe(2);
diff --git a/rivetkit-typescript/packages/rivetkit/src/driver-test-suite/tests/actor-metadata.ts b/rivetkit-typescript/packages/rivetkit/src/driver-test-suite/tests/actor-metadata.ts
@@ -16,7 +16,7 @@ export function runActorMetadataTests(driverTestConfig: DriverTestConfig) {
 				expect(actorName).toBe("metadataActor");
 			});
 
-			test("should preserve actor name in state during onStart", async (c) => {
+			test("should preserve actor name in state during onWake", async (c) => {
 				const { client } = await setupDriverTest(c, driverTestConfig);
 
 				// Get the stored actor name

Original file line number	Diff line number	Diff line change
`@@ -864,19 +864,19 @@ export class ActorInstance<S, CP, CS, V, I, DB extends AnyDatabaseProvider> {`
`864`	`864`
`865`	`865`	`async #callOnStart() {`
`866`	`866`	`this.#rLog.info({ msg: "actor starting" });`
`867`		`- if (this.#config.onStart) {`
`868`		`- const result = this.#config.onStart(this.actorContext);`
	`867`	`+ if (this.#config.onWake) {`
	`868`	`+ const result = this.#config.onWake(this.actorContext);`
`869`	`869`	`if (result instanceof Promise) {`
`870`	`870`	`await result;`
`871`	`871`	`}`
`872`	`872`	`}`
`873`	`873`	`}`
`874`	`874`
`875`	`875`	`async #callOnStop() {`
`876`		`- if (this.#config.onStop) {`
	`876`	`+ if (this.#config.onSleep) {`
`877`	`877`	`try {`
`878`	`878`	`this.#rLog.debug({ msg: "calling onStop" });`
`879`		`- const result = this.#config.onStop(this.actorContext);`
	`879`	`+ const result = this.#config.onSleep(this.actorContext);`
`880`	`880`	`if (result instanceof Promise) {`
`881`	`881`	`await deadline(result, this.#config.options.onStopTimeout);`
`882`	`882`	`}`