telltale-runtime 17.0.0

Choreographic programming for Telltale - effect-based distributed protocols
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
#![cfg(not(target_arch = "wasm32"))]
//! Tests for InMemoryHandler correctness.
//!
//! Verifies core invariants:
//! - Message FIFO ordering
//! - Serialization round-trip fidelity
//! - Label value preservation
//! - Channel isolation (no cross-talk)

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

use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;
use std::sync::{Arc, Mutex};
use telltale_runtime::effects::{
    handlers::in_memory::InMemoryHandler, ChoreoHandler, LabelId, RoleId,
};
use telltale_runtime::RoleName;

// ============================================================================
// Test Role Setup
// ============================================================================

#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
enum TestRole {
    Alice,
    Bob,
    Charlie,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
enum TestLabel {
    Default,
}

impl LabelId for TestLabel {
    fn as_str(&self) -> &'static str {
        match self {
            TestLabel::Default => "default",
        }
    }

    fn from_str(label: &str) -> Option<Self> {
        match label {
            "default" => Some(TestLabel::Default),
            _ => None,
        }
    }
}

impl RoleId for TestRole {
    type Label = TestLabel;

    fn role_name(&self) -> RoleName {
        match self {
            TestRole::Alice => RoleName::from_static("Alice"),
            TestRole::Bob => RoleName::from_static("Bob"),
            TestRole::Charlie => RoleName::from_static("Charlie"),
        }
    }
}

// ============================================================================
// Test Message Types
// ============================================================================

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
struct SimpleMessage {
    value: i32,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
struct ComplexMessage {
    id: u64,
    name: String,
    data: Vec<u8>,
    flag: bool,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
struct LabelMessage {
    label: String,
    special_chars: String,
}

// ============================================================================
// Basic Send/Receive Tests
// ============================================================================

#[tokio::test]
async fn test_basic_send_recv() {
    // Create shared channel maps
    let channels = Arc::new(Mutex::new(BTreeMap::new()));
    let choice_channels = Arc::new(Mutex::new(BTreeMap::new()));

    // Create handlers for Alice and Bob
    let mut alice =
        InMemoryHandler::with_channels(TestRole::Alice, channels.clone(), choice_channels.clone());
    let mut bob =
        InMemoryHandler::with_channels(TestRole::Bob, channels.clone(), choice_channels.clone());

    // Alice sends to Bob
    let msg = SimpleMessage { value: 42 };
    alice
        .send(&mut (), TestRole::Bob, &msg)
        .await
        .expect("Send should succeed");

    // Bob receives from Alice
    let received: SimpleMessage = bob
        .recv(&mut (), TestRole::Alice)
        .await
        .expect("Recv should succeed");

    assert_eq!(received, msg);
}

#[tokio::test]
async fn test_complex_message_serialization() {
    let channels = Arc::new(Mutex::new(BTreeMap::new()));
    let choice_channels = Arc::new(Mutex::new(BTreeMap::new()));

    let mut alice =
        InMemoryHandler::with_channels(TestRole::Alice, channels.clone(), choice_channels.clone());
    let mut bob =
        InMemoryHandler::with_channels(TestRole::Bob, channels.clone(), choice_channels.clone());

    // Send complex message
    let msg = ComplexMessage {
        id: 12345678901234,
        name: "Test Message with Special Chars: 日本語".to_string(),
        data: vec![0, 1, 255, 128, 64],
        flag: true,
    };

    alice
        .send(&mut (), TestRole::Bob, &msg)
        .await
        .expect("Complex message send should succeed");

    let received: ComplexMessage = bob
        .recv(&mut (), TestRole::Alice)
        .await
        .expect("Complex message recv should succeed");

    assert_eq!(received, msg);
}

// ============================================================================
// Multi-Message Tests
// ============================================================================

// NOTE: InMemoryHandler is designed for single-message exchanges per role pair.
// Multiple sequential messages require re-establishing channels.

#[tokio::test]
async fn test_multiple_independent_exchanges() {
    // Demonstrate that each send/recv pair works independently
    // by creating fresh handlers for each exchange

    for i in 0..5 {
        let channels = Arc::new(Mutex::new(BTreeMap::new()));
        let choice_channels = Arc::new(Mutex::new(BTreeMap::new()));

        let mut alice = InMemoryHandler::with_channels(
            TestRole::Alice,
            channels.clone(),
            choice_channels.clone(),
        );
        let mut bob = InMemoryHandler::with_channels(
            TestRole::Bob,
            channels.clone(),
            choice_channels.clone(),
        );

        let msg = SimpleMessage { value: i };
        alice
            .send(&mut (), TestRole::Bob, &msg)
            .await
            .expect("Send should succeed");

        let received: SimpleMessage = bob
            .recv(&mut (), TestRole::Alice)
            .await
            .expect("Recv should succeed");

        assert_eq!(received.value, i, "Each exchange should work correctly");
    }
}

#[tokio::test]
async fn test_interleaved_bidirectional_exchange() {
    // Test that bidirectional communication works when interleaved
    let channels = Arc::new(Mutex::new(BTreeMap::new()));
    let choice_channels = Arc::new(Mutex::new(BTreeMap::new()));

    let mut alice =
        InMemoryHandler::with_channels(TestRole::Alice, channels.clone(), choice_channels.clone());
    let mut bob =
        InMemoryHandler::with_channels(TestRole::Bob, channels.clone(), choice_channels.clone());

    // Alice sends, Bob receives
    alice
        .send(&mut (), TestRole::Bob, &SimpleMessage { value: 1 })
        .await
        .unwrap();
    let r1: SimpleMessage = bob.recv(&mut (), TestRole::Alice).await.unwrap();
    assert_eq!(r1.value, 1);

    // Bob sends, Alice receives
    bob.send(&mut (), TestRole::Alice, &SimpleMessage { value: 2 })
        .await
        .unwrap();
    let r2: SimpleMessage = alice.recv(&mut (), TestRole::Bob).await.unwrap();
    assert_eq!(r2.value, 2);
}

// ============================================================================
// Label Preservation Tests
// ============================================================================

#[tokio::test]
async fn test_label_with_special_characters() {
    // Test various special characters are preserved through serialization
    let test_cases = vec![
        LabelMessage {
            label: "simple".to_string(),
            special_chars: "".to_string(),
        },
        LabelMessage {
            label: "with-hyphen".to_string(),
            special_chars: "-".to_string(),
        },
        LabelMessage {
            label: "with_underscore".to_string(),
            special_chars: "_".to_string(),
        },
        LabelMessage {
            label: "unicode:日本語".to_string(),
            special_chars: "日本語".to_string(),
        },
        LabelMessage {
            label: "emoji:party-rocket".to_string(),
            special_chars: "party".to_string(),
        },
        LabelMessage {
            label: "newline\ntest".to_string(),
            special_chars: "\n\t".to_string(),
        },
    ];

    // Test each case with fresh channels
    for expected in &test_cases {
        let channels = Arc::new(Mutex::new(BTreeMap::new()));
        let choice_channels = Arc::new(Mutex::new(BTreeMap::new()));

        let mut alice = InMemoryHandler::with_channels(
            TestRole::Alice,
            channels.clone(),
            choice_channels.clone(),
        );
        let mut bob = InMemoryHandler::with_channels(
            TestRole::Bob,
            channels.clone(),
            choice_channels.clone(),
        );

        alice
            .send(&mut (), TestRole::Bob, expected)
            .await
            .expect("Send should succeed");

        let received: LabelMessage = bob
            .recv(&mut (), TestRole::Alice)
            .await
            .expect("Recv should succeed");

        assert_eq!(
            &received, expected,
            "Label should be preserved exactly: {:?}",
            expected.label
        );
    }
}

// ============================================================================
// Channel Isolation Tests
// ============================================================================

#[tokio::test]
async fn test_channel_isolation_two_party() {
    let channels = Arc::new(Mutex::new(BTreeMap::new()));
    let choice_channels = Arc::new(Mutex::new(BTreeMap::new()));

    let mut alice =
        InMemoryHandler::with_channels(TestRole::Alice, channels.clone(), choice_channels.clone());
    let mut bob =
        InMemoryHandler::with_channels(TestRole::Bob, channels.clone(), choice_channels.clone());

    // Alice sends to Bob
    let alice_msg = SimpleMessage { value: 100 };
    alice
        .send(&mut (), TestRole::Bob, &alice_msg)
        .await
        .expect("Alice->Bob send should succeed");

    // Bob sends to Alice
    let bob_msg = SimpleMessage { value: 200 };
    bob.send(&mut (), TestRole::Alice, &bob_msg)
        .await
        .expect("Bob->Alice send should succeed");

    // Bob receives from Alice (should get 100, not 200)
    let received_by_bob: SimpleMessage = bob
        .recv(&mut (), TestRole::Alice)
        .await
        .expect("Bob recv should succeed");
    assert_eq!(
        received_by_bob.value, 100,
        "Bob should receive Alice's message"
    );

    // Alice receives from Bob (should get 200, not 100)
    let received_by_alice: SimpleMessage = alice
        .recv(&mut (), TestRole::Bob)
        .await
        .expect("Alice recv should succeed");
    assert_eq!(
        received_by_alice.value, 200,
        "Alice should receive Bob's message"
    );
}

#[tokio::test]
async fn test_channel_isolation_three_party() {
    let channels = Arc::new(Mutex::new(BTreeMap::new()));
    let choice_channels = Arc::new(Mutex::new(BTreeMap::new()));

    let mut alice =
        InMemoryHandler::with_channels(TestRole::Alice, channels.clone(), choice_channels.clone());
    let mut bob =
        InMemoryHandler::with_channels(TestRole::Bob, channels.clone(), choice_channels.clone());
    let mut charlie = InMemoryHandler::with_channels(
        TestRole::Charlie,
        channels.clone(),
        choice_channels.clone(),
    );

    // Alice -> Bob
    alice
        .send(&mut (), TestRole::Bob, &SimpleMessage { value: 1 })
        .await
        .unwrap();

    // Alice -> Charlie
    alice
        .send(&mut (), TestRole::Charlie, &SimpleMessage { value: 2 })
        .await
        .unwrap();

    // Bob -> Charlie
    bob.send(&mut (), TestRole::Charlie, &SimpleMessage { value: 3 })
        .await
        .unwrap();

    // Verify each party receives correct messages
    let bob_from_alice: SimpleMessage = bob.recv(&mut (), TestRole::Alice).await.unwrap();
    assert_eq!(bob_from_alice.value, 1, "Bob should receive 1 from Alice");

    let charlie_from_alice: SimpleMessage = charlie.recv(&mut (), TestRole::Alice).await.unwrap();
    assert_eq!(
        charlie_from_alice.value, 2,
        "Charlie should receive 2 from Alice"
    );

    let charlie_from_bob: SimpleMessage = charlie.recv(&mut (), TestRole::Bob).await.unwrap();
    assert_eq!(
        charlie_from_bob.value, 3,
        "Charlie should receive 3 from Bob"
    );
}

// ============================================================================
// Edge Case Tests
// ============================================================================

#[tokio::test]
async fn test_empty_data() {
    let channels = Arc::new(Mutex::new(BTreeMap::new()));
    let choice_channels = Arc::new(Mutex::new(BTreeMap::new()));

    let mut alice =
        InMemoryHandler::with_channels(TestRole::Alice, channels.clone(), choice_channels.clone());
    let mut bob =
        InMemoryHandler::with_channels(TestRole::Bob, channels.clone(), choice_channels.clone());

    // Send message with empty data
    let msg = ComplexMessage {
        id: 0,
        name: "".to_string(),
        data: vec![],
        flag: false,
    };

    alice.send(&mut (), TestRole::Bob, &msg).await.unwrap();
    let received: ComplexMessage = bob.recv(&mut (), TestRole::Alice).await.unwrap();

    assert_eq!(received, msg, "Empty data should be preserved");
}

#[tokio::test]
async fn test_large_message() {
    let channels = Arc::new(Mutex::new(BTreeMap::new()));
    let choice_channels = Arc::new(Mutex::new(BTreeMap::new()));

    let mut alice =
        InMemoryHandler::with_channels(TestRole::Alice, channels.clone(), choice_channels.clone());
    let mut bob =
        InMemoryHandler::with_channels(TestRole::Bob, channels.clone(), choice_channels.clone());

    // Send large message (1MB of data)
    let msg = ComplexMessage {
        id: u64::MAX,
        name: "x".repeat(10000),
        data: vec![0u8; 1_000_000],
        flag: true,
    };

    alice.send(&mut (), TestRole::Bob, &msg).await.unwrap();
    let received: ComplexMessage = bob.recv(&mut (), TestRole::Alice).await.unwrap();

    assert_eq!(received.id, msg.id);
    assert_eq!(received.name.len(), 10000);
    assert_eq!(received.data.len(), 1_000_000);
}

// ============================================================================
// Handler Construction Tests
// ============================================================================

#[tokio::test]
async fn test_handler_new_constructor() {
    // Verify the basic constructor works
    let _handler: InMemoryHandler<TestRole> = InMemoryHandler::new(TestRole::Alice);
    // If we get here without panic, the constructor works
}

#[tokio::test]
async fn test_multiple_handlers_same_channels() {
    let channels = Arc::new(Mutex::new(BTreeMap::new()));
    let choice_channels = Arc::new(Mutex::new(BTreeMap::new()));

    // Create two handlers for Alice (simulating reconnection scenario)
    let mut alice1 =
        InMemoryHandler::with_channels(TestRole::Alice, channels.clone(), choice_channels.clone());
    let mut bob =
        InMemoryHandler::with_channels(TestRole::Bob, channels.clone(), choice_channels.clone());

    // Alice1 sends
    alice1
        .send(&mut (), TestRole::Bob, &SimpleMessage { value: 42 })
        .await
        .unwrap();

    // Bob receives
    let received: SimpleMessage = bob.recv(&mut (), TestRole::Alice).await.unwrap();
    assert_eq!(received.value, 42);
}