✨ Allow ending a non-file-serve Conduit response with a stream

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.3.22 (WIP)
+
+* Allow ending a non-file-serve `Conduit` response with a stream
+
 ## 1.3.21 (2023-11-27)
 
 * Add `Schema#addComputedField()` method

lib/class/conduit.js

@@ -1806,6 +1806,10 @@ Conduit.setMethod(function end(message) {
 
 	if (typeof message !== 'string') {
 
+		if (message && message instanceof Classes.Stream.Stream) {
+			return this._endWithStream(message);
+		}
+
 		// Use regular JSON if DRY has been disabled in settings
 		if (alchemy.settings.json_dry_response === false || this.json_dry === false) {
 			json_type = 'json';
@@ -1878,12 +1882,29 @@ Conduit.setMethod(function end(message) {
 	this._end(message, 'utf-8');
 });
 
+/**
+ * End with a stream
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.22
+ * @version  1.3.22
+ */
+Conduit.setMethod(function _endWithStream(stream) {
+
+	this.ended = new Date();
+	this.emit('ending');
+
+	this.flushHeaders();
+
+	stream.pipe(this.response);
+});
+
 /**
  * Call the actual end method
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.14
+ * @version  1.3.22
  */
 Conduit.setMethod(function _end(message, encoding = 'utf-8') {
 
@@ -1906,18 +1927,42 @@ Conduit.setMethod(function _end(message, encoding = 'utf-8') {
 		return;
 	}
 
-	let headers = [],
-	    value,
-	    key;
+	// Set the content-length if it hasn't been set yet
+	if (arguments.length > 0 && !this.response_headers['content-length']) {
+		this.response_headers['content-length'] = Buffer.byteLength(message);
+	}
+
+	this.flushHeaders();
+
+	if (arguments.length === 0) {
+		return this.response.end();
+	}
+
+	// End the response
+	return this.response.end(message, encoding);
+});
+
+/**
+ * Flush the headers
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.22
+ * @version  1.3.22
+ */
+Conduit.setMethod(function flushHeaders() {
+
+	if (this._flushed) {
+		return;
+	}
+
+	this._flushed = true;
 
 	if (this.status) {
 		this.response.statusCode = this.status;
 	}
 
-	// Set the content-length if it hasn't been set yet
-	if (arguments.length > 0 && !this.response_headers['content-length']) {
-		this.response_headers['content-length'] = Buffer.byteLength(message);
-	}
+	let value,
+	    key;
 
 	for (key in this.response_headers) {
 		value = this.response_headers[key];
@@ -1935,13 +1980,6 @@ Conduit.setMethod(function _end(message, encoding = 'utf-8') {
 
 	// Write the actual headers
 	this.response.writeHead(this.status);
-
-	if (arguments.length === 0) {
-		return this.response.end();
-	}
-
-	// End the response
-	return this.response.end(message, encoding);
 });
 
 /**

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "alchemymvc",
 	"description": "MVC framework for Node.js",
-	"version": "1.3.21",
+	"version": "1.3.22-alpha",
 	"author": "Jelle De Loecker <jelle@elevenways.be>",
 	"keywords": [
 		"alchemy",