diff options
author | 2022-06-30 14:10:56 +0200 | |
---|---|---|
committer | 2022-06-30 14:10:56 +0200 | |
commit | b934ab5d860aa3adeec56a9c395f629ee7252ca4 (patch) | |
tree | c75a0453e6e62bd6ac9069a4b95fb7164d8b32d7 /packages/integrations/preact/server.js | |
parent | 38f2fd7723407a80fbece621be2d4aa95713df7f (diff) | |
download | astro-b934ab5d860aa3adeec56a9c395f629ee7252ca4.tar.gz astro-b934ab5d860aa3adeec56a9c395f629ee7252ca4.tar.zst astro-b934ab5d860aa3adeec56a9c395f629ee7252ca4.zip |
Fix "Invalid hook call" warning (#3769)
* Fix "Invalid hook call" warning
* Fix eslint warnings
* Apply code review suggestions
Diffstat (limited to 'packages/integrations/preact/server.js')
-rw-r--r-- | packages/integrations/preact/server.js | 83 |
1 files changed, 74 insertions, 9 deletions
diff --git a/packages/integrations/preact/server.js b/packages/integrations/preact/server.js index 29ae8a3b0..36f66b7b5 100644 --- a/packages/integrations/preact/server.js +++ b/packages/integrations/preact/server.js @@ -4,6 +4,9 @@ import StaticHtml from './static-html.js'; const slotName = (str) => str.trim().replace(/[-_]([a-z])/g, (_, w) => w.toUpperCase()); +let originalConsoleError; +let consoleFilterRefs = 0; + function check(Component, props, children) { if (typeof Component !== 'function') return false; @@ -11,18 +14,24 @@ function check(Component, props, children) { return BaseComponent.isPrototypeOf(Component); } + useConsoleFilter(); + try { - const { html } = renderToStaticMarkup(Component, props, children); - if (typeof html !== 'string') { - return false; - } + try { + const { html } = renderToStaticMarkup(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> + // 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; + return !/\<undefined\>/.test(html); + } catch (err) { + return false; + } + } finally { + finishUsingConsoleFilter(); } } @@ -40,6 +49,62 @@ function renderToStaticMarkup(Component, props, { default: children, ...slotted return { 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, ...rest) { + 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, |