stream: make _write() optional when _writev() is implemented

When implementing _writev, _write should be optional. PR-URL: #29639 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Minwoo Jung <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Sep 23, 2019 · d398b8f · d398b8f
1 parent 68d6c4c
commit d398b8f
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 6 deletions.
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -1687,8 +1687,8 @@ const myWritable = new Writable({
 The `stream.Writable` class is extended to implement a [`Writable`][] stream.
 
 Custom `Writable` streams *must* call the `new stream.Writable([options])`
-constructor and implement the `writable._write()` method. The
-`writable._writev()` method *may* also be implemented.
+constructor and implement the `writable._write()` and/or `writable._writev()`
+method.
 
 #### Constructor: new stream.Writable([options])
 <!-- YAML
@@ -1777,6 +1777,12 @@ const myWritable = new Writable({
 ```
 
 #### writable.\_write(chunk, encoding, callback)
+<!-- YAML
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/29639
+    description: _write() is optional when providing _writev().
+-->
 
 * `chunk` {Buffer|string|any} The `Buffer` to be written, converted from the
   `string` passed to [`stream.write()`][stream-write]. If the stream's
@@ -1790,7 +1796,8 @@ const myWritable = new Writable({
   argument) when processing is complete for the supplied chunk.
 
 All `Writable` stream implementations must provide a
-[`writable._write()`][stream-_write] method to send data to the underlying
+[`writable._write()`][stream-_write] and/or
+[`writable._writev()`][stream-_writev] method to send data to the underlying
 resource.
 
 [`Transform`][] streams provide their own implementation of the
@@ -1833,8 +1840,8 @@ This function MUST NOT be called by application code directly. It should be
 implemented by child classes, and called by the internal `Writable` class
 methods only.
 
-The `writable._writev()` method may be implemented in addition to
-`writable._write()` in stream implementations that are capable of processing
+The `writable._writev()` method may be implemented in addition or alternatively
+to `writable._write()` in stream implementations that are capable of processing
 multiple chunks of data at once. If implemented, the method will be called with
 all chunks of data currently buffered in the write queue.
 

diff --git a/lib/_stream_writable.js b/lib/_stream_writable.js
@@ -565,7 +565,11 @@ function clearBuffer(stream, state) {
 }
 
 Writable.prototype._write = function(chunk, encoding, cb) {
-  cb(new ERR_METHOD_NOT_IMPLEMENTED('_write()'));
+  if (this._writev) {
+    this._writev([{ chunk, encoding }], cb);
+  } else {
+    cb(new ERR_METHOD_NOT_IMPLEMENTED('_write()'));
+  }
 };
 
 Writable.prototype._writev = null;

diff --git a/test/parallel/test-stream-writev.js b/test/parallel/test-stream-writev.js
@@ -119,3 +119,12 @@ function test(decode, uncork, multi, next) {
     next();
   });
 }
+
+{
+  const w = new stream.Writable({
+    writev: common.mustCall(function(chunks, cb) {
+      cb();
+    })
+  });
+  w.write('asd', common.mustCall());
+}