| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670 |
- /* global window */
- /* eslint-disable eqeqeq, prefer-const, @typescript-eslint/no-empty-function */
- /*! Copyright (c) Meta Platforms, Inc. and affiliates. **/
- /**
- * This is simplified pure-js version of https://github.com/facebook/react/blob/main/packages/react-refresh/src/ReactFreshRuntime.js
- * without IE11 compatibility and verbose isDev checks.
- * Some utils are appended at the bottom for HMR integration.
- */
- const REACT_FORWARD_REF_TYPE = Symbol.for('react.forward_ref')
- const REACT_MEMO_TYPE = Symbol.for('react.memo')
- // We never remove these associations.
- // It's OK to reference families, but use WeakMap/Set for types.
- let allFamiliesByID = new Map()
- let allFamiliesByType = new WeakMap()
- let allSignaturesByType = new WeakMap()
- // This WeakMap is read by React, so we only put families
- // that have actually been edited here. This keeps checks fast.
- const updatedFamiliesByType = new WeakMap()
- // This is cleared on every performReactRefresh() call.
- // It is an array of [Family, NextType] tuples.
- let pendingUpdates = []
- // This is injected by the renderer via DevTools global hook.
- const helpersByRendererID = new Map()
- const helpersByRoot = new Map()
- // We keep track of mounted roots so we can schedule updates.
- const mountedRoots = new Set()
- // If a root captures an error, we remember it so we can retry on edit.
- const failedRoots = new Set()
- // We also remember the last element for every root.
- // It needs to be weak because we do this even for roots that failed to mount.
- // If there is no WeakMap, we won't attempt to do retrying.
- let rootElements = new WeakMap()
- let isPerformingRefresh = false
- function computeFullKey(signature) {
- if (signature.fullKey !== null) {
- return signature.fullKey
- }
- let fullKey = signature.ownKey
- let hooks
- try {
- hooks = signature.getCustomHooks()
- } catch (err) {
- // This can happen in an edge case, e.g. if expression like Foo.useSomething
- // depends on Foo which is lazily initialized during rendering.
- // In that case just assume we'll have to remount.
- signature.forceReset = true
- signature.fullKey = fullKey
- return fullKey
- }
- for (let i = 0; i < hooks.length; i++) {
- const hook = hooks[i]
- if (typeof hook !== 'function') {
- // Something's wrong. Assume we need to remount.
- signature.forceReset = true
- signature.fullKey = fullKey
- return fullKey
- }
- const nestedHookSignature = allSignaturesByType.get(hook)
- if (nestedHookSignature === undefined) {
- // No signature means Hook wasn't in the source code, e.g. in a library.
- // We'll skip it because we can assume it won't change during this session.
- continue
- }
- const nestedHookKey = computeFullKey(nestedHookSignature)
- if (nestedHookSignature.forceReset) {
- signature.forceReset = true
- }
- fullKey += '\n---\n' + nestedHookKey
- }
- signature.fullKey = fullKey
- return fullKey
- }
- function haveEqualSignatures(prevType, nextType) {
- const prevSignature = allSignaturesByType.get(prevType)
- const nextSignature = allSignaturesByType.get(nextType)
- if (prevSignature === undefined && nextSignature === undefined) {
- return true
- }
- if (prevSignature === undefined || nextSignature === undefined) {
- return false
- }
- if (computeFullKey(prevSignature) !== computeFullKey(nextSignature)) {
- return false
- }
- if (nextSignature.forceReset) {
- return false
- }
- return true
- }
- function isReactClass(type) {
- return type.prototype && type.prototype.isReactComponent
- }
- function canPreserveStateBetween(prevType, nextType) {
- if (isReactClass(prevType) || isReactClass(nextType)) {
- return false
- }
- if (haveEqualSignatures(prevType, nextType)) {
- return true
- }
- return false
- }
- function resolveFamily(type) {
- // Only check updated types to keep lookups fast.
- return updatedFamiliesByType.get(type)
- }
- // This is a safety mechanism to protect against rogue getters and Proxies.
- function getProperty(object, property) {
- try {
- return object[property]
- } catch (err) {
- // Intentionally ignore.
- return undefined
- }
- }
- function performReactRefresh() {
- if (pendingUpdates.length === 0) {
- return null
- }
- if (isPerformingRefresh) {
- return null
- }
- isPerformingRefresh = true
- try {
- const staleFamilies = new Set()
- const updatedFamilies = new Set()
- const updates = pendingUpdates
- pendingUpdates = []
- updates.forEach(([family, nextType]) => {
- // Now that we got a real edit, we can create associations
- // that will be read by the React reconciler.
- const prevType = family.current
- updatedFamiliesByType.set(prevType, family)
- updatedFamiliesByType.set(nextType, family)
- family.current = nextType
- // Determine whether this should be a re-render or a re-mount.
- if (canPreserveStateBetween(prevType, nextType)) {
- updatedFamilies.add(family)
- } else {
- staleFamilies.add(family)
- }
- })
- // TODO: rename these fields to something more meaningful.
- const update = {
- updatedFamilies, // Families that will re-render preserving state
- staleFamilies, // Families that will be remounted
- }
- helpersByRendererID.forEach((helpers) => {
- // Even if there are no roots, set the handler on first update.
- // This ensures that if *new* roots are mounted, they'll use the resolve handler.
- helpers.setRefreshHandler(resolveFamily)
- })
- let didError = false
- let firstError = null
- // We snapshot maps and sets that are mutated during commits.
- // If we don't do this, there is a risk they will be mutated while
- // we iterate over them. For example, trying to recover a failed root
- // may cause another root to be added to the failed list -- an infinite loop.
- const failedRootsSnapshot = new Set(failedRoots)
- const mountedRootsSnapshot = new Set(mountedRoots)
- const helpersByRootSnapshot = new Map(helpersByRoot)
- failedRootsSnapshot.forEach((root) => {
- const helpers = helpersByRootSnapshot.get(root)
- if (helpers === undefined) {
- throw new Error(
- 'Could not find helpers for a root. This is a bug in React Refresh.',
- )
- }
- if (!failedRoots.has(root)) {
- // No longer failed.
- }
- if (rootElements === null) {
- return
- }
- if (!rootElements.has(root)) {
- return
- }
- const element = rootElements.get(root)
- try {
- helpers.scheduleRoot(root, element)
- } catch (err) {
- if (!didError) {
- didError = true
- firstError = err
- }
- // Keep trying other roots.
- }
- })
- mountedRootsSnapshot.forEach((root) => {
- const helpers = helpersByRootSnapshot.get(root)
- if (helpers === undefined) {
- throw new Error(
- 'Could not find helpers for a root. This is a bug in React Refresh.',
- )
- }
- if (!mountedRoots.has(root)) {
- // No longer mounted.
- }
- try {
- helpers.scheduleRefresh(root, update)
- } catch (err) {
- if (!didError) {
- didError = true
- firstError = err
- }
- // Keep trying other roots.
- }
- })
- if (didError) {
- throw firstError
- }
- return update
- } finally {
- isPerformingRefresh = false
- }
- }
- function register(type, id) {
- if (type === null) {
- return
- }
- if (typeof type !== 'function' && typeof type !== 'object') {
- return
- }
- // This can happen in an edge case, e.g. if we register
- // return value of a HOC but it returns a cached component.
- // Ignore anything but the first registration for each type.
- if (allFamiliesByType.has(type)) {
- return
- }
- // Create family or remember to update it.
- // None of this bookkeeping affects reconciliation
- // until the first performReactRefresh() call above.
- let family = allFamiliesByID.get(id)
- if (family === undefined) {
- family = { current: type }
- allFamiliesByID.set(id, family)
- } else {
- pendingUpdates.push([family, type])
- }
- allFamiliesByType.set(type, family)
- // Visit inner types because we might not have registered them.
- if (typeof type === 'object' && type !== null) {
- switch (getProperty(type, '$$typeof')) {
- case REACT_FORWARD_REF_TYPE:
- register(type.render, id + '$render')
- break
- case REACT_MEMO_TYPE:
- register(type.type, id + '$type')
- break
- }
- }
- }
- function setSignature(type, key, forceReset, getCustomHooks) {
- if (!allSignaturesByType.has(type)) {
- allSignaturesByType.set(type, {
- forceReset,
- ownKey: key,
- fullKey: null,
- getCustomHooks: getCustomHooks || (() => []),
- })
- }
- // Visit inner types because we might not have signed them.
- if (typeof type === 'object' && type !== null) {
- switch (getProperty(type, '$$typeof')) {
- case REACT_FORWARD_REF_TYPE:
- setSignature(type.render, key, forceReset, getCustomHooks)
- break
- case REACT_MEMO_TYPE:
- setSignature(type.type, key, forceReset, getCustomHooks)
- break
- }
- }
- }
- // This is lazily called during first render for a type.
- // It captures Hook list at that time so inline requires don't break comparisons.
- function collectCustomHooksForSignature(type) {
- const signature = allSignaturesByType.get(type)
- if (signature !== undefined) {
- computeFullKey(signature)
- }
- }
- export function injectIntoGlobalHook(globalObject) {
- // For React Native, the global hook will be set up by require('react-devtools-core').
- // That code will run before us. So we need to monkeypatch functions on existing hook.
- // For React Web, the global hook will be set up by the extension.
- // This will also run before us.
- let hook = globalObject.__REACT_DEVTOOLS_GLOBAL_HOOK__
- if (hook === undefined) {
- // However, if there is no DevTools extension, we'll need to set up the global hook ourselves.
- // Note that in this case it's important that renderer code runs *after* this method call.
- // Otherwise, the renderer will think that there is no global hook, and won't do the injection.
- let nextID = 0
- globalObject.__REACT_DEVTOOLS_GLOBAL_HOOK__ = hook = {
- renderers: new Map(),
- supportsFiber: true,
- inject: (injected) => nextID++,
- onScheduleFiberRoot: (id, root, children) => {},
- onCommitFiberRoot: (id, root, maybePriorityLevel, didError) => {},
- onCommitFiberUnmount() {},
- }
- }
- if (hook.isDisabled) {
- // This isn't a real property on the hook, but it can be set to opt out
- // of DevTools integration and associated warnings and logs.
- // Using console['warn'] to evade Babel and ESLint
- console['warn'](
- 'Something has shimmed the React DevTools global hook (__REACT_DEVTOOLS_GLOBAL_HOOK__). ' +
- 'Fast Refresh is not compatible with this shim and will be disabled.',
- )
- return
- }
- // Here, we just want to get a reference to scheduleRefresh.
- const oldInject = hook.inject
- hook.inject = function (injected) {
- const id = oldInject.apply(this, arguments)
- if (
- typeof injected.scheduleRefresh === 'function' &&
- typeof injected.setRefreshHandler === 'function'
- ) {
- // This version supports React Refresh.
- helpersByRendererID.set(id, injected)
- }
- return id
- }
- // Do the same for any already injected roots.
- // This is useful if ReactDOM has already been initialized.
- // https://github.com/facebook/react/issues/17626
- hook.renderers.forEach((injected, id) => {
- if (
- typeof injected.scheduleRefresh === 'function' &&
- typeof injected.setRefreshHandler === 'function'
- ) {
- // This version supports React Refresh.
- helpersByRendererID.set(id, injected)
- }
- })
- // We also want to track currently mounted roots.
- const oldOnCommitFiberRoot = hook.onCommitFiberRoot
- const oldOnScheduleFiberRoot = hook.onScheduleFiberRoot || (() => {})
- hook.onScheduleFiberRoot = function (id, root, children) {
- if (!isPerformingRefresh) {
- // If it was intentionally scheduled, don't attempt to restore.
- // This includes intentionally scheduled unmounts.
- failedRoots.delete(root)
- if (rootElements !== null) {
- rootElements.set(root, children)
- }
- }
- return oldOnScheduleFiberRoot.apply(this, arguments)
- }
- hook.onCommitFiberRoot = function (id, root, maybePriorityLevel, didError) {
- const helpers = helpersByRendererID.get(id)
- if (helpers !== undefined) {
- helpersByRoot.set(root, helpers)
- const current = root.current
- const alternate = current.alternate
- // We need to determine whether this root has just (un)mounted.
- // This logic is copy-pasted from similar logic in the DevTools backend.
- // If this breaks with some refactoring, you'll want to update DevTools too.
- if (alternate !== null) {
- const wasMounted =
- alternate.memoizedState != null &&
- alternate.memoizedState.element != null &&
- mountedRoots.has(root)
- const isMounted =
- current.memoizedState != null && current.memoizedState.element != null
- if (!wasMounted && isMounted) {
- // Mount a new root.
- mountedRoots.add(root)
- failedRoots.delete(root)
- } else if (wasMounted && isMounted) {
- // Update an existing root.
- // This doesn't affect our mounted root Set.
- } else if (wasMounted && !isMounted) {
- // Unmount an existing root.
- mountedRoots.delete(root)
- if (didError) {
- // We'll remount it on future edits.
- failedRoots.add(root)
- } else {
- helpersByRoot.delete(root)
- }
- } else if (!wasMounted && !isMounted) {
- if (didError) {
- // We'll remount it on future edits.
- failedRoots.add(root)
- }
- }
- } else {
- // Mount a new root.
- mountedRoots.add(root)
- }
- }
- // Always call the decorated DevTools hook.
- return oldOnCommitFiberRoot.apply(this, arguments)
- }
- }
- // This is a wrapper over more primitive functions for setting signature.
- // Signatures let us decide whether the Hook order has changed on refresh.
- //
- // This function is intended to be used as a transform target, e.g.:
- // var _s = createSignatureFunctionForTransform()
- //
- // function Hello() {
- // const [foo, setFoo] = useState(0);
- // const value = useCustomHook();
- // _s(); /* Call without arguments triggers collecting the custom Hook list.
- // * This doesn't happen during the module evaluation because we
- // * don't want to change the module order with inline requires.
- // * Next calls are noops. */
- // return <h1>Hi</h1>;
- // }
- //
- // /* Call with arguments attaches the signature to the type: */
- // _s(
- // Hello,
- // 'useState{[foo, setFoo]}(0)',
- // () => [useCustomHook], /* Lazy to avoid triggering inline requires */
- // );
- export function createSignatureFunctionForTransform() {
- let savedType
- let hasCustomHooks
- let didCollectHooks = false
- return function (type, key, forceReset, getCustomHooks) {
- if (typeof key === 'string') {
- // We're in the initial phase that associates signatures
- // with the functions. Note this may be called multiple times
- // in HOC chains like _s(hoc1(_s(hoc2(_s(actualFunction))))).
- if (!savedType) {
- // We're in the innermost call, so this is the actual type.
- // $FlowFixMe[escaped-generic] discovered when updating Flow
- savedType = type
- hasCustomHooks = typeof getCustomHooks === 'function'
- }
- // Set the signature for all types (even wrappers!) in case
- // they have no signatures of their own. This is to prevent
- // problems like https://github.com/facebook/react/issues/20417.
- if (
- type != null &&
- (typeof type === 'function' || typeof type === 'object')
- ) {
- setSignature(type, key, forceReset, getCustomHooks)
- }
- return type
- } else {
- // We're in the _s() call without arguments, which means
- // this is the time to collect custom Hook signatures.
- // Only do this once. This path is hot and runs *inside* every render!
- if (!didCollectHooks && hasCustomHooks) {
- didCollectHooks = true
- collectCustomHooksForSignature(savedType)
- }
- }
- }
- }
- function isLikelyComponentType(type) {
- switch (typeof type) {
- case 'function': {
- // First, deal with classes.
- if (type.prototype != null) {
- if (type.prototype.isReactComponent) {
- // React class.
- return true
- }
- const ownNames = Object.getOwnPropertyNames(type.prototype)
- if (ownNames.length > 1 || ownNames[0] !== 'constructor') {
- // This looks like a class.
- return false
- }
- if (type.prototype.__proto__ !== Object.prototype) {
- // It has a superclass.
- return false
- }
- // Pass through.
- // This looks like a regular function with empty prototype.
- }
- // For plain functions and arrows, use name as a heuristic.
- const name = type.name || type.displayName
- return typeof name === 'string' && /^[A-Z]/.test(name)
- }
- case 'object': {
- if (type != null) {
- switch (getProperty(type, '$$typeof')) {
- case REACT_FORWARD_REF_TYPE:
- case REACT_MEMO_TYPE:
- // Definitely React components.
- return true
- default:
- return false
- }
- }
- return false
- }
- default: {
- return false
- }
- }
- }
- function isCompoundComponent(type) {
- if (!isPlainObject(type)) return false
- for (const key in type) {
- if (!isLikelyComponentType(type[key])) return false
- }
- return true
- }
- function isPlainObject(obj) {
- return (
- Object.prototype.toString.call(obj) === '[object Object]' &&
- (obj.constructor === Object || obj.constructor === undefined)
- )
- }
- /**
- * Plugin utils
- */
- export function getRefreshReg(filename) {
- return (type, id) => register(type, filename + ' ' + id)
- }
- // Taken from https://github.com/pmmmwh/react-refresh-webpack-plugin/blob/main/lib/runtime/RefreshUtils.js#L141
- // This allows to resister components not detected by SWC like styled component
- export function registerExportsForReactRefresh(filename, moduleExports) {
- for (const key in moduleExports) {
- if (key === '__esModule') continue
- const exportValue = moduleExports[key]
- if (isLikelyComponentType(exportValue)) {
- // 'export' is required to avoid key collision when renamed exports that
- // shadow a local component name: https://github.com/vitejs/vite-plugin-react/issues/116
- // The register function has an identity check to not register twice the same component,
- // so this is safe to not used the same key here.
- register(exportValue, filename + ' export ' + key)
- } else if (isCompoundComponent(exportValue)) {
- for (const subKey in exportValue) {
- register(
- exportValue[subKey],
- filename + ' export ' + key + '-' + subKey,
- )
- }
- }
- }
- }
- function debounce(fn, delay) {
- let handle
- return () => {
- clearTimeout(handle)
- handle = setTimeout(fn, delay)
- }
- }
- const hooks = []
- window.__registerBeforePerformReactRefresh = (cb) => {
- hooks.push(cb)
- }
- const enqueueUpdate = debounce(async () => {
- if (hooks.length) await Promise.all(hooks.map((cb) => cb()))
- performReactRefresh()
- }, 16)
- export function validateRefreshBoundaryAndEnqueueUpdate(
- id,
- prevExports,
- nextExports,
- ) {
- const ignoredExports = window.__getReactRefreshIgnoredExports?.({ id }) ?? []
- if (
- predicateOnExport(
- ignoredExports,
- prevExports,
- (key) => key in nextExports,
- ) !== true
- ) {
- return 'Could not Fast Refresh (export removed)'
- }
- if (
- predicateOnExport(
- ignoredExports,
- nextExports,
- (key) => key in prevExports,
- ) !== true
- ) {
- return 'Could not Fast Refresh (new export)'
- }
- let hasExports = false
- const allExportsAreComponentsOrUnchanged = predicateOnExport(
- ignoredExports,
- nextExports,
- (key, value) => {
- hasExports = true
- if (isLikelyComponentType(value)) return true
- if (isCompoundComponent(value)) return true
- return prevExports[key] === nextExports[key]
- },
- )
- if (hasExports && allExportsAreComponentsOrUnchanged === true) {
- enqueueUpdate()
- } else {
- return `Could not Fast Refresh ("${allExportsAreComponentsOrUnchanged}" export is incompatible). Learn more at __README_URL__#consistent-components-exports`
- }
- }
- function predicateOnExport(ignoredExports, moduleExports, predicate) {
- for (const key in moduleExports) {
- if (key === '__esModule') continue
- if (ignoredExports.includes(key)) continue
- const desc = Object.getOwnPropertyDescriptor(moduleExports, key)
- if (desc && desc.get) return key
- if (!predicate(key, moduleExports[key])) return key
- }
- return true
- }
- // Hides vite-ignored dynamic import so that Vite can skip analysis if no other
- // dynamic import is present (https://github.com/vitejs/vite/pull/12732)
- export const __hmr_import = (module) => import(/* @vite-ignore */ module)
- // For backwards compatibility with @vitejs/plugin-react.
- export default { injectIntoGlobalHook }
|