mlua-isle 0.5.0

Thread-isolated Lua VM with cancellation, async coroutines, and connection pool for mlua
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
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
#![cfg(all(feature = "pool", feature = "tokio"))]

use mlua_isle::{AsyncIslePool, IsleError, PoolConfig, PoolStrategy};
use std::sync::Arc;
use std::time::Duration;
use tokio::time::Instant;

// ---------------------------------------------------------------------------
// Construction & validation
// ---------------------------------------------------------------------------

#[tokio::test]
async fn pool_new_with_valid_config() {
    let pool = AsyncIslePool::new(
        |lua| {
            lua.globals().set("x", 1)?;
            Ok(())
        },
        PoolConfig {
            max_size: 2,
            strategy: PoolStrategy::Cold,
        },
    )
    .unwrap();

    pool.shutdown().await;
}

#[tokio::test]
async fn pool_max_size_zero_returns_error() {
    let result = AsyncIslePool::new(
        |_lua| Ok(()),
        PoolConfig {
            max_size: 0,
            strategy: PoolStrategy::Cold,
        },
    );
    assert!(matches!(result, Err(IsleError::Init(_))));
}

// ---------------------------------------------------------------------------
// Cold strategy
// ---------------------------------------------------------------------------

#[tokio::test]
async fn cold_checkout_eval() {
    let pool = AsyncIslePool::new(
        |lua| {
            lua.globals().set("base", 10)?;
            Ok(())
        },
        PoolConfig {
            max_size: 2,
            strategy: PoolStrategy::Cold,
        },
    )
    .unwrap();

    let isle = pool.checkout().await.unwrap();
    let result = isle.eval("return base + 5").await.unwrap();
    assert_eq!(result, "15");
    drop(isle);

    pool.shutdown().await;
}

#[tokio::test]
async fn cold_does_not_preserve_state() {
    let pool = Arc::new(
        AsyncIslePool::new(
            |_lua| Ok(()),
            PoolConfig {
                max_size: 1,
                strategy: PoolStrategy::Cold,
            },
        )
        .unwrap(),
    );

    {
        let isle = pool.checkout().await.unwrap();
        isle.eval("my_global = 42").await.unwrap();
    }

    // Give the background driver shutdown task a chance to release the
    // active slot before retry-driven checkout.
    for _ in 0..50 {
        if pool.active() == 0 {
            break;
        }
        tokio::time::sleep(Duration::from_millis(10)).await;
    }

    {
        let isle = pool.checkout().await.unwrap();
        let result = isle.eval("return type(my_global)").await.unwrap();
        assert_eq!(result, "nil", "cold pool must not preserve state");
    }

    pool.shutdown().await;
}

// ---------------------------------------------------------------------------
// Warm strategy
// ---------------------------------------------------------------------------

#[tokio::test]
async fn warm_checkout_eval() {
    let pool = AsyncIslePool::new(
        |lua| {
            lua.globals().set("base", 10)?;
            Ok(())
        },
        PoolConfig {
            max_size: 2,
            strategy: PoolStrategy::Warm,
        },
    )
    .unwrap();

    let isle = pool.checkout().await.unwrap();
    let result = isle.eval("return base + 5").await.unwrap();
    assert_eq!(result, "15");
    drop(isle);

    pool.shutdown().await;
}

#[tokio::test]
async fn warm_preserves_state() {
    let pool = AsyncIslePool::new(
        |_lua| Ok(()),
        PoolConfig {
            max_size: 1,
            strategy: PoolStrategy::Warm,
        },
    )
    .unwrap();

    {
        let isle = pool.checkout().await.unwrap();
        isle.eval("my_global = 42").await.unwrap();
    }

    {
        let isle = pool.checkout().await.unwrap();
        let result = isle.eval("return my_global").await.unwrap();
        assert_eq!(result, "42", "warm pool must preserve state");
    }

    pool.shutdown().await;
}

// ---------------------------------------------------------------------------
// try_checkout
// ---------------------------------------------------------------------------

#[tokio::test]
async fn try_checkout_returns_none_when_exhausted() {
    let pool = AsyncIslePool::new(
        |_lua| Ok(()),
        PoolConfig {
            max_size: 1,
            strategy: PoolStrategy::Warm,
        },
    )
    .unwrap();

    let _isle = pool.checkout().await.unwrap();
    assert!(
        pool.try_checkout().await.unwrap().is_none(),
        "should return None when pool exhausted"
    );

    pool.shutdown().await;
}

#[tokio::test]
async fn try_checkout_succeeds_when_available() {
    let pool = AsyncIslePool::new(
        |_lua| Ok(()),
        PoolConfig {
            max_size: 2,
            strategy: PoolStrategy::Warm,
        },
    )
    .unwrap();

    let isle = pool.try_checkout().await.unwrap();
    assert!(isle.is_some(), "should return Some when available");
    let isle = isle.unwrap();
    assert_eq!(isle.eval("return 1").await.unwrap(), "1");
    drop(isle);

    pool.shutdown().await;
}

// ---------------------------------------------------------------------------
// checkout_timeout
// ---------------------------------------------------------------------------

#[tokio::test]
async fn checkout_timeout_returns_pool_exhausted() {
    let pool = AsyncIslePool::new(
        |_lua| Ok(()),
        PoolConfig {
            max_size: 1,
            strategy: PoolStrategy::Warm,
        },
    )
    .unwrap();

    let _isle = pool.checkout().await.unwrap();

    let result = pool.checkout_timeout(Duration::from_millis(50)).await;
    match result {
        Err(IsleError::PoolExhausted(1)) => {}
        other => panic!("expected PoolExhausted(1), got: {other:?}"),
    }

    pool.shutdown().await;
}

#[tokio::test]
async fn checkout_blocks_then_succeeds_after_return() {
    let pool = Arc::new(
        AsyncIslePool::new(
            |_lua| Ok(()),
            PoolConfig {
                max_size: 1,
                strategy: PoolStrategy::Warm,
            },
        )
        .unwrap(),
    );

    let isle = pool.checkout().await.unwrap();

    let pool_c = Arc::clone(&pool);
    let waiter = tokio::spawn(async move {
        let start = Instant::now();
        let isle = pool_c
            .checkout_timeout(Duration::from_secs(5))
            .await
            .unwrap();
        let elapsed = start.elapsed();
        let result = isle.eval("return 'waited'").await.unwrap();
        (result, elapsed)
    });

    tokio::time::sleep(Duration::from_millis(100)).await;
    drop(isle);

    let (result, elapsed) = waiter.await.unwrap();
    assert_eq!(result, "waited");
    assert!(
        elapsed >= Duration::from_millis(50),
        "should have waited: {elapsed:?}"
    );

    pool.shutdown().await;
}

// ---------------------------------------------------------------------------
// Concurrency: multiple tasks checking out simultaneously
// ---------------------------------------------------------------------------

#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
async fn concurrent_checkouts_all_succeed() {
    let pool = Arc::new(
        AsyncIslePool::new(
            |_lua| Ok(()),
            PoolConfig {
                max_size: 4,
                strategy: PoolStrategy::Warm,
            },
        )
        .unwrap(),
    );

    let mut handles = Vec::new();
    for i in 0..8 {
        let pool = Arc::clone(&pool);
        handles.push(tokio::spawn(async move {
            let isle = pool.checkout().await.unwrap();
            let code = format!("return {} * 2", i);
            let result = isle.eval(&code).await.unwrap();
            assert_eq!(result, (i * 2).to_string());
        }));
    }

    for h in handles {
        h.await.unwrap();
    }

    pool.shutdown().await;
}

// ---------------------------------------------------------------------------
// Coroutine through pooled isle
// ---------------------------------------------------------------------------

#[tokio::test]
async fn pooled_coroutine_eval() {
    let pool = AsyncIslePool::new(
        |_lua| Ok(()),
        PoolConfig {
            max_size: 1,
            strategy: PoolStrategy::Warm,
        },
    )
    .unwrap();

    let isle = pool.checkout().await.unwrap();
    let result = isle.coroutine_eval("return 1 + 2").await.unwrap();
    assert_eq!(result, "3");
    drop(isle);

    pool.shutdown().await;
}

// ---------------------------------------------------------------------------
// kill(): force-discard a poisoned isle
// ---------------------------------------------------------------------------

#[tokio::test]
async fn kill_discards_and_next_checkout_gets_fresh_isle() {
    let pool = AsyncIslePool::new(
        |_lua| Ok(()),
        PoolConfig {
            max_size: 1,
            strategy: PoolStrategy::Warm,
        },
    )
    .unwrap();

    {
        let mut isle = pool.checkout().await.unwrap();
        isle.eval("sentinel = 'old'").await.unwrap();
        isle.kill();
    }

    // Wait for background driver shutdown to free the active slot.
    for _ in 0..50 {
        if pool.active() == 0 {
            break;
        }
        tokio::time::sleep(Duration::from_millis(10)).await;
    }

    {
        let isle = pool.checkout().await.unwrap();
        let result = isle.eval("return type(sentinel)").await.unwrap();
        assert_eq!(
            result, "nil",
            "kill() must discard the isle; fresh checkout should have clean state"
        );
    }

    pool.shutdown().await;
}

// ---------------------------------------------------------------------------
// Shutdown behavior
// ---------------------------------------------------------------------------

#[tokio::test]
async fn checkout_after_shutdown_returns_error() {
    let pool = AsyncIslePool::new(
        |_lua| Ok(()),
        PoolConfig {
            max_size: 2,
            strategy: PoolStrategy::Warm,
        },
    )
    .unwrap();

    {
        let _isle = pool.checkout().await.unwrap();
    }

    pool.shutdown().await;

    let result = pool.checkout().await;
    assert!(
        matches!(result, Err(IsleError::Shutdown)),
        "checkout after shutdown must return Shutdown error, got: {result:?}"
    );
}

#[tokio::test]
async fn shutdown_cleans_up_idle_isles() {
    let pool = AsyncIslePool::new(
        |_lua| Ok(()),
        PoolConfig {
            max_size: 4,
            strategy: PoolStrategy::Warm,
        },
    )
    .unwrap();

    for _ in 0..3 {
        let isle = pool.checkout().await.unwrap();
        isle.eval("return 1").await.unwrap();
    }

    pool.shutdown().await;
    // Should not hang.
}

// ---------------------------------------------------------------------------
// Factory failure
// ---------------------------------------------------------------------------

#[tokio::test]
async fn factory_failure_returns_init_error() {
    let pool = AsyncIslePool::new(
        |_lua| Err(mlua::Error::runtime("factory exploded")),
        PoolConfig {
            max_size: 2,
            strategy: PoolStrategy::Cold,
        },
    )
    .unwrap();

    let result = pool.checkout().await;
    assert!(
        matches!(result, Err(IsleError::Init(_))),
        "factory failure should surface as Init error, got: {result:?}"
    );

    pool.shutdown().await;
}

// ---------------------------------------------------------------------------
// Pool metrics
// ---------------------------------------------------------------------------

#[tokio::test]
async fn pool_metrics_track_active_and_idle() {
    let pool = AsyncIslePool::new(
        |_lua| Ok(()),
        PoolConfig {
            max_size: 3,
            strategy: PoolStrategy::Warm,
        },
    )
    .unwrap();

    assert_eq!(pool.active(), 0);
    assert_eq!(pool.idle(), 0);

    let isle1 = pool.checkout().await.unwrap();
    assert_eq!(pool.active(), 1);
    assert_eq!(pool.idle(), 0);

    let isle2 = pool.checkout().await.unwrap();
    assert_eq!(pool.active(), 2);
    assert_eq!(pool.idle(), 0);

    drop(isle1);
    assert_eq!(pool.active(), 1);
    assert_eq!(pool.idle(), 1); // warm → returned to idle

    drop(isle2);
    assert_eq!(pool.active(), 0);
    assert_eq!(pool.idle(), 2);

    pool.shutdown().await;
}

// ---------------------------------------------------------------------------
// Scenario: VM isolation — distinct VMs do not share runtime state
// ---------------------------------------------------------------------------

/// With `max_size > 1` and `Warm`, two simultaneously-checked-out VMs
/// must have isolated globals.  Writes on one slot's `Isle` must not be
/// visible from the other slot's `Isle`, even after a warm round-trip.
#[tokio::test]
async fn scenario_vm_isolation_across_concurrent_checkouts() {
    let pool = AsyncIslePool::new(
        |_lua| Ok(()),
        PoolConfig {
            max_size: 2,
            strategy: PoolStrategy::Warm,
        },
    )
    .unwrap();

    let isle_a = pool.checkout().await.unwrap();
    let isle_b = pool.checkout().await.unwrap();

    isle_a.eval("tag = 'A'").await.unwrap();
    isle_b.eval("tag = 'B'").await.unwrap();

    assert_eq!(isle_a.eval("return tag").await.unwrap(), "A");
    assert_eq!(isle_b.eval("return tag").await.unwrap(), "B");

    drop(isle_a);
    drop(isle_b);

    // After warm return, each slot still carries its own tag.  The
    // exact checkout order is not guaranteed, so we collect both
    // observed tags into a set.
    let isle1 = pool.checkout().await.unwrap();
    let isle2 = pool.checkout().await.unwrap();
    let t1 = isle1.eval("return tag").await.unwrap();
    let t2 = isle2.eval("return tag").await.unwrap();
    let mut tags = [t1, t2];
    tags.sort();
    assert_eq!(
        tags,
        ["A".to_string(), "B".to_string()],
        "distinct warm slots must carry their own state"
    );

    drop(isle1);
    drop(isle2);
    pool.shutdown().await;
}

// ---------------------------------------------------------------------------
// Scenario: mixed sync + coroutine workload across the pool
// ---------------------------------------------------------------------------

/// Many tokio tasks checkout from a small pool and exercise both
/// `eval` (sync) and `coroutine_eval` (cooperative) paths.  All tasks
/// must complete and the pool must end with all slots idle.
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
async fn scenario_mixed_workload_eval_and_coroutine() {
    let pool = Arc::new(
        AsyncIslePool::new(
            |lua| {
                lua.load(
                    r#"
                    function double(x)
                        return tonumber(x) * 2
                    end
                    "#,
                )
                .exec()?;
                Ok(())
            },
            PoolConfig {
                max_size: 3,
                strategy: PoolStrategy::Warm,
            },
        )
        .unwrap(),
    );

    let mut handles = Vec::new();
    for i in 0..12 {
        let pool = Arc::clone(&pool);
        handles.push(tokio::spawn(async move {
            let isle = pool.checkout().await.unwrap();
            // Alternate: even → coroutine path, odd → sync path.
            if i % 2 == 0 {
                let code = format!("return {} + 100", i);
                let r = isle.coroutine_eval(&code).await.unwrap();
                assert_eq!(r, (i + 100).to_string());
            } else {
                let r = isle.call("double", &[&i.to_string()]).await.unwrap();
                assert_eq!(r, (i * 2).to_string());
            }
        }));
    }

    for h in handles {
        h.await.unwrap();
    }

    // All 12 tasks completed; pool must converge to active=0 with idle
    // bounded by max_size.
    assert_eq!(pool.active(), 0);
    assert!(pool.idle() <= 3);

    pool.shutdown().await;
}

// ---------------------------------------------------------------------------
// Scenario: lifecycle — kill mid-run, pool respawns, warm reuse resumes
// ---------------------------------------------------------------------------

/// A pool of size 1 with `Warm`: poison the VM, `kill()` it, observe the
/// next checkout get a fresh VM, then verify subsequent warm round-trips
/// preserve state on the new VM.
#[tokio::test]
async fn scenario_lifecycle_kill_then_warm_reuse() {
    let pool = AsyncIslePool::new(
        |lua| {
            lua.globals().set("base", 7)?;
            Ok(())
        },
        PoolConfig {
            max_size: 1,
            strategy: PoolStrategy::Warm,
        },
    )
    .unwrap();

    // Step 1: poison and kill.
    {
        let mut isle = pool.checkout().await.unwrap();
        isle.eval("scratch = 'dirty'").await.unwrap();
        isle.kill();
    }

    // Wait for the background driver shutdown to release the slot.
    for _ in 0..50 {
        if pool.active() == 0 {
            break;
        }
        tokio::time::sleep(Duration::from_millis(10)).await;
    }

    // Step 2: fresh VM — factory ran again (base=7), scratch is gone.
    {
        let isle = pool.checkout().await.unwrap();
        assert_eq!(isle.eval("return base").await.unwrap(), "7");
        assert_eq!(isle.eval("return type(scratch)").await.unwrap(), "nil");
        isle.eval("scratch = 'clean'").await.unwrap();
    }

    // Step 3: warm round-trip on the new VM preserves state.
    {
        let isle = pool.checkout().await.unwrap();
        assert_eq!(isle.eval("return scratch").await.unwrap(), "clean");
    }

    pool.shutdown().await;
}