meerkat-session 0.6.21

Session service orchestration for Meerkat
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
#![allow(clippy::panic, clippy::unnecessary_debug_formatting)]

//! Tripwire for wave-c (Section 1.5 #2). Flipped green by **C-3**
//! (fixtures 1-11) + **C-6r** (fixture #12, runtime-side snapshot
//! table).
//!
//! Invariant: every v0 session/runtime-store fixture from
//! `docs/wave-c-prep/persistence-migration.md` §5 must load under the
//! v1 typed schema with lossless round-trip semantics. The canary is
//! fixture #4 (Anthropic extended-thinking `thinking: {type:"enabled",
//! budget_tokens:32000}`), which is the production shape most at risk
//! of being silently dropped by an eager typed retype.
//!
//! At c.0 the stub used fixtures as inline blobs. C-3 lands:
//! - disk fixtures under `meerkat-session/tests/fixtures/pre_wave_b/`
//!   so helper drift cannot mask regressions (per §5 of the design doc);
//! - the migration entry points in
//!   `meerkat_session::persistent::migrations`;
//! - per-fixture typed assertions (the Anthropic `thinking` canary
//!   verifies the typed bag preserves the nested shape byte-for-byte).
//!
//! Fixture #12 (`runtime_session_snapshot_drift`) was un-ignored by
//! C-6r, which routes the `runtime_session_snapshots` read path in
//! `PersistentSessionService::load_authoritative_session_base`
//! through `deserialize_session_migrating` — the same migration entry
//! point used for the primary `SessionStore::load` path. Now green.

#![allow(clippy::unwrap_used, clippy::expect_used)]

use std::path::{Path, PathBuf};

use meerkat_core::{SESSION_METADATA_SCHEMA_VERSION, SESSION_VERSION};
use meerkat_session::migrations::{
    STORED_INPUT_STATE_VERSION, SessionMigrationError, migrate_input_state_value,
    migrate_session_value,
};
use serde_json::{Value, json};

fn fixture_dir() -> PathBuf {
    Path::new(env!("CARGO_MANIFEST_DIR"))
        .join("tests")
        .join("fixtures")
        .join("pre_wave_b")
}

fn load_fixture(name: &str) -> Value {
    let path = fixture_dir().join(format!("{name}.json"));
    let bytes = std::fs::read(&path)
        .unwrap_or_else(|err| panic!("fixture {name} missing at {path:?}: {err}"));
    serde_json::from_slice(&bytes).unwrap_or_else(|err| panic!("fixture {name} parse error: {err}"))
}

/// Call the session-envelope migrator for a fixture where the
/// scenario lives inside `session_metadata`; we splice it into a
/// minimal Session skeleton before handing it to the migrator so the
/// round-trip exercises the full typed path.
fn migrate_metadata_scenario(name: &str) -> Result<meerkat_core::Session, SessionMigrationError> {
    let raw = load_fixture(name);
    let metadata_root = raw
        .as_object()
        .and_then(|obj| obj.get("session_metadata").cloned())
        .unwrap_or(Value::Null);
    let session_llm_identity = raw
        .as_object()
        .and_then(|obj| obj.get("session_llm_identity").cloned());
    let id = raw
        .get("id")
        .and_then(Value::as_str)
        .unwrap_or("00000000-0000-0000-0000-000000000001")
        .to_string();

    let mut envelope = json!({
        "id": id,
        "messages": [],
        "created_at": { "secs_since_epoch": 0, "nanos_since_epoch": 0 },
        "updated_at": { "secs_since_epoch": 0, "nanos_since_epoch": 0 },
        "metadata": {
            "session_metadata": metadata_root,
        },
    });
    if let Some(ident) = session_llm_identity {
        envelope
            .as_object_mut()
            .unwrap()
            .insert("session_llm_identity_scenario".to_string(), ident);
    }
    migrate_session_value(envelope)
}

/// Fixture #1: empty metadata. No `session_metadata` key at all — the
/// migrator should be a no-op on the metadata sub-tree.
#[test]
fn fixture_01_session_empty_metadata() {
    // Synthesize a minimal v0 Session blob — no metadata at all.
    let envelope = json!({
        "id": "00000000-0000-0000-0000-000000000001",
        "messages": [],
        "created_at": { "secs_since_epoch": 0, "nanos_since_epoch": 0 },
        "updated_at": { "secs_since_epoch": 0, "nanos_since_epoch": 0 },
    });
    let session = migrate_session_value(envelope).expect("empty metadata must migrate cleanly");
    assert_eq!(session.version(), SESSION_VERSION);
    // Ensure we didn't fabricate a SessionMetadata entry out of thin air.
    assert!(
        session.metadata().get("session_metadata").is_none(),
        "migrator must not synthesize SessionMetadata when none was persisted"
    );
}

/// Fixture #2: OpenAI provider_params — typed temperature + reasoning +
/// unknown (encrypted_content).
#[test]
fn fixture_02_session_provider_params_openai() {
    let session =
        migrate_metadata_scenario("session_provider_params_openai").expect("must migrate");
    let metadata_json = session
        .metadata()
        .get("session_metadata")
        .expect("session_metadata must be present after migration");
    let params = metadata_json
        .get("provider_params")
        .expect("provider_params preserved");

    // provider_params stays opaque Value at SessionMetadata level in
    // this wave (retype lives on RuntimeTurnMetadata, not on metadata).
    // Canary: temperature, reasoning, and the opaque encrypted_content
    // all survive round-trip.
    assert_eq!(params.get("temperature").and_then(Value::as_f64), Some(0.2));
    assert_eq!(
        params.get("reasoning").and_then(Value::as_str),
        Some("silent")
    );
    assert_eq!(
        params.get("encrypted_content").and_then(Value::as_str),
        Some("Zm9v")
    );
    // Schema version byte stamped forward.
    assert_eq!(
        metadata_json.get("schema_version").and_then(Value::as_u64),
        Some(u64::from(SESSION_METADATA_SCHEMA_VERSION))
    );
}

/// Fixture #3: Anthropic signature passthrough.
#[test]
fn fixture_03_session_provider_params_anthropic_signature() {
    let session = migrate_metadata_scenario("session_provider_params_anthropic_signature")
        .expect("must migrate");
    let params = session
        .metadata()
        .get("session_metadata")
        .and_then(|m| m.get("provider_params"))
        .expect("provider_params preserved");
    assert_eq!(
        params.get("signature").and_then(Value::as_str),
        Some("abc123")
    );
}

/// Fixture #4 — THE CANARY. Anthropic extended-thinking shape
/// `{thinking: {type:"enabled", budget_tokens:32000}}`. Must survive
/// byte-for-byte through the typed round-trip; this is the production
/// payload most at risk of silent drop.
#[test]
fn fixture_04_anthropic_thinking_canary() {
    let session = migrate_metadata_scenario("session_provider_params_anthropic_thinking")
        .expect("must migrate");
    let params = session
        .metadata()
        .get("session_metadata")
        .and_then(|m| m.get("provider_params"))
        .expect("provider_params preserved");
    let thinking = params
        .get("thinking")
        .expect("thinking bag MUST survive — silent-drop canary");

    // Byte-for-byte shape preservation, not just "is_ok()".
    assert_eq!(
        thinking.get("type").and_then(Value::as_str),
        Some("enabled"),
        "thinking.type dropped by migration — regression of silent-drop canary"
    );
    assert_eq!(
        thinking.get("budget_tokens").and_then(Value::as_u64),
        Some(32000),
        "thinking.budget_tokens dropped — regression of silent-drop canary"
    );

    // Round-trip: re-serialise migrated Session, re-run migrator, assert
    // idempotent (no further transforms applied).
    let reserialized = serde_json::to_value(&session).unwrap();
    let again = migrate_session_value(reserialized).expect("idempotent on v2 blob");
    let thinking_again = again
        .metadata()
        .get("session_metadata")
        .and_then(|m| m.get("provider_params"))
        .and_then(|p| p.get("thinking"))
        .expect("thinking survives second migration pass");
    assert_eq!(
        thinking_again.get("budget_tokens").and_then(Value::as_u64),
        Some(32000)
    );
}

/// Fixture #5: non-object provider_params (scalar). Must migrate
/// cleanly — the Value-opaque carrier preserves scalars unchanged.
#[test]
fn fixture_05_session_provider_params_unknown_scalar() {
    let session =
        migrate_metadata_scenario("session_provider_params_unknown").expect("must migrate");
    let params = session
        .metadata()
        .get("session_metadata")
        .and_then(|m| m.get("provider_params"))
        .expect("provider_params preserved");
    assert_eq!(params.as_u64(), Some(42));
}

/// Fixture #6: clean AuthBindingRef — `{realm_id, binding_id}` → typed
/// `{realm, binding}`.
#[test]
fn fixture_06_auth_binding_clean_v0_rename() {
    let session =
        migrate_metadata_scenario("session_auth_binding_slug_valid").expect("must migrate");
    let cref = session
        .metadata()
        .get("session_metadata")
        .and_then(|m| m.get("auth_binding"))
        .expect("auth_binding preserved");
    assert_eq!(cref.get("realm").and_then(Value::as_str), Some("dev"));
    assert_eq!(
        cref.get("binding").and_then(Value::as_str),
        Some("default_openai")
    );
    assert!(cref.get("realm_id").is_none(), "legacy key must be removed");
    assert!(
        cref.get("binding_id").is_none(),
        "legacy key must be removed"
    );
}

/// Fixture #7: invalid slug (`dev mode`). Migration slugifies
/// (`dev_mode`) and returns `SessionMigrationError::Partial` carrying
/// the original payload.
#[test]
fn fixture_07_auth_binding_invalid_slug_slugified() {
    let result = migrate_metadata_scenario("session_auth_binding_slug_invalid");
    match result {
        Err(SessionMigrationError::Partial(partial)) => {
            let cref = partial
                .session
                .metadata()
                .get("session_metadata")
                .and_then(|m| m.get("auth_binding"))
                .expect("auth_binding coerced to valid slug");
            assert_eq!(
                cref.get("realm").and_then(Value::as_str),
                Some("dev_mode"),
                "realm_id `dev mode` must slugify to `dev_mode`"
            );

            // Legacy payload retained under the documented key.
            let salvaged = partial
                .legacy
                .get("legacy_auth_binding_session_metadata")
                .expect("legacy payload retained");
            assert_eq!(
                salvaged.get("realm_id").and_then(Value::as_str),
                Some("dev mode"),
                "original `dev mode` must survive under legacy bag"
            );
        }
        Ok(_) => panic!("invalid slug must return Partial, not Ok"),
        Err(other) => panic!("unexpected migration error: {other:?}"),
    }
}

/// Fixture #8: mixed v0 identity + v1 metadata — both independently
/// migrated, no cross-contamination.
#[test]
fn fixture_08_hot_swap_identity_mixed() {
    let session =
        migrate_metadata_scenario("session_hot_swap_identity_mixed").expect("must migrate");
    let cref = session
        .metadata()
        .get("session_metadata")
        .and_then(|m| m.get("auth_binding"))
        .expect("auth_binding preserved");
    // The fixture's metadata already used v1 shape (realm/binding); the
    // migrator must not duplicate or churn the fields.
    assert_eq!(cref.get("realm").and_then(Value::as_str), Some("prod"));
    assert_eq!(
        cref.get("binding").and_then(Value::as_str),
        Some("openai_main")
    );
}

/// Fixture #9: v0 input-state with full turn_metadata (provider_params,
/// additional_instructions list of strings, model).
#[test]
fn fixture_09_input_state_full_turn_metadata() {
    let raw = load_fixture("input_state_prompt_full_turn_metadata");
    let migrated = migrate_input_state_value(raw).expect("input state migrates");
    let tm = migrated
        .get("persisted_input")
        .and_then(|p| p.get("Prompt"))
        .and_then(|p| p.get("turn_metadata"))
        .expect("turn_metadata survives migration");
    assert_eq!(
        tm.get("provider_params")
            .and_then(|p| p.get("temperature"))
            .and_then(Value::as_f64),
        Some(0.7)
    );
    // Bare-string additional_instructions preserved as-is — the typed
    // lift into `TurnInstruction` happens at read-time inside
    // RuntimeTurnMetadata serde (C-6r wires the production read path).
    let instr = tm
        .get("additional_instructions")
        .and_then(Value::as_array)
        .expect("additional_instructions preserved");
    assert_eq!(instr.len(), 2);
    assert_eq!(instr[0].as_str(), Some("foo"));

    // Version byte stamped.
    assert_eq!(
        migrated
            .get("stored_input_state_version")
            .and_then(Value::as_u64),
        Some(u64::from(STORED_INPUT_STATE_VERSION))
    );
}

/// Fixture #10: minimal input state — no turn_metadata. Migration must
/// be an identity on the absent field (no fabrication).
#[test]
fn fixture_10_input_state_continuation_minimal() {
    let raw = load_fixture("input_state_continuation_minimal");
    let migrated = migrate_input_state_value(raw).expect("input state migrates");
    // No turn_metadata synthesis.
    assert!(
        migrated
            .get("persisted_input")
            .and_then(|p| p.get("Continuation"))
            .and_then(|c| c.get("turn_metadata"))
            .is_none(),
        "migration must not fabricate turn_metadata"
    );
    assert_eq!(
        migrated
            .get("stored_input_state_version")
            .and_then(Value::as_u64),
        Some(u64::from(STORED_INPUT_STATE_VERSION))
    );
}

/// Fixture #11: retired provider string. The transform preserves the
/// raw string — typed provider parse happens downstream inside
/// `Provider::deserialize` (read-time surface in C-6r).
#[test]
fn fixture_11_input_state_provider_unknown_string() {
    let raw = load_fixture("input_state_provider_unknown_string");
    let migrated = migrate_input_state_value(raw).expect("input state migrates");
    let provider = migrated
        .get("persisted_input")
        .and_then(|p| p.get("Prompt"))
        .and_then(|p| p.get("turn_metadata"))
        .and_then(|tm| tm.get("provider"))
        .and_then(Value::as_str);
    assert_eq!(
        provider,
        Some("retired_backend_v0"),
        "retired provider string preserved — downstream Provider::deserialize \
         surfaces the typed error without silent-dropping the legacy value"
    );
}

/// Fixture #12: runtime-snapshot drift — owned by C-6r. Un-ignored
/// once the runtime-side `runtime_session_snapshots` load path in
/// `meerkat-session::persistent::SessionService::restore_session`
/// routes the raw blob through `deserialize_session_migrating`,
/// which wraps `migrate_session_value` directly. The legacy payload
/// canary (`thinking.budget_tokens`) now survives the round-trip
/// without the shell needing to re-hydrate `provider_params` by
/// hand, honoring the wave-c C-3 persistence contract.
#[test]
fn fixture_12_runtime_session_snapshot_drift() {
    let raw = load_fixture("runtime_session_snapshot_drift");
    let snapshot = raw
        .get("snapshot")
        .cloned()
        .expect("fixture contains a `snapshot` wrapper");
    let migrated =
        migrate_session_value(snapshot).expect("runtime snapshot must round-trip via migration");
    // Canary survives through the runtime-side path as well.
    let thinking = migrated
        .metadata()
        .get("session_metadata")
        .and_then(|m| m.get("provider_params"))
        .and_then(|p| p.get("thinking"))
        .expect("thinking survives runtime snapshot migration");
    assert_eq!(
        thinking.get("budget_tokens").and_then(Value::as_u64),
        Some(32000)
    );
}