fix(store): expose originalFn on memoized selector in dev mode for clearer warnings#2448
Merged
Conversation
|
View your CI Pipeline Execution ↗ for commit b7048d6
💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗ ☁️ Nx Cloud last updated this comment at |
@ngxs/devtools-plugin
@ngxs/form-plugin
@ngxs/hmr-plugin
@ngxs/router-plugin
@ngxs/storage-plugin
@ngxs/store
@ngxs/websocket-plugin
commit: |
BundleMonFiles updated (2)
Unchanged files (4)
Total files change +174B +0.11% Groups updated (1)
Final result: ❌ View report in BundleMon website ➡️ |
BundleMon (NGXS Plugins)Unchanged files (9)
No change in files bundle size Unchanged groups (1)
Final result: ✅ View report in BundleMon website ➡️ |
BundleMon (Integration Projects)Files updated (1)
Total files change -17B -0.02% Final result: ✅ View report in BundleMon website ➡️ |
…earer warnings Gate the `reset` and `originalFn` properties on the memoized function behind `ngDevMode`, so they are tree-shaken in production builds. In dev mode, expose the original (unwrapped) selector function via `selector.originalFn`, and use it in the `warnOnNewReferenceWithIdenticalValue` console.error so the logged function is navigable in DevTools rather than the internal memoized wrapper. The `&& originalFn` guard also implicitly suppresses the warning in production where the property is not set. Add unit tests covering: warning fires when a new reference with an identical value is returned, no warning when the option is not configured, and no warning when the value genuinely changes.
arturovt
force-pushed
the
fix/expose_originalFn
branch
from
0070610 to
b7048d6
Compare
arturovt
requested review from
Carniatto,
joaqcid,
kuncevic,
markwhitfeld,
poloagustin and
splincode
as code owners
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Gate the
resetandoriginalFnproperties on the memoized function behindngDevMode, so they are tree-shaken in production builds. In dev mode, expose the original (unwrapped) selector function viaselector.originalFn, and use it in thewarnOnNewReferenceWithIdenticalValueconsole.error so the logged function is navigable in DevTools rather than the internal memoized wrapper. The&& originalFnguard also implicitly suppresses the warning in production where the property is not set.Add unit tests covering: warning fires when a new reference with an identical value is returned, no warning when the option is not configured, and no warning when the value genuinely changes.