esi 0.7.0

A streaming parser and executor for Edge Side Includes
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
//! Tests for DCA (Dynamic Content Assembly) configuration features:
//! - `default_dca`: global default DCA mode
//! - `max_include_depth`: nesting depth limit
//! - `Edge-Control` header parsing (via `enable_edge_control`)
//! - `inherit_parent_dca`: subtree DCA inheritance

use esi::{Configuration, DcaMode, Processor};
use fastly::{Request, Response};
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;

// ---------------------------------------------------------------------------
// Helper: run ESI processing with a config + dispatcher, return output string
// ---------------------------------------------------------------------------

fn run<F>(input: &str, config: Configuration, dispatcher: &F) -> esi::Result<String>
where
    F: Fn(Request, Option<u32>) -> esi::Result<esi::PendingFragmentContent> + 'static,
{
    let reader = std::io::BufReader::new(std::io::Cursor::new(input.as_bytes()));
    let mut output = Vec::new();
    let mut processor = Processor::new(None, config);
    processor.process_stream(
        reader,
        &mut output,
        Some(
            dispatcher as &dyn Fn(Request, Option<u32>) -> esi::Result<esi::PendingFragmentContent>,
        ),
        None,
    )?;
    Ok(String::from_utf8(output).unwrap())
}

fn static_body(
    body: &'static str,
) -> impl Fn(Request, Option<u32>) -> esi::Result<esi::PendingFragmentContent> {
    move |_req, _maxwait| {
        Ok(esi::PendingFragmentContent::CompletedRequest(Box::new(
            Response::from_body(body),
        )))
    }
}

fn with_edge_control(
    body: &'static str,
    header: &'static str,
) -> impl Fn(Request, Option<u32>) -> esi::Result<esi::PendingFragmentContent> {
    move |_req, _maxwait| {
        let mut resp = Response::from_body(body);
        resp.set_header("Edge-Control", header);
        Ok(esi::PendingFragmentContent::CompletedRequest(Box::new(
            resp,
        )))
    }
}

// ===========================================================================
// 1. default_dca tests
// ===========================================================================

/// With default_dca=None (the default), include without dca attr inserts raw content.
#[test]
fn test_default_dca_none_includes_raw() -> esi::Result<()> {
    let d = static_body(r#"<esi:assign name="x" value="1"/><esi:vars>$(x)</esi:vars>"#);
    let result = run(
        r#"<esi:include src="http://example.com/frag"/>"#,
        Configuration::default(),
        &d,
    )?;
    assert_eq!(
        result,
        r#"<esi:assign name="x" value="1"/><esi:vars>$(x)</esi:vars>"#
    );
    Ok(())
}

/// With default_dca=Esi, include without dca attr processes content as ESI.
#[test]
fn test_default_dca_esi_processes_content() -> esi::Result<()> {
    let d = static_body(r#"<esi:assign name="x" value="42"/><esi:vars>X is $(x)</esi:vars>"#);
    let result = run(
        r#"<esi:include src="http://example.com/frag"/>"#,
        Configuration::default().with_default_dca(DcaMode::Esi),
        &d,
    )?;
    assert_eq!(result, "X is 42");
    Ok(())
}

/// Explicit dca="none" on tag overrides default_dca=Esi.
#[test]
fn test_explicit_dca_none_overrides_default_esi() -> esi::Result<()> {
    let d = static_body(r#"<esi:assign name="x" value="1"/><esi:vars>$(x)</esi:vars>"#);
    let result = run(
        r#"<esi:include src="http://example.com/frag" dca="none"/>"#,
        Configuration::default().with_default_dca(DcaMode::Esi),
        &d,
    )?;
    assert_eq!(
        result,
        r#"<esi:assign name="x" value="1"/><esi:vars>$(x)</esi:vars>"#
    );
    Ok(())
}

/// Explicit dca="esi" on tag overrides default_dca=None.
#[test]
fn test_explicit_dca_esi_overrides_default_none() -> esi::Result<()> {
    let d = static_body(r#"<esi:assign name="y" value="99"/><esi:vars>Y is $(y)</esi:vars>"#);
    let result = run(
        r#"<esi:include src="http://example.com/frag" dca="esi"/>"#,
        Configuration::default(),
        &d,
    )?;
    assert_eq!(result, "Y is 99");
    Ok(())
}

// ===========================================================================
// 2. max_include_depth tests
// ===========================================================================

/// Include at depth exactly at the limit is silently omitted.
#[test]
fn test_max_include_depth_omits_at_limit() -> esi::Result<()> {
    let d = static_body(r#"L0[<esi:include src="http://example.com/level1" dca="esi"/>]"#);
    let result = run(
        r#"Before<esi:include src="http://example.com/level0" dca="esi"/>After"#,
        Configuration::default().with_max_include_depth(1),
        &d,
    )?;
    // level0 processed (depth 0 < 1), level1 omitted (depth 1 >= 1)
    assert_eq!(result, "BeforeL0[]After");
    Ok(())
}

/// Include within depth limit is processed normally.
#[test]
fn test_max_include_depth_allows_within_limit() -> esi::Result<()> {
    let d = static_body("inner");
    let result = run(
        r#"<esi:include src="http://example.com/frag" dca="esi"/>"#,
        Configuration::default().with_max_include_depth(5),
        &d,
    )?;
    assert_eq!(result, "inner");
    Ok(())
}

/// Eval with dca="esi" at depth limit is omitted.
#[test]
fn test_max_include_depth_eval_dca_esi_omitted() -> esi::Result<()> {
    let d = static_body(r#"E0[<esi:eval src="http://example.com/e1" dca="esi"/>]"#);
    let result = run(
        r#"Before<esi:eval src="http://example.com/e0" dca="esi"/>After"#,
        Configuration::default().with_max_include_depth(1),
        &d,
    )?;
    assert_eq!(result, "BeforeE0[]After");
    Ok(())
}

/// Eval with dca="none" at depth limit is also omitted.
#[test]
fn test_max_include_depth_eval_dca_none_omitted() -> esi::Result<()> {
    let d = static_body(r#"E0[<esi:eval src="http://example.com/e1" dca="none"/>]"#);
    let result = run(
        r#"Before<esi:eval src="http://example.com/e0" dca="none"/>After"#,
        Configuration::default().with_max_include_depth(1),
        &d,
    )?;
    assert_eq!(result, "BeforeE0[]After");
    Ok(())
}

/// Default depth limit of 15.
#[test]
fn test_max_include_depth_default_is_15() {
    assert_eq!(Configuration::default().max_include_depth, 15);
}

// ===========================================================================
// 3. Edge-Control header tests
// ===========================================================================

/// Edge-Control: dca=esi causes fragment to be ESI-processed (when enabled).
#[test]
fn test_edge_control_dca_esi() -> esi::Result<()> {
    let d = with_edge_control(
        r#"<esi:assign name="v" value="42"/><esi:vars>$(v)</esi:vars>"#,
        "dca=esi",
    );
    let result = run(
        r#"<esi:include src="http://example.com/frag"/>"#,
        Configuration::default().with_edge_control(true),
        &d,
    )?;
    assert_eq!(result, "42");
    Ok(())
}

/// Edge-Control: dca=noop causes fragment to be inserted raw.
#[test]
fn test_edge_control_dca_noop() -> esi::Result<()> {
    let d = with_edge_control(r#"<esi:vars>raw</esi:vars>"#, "dca=noop");
    let result = run(
        r#"<esi:include src="http://example.com/frag"/>"#,
        Configuration::default()
            .with_edge_control(true)
            .with_default_dca(DcaMode::Esi),
        &d,
    )?;
    assert_eq!(result, "<esi:vars>raw</esi:vars>");
    Ok(())
}

/// Edge-Control header is ignored when enable_edge_control is false.
#[test]
fn test_edge_control_ignored_when_disabled() -> esi::Result<()> {
    let d = with_edge_control(
        r#"<esi:assign name="v" value="1"/><esi:vars>$(v)</esi:vars>"#,
        "dca=esi",
    );
    let result = run(
        r#"<esi:include src="http://example.com/frag"/>"#,
        Configuration::default(), // enable_edge_control=false, default_dca=None
        &d,
    )?;
    assert_eq!(
        result,
        r#"<esi:assign name="v" value="1"/><esi:vars>$(v)</esi:vars>"#
    );
    Ok(())
}

/// Explicit tag dca="none" beats Edge-Control: dca=esi.
#[test]
fn test_tag_dca_beats_edge_control() -> esi::Result<()> {
    let d = with_edge_control(r#"<esi:vars>should be raw</esi:vars>"#, "dca=esi");
    let result = run(
        r#"<esi:include src="http://example.com/frag" dca="none"/>"#,
        Configuration::default().with_edge_control(true),
        &d,
    )?;
    assert_eq!(result, "<esi:vars>should be raw</esi:vars>");
    Ok(())
}

/// Edge-Control with dca= alongside other directives.
#[test]
fn test_edge_control_mixed_directives() -> esi::Result<()> {
    let d = with_edge_control(
        r#"<esi:assign name="z" value="7"/><esi:vars>$(z)</esi:vars>"#,
        "no-store, dca=esi",
    );
    let result = run(
        r#"<esi:include src="http://example.com/frag"/>"#,
        Configuration::default().with_edge_control(true),
        &d,
    )?;
    assert_eq!(result, "7");
    Ok(())
}

/// Edge-Control with unrecognised dca value falls through to default.
#[test]
fn test_edge_control_unknown_dca_value() -> esi::Result<()> {
    let d = with_edge_control(r#"<esi:vars>raw</esi:vars>"#, "dca=xslt");
    let result = run(
        r#"<esi:include src="http://example.com/frag"/>"#,
        Configuration::default()
            .with_edge_control(true)
            .with_default_dca(DcaMode::None),
        &d,
    )?;
    assert_eq!(result, "<esi:vars>raw</esi:vars>");
    Ok(())
}

/// Edge-Control without dca= directive falls through to default.
#[test]
fn test_edge_control_no_dca_directive() -> esi::Result<()> {
    let d = with_edge_control(r#"<esi:vars>raw</esi:vars>"#, "no-store");
    let result = run(
        r#"<esi:include src="http://example.com/frag"/>"#,
        Configuration::default()
            .with_edge_control(true)
            .with_default_dca(DcaMode::None),
        &d,
    )?;
    assert_eq!(result, "<esi:vars>raw</esi:vars>");
    Ok(())
}

/// Edge-Control beats default_dca (header > config default).
#[test]
fn test_edge_control_beats_default_dca() -> esi::Result<()> {
    let d = with_edge_control(r#"<esi:vars>raw</esi:vars>"#, "dca=noop");
    let result = run(
        r#"<esi:include src="http://example.com/frag"/>"#,
        Configuration::default()
            .with_edge_control(true)
            .with_default_dca(DcaMode::Esi),
        &d,
    )?;
    assert_eq!(result, "<esi:vars>raw</esi:vars>");
    Ok(())
}

// ===========================================================================
// 4. inherit_parent_dca tests
// ===========================================================================

/// Inheritance off + default=None: child inside dca=esi parent is NOT ESI-processed.
#[test]
fn test_inherit_off_child_uses_default() -> esi::Result<()> {
    let call_count = Arc::new(AtomicUsize::new(0));
    let cc = call_count.clone();
    let d =
        move |_req: Request, _maxwait: Option<u32>| -> esi::Result<esi::PendingFragmentContent> {
            let n = cc.fetch_add(1, Ordering::SeqCst);
            let body = if n == 0 {
                r#"OUTER[<esi:include src="http://example.com/child"/>]"#
            } else {
                r#"<esi:vars>INNER</esi:vars>"#
            };
            Ok(esi::PendingFragmentContent::CompletedRequest(Box::new(
                Response::from_body(body),
            )))
        };
    let result = run(
        r#"<esi:include src="http://example.com/frag0" dca="esi"/>"#,
        Configuration::default(), // inherit=false, default=None
        &d,
    )?;
    assert_eq!(result, "OUTER[<esi:vars>INNER</esi:vars>]");
    Ok(())
}

/// Inheritance on + default=None: child inside dca=esi parent IS ESI-processed.
#[test]
fn test_inherit_on_child_inherits_esi() -> esi::Result<()> {
    let call_count = Arc::new(AtomicUsize::new(0));
    let cc = call_count.clone();
    let d =
        move |_req: Request, _maxwait: Option<u32>| -> esi::Result<esi::PendingFragmentContent> {
            let n = cc.fetch_add(1, Ordering::SeqCst);
            let body = if n == 0 {
                r#"OUTER[<esi:include src="http://example.com/child"/>]"#
            } else {
                r#"<esi:assign name="v" value="42"/><esi:vars>$(v)</esi:vars>"#
            };
            Ok(esi::PendingFragmentContent::CompletedRequest(Box::new(
                Response::from_body(body),
            )))
        };
    let result = run(
        r#"<esi:include src="http://example.com/frag0" dca="esi"/>"#,
        Configuration::default().with_inherit_parent_dca(true),
        &d,
    )?;
    assert_eq!(result, "OUTER[42]");
    Ok(())
}

/// Inheritance on: top-level include (depth=0) falls to default, not Esi.
#[test]
fn test_inherit_on_top_level_uses_default() -> esi::Result<()> {
    let d = static_body(r#"<esi:vars>raw</esi:vars>"#);
    let result = run(
        r#"<esi:include src="http://example.com/frag"/>"#,
        Configuration::default().with_inherit_parent_dca(true),
        &d,
    )?;
    assert_eq!(result, "<esi:vars>raw</esi:vars>");
    Ok(())
}

/// Inheritance on + explicit dca="none" on child → still None (tag wins).
#[test]
fn test_inherit_on_explicit_dca_none_wins() -> esi::Result<()> {
    let call_count = Arc::new(AtomicUsize::new(0));
    let cc = call_count.clone();
    let d =
        move |_req: Request, _maxwait: Option<u32>| -> esi::Result<esi::PendingFragmentContent> {
            let n = cc.fetch_add(1, Ordering::SeqCst);
            let body = if n == 0 {
                r#"OUTER[<esi:include src="http://example.com/child" dca="none"/>]"#
            } else {
                r#"<esi:vars>INNER</esi:vars>"#
            };
            Ok(esi::PendingFragmentContent::CompletedRequest(Box::new(
                Response::from_body(body),
            )))
        };
    let result = run(
        r#"<esi:include src="http://example.com/frag0" dca="esi"/>"#,
        Configuration::default().with_inherit_parent_dca(true),
        &d,
    )?;
    assert_eq!(result, "OUTER[<esi:vars>INNER</esi:vars>]");
    Ok(())
}

/// Inheritance on + Edge-Control dca=noop on child → still None (header beats inheritance).
#[test]
fn test_inherit_on_edge_control_beats_inheritance() -> esi::Result<()> {
    let call_count = Arc::new(AtomicUsize::new(0));
    let cc = call_count.clone();
    let d =
        move |_req: Request, _maxwait: Option<u32>| -> esi::Result<esi::PendingFragmentContent> {
            let n = cc.fetch_add(1, Ordering::SeqCst);
            if n == 0 {
                Ok(esi::PendingFragmentContent::CompletedRequest(Box::new(
                    Response::from_body(r#"OUTER[<esi:include src="http://example.com/child"/>]"#),
                )))
            } else {
                let mut resp = Response::from_body(r#"<esi:vars>INNER</esi:vars>"#);
                resp.set_header("Edge-Control", "dca=noop");
                Ok(esi::PendingFragmentContent::CompletedRequest(Box::new(
                    resp,
                )))
            }
        };
    let result = run(
        r#"<esi:include src="http://example.com/frag0" dca="esi"/>"#,
        Configuration::default()
            .with_edge_control(true)
            .with_inherit_parent_dca(true),
        &d,
    )?;
    assert_eq!(result, "OUTER[<esi:vars>INNER</esi:vars>]");
    Ok(())
}

/// Inheritance on + mixed subtrees: only the dca=esi subtree inherits.
#[test]
fn test_inherit_on_mixed_subtrees() -> esi::Result<()> {
    let call_count = Arc::new(AtomicUsize::new(0));
    let cc = call_count.clone();
    let d =
        move |_req: Request, _maxwait: Option<u32>| -> esi::Result<esi::PendingFragmentContent> {
            let n = cc.fetch_add(1, Ordering::SeqCst);
            let body = match n {
                0 => r#"A[<esi:include src="http://example.com/A1"/>]"#,
                1 => r#"<esi:assign name="v" value="1"/><esi:vars>$(v)</esi:vars>"#,
                2 => r#"<esi:vars>RAW</esi:vars>"#,
                _ => "unexpected",
            };
            Ok(esi::PendingFragmentContent::CompletedRequest(Box::new(
                Response::from_body(body),
            )))
        };
    let result = run(
        r#"<esi:include src="http://example.com/A" dca="esi"/><esi:include src="http://example.com/C"/>"#,
        Configuration::default().with_inherit_parent_dca(true),
        &d,
    )?;
    // A's child inherits ESI, C is raw (top-level, default=None)
    assert_eq!(result, "A[1]<esi:vars>RAW</esi:vars>");
    Ok(())
}

/// Inheritance on with eval: child of dca=esi eval inherits ESI.
#[test]
fn test_inherit_on_eval_subtree() -> esi::Result<()> {
    let call_count = Arc::new(AtomicUsize::new(0));
    let cc = call_count.clone();
    let d =
        move |_req: Request, _maxwait: Option<u32>| -> esi::Result<esi::PendingFragmentContent> {
            let n = cc.fetch_add(1, Ordering::SeqCst);
            let body = if n == 0 {
                r#"E0[<esi:include src="http://example.com/child"/>]"#
            } else {
                r#"<esi:assign name="w" value="88"/><esi:vars>$(w)</esi:vars>"#
            };
            Ok(esi::PendingFragmentContent::CompletedRequest(Box::new(
                Response::from_body(body),
            )))
        };
    let result = run(
        r#"<esi:eval src="http://example.com/e0" dca="esi"/>"#,
        Configuration::default().with_inherit_parent_dca(true),
        &d,
    )?;
    assert_eq!(result, "E0[88]");
    Ok(())
}