rong_stream 0.1.1

Stream module for RongJS
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
use bytes::Bytes;
use rong::*;
use std::cell::RefCell;
use std::rc::Rc;
use std::sync::{Arc, Mutex as StdMutex};
use tokio::io::AsyncWrite;
use tokio::sync::{Mutex, mpsc, oneshot};

type ByteSender = mpsc::Sender<Bytes>;
type DoneReceiver = oneshot::Receiver<Result<(), String>>;
type SharedSenderSlot = Arc<StdMutex<Option<ByteSender>>>;
type SharedDoneSlot = Arc<StdMutex<Option<DoneReceiver>>>;
type SharedErrorSlot = Arc<StdMutex<Option<String>>>;
type SinkSlot = Rc<StdMutex<Option<JSObject>>>;
type WriterChannel = (ByteSender, Option<DoneReceiver>);

#[js_export]
pub struct WritableStream {
    // A single writer lock; getWriter() takes ownership.
    pub(crate) tx_slot: SharedSenderSlot,
    // Optional completion signal for async writer (Some when created via to_async_writer)
    pub(crate) done_slot: SharedDoneSlot,
    // Error slot to surface background write failures to the front-end
    pub(crate) err_slot: SharedErrorSlot,
    // For JS-underlying sink mode
    sink_slot: SinkSlot,
}

#[js_export]
pub struct WritableStreamDefaultWriter {
    // Reference back to the stream's slot to support releaseLock
    slot: SharedSenderSlot,
    // Sender owned while the writer is locked
    tx: Arc<Mutex<Option<ByteSender>>>,
    // Optional completion signal for close()
    done_rx: Arc<StdMutex<Option<DoneReceiver>>>,
    // Reference to stream's done slot to return it on releaseLock
    done_slot_ref: SharedDoneSlot,
    // Shared error slot to report background errors
    err_slot: SharedErrorSlot,
    // For JS sink mode: reference back to stream's sink slot and the held sink object
    sink_slot_ref: SinkSlot,
    sink_obj: RefCell<Option<JSObject>>,
}

impl WritableStream {
    pub fn to_sender(tx: ByteSender) -> Self {
        Self {
            tx_slot: Arc::new(StdMutex::new(Some(tx))),
            done_slot: Arc::new(StdMutex::new(None)),
            err_slot: Arc::new(StdMutex::new(None)),
            sink_slot: Rc::new(StdMutex::new(None)),
        }
    }

    pub fn to_async_writer<W>(mut writer: W) -> Self
    where
        W: AsyncWrite + Unpin + Send + 'static,
    {
        let (tx, mut rx) = mpsc::channel::<Bytes>(16);
        let (done_tx, done_rx) = oneshot::channel::<Result<(), String>>();
        let err_slot: SharedErrorSlot = Arc::new(StdMutex::new(None));
        let err_slot_for_task = err_slot.clone();

        tokio::task::spawn(async move {
            let mut error: Option<String> = None;
            while let Some(chunk) = rx.recv().await {
                if let Err(e) = tokio::io::AsyncWriteExt::write_all(&mut writer, &chunk).await {
                    error = Some(e.to_string());
                    break;
                }
            }
            if let Err(e) = tokio::io::AsyncWriteExt::flush(&mut writer).await
                && error.is_none()
            {
                error = Some(e.to_string());
            }
            if let Some(e) = error.as_ref()
                && let Ok(mut g) = err_slot_for_task.lock()
            {
                *g = Some(e.clone());
            }
            let _ = done_tx.send(match error {
                Some(e) => Err(e),
                None => Ok(()),
            });
        });

        Self {
            tx_slot: Arc::new(StdMutex::new(Some(tx))),
            done_slot: Arc::new(StdMutex::new(Some(done_rx))),
            err_slot,
            sink_slot: Rc::new(StdMutex::new(None)),
        }
    }
}

#[js_class]
impl WritableStream {
    #[js_method(constructor)]
    fn new(underlying: function::Optional<JSValue>) -> JSResult<Self> {
        // If underlying sink provided, store it; else make a dummy sink without channels
        let sink = match underlying.0 {
            Some(v) => v.into_object(),
            None => None,
        };
        Ok(Self {
            tx_slot: Arc::new(StdMutex::new(None)),
            done_slot: Arc::new(StdMutex::new(None)),
            err_slot: Arc::new(StdMutex::new(None)),
            sink_slot: Rc::new(StdMutex::new(sink)),
        })
    }

    #[js_method(rename = "getWriter")]
    pub(crate) fn get_writer(&self) -> JSResult<WritableStreamDefaultWriter> {
        let mut guard = self
            .tx_slot
            .lock()
            .map_err(|_| HostError::new(rong::error::E_INTERNAL, "Stream is poisoned"))?;
        match guard.take() {
            Some(tx) => {
                // Take done_rx if any (only for async writer)
                let done_rx = {
                    let mut d = self.done_slot.lock().map_err(|_| {
                        HostError::new(rong::error::E_INTERNAL, "Stream is poisoned")
                    })?;
                    d.take()
                };
                Ok(WritableStreamDefaultWriter {
                    slot: self.tx_slot.clone(),
                    tx: Arc::new(Mutex::new(Some(tx))),
                    done_rx: Arc::new(StdMutex::new(done_rx)),
                    done_slot_ref: self.done_slot.clone(),
                    err_slot: self.err_slot.clone(),
                    sink_slot_ref: self.sink_slot.clone(),
                    sink_obj: RefCell::new(None),
                })
            }
            None => {
                // Fall back to JS sink mode
                let mut sink_guard = self
                    .sink_slot
                    .lock()
                    .map_err(|_| HostError::new(rong::error::E_INTERNAL, "Stream is poisoned"))?;
                if sink_guard.is_none() {
                    return Err(HostError::new(
                        rong::error::E_INVALID_STATE,
                        "WritableStream is locked",
                    )
                    .with_name("TypeError")
                    .into());
                }
                let obj = sink_guard.take().ok_or_else(|| {
                    HostError::new(rong::error::E_INTERNAL, "WritableStream sink missing")
                })?;
                Ok(WritableStreamDefaultWriter {
                    slot: self.tx_slot.clone(),
                    tx: Arc::new(Mutex::new(None)),
                    done_rx: Arc::new(StdMutex::new(None)),
                    done_slot_ref: self.done_slot.clone(),
                    err_slot: self.err_slot.clone(),
                    sink_slot_ref: self.sink_slot.clone(),
                    sink_obj: RefCell::new(Some(obj)),
                })
            }
        }
    }

    #[js_method]
    fn abort(&self) -> JSResult<()> {
        let mut guard = self
            .tx_slot
            .lock()
            .map_err(|_| HostError::new(rong::error::E_INTERNAL, "Stream is poisoned"))?;
        *guard = None;
        Ok(())
    }
}

#[js_class]
impl WritableStreamDefaultWriter {
    #[js_method(constructor)]
    fn new() -> JSResult<Self> {
        Err(
            HostError::new(rong::error::E_ILLEGAL_CONSTRUCTOR, "Illegal constructor")
                .with_name("TypeError")
                .into(),
        )
    }

    #[js_method]
    pub(crate) async fn write(&self, chunk: JSValue) -> JSResult<()> {
        // Surface background error if any
        if let Ok(err_guard) = self.err_slot.lock()
            && let Some(e) = err_guard.as_ref()
        {
            return Err(HostError::new(
                rong::error::E_STREAM,
                format!("WritableStream error: {}", e),
            )
            .into());
        }
        // If we have a JS sink, call its write method in JS thread
        let sink_obj = self.sink_obj.borrow().clone();
        if let Some(sink_obj) = sink_obj
            && let Ok(write_fn) = sink_obj.get::<_, JSFunc>("write")
        {
            // Await if it returns a Promise
            let _r: JSValue = write_fn.call_async(None, (chunk,)).await?;
            return Ok(());
        }

        // Channel mode
        let bytes: Bytes = if let Some(obj) = chunk.clone().into_object() {
            if let Some(ta) = JSTypedArray::from_object(obj.clone()) {
                if let Some(b) = ta.as_bytes() {
                    Bytes::copy_from_slice(b)
                } else {
                    return Err(
                        HostError::new(rong::error::E_INVALID_ARG, "Invalid TypedArray")
                            .with_name("TypeError")
                            .into(),
                    );
                }
            } else if let Some(ab) = JSArrayBuffer::<u8>::from_object(obj) {
                if let Some(b) = ab.as_bytes() {
                    Bytes::copy_from_slice(b)
                } else {
                    return Err(
                        HostError::new(rong::error::E_INVALID_ARG, "Invalid ArrayBuffer")
                            .with_name("TypeError")
                            .into(),
                    );
                }
            } else {
                return Err(HostError::new(
                    rong::error::E_INVALID_ARG,
                    "write expects Uint8Array or ArrayBuffer",
                )
                .with_name("TypeError")
                .into());
            }
        } else {
            return Err(HostError::new(
                rong::error::E_INVALID_ARG,
                "write expects a TypedArray or ArrayBuffer",
            )
            .with_name("TypeError")
            .into());
        };
        let mut slot = self.tx.lock().await;
        match slot.as_mut() {
            Some(tx) => tx.send(bytes).await.map_err(|_| {
                HostError::new(rong::error::E_INVALID_STATE, "WritableStream closed").into()
            }),
            None => Err(HostError::new(
                rong::error::E_INVALID_STATE,
                "Writer not acquired or closed",
            )
            .into()),
        }
    }

    #[js_method]
    pub(crate) async fn close(&self) -> JSResult<()> {
        // If JS sink has close
        let sink_obj = self.sink_obj.borrow().clone();
        if let Some(sink_obj) = sink_obj
            && let Ok(close_fn) = sink_obj.get::<_, JSFunc>("close")
        {
            let _r: JSValue = close_fn.call_async(None, ()).await?;
        }

        // Channel mode: drop sender and await completion if possible
        {
            let mut slot = self.tx.lock().await;
            *slot = None;
        }
        let rx_opt = {
            let mut d = self
                .done_rx
                .lock()
                .map_err(|_| HostError::new(rong::error::E_INTERNAL, "Stream is poisoned"))?;
            d.take()
        };
        if let Some(rx) = rx_opt {
            match rx.await {
                Ok(Ok(())) => Ok(()),
                Ok(Err(e)) => Err(HostError::new(rong::error::E_STREAM, e).into()),
                Err(_) => Ok(()),
            }
        } else {
            Ok(())
        }
    }

    #[js_method]
    pub(crate) async fn abort(&self) -> JSResult<()> {
        let mut slot = self.tx.lock().await;
        *slot = None;
        Ok(())
    }

    #[js_method(rename = "releaseLock")]
    pub(crate) async fn release_lock(&self) -> JSResult<()> {
        // Take JS sink (if any) first so we don't hold a RefCell borrow across await.
        let sink_opt = self.sink_obj.borrow_mut().take();

        // Take back sender and return it to the stream's slot
        let tx_opt = {
            let mut slot = self.tx.lock().await;
            slot.take()
        };
        if let Some(tx) = tx_opt {
            let mut guard = self
                .slot
                .lock()
                .map_err(|_| HostError::new(rong::error::E_INTERNAL, "Stream is poisoned"))?;
            if guard.is_none() {
                *guard = Some(tx);
            }
        }
        // Also return done_rx if any so next writer can await close
        let done_opt = {
            let mut d = self
                .done_rx
                .lock()
                .map_err(|_| HostError::new(rong::error::E_INTERNAL, "Stream is poisoned"))?;
            d.take()
        };
        if let Some(done) = done_opt {
            let mut g = self
                .done_slot_ref
                .lock()
                .map_err(|_| HostError::new(rong::error::E_INTERNAL, "Stream is poisoned"))?;
            if g.is_none() {
                *g = Some(done);
            }
        }
        // Return JS sink to stream slot if present
        if let Some(sink_obj) = sink_opt {
            let mut slot = self
                .sink_slot_ref
                .lock()
                .map_err(|_| HostError::new(rong::error::E_INTERNAL, "Stream is poisoned"))?;
            if slot.is_none() {
                *slot = Some(sink_obj);
            }
        }
        Ok(())
    }
}

// Internal helpers for native fast paths
impl WritableStreamDefaultWriter {
    // Expose the underlying channel sender and done signal for intra-crate optimizations
    pub(crate) fn take_channel(&mut self) -> Option<WriterChannel> {
        // Only available when the writer is channel-backed (not JS sink)
        if self.sink_obj.borrow().is_some() {
            return None;
        }
        // Take ownership of the sender
        let tx_opt = futures::executor::block_on(async { self.tx.lock().await.take() });
        if let Some(tx) = tx_opt {
            // Also take the done receiver if any
            let done_opt = self.done_rx.lock().ok().and_then(|mut g| g.take());
            Some((tx, done_opt))
        } else {
            None
        }
    }
}

// Public Rust helpers for other modules
pub fn writable_stream_to_sender(tx: mpsc::Sender<Bytes>) -> WritableStream {
    WritableStream::to_sender(tx)
}

pub fn writable_stream_to_sender_with_done(
    tx: ByteSender,
    done_rx: DoneReceiver,
) -> WritableStream {
    WritableStream {
        tx_slot: Arc::new(StdMutex::new(Some(tx))),
        done_slot: Arc::new(StdMutex::new(Some(done_rx))),
        err_slot: Arc::new(StdMutex::new(None)),
        sink_slot: Rc::new(StdMutex::new(None)),
    }
}

pub fn writable_stream_to_async_write<W>(writer: W) -> WritableStream
where
    W: AsyncWrite + Unpin + Send + 'static,
{
    WritableStream::to_async_writer(writer)
}

pub fn init(ctx: &JSContext) -> JSResult<()> {
    ctx.register_class::<WritableStream>()?;
    ctx.register_class::<WritableStreamDefaultWriter>()?;
    Ok(())
}

/// Wrapper helper for clearer semantics
#[derive(Clone)]
pub struct JSWritableStream(pub JSObject);

impl JSWritableStream {
    pub fn new(ctx: &JSContext, stream: WritableStream) -> JSResult<Self> {
        let obj = rong::Class::get::<WritableStream>(ctx)?.instance(stream);
        Ok(Self(obj))
    }

    pub fn from_async_writer<W>(ctx: &JSContext, writer: W) -> JSResult<Self>
    where
        W: AsyncWrite + Unpin + Send + 'static,
    {
        let stream = WritableStream::to_async_writer(writer);
        Self::new(ctx, stream)
    }

    pub fn into_object(self) -> JSObject {
        self.0
    }

    pub fn object(&self) -> JSObject {
        self.0.clone()
    }
}