fix(rivetkit-napi): plumb ctx through serializeState TSF and stop panicking on runtime_state Ref drop

Author: NathanFlurry

rivetkit-typescript/packages/rivetkit-napi/index.d.ts

@@ -50,6 +50,7 @@ export interface JsActionDefinition {
 export interface JsActorConfig {
   name?: string
   icon?: string
+  hasDatabase?: boolean
   canHibernateWebsocket?: boolean
   stateSaveIntervalMs?: number
   createStateTimeoutMs?: number

rivetkit-typescript/packages/rivetkit-napi/src/actor_context.rs

@@ -766,14 +766,30 @@ impl ActorContextShared {
 		*self.abort_token.lock() = None;
 		*self.run_restart.lock() = None;
 		*self.task_sender.lock() = None;
-		*self.runtime_state.lock() = None;
+		// napi Ref::unref requires an Env; this function runs on tokio workers
+		// with no Env available. Dropping without unref panics a debug_assert in
+		// napi-rs and silently leaks the napi reference slot in release. Forget
+		// instead so debug matches release behavior. Leak is bounded to one
+		// JsObject per actor wake cycle until the process exits.
+		if let Some(old) = self.runtime_state.lock().take() {
+			std::mem::forget(old);
+		}
 		*self.end_reason.lock() = None;
 		*self.websocket_callback_regions.lock() = BTreeMap::new();
 		self.next_websocket_callback_region_id
 			.store(0, Ordering::SeqCst);
 	}
 }
 
+impl Drop for ActorContextShared {
+	fn drop(&mut self) {
+		// Same Env-less drop problem as reset_runtime_state. See comment there.
+		if let Some(old) = self.runtime_state.lock().take() {
+			std::mem::forget(old);
+		}
+	}
+}
+
 fn actor_context_shared(actor_id: &str) -> Arc<ActorContextShared> {
 	ACTOR_CONTEXT_SHARED.retain_sync(|_, shared| shared.strong_count() > 0);
 

rivetkit-typescript/packages/rivetkit-napi/src/actor_factory.rs

@@ -65,6 +65,7 @@ pub struct JsActionDefinition {
 pub struct JsActorConfig {
 	pub name: Option<String>,
 	pub icon: Option<String>,
+	pub has_database: Option<bool>,
 	pub can_hibernate_websocket: Option<bool>,
 	pub state_save_interval_ms: Option<u32>,
 	pub create_state_timeout_ms: Option<u32>,
@@ -195,6 +196,7 @@ pub(crate) struct WorkflowReplayPayload {
 
 #[derive(Clone)]
 pub(crate) struct SerializeStatePayload {
+	pub(crate) ctx: CoreActorContext,
 	pub(crate) reason: String,
 }
 
@@ -738,7 +740,7 @@ impl TsfnPayloadSummary for WorkflowReplayPayload {
 
 impl TsfnPayloadSummary for SerializeStatePayload {
 	fn payload_summary(&self) -> String {
-		format!("reason={}", self.reason)
+		format!("actor_id={} reason={}", self.ctx.actor_id(), self.reason)
 	}
 }
 
@@ -882,7 +884,6 @@ fn build_action_payload(env: &Env, payload: ActionPayload) -> napi::Result<Vec<n
 		Some(conn) => object.set("conn", ConnHandle::new(conn))?,
 		None => object.set("conn", env.get_null()?)?,
 	}
-	object.set("name", payload.name)?;
 	object.set("args", Buffer::from(payload.args))?;
 	match payload.cancel_token {
 		Some(cancel_token) => object.set("cancelToken", CancellationToken::new(cancel_token))?,
@@ -926,9 +927,10 @@ fn build_serialize_state_payload(
 	env: &Env,
 	payload: SerializeStatePayload,
 ) -> napi::Result<Vec<napi::JsUnknown>> {
-	Ok(vec![
-		env.create_string_from_std(payload.reason)?.into_unknown(),
-	])
+	let mut object = env.create_object()?;
+	object.set("ctx", ActorContext::new(payload.ctx))?;
+	object.set("reason", env.create_string_from_std(payload.reason)?)?;
+	Ok(vec![object.into_unknown()])
 }
 
 fn build_request_object(env: &Env, request: Request) -> napi::Result<JsObject> {
@@ -1033,6 +1035,7 @@ impl From<JsActorConfig> for ActorConfigInput {
 		Self {
 			name: value.name,
 			icon: value.icon,
+			has_database: value.has_database,
 			can_hibernate_websocket: value.can_hibernate_websocket,
 			state_save_interval_ms: value.state_save_interval_ms,
 			create_vars_timeout_ms: value.create_vars_timeout_ms,

rivetkit-typescript/packages/rivetkit-napi/src/napi_actor_events.rs

@@ -541,7 +541,7 @@ pub(crate) async fn dispatch_event(
 			});
 		}
 		ActorEvent::SerializeState { reason, reply } => {
-			reply.send(maybe_serialize(bindings.as_ref(), dirty.as_ref(), reason).await);
+			reply.send(maybe_serialize(bindings.as_ref(), dirty.as_ref(), ctx, reason).await);
 		}
 		ActorEvent::RunGracefulCleanup { reason, reply } => {
 			let callback = match reason {
@@ -617,12 +617,13 @@ pub(crate) async fn dispatch_event(
 async fn maybe_serialize(
 	bindings: &CallbackBindings,
 	dirty: &AtomicBool,
+	ctx: &ActorContext,
 	reason: SerializeStateReason,
 ) -> Result<Vec<StateDelta>> {
 	// The adapter dirty bit is consumed only by persistence-bound serialization.
 	// Inspector snapshots feed the live overlay and must not steal a pending save.
 	maybe_serialize_with(bindings, dirty, reason, |bindings, reason| async move {
-		call_serialize_state(bindings, reason).await
+		call_serialize_state(bindings, ctx, reason).await
 	})
 	.await
 }
@@ -646,6 +647,7 @@ where
 
 async fn call_serialize_state(
 	bindings: &CallbackBindings,
+	ctx: &ActorContext,
 	reason: &'static str,
 ) -> Result<Vec<StateDelta>> {
 	let callback = bindings
@@ -656,6 +658,7 @@ async fn call_serialize_state(
 		"serializeState",
 		callback,
 		SerializeStatePayload {
+			ctx: ctx.inner().clone(),
 			reason: reason.to_owned(),
 		},
 	)
@@ -1713,8 +1716,11 @@ mod tests {
 	async fn maybe_serialize_skips_save_when_adapter_is_clean() {
 		let bindings = empty_bindings();
 		let dirty = AtomicBool::new(false);
+		let core_ctx =
+			rivetkit_core::ActorContext::new("maybe-serialize-clean", "actor", Vec::new(), "local");
+		let ctx = ActorContext::new(core_ctx);
 
-		let deltas = maybe_serialize(&bindings, &dirty, SerializeStateReason::Save)
+		let deltas = maybe_serialize(&bindings, &dirty, &ctx, SerializeStateReason::Save)
 			.await
 			.expect("clean save serialize should not fail");
 

rivetkit-typescript/packages/rivetkit/src/registry/native.ts

@@ -118,7 +118,7 @@ type NativeWebSocketWithEvents = NativeWebSocket & {
 };
 const textEncoder = new TextEncoder();
 const textDecoder = new TextDecoder();
-type SerializeStateReason = "save" | "inspector" | "sleep" | "destroy";
+type SerializeStateReason = "save" | "inspector";
 type NativeOnStateChangeHandler = (
 	ctx: NativeActorContextAdapter,
 	state: unknown,
@@ -3046,6 +3046,7 @@ function buildActorConfig(
 	return {
 		name: options.name as string | undefined,
 		icon: options.icon as string | undefined,
+		hasDatabase: config.db !== undefined,
 		canHibernateWebsocket:
 			typeof canHibernate === "boolean" ? canHibernate : undefined,
 		stateSaveIntervalMs: options.stateSaveInterval as number | undefined,