fix: Only abort pipeablestream if not already closed (#417)

* fix: Only abort pipeablestream if not complete

* docs: Add changeset

Author: rschristian

.changeset/yellow-hounds-jog.md

@@ -0,0 +1,5 @@
+---
+'preact-render-to-string': patch
+---
+
+Only abort/report errors from `renderToPipeableStream()` if the stream hasn't already been closed

src/stream-node.js

@@ -60,7 +60,14 @@ export function renderToPipeableStream(vnode, options, context) {
 		/**
 		 * @param {unknown} [reason]
 		 */
-		abort(reason = new Error('The render was aborted by the server without a reason.')) {
+		abort(
+			reason = new Error(
+				'The render was aborted by the server without a reason.'
+			)
+		) {
+			// Remix/React-Router will always call abort after a timeout, even on success
+			if (stream.closed) return;
+
 			controller.abort();
 			stream.destroy();
 			if (options.onError) {

test/compat/stream-node.test.js

@@ -73,4 +73,19 @@ describe('renderToPipeableStream', () => {
 			'</div>'
 		]);
 	});
+
+	it('should not error if the stream has already been closed', async () => {
+		let error;
+		const sink = createSink();
+		const { pipe, abort } = renderToPipeableStream(<div class="foo">bar</div>, {
+			onAllReady: () => {
+				pipe(sink.stream);
+			},
+			onError: (e) => (error = e)
+		});
+		await sink.promise;
+		abort();
+
+		expect(error).to.be.undefined;
+	});
 });

test/compat/stream.test.js

@@ -82,10 +82,10 @@ describe('renderToReadableStream', () => {
 		const result = await sink.promise;
 
 		expect(result).to.deep.equal([
-			'<div><!--preact-island:54-->loading...<!--/preact-island:54--></div>',
+			'<div><!--preact-island:56-->loading...<!--/preact-island:56--></div>',
 			'<div hidden>',
 			createInitScript(),
-			createSubtree('54', '<p>it works</p>'),
+			createSubtree('56', '<p>it works</p>'),
 			'</div>'
 		]);
 	});