preact-render-to-string 6.0.0-experimental.0 → 6.0.1

package/src/index.js

@@ -1,441 +1,381 @@
+import { encodeEntities, styleObjToCss, UNSAFE_NAME, XLINK } from './util';
+import { options, h, Fragment } from 'preact';
 import {
-	encodeEntities,
-	indent,
-	isLargeString,
-	styleObjToCss,
-	assign,
-	getChildren,
-	createInternalFromVnode
-} from './util';
-import { options, Fragment } from 'preact';
+	CHILDREN,
+	COMMIT,
+	COMPONENT,
+	DIFF,
+	DIFFED,
+	DIRTY,
+	NEXT_STATE,
+	PARENT,
+	RENDER,
+	SKIP_EFFECTS,
+	VNODE
+} from './constants';
 
 /** @typedef {import('preact').VNode} VNode */
 
-const SHALLOW = { shallow: true };
-
-// components without names, kept as a hash for later comparison to return consistent UnnamedComponentXX names.
-const UNNAMED = [];
-
-const VOID_ELEMENTS = /^(area|base|br|col|embed|hr|img|input|link|meta|param|source|track|wbr)$/;
-
-const UNSAFE_NAME = /[\s\n\\/='"\0<>]/;
+const EMPTY_ARR = [];
+const isArray = Array.isArray;
+const assign = Object.assign;
 
-const noop = () => {};
+// Global state for the current render pass
+let beforeDiff, afterDiff, renderHook, ummountHook;
 
-/** Render Preact JSX + Components to an HTML string.
- *	@name render
- *	@function
- *	@param {VNode} vnode	JSX VNode to render.
- *	@param {Object} [context={}]	Optionally pass an initial context object through the render path.
- *	@param {Object} [options={}]	Rendering options
- *	@param {Boolean} [options.shallow=false]	If `true`, renders nested Components as HTML elements (`<Foo a="b" />`).
- *	@param {Boolean} [options.xml=false]		If `true`, uses self-closing tags for elements without children.
- *	@param {Boolean} [options.pretty=false]		If `true`, adds whitespace for readability
- *	@param {RegExp|undefined} [options.voidElements]       RegeEx that matches elements that are considered void (self-closing)
- */
-renderToString.render = renderToString;
-
-/** Only render elements, leaving Components inline as `<ComponentName ... />`.
- *	This method is just a convenience alias for `render(vnode, context, { shallow:true })`
- *	@name shallow
- *	@function
- *	@param {VNode} vnode	JSX VNode to render.
- *	@param {Object} [context={}]	Optionally pass an initial context object through the render path.
+/**
+ * Render Preact JSX + Components to an HTML string.
+ * @param {VNode} vnode	JSX Element / VNode to render
+ * @param {Object} [context={}] Initial root context object
+ * @returns {string} serialized HTML
  */
-let shallowRender = (vnode, context) => renderToString(vnode, context, SHALLOW);
-
-const EMPTY_ARR = [];
-function renderToString(vnode, context, opts) {
-	context = context || {};
-	opts = opts || {};
-
+export default function renderToString(vnode, context) {
 	// Performance optimization: `renderToString` is synchronous and we
 	// therefore don't execute any effects. To do that we pass an empty
 	// array to `options._commit` (`__c`). But we can go one step further
 	// and avoid a lot of dirty checks and allocations by setting
 	// `options._skipEffects` (`__s`) too.
-	const previousSkipEffects = options.__s;
-	options.__s = true;
+	const previousSkipEffects = options[SKIP_EFFECTS];
+	options[SKIP_EFFECTS] = true;
+
+	// store options hooks once before each synchronous render call
+	beforeDiff = options[DIFF];
+	afterDiff = options[DIFFED];
+	renderHook = options[RENDER];
+	ummountHook = options.unmount;
+
+	const parent = h(Fragment, null);
+	parent[CHILDREN] = [vnode];
+
+	try {
+		return _renderToString(
+			vnode,
+			context || EMPTY_OBJ,
+			false,
+			undefined,
+			parent
+		);
+	} finally {
+		// options._commit, we don't schedule any effects in this library right now,
+		// so we can pass an empty queue to this hook.
+		if (options[COMMIT]) options[COMMIT](vnode, EMPTY_ARR);
+		options[SKIP_EFFECTS] = previousSkipEffects;
+		EMPTY_ARR.length = 0;
+	}
+}
+
+// Installed as setState/forceUpdate for function components
+function markAsDirty() {
+	this.__d = true;
+}
+
+const EMPTY_OBJ = {};
+
+/**
+ * @param {VNode} vnode
+ * @param {Record<string, unknown>} context
+ */
+function renderClassComponent(vnode, context) {
+	let type = /** @type {import("preact").ComponentClass<typeof vnode.props>} */ (vnode.type);
+
+	let c = new type(vnode.props, context);
+
+	vnode[COMPONENT] = c;
+	c[VNODE] = vnode;
 
-	const res = _renderToString(vnode, context, opts);
+	c.props = vnode.props;
+	c.context = context;
+	// turn off stateful re-rendering:
+	c[DIRTY] = true;
+
+	if (c.state == null) c.state = EMPTY_OBJ;
+
+	if (c[NEXT_STATE] == null) {
+		c[NEXT_STATE] = c.state;
+	}
+
+	if (type.getDerivedStateFromProps) {
+		c.state = assign(
+			{},
+			c.state,
+			type.getDerivedStateFromProps(c.props, c.state)
+		);
+	} else if (c.componentWillMount) {
+		c.componentWillMount();
+
+		// If the user called setState in cWM we need to flush pending,
+		// state updates. This is the same behaviour in React.
+		c.state = c[NEXT_STATE] !== c.state ? c[NEXT_STATE] : c.state;
+	}
 
-	// options._commit, we don't schedule any effects in this library right now,
-	// so we can pass an empty queue to this hook.
-	if (options.__c) options.__c(vnode, EMPTY_ARR);
-	EMPTY_ARR.length = 0;
-	options.__s = previousSkipEffects;
-	return res;
+	if (renderHook) renderHook(vnode);
+
+	return c.render(c.props, c.state, context);
 }
 
-/** The default export is an alias of `render()`. */
-function _renderToString(vnode, context, opts, inner, isSvgMode, selectValue) {
-	if (vnode == null || typeof vnode === 'boolean') {
+/**
+ * Recursively render VNodes to HTML.
+ * @param {VNode|any} vnode
+ * @param {any} context
+ * @param {boolean} isSvgMode
+ * @param {any} selectValue
+ * @param {VNode} parent
+ * @returns {string}
+ */
+function _renderToString(vnode, context, isSvgMode, selectValue, parent) {
+	// Ignore non-rendered VNodes/values
+	if (vnode == null || vnode === true || vnode === false || vnode === '') {
 		return '';
 	}
 
-	// #text nodes
+	// Text VNodes: escape as HTML
 	if (typeof vnode !== 'object') {
-		return encodeEntities(vnode);
+		if (typeof vnode === 'function') return '';
+		return encodeEntities(vnode + '');
 	}
 
-	let pretty = opts.pretty,
-		indentChar = pretty && typeof pretty === 'string' ? pretty : '\t';
-
-	if (Array.isArray(vnode)) {
+	// Recurse into children / Arrays
+	if (isArray(vnode)) {
 		let rendered = '';
+		parent[CHILDREN] = vnode;
 		for (let i = 0; i < vnode.length; i++) {
-			if (pretty && i > 0) rendered += '\n';
-			rendered += _renderToString(
-				vnode[i],
-				context,
-				opts,
-				inner,
-				isSvgMode,
-				selectValue
-			);
+			let child = vnode[i];
+			if (child == null || typeof child === 'boolean') continue;
+
+			rendered =
+				rendered +
+				_renderToString(child, context, isSvgMode, selectValue, parent);
 		}
 		return rendered;
 	}
 
-	let nodeName = vnode.type,
+	// VNodes have {constructor:undefined} to prevent JSON injection:
+	if (vnode.constructor !== undefined) return '';
+
+	vnode[PARENT] = parent;
+	if (beforeDiff) beforeDiff(vnode);
+
+	let type = vnode.type,
 		props = vnode.props,
-		isComponent = false;
-
-	// components
-	if (typeof nodeName === 'function') {
-		isComponent = true;
-		if (opts.shallow && (inner || opts.renderRootComponent === false)) {
-			nodeName = getComponentName(nodeName);
-		} else if (nodeName === Fragment) {
-			const children = [];
-			getChildren(children, vnode.props.children);
-			return _renderToString(
-				children,
-				context,
-				opts,
-				opts.shallowHighOrder !== false,
-				isSvgMode,
-				selectValue
-			);
+		cctx = context,
+		contextType,
+		rendered,
+		component;
+
+	// Invoke rendering on Components
+	if (typeof type === 'function') {
+		if (type === Fragment) {
+			rendered = props.children;
 		} else {
-			let rendered;
-
-			let c = (vnode.__c = {
-				__v: vnode,
-				context,
-				props: vnode.props,
-				// silently drop state updates
-				setState: noop,
-				forceUpdate: noop,
-				// hooks
-				data: {}
-			});
-
-			// options._diff
-			if (options.__b) options.__b(vnode);
-
-			const internal = createInternalFromVnode(vnode, context);
-			// options._render
-			if (options.__r) options.__r(internal);
-
-			if (
-				!nodeName.prototype ||
-				typeof nodeName.prototype.render !== 'function'
-			) {
-				// Necessary for createContext api. Setting this property will pass
-				// the context value as `this.context` just for this component.
-				let cxType = nodeName.contextType;
-				let provider = cxType && context[cxType.__c];
-				let cctx =
-					cxType != null
-						? provider
-							? provider.props.value
-							: cxType.__
-						: context;
-
-				// stateless functional components
-				rendered = nodeName.call(vnode.__c, props, cctx);
-			} else {
-				// class-based components
-				let cxType = nodeName.contextType;
-				let provider = cxType && context[cxType.__c];
-				let cctx =
-					cxType != null
-						? provider
-							? provider.props.value
-							: cxType.__
-						: context;
-
-				// c = new nodeName(props, context);
-				c = vnode.__c = new nodeName(props, cctx);
-				c.__v = vnode;
-				// turn off stateful re-rendering:
-				c._dirty = c.__d = true;
-				c.props = props;
-				if (c.state == null) c.state = {};
-
-				if (c._nextState == null && c.__s == null) {
-					c._nextState = c.__s = c.state;
-				}
+			contextType = type.contextType;
+			if (contextType != null) {
+				let provider = context[contextType.__c];
+				cctx = provider ? provider.props.value : contextType.__;
+			}
 
-				c.context = cctx;
-				if (nodeName.getDerivedStateFromProps)
-					c.state = assign(
-						assign({}, c.state),
-						nodeName.getDerivedStateFromProps(c.props, c.state)
-					);
-				else if (c.componentWillMount) {
-					c.componentWillMount();
-
-					// If the user called setState in cWM we need to flush pending,
-					// state updates. This is the same behaviour in React.
-					c.state =
-						c._nextState !== c.state
-							? c._nextState
-							: c.__s !== c.state
-							? c.__s
-							: c.state;
+			if (type.prototype && typeof type.prototype.render === 'function') {
+				rendered = /**#__NOINLINE__**/ renderClassComponent(vnode, cctx);
+				component = vnode[COMPONENT];
+			} else {
+				component = {
+					__v: vnode,
+					props,
+					context: cctx,
+					// silently drop state updates
+					setState: markAsDirty,
+					forceUpdate: markAsDirty,
+					__d: true,
+					// hooks
+					__h: []
+				};
+				vnode[COMPONENT] = component;
+
+				// If a hook invokes setState() to invalidate the component during rendering,
+				// re-render it up to 25 times to allow "settling" of memoized states.
+				// Note:
+				//   This will need to be updated for Preact 11 to use internal.flags rather than component._dirty:
+				//   https://github.com/preactjs/preact/blob/d4ca6fdb19bc715e49fd144e69f7296b2f4daa40/src/diff/component.js#L35-L44
+				let count = 0;
+				while (component[DIRTY] && count++ < 25) {
+					component[DIRTY] = false;
+
+					if (renderHook) renderHook(vnode);
+
+					rendered = type.call(component, props, cctx);
 				}
-
-				rendered = c.render(c.props, c.state, c.context);
+				component[DIRTY] = true;
 			}
 
-			if (c.getChildContext) {
-				context = assign(assign({}, context), c.getChildContext());
+			if (component.getChildContext != null) {
+				context = assign({}, context, component.getChildContext());
 			}
-
-			if (options.diffed) options.diffed(vnode);
-			return _renderToString(
-				rendered,
-				context,
-				opts,
-				opts.shallowHighOrder !== false,
-				isSvgMode,
-				selectValue
-			);
 		}
-	}
 
-	// render JSX to HTML
-	let s = '<' + nodeName,
-		propChildren,
-		html;
+		// When a component returns a Fragment node we flatten it in core, so we
+		// need to mirror that logic here too
+		let isTopLevelFragment =
+			rendered != null && rendered.type === Fragment && rendered.key == null;
+		rendered = isTopLevelFragment ? rendered.props.children : rendered;
+
+		// Recurse into children before invoking the after-diff hook
+		const str = _renderToString(
+			rendered,
+			context,
+			isSvgMode,
+			selectValue,
+			vnode
+		);
+		if (afterDiff) afterDiff(vnode);
+		vnode[PARENT] = undefined;
+
+		if (ummountHook) ummountHook(vnode);
+
+		return str;
+	}
 
-	if (props) {
-		let attrs = Object.keys(props);
+	// Serialize Element VNodes to HTML
+	let s = '<' + type,
+		html = '',
+		children;
 
-		// allow sorting lexicographically for more determinism (useful for tests, such as via preact-jsx-chai)
-		if (opts && opts.sortAttributes === true) attrs.sort();
+	for (let name in props) {
+		let v = props[name];
 
-		for (let i = 0; i < attrs.length; i++) {
-			let name = attrs[i],
-				v = props[name];
-			if (name === 'children') {
-				propChildren = v;
+		switch (name) {
+			case 'children':
+				children = v;
 				continue;
-			}
-
-			if (UNSAFE_NAME.test(name)) continue;
 
-			if (
-				!(opts && opts.allAttributes) &&
-				(name === 'key' ||
-					name === 'ref' ||
-					name === '__self' ||
-					name === '__source')
-			)
+			// VDOM-specific props
+			case 'key':
+			case 'ref':
+			case '__self':
+			case '__source':
 				continue;
 
-			if (name === 'defaultValue') {
-				name = 'value';
-			} else if (name === 'className') {
-				if (typeof props.class !== 'undefined') continue;
-				name = 'class';
-			} else if (isSvgMode && name.match(/^xlink:?./)) {
-				name = name.toLowerCase().replace(/^xlink:?/, 'xlink:');
-			}
-
-			if (name === 'htmlFor') {
-				if (props.for) continue;
+			// prefer for/class over htmlFor/className
+			case 'htmlFor':
+				if ('for' in props) continue;
 				name = 'for';
-			}
-
-			if (name === 'style' && v && typeof v === 'object') {
-				v = styleObjToCss(v);
-			}
-
-			// always use string values instead of booleans for aria attributes
-			// also see https://github.com/preactjs/preact/pull/2347/files
-			if (name[0] === 'a' && name['1'] === 'r' && typeof v === 'boolean') {
-				v = String(v);
-			}
+				break;
+			case 'className':
+				if ('class' in props) continue;
+				name = 'class';
+				break;
 
-			let hooked =
-				opts.attributeHook &&
-				opts.attributeHook(name, v, context, opts, isComponent);
-			if (hooked || hooked === '') {
-				s += hooked;
-				continue;
-			}
+			// Form element reflected properties
+			case 'defaultChecked':
+				name = 'checked';
+				break;
+			case 'defaultSelected':
+				name = 'selected';
+				break;
 
-			if (name === 'dangerouslySetInnerHTML') {
-				html = v && v.__html;
-			} else if (nodeName === 'textarea' && name === 'value') {
-				// <textarea value="a&b"> --> <textarea>a&amp;b</textarea>
-				propChildren = v;
-			} else if ((v || v === 0 || v === '') && typeof v !== 'function') {
-				if (v === true || v === '') {
-					v = name;
-					// in non-xml mode, allow boolean attributes
-					if (!opts || !opts.xml) {
-						s += ' ' + name;
+			// Special value attribute handling
+			case 'defaultValue':
+			case 'value':
+				name = 'value';
+				switch (type) {
+					// <textarea value="a&b"> --> <textarea>a&amp;b</textarea>
+					case 'textarea':
+						children = v;
 						continue;
-					}
-				}
 
-				if (name === 'value') {
-					if (nodeName === 'select') {
+					// <select value> is serialized as a selected attribute on the matching option child
+					case 'select':
 						selectValue = v;
 						continue;
-					} else if (nodeName === 'option' && selectValue == v) {
-						s += ` selected`;
-					}
-				}
-				s += ` ${name}="${encodeEntities(v)}"`;
-			}
-		}
-	}
-
-	// account for >1 multiline attribute
-	if (pretty) {
-		let sub = s.replace(/\n\s*/, ' ');
-		if (sub !== s && !~sub.indexOf('\n')) s = sub;
-		else if (pretty && ~s.indexOf('\n')) s += '\n';
-	}
 
-	s += '>';
-
-	if (UNSAFE_NAME.test(nodeName))
-		throw new Error(`${nodeName} is not a valid HTML tag name in ${s}`);
+					// Add a selected attribute to <option> if its value matches the parent <select> value
+					case 'option':
+						if (selectValue == v && !('selected' in props)) {
+							s = s + ' selected';
+						}
+						break;
+				}
+				break;
 
-	let isVoid =
-		VOID_ELEMENTS.test(nodeName) ||
-		(opts.voidElements && opts.voidElements.test(nodeName));
-	let pieces = [];
+			case 'dangerouslySetInnerHTML':
+				html = v && v.__html;
+				continue;
 
-	let children;
-	if (html) {
-		// if multiline, indent.
-		if (pretty && isLargeString(html)) {
-			html = '\n' + indentChar + indent(html, indentChar);
-		}
-		s += html;
-	} else if (
-		propChildren != null &&
-		getChildren((children = []), propChildren).length
-	) {
-		let hasLarge = pretty && ~s.indexOf('\n');
-		let lastWasText = false;
-
-		for (let i = 0; i < children.length; i++) {
-			let child = children[i];
-
-			if (child != null && child !== false) {
-				let childSvgMode =
-						nodeName === 'svg'
-							? true
-							: nodeName === 'foreignObject'
-							? false
-							: isSvgMode,
-					ret = _renderToString(
-						child,
-						context,
-						opts,
-						true,
-						childSvgMode,
-						selectValue
-					);
-
-				if (pretty && !hasLarge && isLargeString(ret)) hasLarge = true;
-
-				// Skip if we received an empty string
-				if (ret) {
-					if (pretty) {
-						let isText = ret.length > 0 && ret[0] != '<';
-
-						// We merge adjacent text nodes, otherwise each piece would be printed
-						// on a new line.
-						if (lastWasText && isText) {
-							pieces[pieces.length - 1] += ret;
-						} else {
-							pieces.push(ret);
-						}
+			// serialize object styles to a CSS string
+			case 'style':
+				if (typeof v === 'object') {
+					v = styleObjToCss(v);
+				}
+				break;
 
-						lastWasText = isText;
-					} else {
-						pieces.push(ret);
-					}
+			default: {
+				if (isSvgMode && XLINK.test(name)) {
+					name = name.toLowerCase().replace(XLINK_REPLACE_REGEX, 'xlink:');
+				} else if (UNSAFE_NAME.test(name)) {
+					continue;
+				} else if ((name[4] === '-' || name === 'draggable') && v != null) {
+					// serialize boolean aria-xyz or draggable attribute values as strings
+					// `draggable` is an enumerated attribute and not Boolean. A value of `true` or `false` is mandatory
+					// https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/draggable
+					v += '';
 				}
 			}
 		}
-		if (pretty && hasLarge) {
-			for (let i = pieces.length; i--; ) {
-				pieces[i] = '\n' + indentChar + indent(pieces[i], indentChar);
+
+		// write this attribute to the buffer
+		if (v != null && v !== false && typeof v !== 'function') {
+			if (v === true || v === '') {
+				s = s + ' ' + name;
+			} else {
+				s = s + ' ' + name + '="' + encodeEntities(v + '') + '"';
 			}
 		}
 	}
 
-	if (pieces.length || html) {
-		s += pieces.join('');
-	} else if (opts && opts.xml) {
-		return s.substring(0, s.length - 1) + ' />';
+	if (UNSAFE_NAME.test(type)) {
+		// this seems to performs a lot better than throwing
+		// return '<!-- -->';
+		throw new Error(`${type} is not a valid HTML tag name in ${s}>`);
 	}
 
-	if (isVoid && !children && !html) {
-		s = s.replace(/>$/, ' />');
-	} else {
-		if (pretty && ~s.indexOf('\n')) s += '\n';
-		s += `</${nodeName}>`;
+	if (html) {
+		// dangerouslySetInnerHTML defined this node's contents
+	} else if (typeof children === 'string') {
+		// single text child
+		html = encodeEntities(children);
+	} else if (children != null && children !== false && children !== true) {
+		// recurse into this element VNode's children
+		let childSvgMode =
+			type === 'svg' || (type !== 'foreignObject' && isSvgMode);
+		html = _renderToString(children, context, childSvgMode, selectValue, vnode);
 	}
 
-	return s;
-}
+	if (afterDiff) afterDiff(vnode);
+	vnode[PARENT] = undefined;
+	if (ummountHook) ummountHook(vnode);
 
-function getComponentName(component) {
-	return (
-		component.displayName ||
-		(component !== Function && component.name) ||
-		getFallbackComponentName(component)
-	);
-}
-
-function getFallbackComponentName(component) {
-	let str = Function.prototype.toString.call(component),
-		name = (str.match(/^\s*function\s+([^( ]+)/) || '')[1];
-	if (!name) {
-		// search for an existing indexed name for the given component:
-		let index = -1;
-		for (let i = UNNAMED.length; i--; ) {
-			if (UNNAMED[i] === component) {
-				index = i;
-				break;
-			}
-		}
-		// not found, create a new indexed name:
-		if (index < 0) {
-			index = UNNAMED.push(component) - 1;
-		}
-		name = `UnnamedComponent${index}`;
+	// Emit self-closing tag for empty void elements:
+	if (!html && SELF_CLOSING.has(type)) {
+		return s + '/>';
 	}
-	return name;
-}
-renderToString.shallowRender = shallowRender;
 
-export default renderToString;
+	return s + '>' + html + '</' + type + '>';
+}
 
-export {
-	renderToString as render,
-	renderToString as renderToStaticMarkup,
-	renderToString,
-	shallowRender
-};
+const XLINK_REPLACE_REGEX = /^xlink:?/;
+const SELF_CLOSING = new Set([
+	'area',
+	'base',
+	'br',
+	'col',
+	'command',
+	'embed',
+	'hr',
+	'img',
+	'input',
+	'keygen',
+	'link',
+	'meta',
+	'param',
+	'source',
+	'track',
+	'wbr'
+]);