diff options
author | 2022-10-10 09:01:15 -0400 | |
---|---|---|
committer | 2022-10-10 09:01:15 -0400 | |
commit | b1964e9e1b7f9178036e266b89d3c8b9cbffd1c6 (patch) | |
tree | 950e85912ddfd20a20ca2ac7cec58479b3199da7 /packages/integrations/preact/src/server.ts | |
parent | 2314e48f03249b2eca9f9ceb883d2d20fd6efc51 (diff) | |
download | astro-b1964e9e1b7f9178036e266b89d3c8b9cbffd1c6.tar.gz astro-b1964e9e1b7f9178036e266b89d3c8b9cbffd1c6.tar.zst astro-b1964e9e1b7f9178036e266b89d3c8b9cbffd1c6.zip |
Revert "Revert preact signals support (#4843)" (#5015)
This reverts commit 25a5b9a89aee81c87affca64e1682ebc0c553eaf.
Diffstat (limited to 'packages/integrations/preact/src/server.ts')
-rw-r--r-- | packages/integrations/preact/src/server.ts | 130 |
1 files changed, 130 insertions, 0 deletions
diff --git a/packages/integrations/preact/src/server.ts b/packages/integrations/preact/src/server.ts new file mode 100644 index 000000000..212e183cf --- /dev/null +++ b/packages/integrations/preact/src/server.ts @@ -0,0 +1,130 @@ +import { Component as BaseComponent, h } from 'preact'; +import render from 'preact-render-to-string'; +import { getContext } from './context.js'; +import { restoreSignalsOnProps, serializeSignals } from './signals.js'; +import StaticHtml from './static-html.js'; +import type { AstroPreactAttrs, RendererContext } from './types'; + +const slotName = (str: string) => str.trim().replace(/[-_]([a-z])/g, (_, w) => w.toUpperCase()); + +let originalConsoleError: typeof console.error; +let consoleFilterRefs = 0; + +function check(this: RendererContext, Component: any, props: Record<string, any>, children: any) { + if (typeof Component !== 'function') return false; + + if (Component.prototype != null && typeof Component.prototype.render === 'function') { + return BaseComponent.isPrototypeOf(Component); + } + + useConsoleFilter(); + + try { + try { + const { html } = renderToStaticMarkup.call(this, Component, props, children); + if (typeof html !== 'string') { + return false; + } + + // There are edge cases (SolidJS) where Preact *might* render a string, + // but components would be <undefined></undefined> + + return !/\<undefined\>/.test(html); + } catch (err) { + return false; + } + } finally { + finishUsingConsoleFilter(); + } +} + +function renderToStaticMarkup( + this: RendererContext, + Component: any, + props: Record<string, any>, + { default: children, ...slotted }: Record<string, any> +) { + const ctx = getContext(this.result); + + const slots: Record<string, ReturnType<typeof h>> = {}; + for (const [key, value] of Object.entries(slotted)) { + const name = slotName(key); + slots[name] = h(StaticHtml, { value, name }); + } + + // Restore signals back onto props so that they will be passed as-is to components + let propsMap = restoreSignalsOnProps(ctx, props); + + const newProps = { ...props, ...slots }; + + const attrs: AstroPreactAttrs = {}; + serializeSignals(ctx, props, attrs, propsMap); + + const html = render( + h(Component, newProps, children != null ? h(StaticHtml, { value: children }) : children) + ); + return { + attrs, + html, + }; +} + +/** + * Reduces console noise by filtering known non-problematic errors. + * + * Performs reference counting to allow parallel usage from async code. + * + * To stop filtering, please ensure that there always is a matching call + * to `finishUsingConsoleFilter` afterwards. + */ +function useConsoleFilter() { + consoleFilterRefs++; + + if (!originalConsoleError) { + // eslint-disable-next-line no-console + originalConsoleError = console.error; + + try { + // eslint-disable-next-line no-console + console.error = filteredConsoleError; + } catch (error) { + // If we're unable to hook `console.error`, just accept it + } + } +} + +/** + * Indicates that the filter installed by `useConsoleFilter` + * is no longer needed by the calling code. + */ +function finishUsingConsoleFilter() { + consoleFilterRefs--; + + // Note: Instead of reverting `console.error` back to the original + // when the reference counter reaches 0, we leave our hook installed + // to prevent potential race conditions once `check` is made async +} + +/** + * Hook/wrapper function for the global `console.error` function. + * + * Ignores known non-problematic errors while any code is using the console filter. + * Otherwise, simply forwards all arguments to the original function. + */ +function filteredConsoleError(msg: string, ...rest: any[]) { + if (consoleFilterRefs > 0 && typeof msg === 'string') { + // In `check`, we attempt to render JSX components through Preact. + // When attempting this on a React component, React may output + // the following error, which we can safely filter out: + const isKnownReactHookError = + msg.includes('Warning: Invalid hook call.') && + msg.includes('https://reactjs.org/link/invalid-hook-call'); + if (isKnownReactHookError) return; + } + originalConsoleError(msg, ...rest); +} + +export default { + check, + renderToStaticMarkup, +}; |