@promistream/from-node-stream 0.1.6 → 0.1.8

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@promistream/from-node-stream",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "main": "src/index.js",
-  "repository": "https://codeberg.org/promistream/from-node-stream.git",
+  "repository": {
+    "type": "git",
+    "url": "https://codeberg.org/promistream/from-node-stream.git"
+  },
   "author": "Sven Slootweg <admin@cryto.net>",
   "license": "WTFPL OR CC0-1.0",
   "dependencies": {
@@ -15,24 +18,24 @@
     "@promistream/propagate-abort": "^0.1.7",
     "@promistream/propagate-peek": "^0.1.2",
     "@promistream/simple-sink": "^0.3.5",
-    "@promistream/simple-source": "^0.1.10",
+    "@promistream/simple-source": "^0.1.11",
     "debug-instanced": "^1.0.0",
-    "promisify-event": "^1.0.0",
     "push-buffer": "^1.5.7",
     "single-concurrent": "^1.0.0",
     "split-filter": "^1.1.3"
   },
   "devDependencies": {
     "@promistream/buffered-map": "^0.1.1",
-    "@promistream/collect": "^0.1.2",
+    "@promistream/collect": "^0.1.4",
     "@promistream/debug": "^0.1.2",
     "@promistream/from-iterable": "^0.1.1",
     "@promistream/map": "^0.1.10",
-    "@promistream/parallelize": "^0.1.8",
+    "@promistream/parallelize": "^0.1.10",
     "@promistream/pipe": "^0.1.8",
     "@promistream/range-numbers": "^0.1.2",
+    "@promistream/test-abort": "^0.1.0",
     "bluebird": "^3.7.2",
     "p-defer": "^4.0.1",
     "through2": "^4.0.2"
   }
-}
+}

package/src/index.js

@@ -11,7 +11,6 @@ const makeDebug = require("debug-instanced")("promistream:from-node-stream");
 
 const { once } = require("node:events");
 const pushBuffer = require("push-buffer");
-const promisifyEvent = require("promisify-event");
 const singleConcurrent = require("single-concurrent");
 const warning = require("@joepie91/warning");
 const util = require("node:util");
@@ -106,8 +105,12 @@ function convertFromReadable(stream) {
 		onRequest: () => {
 			return read();
 		},
-		onAbort: () => {
-			return abort();
+		onAbort: (reason) => {
+			if (reason === true) {
+				return abort();
+			} else {
+				return abort(reason);
+			}
 		}
 	});
 }
@@ -131,6 +134,7 @@ function wireWritable(debug, stream) {
 		if (stream.writableNeedDrain) {
 			/* Wait for the write buffer to be fully processed */
 			// FIXME: Verify that this cannot cause a never-ending wait; if we wait to close the stream until it has drained, then during that time writes to it can continue to happen indefinitely, never letting it drain? Or is this prevented by the backpressure mechanisms we already have (re: .pause and .resume)?
+			debug("Waiting for internal write queue to drain...");
 			await once(stream, "drain");
 		}
 	}
@@ -172,7 +176,7 @@ function wireWritable(debug, stream) {
 
 				if (!canWriteMore) {
 					debug("Stream is backlogged, waiting for drain event...");
-					await promisifyEvent(stream, "drain");
+					await once(stream, "drain");
 					debug("Drain event received");
 				} else {
 					debug("Write successful, can write more");

package/test.js

@@ -13,7 +13,9 @@ const fromIterable = require("@promistream/from-iterable");
 const fromNodeStream = require(".");
 const collect = require("@promistream/collect");
 const parallelize = require("@promistream/parallelize");
+const testAbort = require("@promistream/test-abort");
 const debug = require("@promistream/debug");
+const { once } = require("node:events");
 
 test("readable stream", async () => {
 	let testFile = path.join(__dirname, "pnpm-lock.yaml"); // Big-ish file, so we're likely to read in multiple chunks
@@ -24,9 +26,41 @@ test("readable stream", async () => {
 		collect()
 	]).read();
 
-	assert.deepStrictEqual(result, [ expected ]);	
+	assert.deepStrictEqual(result, [ expected ]);
 });
 
+test("readable stream with error abort", { timeout: 500 }, async () => {
+	let testFile = path.join(__dirname, "pnpm-lock.yaml");
+	let nodeStream = fs.createReadStream(testFile);
+
+	let errorFromNodeStreamPromise = once(nodeStream, "error");
+
+	assert.rejects(async () => {
+		let result = await pipe([
+			fromNodeStream.fromReadable(nodeStream),
+			testAbort(0, new Error("sample error")),
+			collect()
+		]).read();
+	}, { message: "sample error" });
+
+	let [ errorFromNodeStream ] = await errorFromNodeStreamPromise;
+	assert.strictEqual(errorFromNodeStream.message, "sample error");
+});
+
+
+test("readable stream with happy abort", { timeout: 500 }, async () => {
+	let testFile = path.join(__dirname, "pnpm-lock.yaml");
+
+	let result = await pipe([
+		fromNodeStream.fromReadable(fs.createReadStream(testFile)),
+		testAbort(0, true),
+		collect()
+	]).read();
+
+	assert.deepStrictEqual(result, []);
+});
+
+
 test("writable stream", async () => {
 	let buffer = Buffer.alloc(400000);
 
@@ -116,6 +150,18 @@ test("transform stream, parallel", async () => {
 });
 
 /* FIXME: Do network socket test with both happy abort and error abort */
+/* TODO: Flaky test behaviour was observed for the below test:
+
+	✖ network socket (9.891608ms)
+	AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
+	+ actual - expected
+	
+	+ Buffer(0) [Uint8Array] []
+	- Buffer(2) [Uint8Array] [
+	-   99,
+	-   100
+	- ]
+*/
 test("network socket", async () => {
 	let { resolve, promise } = pDefer();