fix(signals): enable withProps to handle Symbols
#4656
+28
−3
Conversation
This file contains 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
Resolve an issue in `signalStore` that prevented Symbols from being added as property keys when merging different features.
✅ Deploy Preview for ngrx-io ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
timdeschryver
approved these changes
Jan 6, 2025
markostanimirovic
requested changes
Jan 14, 2025
Comment on lines
+52
to
+70
| it('allows symbols as props', () => { | ||
| const SECRET = Symbol('SECRET'); | ||
|
|
||
| const Store = signalStore(withProps(() => ({ [SECRET]: 'secret' }))); | ||
| const store = TestBed.configureTestingModule({ providers: [Store] }).inject( | ||
| Store | ||
| ); | ||
|
|
||
| expect(store[SECRET]).toBe('secret'); | ||
| }); | ||
|
|
||
| it('allows numbers as props', () => { | ||
| const Store = signalStore(withProps(() => ({ 1: 'Number One' }))); | ||
| const store = TestBed.configureTestingModule({ providers: [Store] }).inject( | ||
| Store | ||
| ); | ||
|
|
||
| expect(store[1]).toBe('Number One'); | ||
| }); |
There was a problem hiding this comment.
The with-props.spec.ts file should contain only unit tests for the withProps function. Check other tests from this file for more info.
These (integration) tests with SignalStore should be added to the signal-store.spec.ts: https://github.com/ngrx/platform/blob/main/modules/signals/spec/signal-store.spec.ts#L150
Let's also add a test that verifies that a symbol prop is available in the next feature, not only in the final store:
signalStore(
withProps(() => ({ [symbol]: 1 })),
withMethods((store) => store[symbol]...
)We should also have tests to verify:
- Behavior when state slice/method name is a symbol.
- Immutability checks for symbol state slices. I don't think the current check will work -
deepFreezeusesObject.getOwnPropertyNames. - Assertion for duplicate keys defined as symbols. Currently, it will not work because
Object.keysis used with theassertUniqueStoreMembersfunction.
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.
Resolve an issue in
signalStorethat prevented Symbols from being added as property keys when mergingdifferent features.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
The value is just undefined.
Closes #4655
Does this PR introduce a breaking change?