rivetkit-core 2.3.4

Core runtime primitives for RivetKit actor hosts
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
use super::*;

mod moved_tests {
	use super::{Inspector, InspectorSignal, InspectorSnapshot};
	use crate::QueueNextOpts;
	use crate::actor::connection::{
		ConnHandle, PersistedConnection, PersistedSubscription, encode_persisted_connection,
	};
	use crate::actor::context::tests::new_with_kv;
	use crate::actor::keys::{INSPECTOR_TOKEN_KEY, make_connection_key};
	use crate::actor::messages::StateDelta;
	use crate::inspector::InspectorAuth;
	use crate::inspector::auth::test_inspector_env_lock;
	use rivet_error::RivetError;
	use std::sync::Arc;
	use std::sync::atomic::{AtomicUsize, Ordering};

	#[tokio::test]
	async fn state_updates_increment_inspector_revisions() {
		let ctx = new_with_kv(
			"actor-1",
			"inspector-state",
			Vec::new(),
			"local",
			crate::kv::tests::new_in_memory(),
		);
		let inspector = Inspector::new();

		ctx.configure_inspector(Some(inspector.clone()));
		ctx.save_state(vec![StateDelta::ActorState(vec![1, 2, 3])])
			.await
			.expect("state save should succeed");

		assert_eq!(
			inspector.snapshot(),
			InspectorSnapshot {
				state_revision: 1,
				..InspectorSnapshot::default()
			},
		);
	}

	#[tokio::test]
	async fn connection_lifecycle_updates_inspector_snapshot() {
		let kv = crate::kv::tests::new_in_memory();
		let ctx = new_with_kv(
			"actor-1",
			"inspector-connections",
			Vec::new(),
			"local",
			kv.clone(),
		);
		let inspector = Inspector::new();

		ctx.configure_inspector(Some(inspector.clone()));

		let conn = ConnHandle::new("conn-1", vec![1], vec![2], false);
		ctx.add_conn(conn.clone());
		assert_eq!(
			inspector.snapshot(),
			InspectorSnapshot {
				connections_revision: 1,
				active_connections: 1,
				..InspectorSnapshot::default()
			},
		);

		ctx.remove_conn(conn.id());
		assert_eq!(
			inspector.snapshot(),
			InspectorSnapshot {
				connections_revision: 2,
				active_connections: 0,
				..InspectorSnapshot::default()
			},
		);

		let restored = PersistedConnection {
			id: "restored-1".into(),
			parameters: vec![9],
			state: vec![8],
			subscriptions: vec![PersistedSubscription {
				event_name: "counter.updated".into(),
			}],
			gateway_id: [1, 2, 3, 4],
			request_id: [5, 6, 7, 8],
			server_message_index: 3,
			client_message_index: 4,
			request_path: "/socket".into(),
			request_headers: Default::default(),
		};
		kv.put(
			&make_connection_key(&restored.id),
			&encode_persisted_connection(&restored).expect("encode restored connection"),
		)
		.await
		.expect("persist restored connection");

		let restored_connections = ctx
			.restore_hibernatable_connections()
			.await
			.expect("restore should succeed");
		assert_eq!(restored_connections.len(), 1);
		assert_eq!(
			inspector.snapshot(),
			InspectorSnapshot {
				connections_revision: 3,
				active_connections: 1,
				..InspectorSnapshot::default()
			},
		);

		ctx.remove_conn("restored-1");
		assert_eq!(
			inspector.snapshot(),
			InspectorSnapshot {
				connections_revision: 4,
				active_connections: 0,
				..InspectorSnapshot::default()
			},
		);
	}

	#[tokio::test]
	async fn queue_lifecycle_updates_inspector_snapshot() {
		let ctx = new_with_kv(
			"actor-1",
			"inspector-queue",
			Vec::new(),
			"local",
			crate::kv::tests::new_in_memory(),
		);
		let inspector = Inspector::new();

		ctx.configure_inspector(Some(inspector.clone()));

		ctx.queue()
			.send("jobs", b"first")
			.await
			.expect("enqueue should succeed");
		assert_eq!(
			inspector.snapshot(),
			InspectorSnapshot {
				queue_revision: 1,
				queue_size: 1,
				..InspectorSnapshot::default()
			},
		);

		let received = ctx
			.queue()
			.next(QueueNextOpts::default())
			.await
			.expect("queue next should succeed")
			.expect("message should exist");
		assert_eq!(received.body, b"first".to_vec());
		assert_eq!(
			inspector.snapshot(),
			InspectorSnapshot {
				queue_revision: 2,
				queue_size: 0,
				..InspectorSnapshot::default()
			},
		);

		ctx.queue()
			.send("jobs", b"second")
			.await
			.expect("second enqueue should succeed");
		assert_eq!(
			inspector.snapshot(),
			InspectorSnapshot {
				queue_revision: 3,
				queue_size: 1,
				..InspectorSnapshot::default()
			},
		);

		let completable = ctx
			.queue()
			.next(QueueNextOpts {
				names: None,
				timeout: None,
				signal: None,
				completable: true,
			})
			.await
			.expect("completable receive should succeed")
			.expect("completable message should exist");
		assert_eq!(
			inspector.snapshot(),
			InspectorSnapshot {
				queue_revision: 4,
				queue_size: 1,
				..InspectorSnapshot::default()
			},
		);

		completable
			.complete(Some(vec![7]))
			.await
			.expect("queue ack should succeed");
		assert_eq!(
			inspector.snapshot(),
			InspectorSnapshot {
				queue_revision: 5,
				queue_size: 0,
				..InspectorSnapshot::default()
			},
		);
	}

	#[tokio::test]
	async fn reset_drains_queue_and_preserves_next_id() {
		let ctx = new_with_kv(
			"actor-1",
			"inspector-queue-reset",
			Vec::new(),
			"local",
			crate::kv::tests::new_in_memory(),
		);
		let inspector = Inspector::new();
		ctx.configure_inspector(Some(inspector.clone()));

		let first = ctx
			.queue()
			.send("jobs", b"first")
			.await
			.expect("enqueue first");
		ctx.queue()
			.send("jobs", b"second")
			.await
			.expect("enqueue second");
		let third = ctx
			.queue()
			.send("jobs", b"third")
			.await
			.expect("enqueue third");
		let pre_reset_revision = inspector.snapshot().queue_revision;
		assert_eq!(inspector.snapshot().queue_size, 3);

		ctx.queue().reset().await.expect("reset should succeed");

		let after_reset = inspector.snapshot();
		assert_eq!(after_reset.queue_size, 0);
		// reset bumps the queue revision so inspector subscribers re-render.
		assert!(after_reset.queue_revision > pre_reset_revision);
		assert!(
			ctx.queue()
				.inspect_messages()
				.await
				.expect("inspect after reset")
				.is_empty()
		);

		// next_id is preserved across reset so a post-reset message never reuses
		// an id that a pre-reset completion handle still holds.
		let again = ctx
			.queue()
			.send("jobs", b"again")
			.await
			.expect("enqueue again");
		assert!(again.id > first.id);
		assert!(again.id > third.id);
		assert_eq!(inspector.snapshot().queue_size, 1);
	}

	#[tokio::test]
	async fn reset_drains_queue_larger_than_delete_chunk() {
		let ctx = new_with_kv(
			"actor-1",
			"inspector-queue-reset-large",
			Vec::new(),
			"local",
			crate::kv::tests::new_in_memory(),
		);

		// Exceed the engine per-call key limit (128) so reset must delete in
		// more than one chunk.
		for i in 0..200u32 {
			ctx.queue()
				.send("jobs", format!("msg-{i}").as_bytes())
				.await
				.expect("enqueue should succeed");
		}

		ctx.queue().reset().await.expect("reset should succeed");

		assert!(
			ctx.queue()
				.inspect_messages()
				.await
				.expect("inspect after reset")
				.is_empty()
		);
	}

	#[test]
	fn inspector_subscriptions_track_connected_clients_and_cleanup() {
		let inspector = Inspector::new();
		let state_updates = Arc::new(AtomicUsize::new(0));
		let queue_updates = Arc::new(AtomicUsize::new(0));
		let state_updates_clone = state_updates.clone();
		let queue_updates_clone = queue_updates.clone();

		let subscription = inspector.subscribe(Arc::new(move |signal| match signal {
			InspectorSignal::StateUpdated => {
				state_updates_clone.fetch_add(1, Ordering::SeqCst);
			}
			InspectorSignal::QueueUpdated => {
				queue_updates_clone.fetch_add(1, Ordering::SeqCst);
			}
			InspectorSignal::ConnectionsUpdated | InspectorSignal::WorkflowHistoryUpdated => {}
		}));

		assert_eq!(inspector.snapshot().connected_clients, 1);

		inspector.record_state_updated();
		inspector.record_queue_updated(3);

		assert_eq!(state_updates.load(Ordering::SeqCst), 1);
		assert_eq!(queue_updates.load(Ordering::SeqCst), 1);

		drop(subscription);

		assert_eq!(inspector.snapshot().connected_clients, 0);

		inspector.record_state_updated();
		assert_eq!(state_updates.load(Ordering::SeqCst), 1);
	}

	#[tokio::test]
	async fn inspector_auth_uses_env_token_before_kv_fallback() {
		let _env_guard = test_inspector_env_lock().lock().expect("env lock poisoned");
		unsafe {
			std::env::set_var("_RIVET_TEST_INSPECTOR_TOKEN", "env-token");
		}

		let kv = crate::kv::tests::new_in_memory();
		let ctx = new_with_kv(
			"actor-1",
			"inspector-auth-env",
			Vec::new(),
			"local",
			kv.clone(),
		);
		kv.put(&INSPECTOR_TOKEN_KEY, b"kv-token")
			.await
			.expect("kv token should persist");

		InspectorAuth::new()
			.verify(&ctx, Some("env-token"))
			.await
			.expect("env token should authorize");

		let error = InspectorAuth::new()
			.verify(&ctx, Some("kv-token"))
			.await
			.expect_err("kv token should not bypass configured env token");
		let error = RivetError::extract(&error);
		assert_eq!(error.group(), "inspector");
		assert_eq!(error.code(), "unauthorized");

		unsafe {
			std::env::remove_var("_RIVET_TEST_INSPECTOR_TOKEN");
		}
	}

	#[tokio::test]
	async fn inspector_auth_falls_back_to_actor_kv_token() {
		let _env_guard = test_inspector_env_lock().lock().expect("env lock poisoned");
		unsafe {
			std::env::remove_var("_RIVET_TEST_INSPECTOR_TOKEN");
		}

		let kv = crate::kv::tests::new_in_memory();
		let ctx = new_with_kv(
			"actor-1",
			"inspector-auth-kv",
			Vec::new(),
			"local",
			kv.clone(),
		);
		kv.put(&INSPECTOR_TOKEN_KEY, b"kv-token")
			.await
			.expect("kv token should persist");

		InspectorAuth::new()
			.verify(&ctx, Some("kv-token"))
			.await
			.expect("kv token should authorize");

		let error = InspectorAuth::new()
			.verify(&ctx, Some("nope"))
			.await
			.expect_err("wrong token should fail");
		let error = RivetError::extract(&error);
		assert_eq!(error.group(), "inspector");
		assert_eq!(error.code(), "unauthorized");
	}

	#[tokio::test]
	async fn inspector_auth_rejects_missing_token() {
		let _env_guard = test_inspector_env_lock().lock().expect("env lock poisoned");
		unsafe {
			std::env::remove_var("_RIVET_TEST_INSPECTOR_TOKEN");
		}

		let ctx = new_with_kv(
			"actor-1",
			"inspector-auth-missing",
			Vec::new(),
			"local",
			crate::kv::tests::new_in_memory(),
		);

		let error = InspectorAuth::new()
			.verify(&ctx, None)
			.await
			.expect_err("missing token should fail");
		let error = RivetError::extract(&error);
		assert_eq!(error.group(), "inspector");
		assert_eq!(error.code(), "unauthorized");
	}
}