Merge pull request #464 from preactjs/jovi/options-root-suspense-mask

fix: call root hook during server render

Author: JoviDeCroock

.changeset/clever-peaches-brush.md

@@ -0,0 +1,5 @@
+---
+"preact-render-to-string": patch
+---
+
+Call `options._root` before the render-to-string invocation

src/index.js

@@ -21,6 +21,7 @@ import {
 	NEXT_STATE,
 	PARENT,
 	RENDER,
+	ROOT,
 	SKIP_EFFECTS,
 	VNODE,
 	CATCH_ERROR
@@ -80,6 +81,7 @@ export function renderToString(vnode, context, _rendererState) {
 
 	const parent = h(Fragment, null);
 	parent[CHILDREN] = [vnode];
+	if (options[ROOT]) options[ROOT](vnode, { [CHILDREN]: parent, nodeType: 1 });
 
 	try {
 		const rendered = _renderToString(
@@ -134,6 +136,7 @@ export async function renderToStringAsync(vnode, context) {
 
 	const parent = h(Fragment, null);
 	parent[CHILDREN] = [vnode];
+	if (options[ROOT]) options[ROOT](vnode, { [CHILDREN]: parent, nodeType: 1 });
 
 	try {
 		const rendered = await _renderToString(

src/lib/constants.js

@@ -5,6 +5,7 @@ export const DIFFED = 'diffed';
 export const COMMIT = '__c';
 export const SKIP_EFFECTS = '__s';
 export const CATCH_ERROR = '__e';
+export const ROOT = '__';
 
 // VNode properties
 export const COMPONENT = '__c';

test/render.test.jsx

@@ -20,6 +20,7 @@ import {
 import { expect, vi, describe, it } from 'vitest';
 import { svgAttributes, htmlAttributes } from './utils.jsx';
 import { COMPONENT_DIRTY_BIT } from '../src/lib/util.js';
+import { CHILDREN } from '../src/lib/constants.js';
 
 function shallowRender(vnode) {
 	const context = {};
@@ -1396,6 +1397,30 @@ describe('render', () => {
 
 			expect(render(<App />)).to.equal('<div><p>P0-0</p><p>P0-1</p></div>');
 		});
+
+		it('should invoke options._root for root renders', () => {
+			const oldRoot = options.__;
+			let args;
+
+			function App() {
+				const id = useId();
+				return <p>{id}</p>;
+			}
+
+			const vnode = <App />;
+			options.__ = (rootVNode, parentDom) => {
+				args = [rootVNode, parentDom];
+			};
+
+			try {
+				expect(render(vnode)).to.equal('<p>P0-0</p>');
+				expect(args[0]).to.equal(vnode);
+				expect(args[1][CHILDREN][CHILDREN][0]).to.equal(vnode);
+				expect(args[1]).to.have.property('nodeType', 1);
+			} finally {
+				options.__ = oldRoot;
+			}
+		});
 	});
 
 	describe('Error Handling', () => {