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
//! Integration tests for extension readiness tracking.
//!
//! These tests verify that the Lambda lifecycle is correctly simulated:
//! 1. Extensions receive INVOKE events
//! 2. Runtime processes and responds
//! 3. Extensions do post-invocation work
//! 4. Extensions poll /next to signal readiness
//! 5. platform.report is emitted after all extensions are ready
//! 6. Process freezes after platform.report

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

/// Helper to register an extension.
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()
}

#[tokio::test]
async fn test_extension_readiness_with_single_extension() {
    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 extension_id = register_extension(
        &client,
        &base_url,
        "test-extension",
        vec![EventType::Invoke],
    )
    .await;

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

    simulator.enqueue(invocation).await;

    assert!(
        !simulator.are_extensions_ready(&request_id).await,
        "Extensions should not be ready before runtime responds"
    );

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

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

    assert!(
        !simulator.are_extensions_ready(&request_id).await,
        "Extensions should not be ready before polling /next"
    );

    let report_events_before = simulator
        .get_telemetry_events_by_type("platform.report")
        .await;
    assert!(
        report_events_before.is_empty(),
        "platform.report should not be emitted before extensions are ready"
    );

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

    simulator
        .wait_for_extensions_ready(&request_id, Duration::from_secs(5))
        .await
        .expect("Extensions should become ready after polling /next");

    simulator
        .wait_for(
            || async {
                !simulator
                    .get_telemetry_events_by_type("platform.report")
                    .await
                    .is_empty()
            },
            Duration::from_secs(5),
        )
        .await
        .expect("platform.report should be emitted after extensions are ready");

    let report_events = simulator
        .get_telemetry_events_by_type("platform.report")
        .await;
    assert_eq!(
        report_events.len(),
        1,
        "platform.report should be emitted after extensions are ready"
    );

    simulator.shutdown().await;
}

#[tokio::test]
async fn test_extension_readiness_with_multiple_extensions() {
    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 ext1_id =
        register_extension(&client, &base_url, "extension-1", vec![EventType::Invoke]).await;
    let ext2_id =
        register_extension(&client, &base_url, "extension-2", vec![EventType::Invoke]).await;

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

    simulator.enqueue(invocation).await;

    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();

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

    let report_events = simulator
        .get_telemetry_events_by_type("platform.report")
        .await;
    assert!(
        report_events.is_empty(),
        "platform.report should not be emitted with only partial readiness"
    );

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

    simulator
        .wait_for_extensions_ready(&request_id, Duration::from_secs(5))
        .await
        .expect("Should be ready after all extensions poll /next");

    simulator
        .wait_for(
            || async {
                !simulator
                    .get_telemetry_events_by_type("platform.report")
                    .await
                    .is_empty()
            },
            Duration::from_secs(5),
        )
        .await
        .expect("platform.report should be emitted after all extensions are ready");

    let report_events = simulator
        .get_telemetry_events_by_type("platform.report")
        .await;
    assert_eq!(
        report_events.len(),
        1,
        "platform.report should be emitted after all extensions are ready"
    );

    simulator.shutdown().await;
}

#[tokio::test]
async fn test_extension_readiness_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;

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

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

    simulator.enqueue(invocation).await;

    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();

    simulator
        .wait_for(
            || async {
                !simulator
                    .get_telemetry_events_by_type("platform.report")
                    .await
                    .is_empty()
            },
            Duration::from_secs(5),
        )
        .await
        .expect("platform.report should be emitted after timeout even without extension readiness");

    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 without extension readiness"
    );

    simulator.shutdown().await;
}

#[tokio::test]
async fn test_no_invoke_extensions_immediate_report() {
    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;

    register_extension(
        &client,
        &base_url,
        "shutdown-only",
        vec![EventType::Shutdown],
    )
    .await;

    let invocation = InvocationBuilder::new()
        .payload(json!({"test": "no-invoke"}))
        .build()
        .unwrap();
    let request_id = invocation.request_id.clone();

    simulator.enqueue(invocation).await;

    assert!(
        simulator.are_extensions_ready(&request_id).await,
        "Should be immediately ready when no extensions subscribe to INVOKE"
    );

    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();

    simulator
        .wait_for(
            || async {
                !simulator
                    .get_telemetry_events_by_type("platform.report")
                    .await
                    .is_empty()
            },
            Duration::from_secs(5),
        )
        .await
        .expect("platform.report should be emitted immediately with no INVOKE subscribers");

    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 no INVOKE subscribers"
    );

    simulator.shutdown().await;
}

#[tokio::test]
async fn test_wait_for_extensions_ready_helper() {
    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 extension_id =
        register_extension(&client, &base_url, "wait-test", vec![EventType::Invoke]).await;

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

    simulator.enqueue(invocation).await;

    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();

    let wait_result = tokio::time::timeout(
        Duration::from_millis(100),
        simulator.wait_for_extensions_ready(&request_id, Duration::from_secs(5)),
    )
    .await;

    assert!(
        wait_result.is_err(),
        "wait_for_extensions_ready should not complete before extension polls"
    );

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

    simulator
        .wait_for_extensions_ready(&request_id, Duration::from_secs(5))
        .await
        .expect("wait_for_extensions_ready should complete after extension polls");

    simulator
        .wait_for(
            || async {
                !simulator
                    .get_telemetry_events_by_type("platform.report")
                    .await
                    .is_empty()
            },
            Duration::from_secs(5),
        )
        .await
        .expect("platform.report should be emitted");

    let report_events = simulator
        .get_telemetry_events_by_type("platform.report")
        .await;
    assert_eq!(report_events.len(), 1, "platform.report should be emitted");

    simulator.shutdown().await;
}