lambda-simulator 0.1.5

High-fidelity AWS Lambda Runtime API simulator for testing Lambda runtimes and extensions locally
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
//! Tests for timing and timeout scenarios.
//!
//! These tests verify correct handling of:
//! - Extension readiness timeouts
//! - Invocation deadlines
//! - Overhead calculations

use lambda_simulator::{EventType, InvocationBuilder, Simulator};
use reqwest::Client;
use serde_json::json;
use std::time::Duration;

async fn register_extension(
    client: &Client,
    base_url: &str,
    name: &str,
    events: Vec<EventType>,
) -> String {
    let response = client
        .post(format!("{}/2020-01-01/extension/register", base_url))
        .header("Lambda-Extension-Name", name)
        .json(&json!({ "events": events }))
        .send()
        .await
        .unwrap();

    assert_eq!(response.status(), 200);

    response
        .headers()
        .get("Lambda-Extension-Identifier")
        .unwrap()
        .to_str()
        .unwrap()
        .to_string()
}

/// Some extensions ready, some timeout - partial readiness triggers timeout.
#[tokio::test]
async fn test_partial_extension_readiness_triggers_timeout() {
    let simulator = Simulator::builder()
        .extension_ready_timeout(Duration::from_millis(200))
        .build()
        .await
        .unwrap();

    let base_url = simulator.runtime_api_url();
    let client = Client::new();

    simulator.enable_telemetry_capture().await;

    let ext1_id = register_extension(
        &client,
        &base_url,
        "fast-extension",
        vec![EventType::Invoke],
    )
    .await;
    let _ext2_id = register_extension(
        &client,
        &base_url,
        "slow-extension",
        vec![EventType::Invoke],
    )
    .await;

    let invocation = InvocationBuilder::new()
        .payload(json!({"test": "partial_readiness"}))
        .build()
        .unwrap();

    let request_id = invocation.request_id.clone();
    simulator.enqueue(invocation).await;

    let _ = client
        .get(format!("{}/2018-06-01/runtime/invocation/next", base_url))
        .send()
        .await
        .unwrap();

    client
        .post(format!(
            "{}/2018-06-01/runtime/invocation/{}/response",
            base_url, request_id
        ))
        .json(&json!({"result": "ok"}))
        .send()
        .await
        .unwrap();

    client
        .get(format!("{}/2020-01-01/extension/event/next", base_url))
        .header("Lambda-Extension-Identifier", &ext1_id)
        .send()
        .await
        .unwrap();

    tokio::time::sleep(Duration::from_millis(50)).await;

    assert!(
        !simulator.are_extensions_ready(&request_id).await,
        "Should not be ready with only one of two extensions"
    );

    tokio::time::sleep(Duration::from_millis(200)).await;

    let report_events = simulator
        .get_telemetry_events_by_type("platform.report")
        .await;

    assert_eq!(
        report_events.len(),
        1,
        "platform.report should be emitted after timeout even with partial readiness"
    );

    simulator.shutdown().await;
}

/// Zero timeout configured causes immediate report emission.
#[tokio::test]
async fn test_zero_timeout_emits_immediate_report() {
    let simulator = Simulator::builder()
        .extension_ready_timeout(Duration::ZERO)
        .build()
        .await
        .unwrap();

    let base_url = simulator.runtime_api_url();
    let client = Client::new();

    simulator.enable_telemetry_capture().await;

    let _ext_id =
        register_extension(&client, &base_url, "extension", vec![EventType::Invoke]).await;

    let invocation = InvocationBuilder::new()
        .payload(json!({"test": "zero_timeout"}))
        .build()
        .unwrap();

    let request_id = invocation.request_id.clone();
    simulator.enqueue(invocation).await;

    let _ = client
        .get(format!("{}/2018-06-01/runtime/invocation/next", base_url))
        .send()
        .await
        .unwrap();

    client
        .post(format!(
            "{}/2018-06-01/runtime/invocation/{}/response",
            base_url, request_id
        ))
        .json(&json!({"result": "ok"}))
        .send()
        .await
        .unwrap();

    tokio::time::sleep(Duration::from_millis(50)).await;

    let report_events = simulator
        .get_telemetry_events_by_type("platform.report")
        .await;

    assert_eq!(
        report_events.len(),
        1,
        "platform.report should be emitted immediately with zero timeout"
    );

    simulator.shutdown().await;
}

/// Actual wait matches the configured timeout duration.
/// We verify by checking the platform.report metrics show appropriate duration.
#[tokio::test]
async fn test_timeout_duration_accuracy() {
    let timeout_ms = 200u64;
    let simulator = Simulator::builder()
        .extension_ready_timeout(Duration::from_millis(timeout_ms))
        .build()
        .await
        .unwrap();

    let base_url = simulator.runtime_api_url();
    let client = Client::new();

    simulator.enable_telemetry_capture().await;

    let _ext_id = register_extension(
        &client,
        &base_url,
        "slow-extension",
        vec![EventType::Invoke],
    )
    .await;

    let invocation = InvocationBuilder::new()
        .payload(json!({"test": "timeout_accuracy"}))
        .build()
        .unwrap();

    let request_id = invocation.request_id.clone();
    simulator.enqueue(invocation).await;

    let _ = client
        .get(format!("{}/2018-06-01/runtime/invocation/next", base_url))
        .send()
        .await
        .unwrap();

    let response_time = std::time::Instant::now();

    client
        .post(format!(
            "{}/2018-06-01/runtime/invocation/{}/response",
            base_url, request_id
        ))
        .json(&json!({"result": "ok"}))
        .send()
        .await
        .unwrap();

    tokio::time::sleep(Duration::from_millis(timeout_ms + 100)).await;

    let elapsed = response_time.elapsed();

    let report_events = simulator
        .get_telemetry_events_by_type("platform.report")
        .await;

    assert_eq!(
        report_events.len(),
        1,
        "platform.report should be emitted after timeout expires"
    );

    assert!(
        elapsed.as_millis() >= timeout_ms as u128,
        "Should have waited at least the timeout duration (waited {}ms, timeout {}ms)",
        elapsed.as_millis(),
        timeout_ms
    );

    assert!(
        elapsed.as_millis() < timeout_ms as u128 + 150,
        "Should not have waited much longer than the timeout (waited {}ms, timeout {}ms)",
        elapsed.as_millis(),
        timeout_ms
    );

    simulator.shutdown().await;
}

/// Extension overhead reflects timeout when extension doesn't respond.
/// When the timeout expires, the overhead should approximately equal the timeout value.
/// We verify this through the platform.report telemetry event.
#[tokio::test]
async fn test_extension_overhead_reflects_timeout() {
    let timeout_ms = 150u64;
    let simulator = Simulator::builder()
        .extension_ready_timeout(Duration::from_millis(timeout_ms))
        .build()
        .await
        .unwrap();

    let base_url = simulator.runtime_api_url();
    let client = Client::new();

    simulator.enable_telemetry_capture().await;

    let _ext_id = register_extension(
        &client,
        &base_url,
        "unresponsive-ext",
        vec![EventType::Invoke],
    )
    .await;

    let invocation = InvocationBuilder::new()
        .payload(json!({"test": "overhead_timeout"}))
        .build()
        .unwrap();

    let request_id = invocation.request_id.clone();
    simulator.enqueue(invocation).await;

    let _ = client
        .get(format!("{}/2018-06-01/runtime/invocation/next", base_url))
        .send()
        .await
        .unwrap();

    client
        .post(format!(
            "{}/2018-06-01/runtime/invocation/{}/response",
            base_url, request_id
        ))
        .json(&json!({"result": "ok"}))
        .send()
        .await
        .unwrap();

    tokio::time::sleep(Duration::from_millis(timeout_ms + 100)).await;

    let report_events = simulator
        .get_telemetry_events_by_type("platform.report")
        .await;

    assert_eq!(
        report_events.len(),
        1,
        "platform.report should be emitted after timeout"
    );

    let report = &report_events[0];
    let duration_ms = report.record["metrics"]["durationMs"]
        .as_f64()
        .expect("durationMs should be present");

    assert!(
        duration_ms >= timeout_ms as f64 * 0.8,
        "Duration ({:.2}ms) should reflect the timeout wait ({}ms)",
        duration_ms,
        timeout_ms
    );

    simulator.shutdown().await;
}

/// Deadline header is correctly calculated.
#[tokio::test]
async fn test_deadline_header_calculated_correctly() {
    let timeout_ms = 5000u64;
    let simulator = Simulator::builder()
        .function_name("deadline-test")
        .build()
        .await
        .unwrap();

    let base_url = simulator.runtime_api_url();
    let client = Client::new();

    let invocation = InvocationBuilder::new()
        .payload(json!({"test": "deadline"}))
        .timeout_ms(timeout_ms)
        .build()
        .unwrap();

    let created_at = invocation.created_at;
    let expected_deadline_ms = invocation.deadline_ms();

    simulator.enqueue(invocation).await;

    let response = client
        .get(format!("{}/2018-06-01/runtime/invocation/next", base_url))
        .send()
        .await
        .unwrap();

    let deadline_header = response
        .headers()
        .get("Lambda-Runtime-Deadline-Ms")
        .expect("Lambda-Runtime-Deadline-Ms header should be present")
        .to_str()
        .unwrap();

    let deadline_ms: i64 = deadline_header
        .parse()
        .expect("Deadline should be a valid integer");

    assert_eq!(
        deadline_ms, expected_deadline_ms,
        "Deadline header should match invocation deadline"
    );

    let created_ms = created_at.timestamp_millis();
    let delta = deadline_ms - created_ms;

    assert!(
        (delta - timeout_ms as i64).abs() < 10,
        "Deadline should be created_at + timeout_ms (got delta={}ms, expected {}ms)",
        delta,
        timeout_ms
    );

    simulator.shutdown().await;
}

/// Invocation timeout status when deadline is exceeded.
/// Note: Full timeout enforcement may not be implemented, but we test the structure.
#[tokio::test]
async fn test_invocation_timeout_status() {
    let simulator = Simulator::builder()
        .function_name("timeout-status-test")
        .build()
        .await
        .unwrap();

    let base_url = simulator.runtime_api_url();
    let client = Client::new();

    let invocation = InvocationBuilder::new()
        .payload(json!({"test": "timeout_status"}))
        .timeout_ms(100)
        .build()
        .unwrap();

    let request_id = invocation.request_id.clone();
    simulator.enqueue(invocation).await;

    let response = client
        .get(format!("{}/2018-06-01/runtime/invocation/next", base_url))
        .send()
        .await
        .unwrap();

    assert_eq!(response.status(), 200);

    let deadline_header = response
        .headers()
        .get("Lambda-Runtime-Deadline-Ms")
        .unwrap()
        .to_str()
        .unwrap();

    let deadline_ms: i64 = deadline_header.parse().unwrap();
    let now_ms = chrono::Utc::now().timestamp_millis();

    assert!(
        deadline_ms > now_ms - 200,
        "Deadline should be in the recent past or future (deadline={}, now={})",
        deadline_ms,
        now_ms
    );

    client
        .post(format!(
            "{}/2018-06-01/runtime/invocation/{}/response",
            base_url, request_id
        ))
        .json(&json!({"result": "late_but_accepted"}))
        .send()
        .await
        .unwrap();

    simulator.shutdown().await;
}

/// Extension overhead can extend beyond invocation deadline.
/// The invocation is still Success if runtime responded in time, even if
/// extension processing takes longer than the deadline.
#[tokio::test]
async fn test_extension_overhead_can_exceed_deadline() {
    let simulator = Simulator::builder()
        .function_name("overhead-beyond-deadline")
        .extension_ready_timeout(Duration::from_millis(500))
        .build()
        .await
        .unwrap();

    let base_url = simulator.runtime_api_url();
    let client = Client::new();

    simulator.enable_telemetry_capture().await;

    let ext_id = register_extension(
        &client,
        &base_url,
        "slow-processor",
        vec![EventType::Invoke],
    )
    .await;

    let invocation = InvocationBuilder::new()
        .payload(json!({"test": "overhead_beyond"}))
        .timeout_ms(100)
        .build()
        .unwrap();

    let request_id = invocation.request_id.clone();
    simulator.enqueue(invocation).await;

    let _ = client
        .get(format!("{}/2018-06-01/runtime/invocation/next", base_url))
        .send()
        .await
        .unwrap();

    client
        .post(format!(
            "{}/2018-06-01/runtime/invocation/{}/response",
            base_url, request_id
        ))
        .json(&json!({"result": "quick_response"}))
        .send()
        .await
        .unwrap();

    tokio::time::sleep(Duration::from_millis(200)).await;

    client
        .get(format!("{}/2020-01-01/extension/event/next", base_url))
        .header("Lambda-Extension-Identifier", &ext_id)
        .send()
        .await
        .unwrap();

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

    let state = simulator
        .get_invocation_state(&request_id)
        .await
        .expect("Should have invocation state");

    assert_eq!(
        state.status,
        lambda_simulator::InvocationStatus::Success,
        "Status should be Success since runtime responded before deadline"
    );

    let report_events = simulator
        .get_telemetry_events_by_type("platform.report")
        .await;

    assert_eq!(report_events.len(), 1, "Should have platform.report");

    let report = &report_events[0];
    assert_eq!(
        report.record["status"],
        json!("success"),
        "Report should show success status"
    );

    let duration_ms = report.record["metrics"]["durationMs"]
        .as_f64()
        .expect("durationMs should be present");

    assert!(
        duration_ms >= 150.0,
        "Duration ({:.2}ms) should reflect the extension processing delay",
        duration_ms
    );

    simulator.shutdown().await;
}

/// Additional test: Verify extension overhead is minimal when extension responds immediately.
#[tokio::test]
async fn test_extension_overhead_minimal_when_fast() {
    let simulator = Simulator::builder()
        .extension_ready_timeout(Duration::from_secs(5))
        .build()
        .await
        .unwrap();

    let base_url = simulator.runtime_api_url();
    let client = Client::new();

    simulator.enable_telemetry_capture().await;

    let ext_id = register_extension(
        &client,
        &base_url,
        "fast-extension",
        vec![EventType::Invoke],
    )
    .await;

    let invocation = InvocationBuilder::new()
        .payload(json!({"test": "fast_overhead"}))
        .build()
        .unwrap();

    let request_id = invocation.request_id.clone();
    simulator.enqueue(invocation).await;

    let _ = client
        .get(format!("{}/2018-06-01/runtime/invocation/next", base_url))
        .send()
        .await
        .unwrap();

    client
        .post(format!(
            "{}/2018-06-01/runtime/invocation/{}/response",
            base_url, request_id
        ))
        .json(&json!({"result": "ok"}))
        .send()
        .await
        .unwrap();

    client
        .get(format!("{}/2020-01-01/extension/event/next", base_url))
        .header("Lambda-Extension-Identifier", &ext_id)
        .send()
        .await
        .unwrap();

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

    let report_events = simulator
        .get_telemetry_events_by_type("platform.report")
        .await;

    assert_eq!(report_events.len(), 1, "Should have platform.report");

    let report = &report_events[0];
    let duration_ms = report.record["metrics"]["durationMs"]
        .as_f64()
        .expect("durationMs should be present");

    assert!(
        duration_ms < 1000.0,
        "Duration ({:.2}ms) should be small when extension responds quickly",
        duration_ms
    );

    simulator.shutdown().await;
}