ferrijs-std 0.2.1

Node and web standard library for the ferrijs QuickJS runtime: WHATWG Streams, Events, AbortController, Buffer, crypto, fs, os, url, zlib and the capability model they enforce (partly derived from awslabs/llrt, Apache-2.0).
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
use crate::test::test_async_with;
use rquickjs::Promise;

fn eval_async<'js>(ctx: &rquickjs::Ctx<'js>, js: &str) -> rquickjs::Result<Promise<'js>> {
    ctx.eval(format!("(async () => {{ {js} }})()"))
}

#[tokio::test]
async fn identity_passthrough() {
    test_async_with(|ctx| {
        crate::stream_web::init(&ctx).unwrap();
        Box::pin(async move {
            eval_async(
                &ctx,
                r#"
                const ts = new TransformStream();
                const writer = ts.writable.getWriter();
                const reader = ts.readable.getReader();

                writer.write("one");
                writer.write("two");
                writer.close();

                const chunks = [];
                while (true) {
                    const { value, done } = await reader.read();
                    if (done) break;
                    chunks.push(value);
                }
                if (chunks.join(",") !== "one,two") throw new Error("got: " + chunks);
            "#,
            )
            .unwrap()
            .into_future::<()>()
            .await
            .unwrap();
        })
    })
    .await;
}

#[tokio::test]
async fn transform_chunks() {
    test_async_with(|ctx| {
        crate::stream_web::init(&ctx).unwrap();
        Box::pin(async move {
            eval_async(
                &ctx,
                r#"
                const ts = new TransformStream({
                    transform(chunk, controller) {
                        controller.enqueue(chunk.toUpperCase());
                    }
                });
                const writer = ts.writable.getWriter();
                const reader = ts.readable.getReader();

                writer.write("hello");
                writer.write("world");
                writer.close();

                const chunks = [];
                while (true) {
                    const { value, done } = await reader.read();
                    if (done) break;
                    chunks.push(value);
                }
                if (chunks.join(" ") !== "HELLO WORLD") throw new Error("got: " + chunks);
            "#,
            )
            .unwrap()
            .into_future::<()>()
            .await
            .unwrap();
        })
    })
    .await;
}

#[tokio::test]
async fn one_to_many_expansion() {
    test_async_with(|ctx| {
        crate::stream_web::init(&ctx).unwrap();
        Box::pin(async move {
            eval_async(
                &ctx,
                r#"
                const ts = new TransformStream({
                    transform(chunk, controller) {
                        for (const byte of chunk) {
                            controller.enqueue(byte);
                        }
                    }
                });
                const writer = ts.writable.getWriter();
                const reader = ts.readable.getReader();

                writer.write([1, 2, 3]);
                writer.close();

                const chunks = [];
                while (true) {
                    const { value, done } = await reader.read();
                    if (done) break;
                    chunks.push(value);
                }
                if (chunks.join(",") !== "1,2,3") throw new Error("got: " + chunks);
            "#,
            )
            .unwrap()
            .into_future::<()>()
            .await
            .unwrap();
        })
    })
    .await;
}

#[tokio::test]
async fn readable_high_water_mark_applies_backpressure() {
    test_async_with(|ctx| {
        crate::stream_web::init(&ctx).unwrap();
        Box::pin(async move {
            ctx.eval::<(), _>(
                r#"
                globalThis.transformed = [];
                globalThis.ts = new TransformStream({
                    transform(chunk, controller) {
                        transformed.push(chunk);
                        controller.enqueue(chunk);
                    }
                }, undefined, { highWaterMark: 3 });
                globalThis.writer = ts.writable.getWriter();
                [0, 1, 2, 3].forEach(chunk => writer.write(chunk));
            "#,
            )
            .unwrap();

            while ctx.execute_pending_job() {}
            assert_eq!(
                ctx.eval::<String, _>("transformed.join(',')").unwrap(),
                "0,1,2"
            );

            ctx.eval::<(), _>("globalThis.reader = ts.readable.getReader(); reader.read();")
                .unwrap();
            while ctx.execute_pending_job() {}
            assert_eq!(
                ctx.eval::<String, _>("transformed.join(',')").unwrap(),
                "0,1,2,3"
            );
        })
    })
    .await;
}

#[tokio::test]
async fn flush_on_close() {
    test_async_with(|ctx| {
        crate::stream_web::init(&ctx).unwrap();
        Box::pin(async move {
            eval_async(
                &ctx,
                r#"
                const ts = new TransformStream({
                    transform(chunk, controller) {
                        controller.enqueue(chunk);
                    },
                    flush(controller) {
                        controller.enqueue("DONE");
                    }
                });
                const writer = ts.writable.getWriter();
                const reader = ts.readable.getReader();

                writer.write("a");
                writer.close();

                const chunks = [];
                while (true) {
                    const { value, done } = await reader.read();
                    if (done) break;
                    chunks.push(value);
                }
                if (chunks.join(",") !== "a,DONE") throw new Error("got: " + chunks);
            "#,
            )
            .unwrap()
            .into_future::<()>()
            .await
            .unwrap();
        })
    })
    .await;
}

#[tokio::test]
async fn pipe_through_chain() {
    test_async_with(|ctx| {
        crate::stream_web::init(&ctx).unwrap();
        Box::pin(async move {
            eval_async(
                &ctx,
                r#"
                const source = new ReadableStream({
                    start(controller) {
                        controller.enqueue("hello");
                        controller.enqueue("world");
                        controller.close();
                    }
                });

                const upper = new TransformStream({
                    transform(chunk, c) { c.enqueue(chunk.toUpperCase()); }
                });
                const exclaim = new TransformStream({
                    transform(chunk, c) { c.enqueue(chunk + "!"); }
                });

                const reader = source
                    .pipeThrough(upper)
                    .pipeThrough(exclaim)
                    .getReader();

                const chunks = [];
                while (true) {
                    const { value, done } = await reader.read();
                    if (done) break;
                    chunks.push(value);
                }
                if (chunks.join(" ") !== "HELLO! WORLD!") throw new Error("got: " + chunks);
            "#,
            )
            .unwrap()
            .into_future::<()>()
            .await
            .unwrap();
        })
    })
    .await;
}

#[tokio::test]
async fn async_transform() {
    test_async_with(|ctx| {
        crate::stream_web::init(&ctx).unwrap();
        Box::pin(async move {
            eval_async(
                &ctx,
                r#"
                const ts = new TransformStream({
                    async transform(chunk, controller) {
                        await new Promise(r => r());
                        controller.enqueue(chunk * 2);
                    }
                });
                const writer = ts.writable.getWriter();
                const reader = ts.readable.getReader();

                writer.write(5);
                writer.close();

                const { value } = await reader.read();
                if (value !== 10) throw new Error("expected 10, got " + value);
            "#,
            )
            .unwrap()
            .into_future::<()>()
            .await
            .unwrap();
        })
    })
    .await;
}

#[tokio::test]
async fn error_propagates_to_reader() {
    test_async_with(|ctx| {
        crate::stream_web::init(&ctx).unwrap();
        Box::pin(async move {
            eval_async(
                &ctx,
                r#"
                const ts = new TransformStream({
                    transform(chunk, controller) {
                        controller.error(new Error("broken"));
                    }
                });
                const writer = ts.writable.getWriter();
                const reader = ts.readable.getReader();

                writer.write("x").catch(() => {});

                try {
                    await reader.read();
                    throw new Error("should have thrown");
                } catch (e) {
                    if (e.message !== "broken") throw new Error("wrong error: " + e.message);
                }
            "#,
            )
            .unwrap()
            .into_future::<()>()
            .await
            .unwrap();
        })
    })
    .await;
}

#[tokio::test]
async fn start_receives_controller() {
    test_async_with(|ctx| {
        crate::stream_web::init(&ctx).unwrap();
        Box::pin(async move {
            eval_async(
                &ctx,
                r#"
                let controllerRef;
                const ts = new TransformStream({
                    start(controller) {
                        controllerRef = controller;
                        controller.enqueue("from-start");
                    }
                });

                if (typeof controllerRef.desiredSize !== "number")
                    throw new Error("controller.desiredSize should be a number");

                const reader = ts.readable.getReader();
                const { value } = await reader.read();
                if (value !== "from-start") throw new Error("got: " + value);
            "#,
            )
            .unwrap()
            .into_future::<()>()
            .await
            .unwrap();
        })
    })
    .await;
}

#[tokio::test]
async fn terminate_closes_readable() {
    test_async_with(|ctx| {
        crate::stream_web::init(&ctx).unwrap();
        Box::pin(async move {
            eval_async(
                &ctx,
                r#"
                const ts = new TransformStream({
                    transform(chunk, controller) {
                        if (chunk === "stop") {
                            controller.terminate();
                            return;
                        }
                        controller.enqueue(chunk);
                    }
                });
                const writer = ts.writable.getWriter();
                const reader = ts.readable.getReader();

                writer.write("keep").catch(() => {});
                writer.write("stop").catch(() => {});

                const { value } = await reader.read();
                if (value !== "keep") throw new Error("got: " + value);

                const { done } = await reader.read();
                if (!done) throw new Error("expected stream to be closed after terminate");
            "#,
            )
            .unwrap()
            .into_future::<()>()
            .await
            .unwrap();
        })
    })
    .await;
}

#[tokio::test]
async fn illegal_constructor() {
    test_async_with(|ctx| {
        crate::stream_web::init(&ctx).unwrap();
        Box::pin(async move {
            eval_async(
                &ctx,
                r#"
                try {
                    new TransformStreamDefaultController();
                    throw new Error("should have thrown");
                } catch (e) {
                    if (!(e instanceof TypeError)) throw new Error("expected TypeError, got " + e);
                }
            "#,
            )
            .unwrap()
            .into_future::<()>()
            .await
            .unwrap();
        })
    })
    .await;
}

#[tokio::test]
async fn pipe_to_writable_stream() {
    test_async_with(|ctx| {
        crate::stream_web::init(&ctx).unwrap();
        Box::pin(async move {
            eval_async(
                &ctx,
                r#"
                const collected = [];
                const source = new ReadableStream({
                    start(c) { c.enqueue(1); c.enqueue(2); c.enqueue(3); c.close(); }
                });
                const transform = new TransformStream({
                    transform(chunk, c) { c.enqueue(chunk * 10); }
                });
                const sink = new WritableStream({
                    write(chunk) { collected.push(chunk); }
                });

                await source.pipeThrough(transform).pipeTo(sink);

                if (collected.join(",") !== "10,20,30") throw new Error("got: " + collected);
            "#,
            )
            .unwrap()
            .into_future::<()>()
            .await
            .unwrap();
        })
    })
    .await;
}

#[tokio::test]
async fn transform_error_rejects_write_without_leaking() {
    test_async_with(|ctx| {
        crate::stream_web::init(&ctx).unwrap();
        Box::pin(async move {
            eval_async(
                &ctx,
                r#"
                const ts = new TransformStream(
                    { transform() { throw new Error("boom"); } },
                    undefined,
                    { highWaterMark: 1 },
                );
                const writer = ts.writable.getWriter();
                let message = null;
                try { await writer.write("x"); } catch (e) { message = e.message; }
                if (message !== "boom") throw new Error("got: " + message);
            "#,
            )
            .unwrap()
            .into_future::<()>()
            .await
            .unwrap();
        })
    })
    .await;
}

/// A `transform()` that THROWS (rather than calling `controller.error`)
/// must error the stream too, so a pending read rejects instead of
/// hanging forever.
#[tokio::test]
async fn thrown_transform_error_reaches_a_pending_read() {
    test_async_with(|ctx| {
        crate::stream_web::init(&ctx).unwrap();
        Box::pin(async move {
            eval_async(
                &ctx,
                r#"
                const ts = new TransformStream({ transform() { throw new Error("boom"); } });
                const w = ts.writable.getWriter(); const r = ts.readable.getReader();
                w.write("x").catch(() => {});
                let message = null;
                try { await r.read(); } catch (e) { message = e.message; }
                if (message !== "boom") throw new Error("got: " + message);
            "#,
            )
            .unwrap()
            .into_future::<()>()
            .await
            .unwrap();
        })
    }).await;
}