Commit441dea2

authored

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

* fix: Only abort pipeablestream if not complete* docs: Add changeset

1 parent27f340b commit441dea2Copy full SHA for 441dea2

File tree

+30

-3

lines changed

+30

-3

lines changed

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,5 @@`
	`1`	`+---`
	`2`	`+'preact-render-to-string':patch`
	`3`	`+---`
	`4`	`+`
	`5`	+Only abort/report errors from`renderToPipeableStream()` if the stream hasn't already been closed

Lines changed: 8 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,14 @@ export function renderToPipeableStream(vnode, options, context) {`
`60`	`60`	`/**`
`61`	`61`	`*@param {unknown} [reason]`
`62`	`62`	`*/`
`63`		`-abort(reason=newError('The render was aborted by the server without a reason.')){`
	`63`	`+abort(`
	`64`	`+reason=newError(`
	`65`	`+'The render was aborted by the server without a reason.'`
	`66`	`+)`
	`67`	`+){`
	`68`	`+// Remix/React-Router will always call abort after a timeout, even on success`
	`69`	`+if(stream.closed)return;`
	`70`	`+`
`64`	`71`	`controller.abort();`
`65`	`72`	`stream.destroy();`
`66`	`73`	`if(options.onError){`

Lines changed: 15 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -73,4 +73,19 @@ describe('renderToPipeableStream', () => {`
`73`	`73`	`'</div>'`
`74`	`74`	`]);`
`75`	`75`	`});`
	`76`	`+`
	`77`	`+it('should not error if the stream has already been closed',async()=>{`
	`78`	`+leterror;`
	`79`	`+constsink=createSink();`
	`80`	`+const{ pipe, abort}=renderToPipeableStream(<divclass="foo">bar</div>,{`
	`81`	`+onAllReady:()=>{`
	`82`	`+pipe(sink.stream);`
	`83`	`+},`
	`84`	`+onError:(e)=>(error=e)`
	`85`	`+});`
	`86`	`+awaitsink.promise;`
	`87`	`+abort();`
	`88`	`+`
	`89`	`+expect(error).to.be.undefined;`
	`90`	`+});`
`76`	`91`	`});`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -82,10 +82,10 @@ describe('renderToReadableStream', () => {`
`82`	`82`	`constresult=awaitsink.promise;`
`83`	`83`
`84`	`84`	`expect(result).to.deep.equal([`
`85`		`-'<div><!--preact-island:54-->loading...<!--/preact-island:54--></div>',`
	`85`	`+'<div><!--preact-island:56-->loading...<!--/preact-island:56--></div>',`
`86`	`86`	`'<div hidden>',`
`87`	`87`	`createInitScript(),`
`88`		`-createSubtree('54','<p>it works</p>'),`
	`88`	`+createSubtree('56','<p>it works</p>'),`
`89`	`89`	`'</div>'`
`90`	`90`	`]);`
`91`	`91`	`});`

Comments

(0)