diff --git a/packages/react-server/src/ReactFlightLedgers.js b/packages/react-server/src/ReactFlightLedgers.js new file mode 100644 index 0000000000..54e9184bbe --- /dev/null +++ b/packages/react-server/src/ReactFlightLedgers.js @@ -0,0 +1,20 @@ +/** + * Copyright (c) Meta Platforms, Inc. and affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + * + * @flow + */ + +// TODO: Only the mask kind exists yet; the other kinds land in a later PR. +export const MASK_LEDGER = 1; + +export type LedgerKind = 1; + +// A ledger identifies which writes a capture should collect. Each capture +// computes its own accumulated value. +// eslint-disable-next-line no-unused-vars +export type Ledger<-E> = { + +kind: LedgerKind, +}; diff --git a/packages/react/src/ReactLedgers.js b/packages/react/src/ReactLedgers.js new file mode 100644 index 0000000000..447e1e8ee9 --- /dev/null +++ b/packages/react/src/ReactLedgers.js @@ -0,0 +1,31 @@ +/** + * Copyright (c) Meta Platforms, Inc. and affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + * + * @flow + */ + +import type {Ledger, LedgerKind} from 'react-server/src/ReactFlightLedgers'; + +import {MASK_LEDGER} from 'react-server/src/ReactFlightLedgers'; + +function createLedger(kind: LedgerKind): Ledger { + const type = { + kind, + }; + if (__DEV__) { + if (Object.freeze) { + Object.freeze(type); + } + } + return type; +} + +export function createMaskLedger(): Ledger { + return createLedger(MASK_LEDGER); +} + +// TODO: Record entries during a Flight render. +export function addToLedger(ledger: Ledger, entry: E): void {} diff --git a/packages/react/src/ReactServer.experimental.development.js b/packages/react/src/ReactServer.experimental.development.js index dd92bf9104..cb2853bd6e 100644 --- a/packages/react/src/ReactServer.experimental.development.js +++ b/packages/react/src/ReactServer.experimental.development.js @@ -38,6 +38,7 @@ import {forwardRef} from './ReactForwardRef'; import {lazy} from './ReactLazy'; import {memo} from './ReactMemo'; import {cache, cacheSignal} from './ReactCacheServer'; +import {createMaskLedger, addToLedger} from './ReactLedgers'; import {startTransition} from './ReactStartTransition'; import {captureOwnerStack} from './ReactOwnerStack'; import version from 'shared/ReactVersion'; @@ -74,6 +75,8 @@ export { memo, cache, cacheSignal, + createMaskLedger, + addToLedger, startTransition, getCacheForType as unstable_getCacheForType, useId, diff --git a/packages/react/src/ReactServer.experimental.js b/packages/react/src/ReactServer.experimental.js index 0eb8eafccd..5b4ecaf8a7 100644 --- a/packages/react/src/ReactServer.experimental.js +++ b/packages/react/src/ReactServer.experimental.js @@ -38,6 +38,7 @@ import {forwardRef} from './ReactForwardRef'; import {lazy} from './ReactLazy'; import {memo} from './ReactMemo'; import {cache, cacheSignal} from './ReactCacheServer'; +import {createMaskLedger, addToLedger} from './ReactLedgers'; import {startTransition} from './ReactStartTransition'; import version from 'shared/ReactVersion'; @@ -73,6 +74,8 @@ export { memo, cache, cacheSignal, + createMaskLedger, + addToLedger, startTransition, getCacheForType as unstable_getCacheForType, useId, diff --git a/packages/shared/ReactFeatureFlags.js b/packages/shared/ReactFeatureFlags.js index e376a0fbd1..3fcf78e1c2 100644 --- a/packages/shared/ReactFeatureFlags.js +++ b/packages/shared/ReactFeatureFlags.js @@ -90,6 +90,9 @@ export const enableFlightWeakThenables = __EXPERIMENTAL__; // where it resolves via the manifest. export const enableFlightObjectReferences = __EXPERIMENTAL__; +// Track metadata such as cache lifetimes and tags during a Flight render. +export const enableFlightLedgers = __EXPERIMENTAL__; + export const enableTaint = __EXPERIMENTAL__; export const enableViewTransition: boolean = true; diff --git a/packages/shared/forks/ReactFeatureFlags.native-fb.js b/packages/shared/forks/ReactFeatureFlags.native-fb.js index 32224aa2b7..f28bfc865e 100644 --- a/packages/shared/forks/ReactFeatureFlags.native-fb.js +++ b/packages/shared/forks/ReactFeatureFlags.native-fb.js @@ -38,6 +38,7 @@ export const disableTextareaChildren: boolean = false; export const enableAsyncIterableChildren: boolean = false; export const enableFlightWeakThenables: boolean = false; export const enableFlightObjectReferences: boolean = false; +export const enableFlightLedgers: boolean = false; export const enableCPUSuspense: boolean = true; export const enableCreateEventHandleAPI: boolean = false; export const enableMoveBefore: boolean = true; diff --git a/packages/shared/forks/ReactFeatureFlags.native-oss.js b/packages/shared/forks/ReactFeatureFlags.native-oss.js index 312bafd0e1..956d365863 100644 --- a/packages/shared/forks/ReactFeatureFlags.native-oss.js +++ b/packages/shared/forks/ReactFeatureFlags.native-oss.js @@ -27,6 +27,7 @@ export const disableTextareaChildren: boolean = false; export const enableAsyncIterableChildren: boolean = false; export const enableFlightWeakThenables: boolean = false; export const enableFlightObjectReferences: boolean = false; +export const enableFlightLedgers: boolean = false; export const enableCPUSuspense: boolean = false; export const enableCreateEventHandleAPI: boolean = false; export const enableMoveBefore: boolean = true; diff --git a/packages/shared/forks/ReactFeatureFlags.test-renderer.js b/packages/shared/forks/ReactFeatureFlags.test-renderer.js index 8a2d9d98fa..28d0980c1c 100644 --- a/packages/shared/forks/ReactFeatureFlags.test-renderer.js +++ b/packages/shared/forks/ReactFeatureFlags.test-renderer.js @@ -21,6 +21,7 @@ export const enableLegacyCache: boolean = __EXPERIMENTAL__; export const enableAsyncIterableChildren: boolean = false; export const enableFlightWeakThenables: boolean = false; export const enableFlightObjectReferences: boolean = false; +export const enableFlightLedgers: boolean = false; export const enableTaint: boolean = true; export const disableCommentsAsDOMContainers: boolean = true; export const disableInputAttributeSyncing: boolean = false; diff --git a/packages/shared/forks/ReactFeatureFlags.test-renderer.native-fb.js b/packages/shared/forks/ReactFeatureFlags.test-renderer.native-fb.js index 70866376aa..9a247a894d 100644 --- a/packages/shared/forks/ReactFeatureFlags.test-renderer.native-fb.js +++ b/packages/shared/forks/ReactFeatureFlags.test-renderer.native-fb.js @@ -22,6 +22,7 @@ export const disableTextareaChildren = false; export const enableAsyncIterableChildren = false; export const enableFlightWeakThenables = false; export const enableFlightObjectReferences = false; +export const enableFlightLedgers = false; export const enableCPUSuspense = true; export const enableCreateEventHandleAPI = false; export const enableMoveBefore = false; diff --git a/packages/shared/forks/ReactFeatureFlags.test-renderer.www.js b/packages/shared/forks/ReactFeatureFlags.test-renderer.www.js index 88648ed04d..de08fb9705 100644 --- a/packages/shared/forks/ReactFeatureFlags.test-renderer.www.js +++ b/packages/shared/forks/ReactFeatureFlags.test-renderer.www.js @@ -21,6 +21,7 @@ export const enableLegacyCache: boolean = true; export const enableAsyncIterableChildren: boolean = false; export const enableFlightWeakThenables: boolean = false; export const enableFlightObjectReferences: boolean = false; +export const enableFlightLedgers: boolean = false; export const enableTaint: boolean = true; export const disableCommentsAsDOMContainers: boolean = true; export const disableInputAttributeSyncing: boolean = false; diff --git a/packages/shared/forks/ReactFeatureFlags.www.js b/packages/shared/forks/ReactFeatureFlags.www.js index 39298336f0..ac04472857 100644 --- a/packages/shared/forks/ReactFeatureFlags.www.js +++ b/packages/shared/forks/ReactFeatureFlags.www.js @@ -68,6 +68,7 @@ export const enableLegacyCache: boolean = true; export const enableAsyncIterableChildren: boolean = false; export const enableFlightWeakThenables: boolean = false; export const enableFlightObjectReferences: boolean = false; +export const enableFlightLedgers: boolean = false; export const enableTaint: boolean = false;