feat(client-core-interfaces): DeepReadonly and ShallowReadonly utility types
#24265
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ility types Alternates to `Readonly` that handle `Map`s, `Set`s, `Promise`s, `WeakMap`, and `WeakSet` by providing readonly equivalents. The generic types of those and `IFluidHandle` may also optionally be changed to readonly types. `DeepReadonly` will also apply readonly throughout the entire type not just at the outer level. Also add `ReadonlyJsonTypeWith` and (internal) `ReadonlyNonNullJsonObjectWith` as immutable versions of `JsonTypeWith` and `NonNullJsonObjectWith` respectively. These are used to create readonly versions of the `JsonTypeWith` and `NonNullJsonObjectWith` types.
jason-ha
requested review from
a team,
pragya91,
markfields,
jatgarg,
kian-thompson,
WillieHabi and
MarioJGMsoft
There was a problem hiding this comment.
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
packages/common/core-interfaces/src/jsonType.ts:52
- [nitpick] The documentation comment appears incomplete or unclear; consider revising it to clearly explain the mutability behavior of a 'const' variable.
* does not prevent later `x = 5`. (Does prevent )
jason-ha
commented
Apr 15, 2025
pragya91
approved these changes
Apr 15, 2025
WillieHabi
approved these changes
Apr 22, 2025
markfields
approved these changes
Apr 22, 2025
There was a problem hiding this comment.
Approving without having carefully reviewed the type gymnastics. If it works, it works, and this change can only help avoid runtime abuse (even if it turns out to have a bug or a gap). I see there's lots of tests, so it's clear that this will provide plenty of a speed bump for anyone trying to mess with signals payloads.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Alternates to
Readonlythat handleMap,Set,Promise,WeakMap, andWeakSetby providing readonly equivalents. The generic types of those andIFluidHandlemay also optionally be changed to readonly types.DeepReadonlywill also apply readonly throughout the entire type not just at the outer level.Additionally, the utility types respect FF's
ErasedTypeand class branded primitives.Also add
ReadonlyJsonTypeWithand (internal)ReadonlyNonNullJsonObjectWithas immutable versions ofJsonTypeWithandNonNullJsonObjectWithrespectively. These are used to create readonly versions of theJsonTypeWithandNonNullJsonObjectWithtypes.