ferrijs-std 0.2.3

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
495
496
use crate::utils::option::Null;
use rquickjs::{
    class::{JsClass, OwnedBorrow, OwnedBorrowMut, Trace},
    function::Constructor,
    prelude::{Opt, This},
    Class, Ctx, Exception, JsLifetime, Promise, Result, Value,
};

use crate::stream_web::{
    utils::{
        promise::{
            promise_rejected_with, promise_rejected_with_constructor, PromisePrimordials,
            ResolveablePromise,
        },
        UnwrapOrUndefined,
    },
    writable::{
        default_controller::WritableStreamDefaultController,
        objects::WritableStreamObjects,
        stream::{WritableStream, WritableStreamOwned, WritableStreamState},
        writer::WritableStreamWriter,
    },
};

#[rquickjs::class]
#[derive(JsLifetime)]
pub(crate) struct WritableStreamDefaultWriter<'js> {
    pub(crate) ready_promise: ResolveablePromise<'js>,
    pub(crate) closed_promise: ResolveablePromise<'js>,
    pub(super) stream: Option<Class<'js, WritableStream<'js>>>,

    constructor_type_error: Constructor<'js>,
    promise_primordials: PromisePrimordials<'js>,
}

impl<'js> Trace<'js> for WritableStreamDefaultWriter<'js> {
    fn trace<'a>(&self, tracer: rquickjs::class::Tracer<'a, 'js>) {
        self.ready_promise.trace(tracer);
        self.closed_promise.trace(tracer);
        self.stream.trace(tracer);
        self.constructor_type_error.trace(tracer);
        self.promise_primordials.trace(tracer);
    }
}

pub(crate) type WritableStreamDefaultWriterClass<'js> =
    Class<'js, WritableStreamDefaultWriter<'js>>;
pub(crate) type WritableStreamDefaultWriterOwned<'js> =
    OwnedBorrowMut<'js, WritableStreamDefaultWriter<'js>>;

#[rquickjs::methods(rename_all = "camelCase")]
impl<'js> WritableStreamDefaultWriter<'js> {
    // this is required by web platform tests
    #[qjs(get)]
    pub fn constructor(ctx: Ctx<'js>) -> Result<Option<Constructor<'js>>> {
        <WritableStreamDefaultWriter as JsClass>::constructor(&ctx)
    }

    #[qjs(constructor)]
    fn new(ctx: Ctx<'js>, stream: WritableStreamOwned<'js>) -> Result<Class<'js, Self>> {
        // Perform ? SetUpWritableStreamDefaultWriter(this, stream).
        let (_, writer) = Self::set_up_writable_stream_default_writer(&ctx, stream)?;
        Ok(writer)
    }

    #[qjs(get)]
    fn closed(writer: This<OwnedBorrowMut<'js, Self>>) -> Promise<'js> {
        // Return this.[[closedPromise]].
        writer.0.closed_promise.promise.clone()
    }

    #[qjs(get)]
    fn desired_size(ctx: Ctx<'js>, writer: This<OwnedBorrowMut<'js, Self>>) -> Result<Null<f64>> {
        match writer.0.stream {
            // If this.[[stream]] is undefined, throw a TypeError exception.
            None => Err(Exception::throw_type(
                &ctx,
                "Cannot desiredSize a stream using a released writer",
            )),
            Some(ref stream) => {
                // Return ! WritableStreamDefaultWriterGetDesiredSize(this).
                Self::writable_stream_default_writer_get_desired_size(&OwnedBorrowMut::from_class(
                    stream.clone(),
                ))
            },
        }
    }

    #[qjs(get)]
    fn ready(writer: This<OwnedBorrowMut<'js, Self>>) -> Promise<'js> {
        // Return this.[[readyPromise]].
        writer.0.ready_promise.promise.clone()
    }

    fn abort(
        ctx: Ctx<'js>,
        writer: This<OwnedBorrowMut<'js, Self>>,
        reason: Opt<Value<'js>>,
    ) -> Result<Promise<'js>> {
        // If this.[[stream]] is undefined, throw a TypeError exception.
        if writer.0.stream.is_none() {
            promise_rejected_with_constructor(
                &writer.constructor_type_error,
                &writer.promise_primordials,
                "Cannot abort a stream using a released writer",
            )
        } else {
            let objects = WritableStreamObjects::from_writer(writer.0);

            // Return ! WritableStreamDefaultWriterAbort(this, reason).
            Self::writable_stream_default_writer_abort(ctx.clone(), objects, reason.0)
        }
    }

    fn close(ctx: Ctx<'js>, writer: This<OwnedBorrowMut<'js, Self>>) -> Result<Promise<'js>> {
        // If this.[[stream]] is undefined, throw a TypeError exception.
        if writer.0.stream.is_none() {
            promise_rejected_with_constructor(
                &writer.constructor_type_error,
                &writer.promise_primordials,
                "Cannot close a stream using a released writer",
            )
        } else {
            let objects = WritableStreamObjects::from_writer(writer.0);

            // If ! WritableStreamCloseQueuedOrInFlight(stream) is true, return a promise rejected with a TypeError exception.
            if objects.stream.writable_stream_close_queued_or_in_flight() {
                return promise_rejected_with_constructor(
                    &objects.writer.constructor_type_error,
                    &objects.writer.promise_primordials,
                    "Cannot close an already-closing",
                );
            }

            // Return ! WritableStreamDefaultWriterClose(this).
            Self::writable_stream_default_writer_close(ctx, objects)
        }
    }

    fn release_lock(writer: This<OwnedBorrowMut<'js, Self>>) -> Result<()> {
        // If stream is undefined, return.
        if writer.0.stream.is_none() {
            Ok(())
        } else {
            let objects = WritableStreamObjects::from_writer(writer.0);

            // Perform ! WritableStreamDefaultWriterRelease(this).
            Self::writable_stream_default_writer_release(objects)
        }
    }

    fn write(
        ctx: Ctx<'js>,
        writer: This<OwnedBorrowMut<'js, Self>>,
        chunk: Opt<Value<'js>>,
    ) -> Result<Promise<'js>> {
        // If this.[[stream]] is undefined, throw a TypeError exception.
        if writer.0.stream.is_none() {
            promise_rejected_with_constructor(
                &writer.constructor_type_error,
                &writer.promise_primordials,
                "Cannot write a stream using a released writer",
            )
        } else {
            let objects = WritableStreamObjects::from_writer(writer.0);

            // Return ! WritableStreamDefaultWriterWrite(this, chunk).
            Self::writable_stream_default_writer_write(
                ctx.clone(),
                objects,
                chunk.0.unwrap_or_undefined(&ctx),
            )
        }
    }
}

impl<'js> WritableStreamDefaultWriter<'js> {
    pub(crate) fn acquire_writable_stream_default_writer(
        ctx: &Ctx<'js>,
        stream: WritableStreamOwned<'js>,
    ) -> Result<(WritableStreamOwned<'js>, Class<'js, Self>)> {
        Self::set_up_writable_stream_default_writer(ctx, stream)
    }

    pub(super) fn set_up_writable_stream_default_writer(
        ctx: &Ctx<'js>,
        mut stream: WritableStreamOwned<'js>,
    ) -> Result<(WritableStreamOwned<'js>, Class<'js, Self>)> {
        // If ! IsWritableStreamLocked(stream) is true, throw a TypeError exception.
        if stream.is_writable_stream_locked() {
            return Err(Exception::throw_type(
                ctx,
                "This stream has already been locked for exclusive writing by another writer",
            ));
        }

        let promise_primordials = stream.promise_primordials.clone();
        let constructor_type_error = stream.constructor_type_error.clone();
        let stream_class = stream.into_inner();
        stream = OwnedBorrowMut::from_class(stream_class.clone());

        let (ready_promise, closed_promise) = match stream.state {
            WritableStreamState::Writable => {
                let ready_promise =
                    if !stream.writable_stream_close_queued_or_in_flight() && stream.backpressure {
                        // If ! WritableStreamCloseQueuedOrInFlight(stream) is false and stream.[[backpressure]] is true, set writer.[[readyPromise]] to a new promise.
                        ResolveablePromise::new(ctx)?
                    } else {
                        // Otherwise, set writer.[[readyPromise]] to a promise resolved with undefined.
                        ResolveablePromise::resolved_with_undefined(&stream.promise_primordials)
                    };

                // Set writer.[[closedPromise]] to a new promise.
                (ready_promise, ResolveablePromise::new(ctx)?)
            },
            WritableStreamState::Erroring(ref stored_error) => {
                let ready_promise = ResolveablePromise::rejected_with(
                    &stream.promise_primordials,
                    stored_error.clone(),
                )?;
                ready_promise.set_is_handled()?;
                // Set writer.[[closedPromise]] to a new promise.
                (ready_promise, ResolveablePromise::new(ctx)?)
            },
            WritableStreamState::Closed => {
                let promise =
                    ResolveablePromise::resolved_with_undefined(&stream.promise_primordials);
                // Set writer.[[readyPromise]] to a promise resolved with undefined.
                // Set writer.[[closedPromise]] to a promise resolved with undefined.
                (promise.clone(), promise)
            },
            // Let storedError be stream.[[storedError]].
            WritableStreamState::Errored(ref stored_error) => {
                let promise = ResolveablePromise::rejected_with(
                    &stream.promise_primordials,
                    stored_error.clone(),
                )?;
                promise.set_is_handled()?;
                // Set writer.[[readyPromise]] to a promise rejected with storedError.
                // Set writer.[[readyPromise]].[[PromiseIsHandled]] to true.
                // Set writer.[[closedPromise]] to a promise rejected with storedError.
                // Set writer.[[closedPromise]].[[PromiseIsHandled]] to true.
                (promise.clone(), promise)
            },
        };

        let writer = Self {
            ready_promise,
            closed_promise,
            // Set writer.[[stream]] to stream.
            stream: Some(stream_class),
            promise_primordials,
            constructor_type_error,
        };

        let writer = Class::instance(ctx.clone(), writer)?;

        stream.writer = Some(writer.clone());

        Ok((stream, writer))
    }

    pub(super) fn writable_stream_default_writer_ensure_ready_promise_rejected(
        &mut self,
        promise_primordials: &PromisePrimordials<'js>,
        error: Value<'js>,
    ) -> Result<()> {
        if self.ready_promise.is_pending() {
            // If writer.[[readyPromise]].[[PromiseState]] is "pending", reject writer.[[readyPromise]] with error.
            self.ready_promise.reject(error)?;
        } else {
            // Otherwise, set writer.[[readyPromise]] to a promise rejected with error.
            self.ready_promise = ResolveablePromise::rejected_with(promise_primordials, error)?;
        }

        // Set writer.[[readyPromise]].[[PromiseIsHandled]] to true.
        self.ready_promise.set_is_handled()?;
        Ok(())
    }

    pub(super) fn writable_stream_default_writer_ensure_closed_promise_rejected(
        &mut self,
        promise_primordials: &PromisePrimordials<'js>,
        error: Value<'js>,
    ) -> Result<()> {
        if self.closed_promise.is_pending() {
            // If writer.[[closedPromise]].[[PromiseState]] is "pending", reject writer.[[closedPromise]] with error.
            self.closed_promise.reject(error)?;
        } else {
            // Otherwise, set writer.[[closedPromise]] to a promise rejected with error.
            self.closed_promise = ResolveablePromise::rejected_with(promise_primordials, error)?;
        }

        // Set writer.[[closedPromise]].[[PromiseIsHandled]] to true.
        self.closed_promise.set_is_handled()?;
        Ok(())
    }

    pub(super) fn writable_stream_default_writer_get_desired_size(
        // Let stream be writer.[[stream]].
        stream: &WritableStream<'js>,
    ) -> Result<Null<f64>> {
        // Let state be stream.[[state]].
        // If state is "errored" or "erroring", return null.
        if matches!(
            stream.state,
            WritableStreamState::Errored(_) | WritableStreamState::Erroring(_)
        ) {
            return Ok(Null(None));
        }

        // If state is "closed", return 0.
        if matches!(stream.state, WritableStreamState::Closed) {
            return Ok(Null(Some(0.0)));
        }

        // Return ! WritableStreamDefaultControllerGetDesiredSize(stream.[[controller]]).
        let controller = OwnedBorrow::from_class(
            stream
                .controller
                .clone()
                .expect("Stream in state writable must have a controller"),
        );

        Ok(Null(Some(
            controller.writable_stream_default_controller_get_desired_size(),
        )))
    }

    fn writable_stream_default_writer_abort(
        ctx: Ctx<'js>,
        objects: WritableStreamObjects<'js, OwnedBorrowMut<'js, Self>>,
        reason: Option<Value<'js>>,
    ) -> Result<Promise<'js>> {
        // Return ! WritableStreamAbort(stream, reason).
        let (promise, _) = WritableStream::writable_stream_abort(ctx, objects, reason)?;
        Ok(promise)
    }

    fn writable_stream_default_writer_close(
        ctx: Ctx<'js>,
        objects: WritableStreamObjects<'js, OwnedBorrowMut<'js, Self>>,
    ) -> Result<Promise<'js>> {
        // Return ! WritableStreamClose(stream).
        let (promise, _) = WritableStream::writable_stream_close(ctx, objects)?;
        Ok(promise)
    }

    pub(crate) fn writable_stream_default_writer_close_with_error_propagation(
        ctx: Ctx<'js>,
        // Let stream be writer.[[stream]].
        objects: WritableStreamObjects<'js, OwnedBorrowMut<'js, Self>>,
    ) -> Result<Promise<'js>> {
        // Let state be stream.[[state]].
        // If ! WritableStreamCloseQueuedOrInFlight(stream) is true or state is "closed", return a promise resolved with undefined.
        if objects.stream.writable_stream_close_queued_or_in_flight()
            || matches!(objects.stream.state, WritableStreamState::Closed)
        {
            return Ok(objects
                .stream
                .promise_primordials
                .promise_resolved_with_undefined
                .clone());
        }

        // If state is "errored", return a promise rejected with stream.[[storedError]].
        if let WritableStreamState::Errored(ref stored_error) = objects.stream.state {
            return promise_rejected_with(
                &objects.stream.promise_primordials,
                stored_error.clone(),
            );
        }

        // Return ! WritableStreamDefaultWriterClose(writer).
        Self::writable_stream_default_writer_close(ctx, objects)
    }

    pub(crate) fn writable_stream_default_writer_release(
        mut objects: WritableStreamObjects<'js, OwnedBorrowMut<'js, Self>>,
    ) -> Result<()> {
        // Let releasedError be a new TypeError.
        let released_error: Value = objects.stream.constructor_type_error.call((
            "Writer was released and can no longer be used to monitor the stream's closedness",
        ))?;

        // Perform ! WritableStreamDefaultWriterEnsureReadyPromiseRejected(writer, releasedError).
        objects
            .writer
            .writable_stream_default_writer_ensure_ready_promise_rejected(
                &objects.stream.promise_primordials,
                released_error.clone(),
            )?;
        // Perform ! WritableStreamDefaultWriterEnsureClosedPromiseRejected(writer, releasedError).
        objects
            .writer
            .writable_stream_default_writer_ensure_closed_promise_rejected(
                &objects.stream.promise_primordials,
                released_error,
            )?;

        // Set stream.[[writer]] to undefined.
        objects.stream.writer = None;
        // Set writer.[[stream]] to undefined.
        objects.writer.stream = None;

        Ok(())
    }

    pub(crate) fn writable_stream_default_writer_write(
        ctx: Ctx<'js>,
        objects: WritableStreamObjects<'js, OwnedBorrowMut<'js, Self>>,
        chunk: Value<'js>,
    ) -> Result<Promise<'js>> {
        // Let chunkSize be ! WritableStreamDefaultControllerGetChunkSize(controller, chunk).
        let (chunk_size, mut objects) =
            WritableStreamDefaultController::writable_stream_default_controller_get_chunk_size(
                ctx.clone(),
                objects,
                chunk.clone(),
            )?;

        let stream_class = objects.stream.into_inner();
        objects.stream = OwnedBorrowMut::from_class(stream_class.clone());

        // If stream is not equal to writer.[[stream]], return a promise rejected with a TypeError exception.
        if objects.writer.stream != Some(stream_class) {
            return promise_rejected_with_constructor(
                &objects.stream.constructor_type_error,
                &objects.stream.promise_primordials,
                "Cannot write to a stream using a released writer",
            );
        }

        // Let state be stream.[[state]].
        // If state is "errored", return a promise rejected with stream.[[storedError]].
        if let WritableStreamState::Errored(ref stored_error) = objects.stream.state {
            return promise_rejected_with(
                &objects.stream.promise_primordials,
                stored_error.clone(),
            );
        }

        // If ! WritableStreamCloseQueuedOrInFlight(stream) is true or state is "closed", return a promise rejected with a TypeError exception indicating that the stream is closing or closed.
        if objects.stream.writable_stream_close_queued_or_in_flight()
            || matches!(objects.stream.state, WritableStreamState::Closed)
        {
            return promise_rejected_with_constructor(
                &objects.stream.constructor_type_error,
                &objects.stream.promise_primordials,
                "The stream is closing or closed and cannot be written to",
            );
        }

        // If state is "erroring", return a promise rejected with stream.[[storedError]].
        if let WritableStreamState::Erroring(ref stored_error) = objects.stream.state {
            return promise_rejected_with(
                &objects.stream.promise_primordials,
                stored_error.clone(),
            );
        }

        // Let promise be ! WritableStreamAddWriteRequest(stream).
        let promise = objects.stream.writable_stream_add_write_request(&ctx);
        // Perform ! WritableStreamDefaultControllerWrite(controller, chunk, chunkSize).
        WritableStreamDefaultController::writable_stream_default_controller_write(
            ctx, objects, chunk, chunk_size,
        )?;

        // Return promise.
        promise
    }
}

impl<'js> WritableStreamWriter<'js> for WritableStreamDefaultWriterOwned<'js> {
    type Class = WritableStreamDefaultWriterClass<'js>;

    fn with_writer<C>(
        self,
        ctx: C,
        default: impl FnOnce(
            C,
            WritableStreamDefaultWriterOwned<'js>,
        ) -> Result<(C, WritableStreamDefaultWriterOwned<'js>)>,
        _: impl FnOnce(C) -> Result<C>,
    ) -> Result<(C, Self)> {
        default(ctx, self)
    }

    fn into_inner(self) -> Self::Class {
        self.into_inner()
    }

    fn from_class(class: Self::Class) -> Self {
        OwnedBorrowMut::from_class(class)
    }
}