doc,test: add tests and docs for duplex.fromWeb and duplex.toWeb

PR-URL: #42738 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Juan José Arboleda <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>
nodejs · Apr 28, 2022 · bc47eb3 · bc47eb3
1 parent fc485a9
commit bc47eb3
Show file tree

Hide file tree

Showing 2 changed files with 185 additions and 1 deletion.
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -2887,6 +2887,67 @@ added: v17.0.0
   * `signal` {AbortSignal}
 * Returns: {stream.Duplex}
 
+```mjs
+import { Duplex } from 'node:stream';
+import {
+  ReadableStream,
+  WritableStream
+} from 'node:stream/web';
+
+const readable = new ReadableStream({
+  start(controller) {
+    controller.enqueue('world');
+  },
+});
+
+const writable = new WritableStream({
+  write(chunk) {
+    console.log('writable', chunk);
+  }
+});
+
+const pair = {
+  readable,
+  writable
+};
+const duplex = Duplex.fromWeb(pair, { encoding: 'utf8', objectMode: true });
+
+duplex.write('hello');
+
+for await (const chunk of duplex) {
+  console.log('readable', chunk);
+}
+```
+
+```cjs
+const { Duplex } = require('node:stream');
+const {
+  ReadableStream,
+  WritableStream
+} = require('node:stream/web');
+
+const readable = new ReadableStream({
+  start(controller) {
+    controller.enqueue('world');
+  },
+});
+
+const writable = new WritableStream({
+  write(chunk) {
+    console.log('writable', chunk);
+  }
+});
+
+const pair = {
+  readable,
+  writable
+};
+const duplex = Duplex.fromWeb(pair, { encoding: 'utf8', objectMode: true });
+
+duplex.write('hello');
+duplex.once('readable', () => console.log('readable', duplex.read()));
+```
+
 ### `stream.Duplex.toWeb(streamDuplex)`
 
 <!-- YAML
@@ -2900,6 +2961,51 @@ added: v17.0.0
   * `readable` {ReadableStream}
   * `writable` {WritableStream}
 
+```mjs
+import { Duplex } from 'node:stream';
+
+const duplex = Duplex({
+  objectMode: true,
+  read() {
+    this.push('world');
+    this.push(null);
+  },
+  write(chunk, encoding, callback) {
+    console.log('writable', chunk);
+    callback();
+  }
+});
+
+const { readable, writable } = Duplex.toWeb(duplex);
+writable.getWriter().write('hello');
+
+const { value } = await readable.getReader().read();
+console.log('readable', value);
+```
+
+```cjs
+const { Duplex } = require('node:stream');
+
+const duplex = Duplex({
+  objectMode: true,
+  read() {
+    this.push('world');
+    this.push(null);
+  },
+  write(chunk, encoding, callback) {
+    console.log('writable', chunk);
+    callback();
+  }
+});
+
+const { readable, writable } = Duplex.toWeb(duplex);
+writable.getWriter().write('hello');
+
+readable.getReader().read().then((result) => {
+  console.log('readable', result.value);
+});
+```
+
 ### `stream.addAbortSignal(signal, stream)`
 
 <!-- YAML

diff --git a/test/parallel/test-stream-duplex.js b/test/parallel/test-stream-duplex.js
@@ -20,9 +20,10 @@
 // USE OR OTHER DEALINGS IN THE SOFTWARE.
 'use strict';
 
-require('../common');
+const common = require('../common');
 const assert = require('assert');
 const Duplex = require('stream').Duplex;
+const { ReadableStream, WritableStream } = require('stream/web');
 
 const stream = new Duplex({ objectMode: true });
 
@@ -53,3 +54,80 @@ process.on('exit', () => {
   assert.strictEqual(read.val, 1);
   assert.strictEqual(written.val, 2);
 });
+
+// Duplex.fromWeb
+{
+  const dataToRead = Buffer.from('hello');
+  const dataToWrite = Buffer.from('world');
+
+  const readable = new ReadableStream({
+    start(controller) {
+      controller.enqueue(dataToRead);
+    },
+  });
+
+  const writable = new WritableStream({
+    write: common.mustCall((chunk) => {
+      assert.strictEqual(chunk, dataToWrite);
+    })
+  });
+
+  const pair = { readable, writable };
+  const duplex = Duplex.fromWeb(pair);
+
+  duplex.write(dataToWrite);
+  duplex.once('data', common.mustCall((chunk) => {
+    assert.strictEqual(chunk, dataToRead);
+  }));
+}
+
+// Duplex.fromWeb - using utf8 and objectMode
+{
+  const dataToRead = 'hello';
+  const dataToWrite = 'world';
+
+  const readable = new ReadableStream({
+    start(controller) {
+      controller.enqueue(dataToRead);
+    },
+  });
+
+  const writable = new WritableStream({
+    write: common.mustCall((chunk) => {
+      assert.strictEqual(chunk, dataToWrite);
+    })
+  });
+
+  const pair = {
+    readable,
+    writable
+  };
+  const duplex = Duplex.fromWeb(pair, { encoding: 'utf8', objectMode: true });
+
+  duplex.write(dataToWrite);
+  duplex.once('data', common.mustCall((chunk) => {
+    assert.strictEqual(chunk, dataToRead);
+  }));
+}
+// Duplex.toWeb
+{
+  const dataToRead = Buffer.from('hello');
+  const dataToWrite = Buffer.from('world');
+
+  const duplex = Duplex({
+    read() {
+      this.push(dataToRead);
+      this.push(null);
+    },
+    write: common.mustCall((chunk) => {
+      assert.strictEqual(chunk, dataToWrite);
+    })
+  });
+
+  const { writable, readable } = Duplex.toWeb(duplex);
+  writable.getWriter().write(dataToWrite);
+
+  readable.getReader().read().then(common.mustCall((result) => {
+    assert.deepStrictEqual(Buffer.from(result.value), dataToRead);
+  }));
+}