From efe043e42bace8bf698ea49717f67ac985d19776 Mon Sep 17 00:00:00 2001
From: Ruben Bridgewater <ruben@bridgewater.de>
Date: Wed, 3 Apr 2019 19:18:57 +0200
Subject: [PATCH] stream: use an assertion for weird error cases

These two cases should only happen in case there's a bug in our
implementation or the user manipulated things pretty bad. So instead
of using our regular error system for these two cases, use a simple
assertion.
---
 doc/api/errors.md        | 28 ++++++++++++++++++----------
 lib/_stream_transform.js | 18 +++++++-----------
 lib/internal/errors.js   |  7 -------
 3 files changed, 25 insertions(+), 28 deletions(-)

diff --git a/doc/api/errors.md b/doc/api/errors.md
index a1fb20e58fcf96..864ee632eae536 100644
--- a/doc/api/errors.md
+++ b/doc/api/errors.md
@@ -1822,16 +1822,6 @@ cannot be serialized.
 This can only happen when native addons create `SharedArrayBuffer`s in
 "externalized" mode, or put existing `SharedArrayBuffer` into externalized mode.
 
-<a id="ERR_TRANSFORM_ALREADY_TRANSFORMING"></a>
-### ERR_TRANSFORM_ALREADY_TRANSFORMING
-
-A `Transform` stream finished while it was still transforming.
-
-<a id="ERR_TRANSFORM_WITH_LENGTH_0"></a>
-### ERR_TRANSFORM_WITH_LENGTH_0
-
-A `Transform` stream finished with data still in the write buffer.
-
 <a id="ERR_TTY_INIT_FAILED"></a>
 ### ERR_TTY_INIT_FAILED
 
@@ -2165,6 +2155,24 @@ removed: v10.0.0
 
 Used when a TLS renegotiation request has failed in a non-specific way.
 
+<a id="ERR_TRANSFORM_ALREADY_TRANSFORMING"></a>
+### ERR_TRANSFORM_ALREADY_TRANSFORMING
+<!-- YAML
+added: v8.0.0
+removed: REPLACEME
+-->
+
+A `Transform` stream finished while it was still transforming.
+
+<a id="ERR_TRANSFORM_WITH_LENGTH_0"></a>
+### ERR_TRANSFORM_WITH_LENGTH_0
+<!-- YAML
+added: v8.0.0
+removed: REPLACEME
+-->
+
+A `Transform` stream finished with data still in the write buffer.
+
 <a id="ERR_UNKNOWN_BUILTIN_MODULE"></a>
 ### ERR_UNKNOWN_BUILTIN_MODULE
 <!-- YAML
diff --git a/lib/_stream_transform.js b/lib/_stream_transform.js
index cec617dfb6bca7..e9a6f25ecb442c 100644
--- a/lib/_stream_transform.js
+++ b/lib/_stream_transform.js
@@ -66,10 +66,9 @@
 module.exports = Transform;
 const {
   ERR_METHOD_NOT_IMPLEMENTED,
-  ERR_MULTIPLE_CALLBACK,
-  ERR_TRANSFORM_ALREADY_TRANSFORMING,
-  ERR_TRANSFORM_WITH_LENGTH_0
+  ERR_MULTIPLE_CALLBACK
 } = require('internal/errors').codes;
+const assert = require('internal/assert');
 const Duplex = require('_stream_duplex');
 Object.setPrototypeOf(Transform.prototype, Duplex.prototype);
 Object.setPrototypeOf(Transform, Duplex);
@@ -207,13 +206,10 @@ function done(stream, er, data) {
   if (data != null) // Single equals check for both `null` and `undefined`
     stream.push(data);
 
-  // TODO(BridgeAR): Write a test for these two error cases
-  // if there's nothing in the write buffer, then that means
-  // that nothing more will ever be provided
-  if (stream._writableState.length)
-    throw new ERR_TRANSFORM_WITH_LENGTH_0();
-
-  if (stream._transformState.transforming)
-    throw new ERR_TRANSFORM_ALREADY_TRANSFORMING();
+  assert(
+    stream._writableState.length === 0 && !stream._transformState.transforming,
+    'Transform done was called while still transforming or writing. ' +
+      'Please report this.'
+  );
   return stream.push(null);
 }
diff --git a/lib/internal/errors.js b/lib/internal/errors.js
index 3eb387d5896b80..5ae688d469efe7 100644
--- a/lib/internal/errors.js
+++ b/lib/internal/errors.js
@@ -1060,12 +1060,6 @@ E('ERR_TLS_SNI_FROM_SERVER',
 E('ERR_TRACE_EVENTS_CATEGORY_REQUIRED',
   'At least one category is required', TypeError);
 E('ERR_TRACE_EVENTS_UNAVAILABLE', 'Trace events are unavailable', Error);
-E('ERR_TRANSFORM_ALREADY_TRANSFORMING',
-  'Calling transform done when still transforming', Error);
-
-// This should probably be a `RangeError`.
-E('ERR_TRANSFORM_WITH_LENGTH_0',
-  'Calling transform done when writableState.length != 0', Error);
 E('ERR_TTY_INIT_FAILED', 'TTY initialization failed', SystemError);
 E('ERR_UNCAUGHT_EXCEPTION_CAPTURE_ALREADY_SET',
   '`process.setupUncaughtExceptionCapture()` was called while a capture ' +
@@ -1086,7 +1080,6 @@ E('ERR_UNKNOWN_ENCODING', 'Unknown encoding: %s', TypeError);
 E('ERR_UNKNOWN_FILE_EXTENSION', 'Unknown file extension: %s', TypeError);
 E('ERR_UNKNOWN_MODULE_FORMAT', 'Unknown module format: %s', RangeError);
 E('ERR_UNKNOWN_SIGNAL', 'Unknown signal: %s', TypeError);
-
 E('ERR_V8BREAKITERATOR',
   'Full ICU data not installed. See https://github.com/nodejs/node/wiki/Intl',
   Error);