[wb1812.0.fixrenderstate] Make sure RenderState.Root is an internal concept only #2387
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
🦋 Changeset detectedLatest commit: 00b2edd The changes in this PR will be included in the next version bump. This PR includes changesets to release 27 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
GeraldRequired Reviewers
Don't want to be involved in this pull request? Comment |
npm Snapshot: Published🎉 Good news!! We've packaged up the latest commit from this PR (e3eec76) and published all packages with changesets to npm. You can install the packages in webapp by running: ./services/static/dev/tools/deploy_wonder_blocks.js --tag="PR2387"Packages can also be installed manually by running: yarn add @khanacademy/wonder-blocks-<package-name>@PR2387 |
|
Size Change: +33 B (+0.03%) Total Size: 102 kB
ℹ️ View Unchanged
|
A new build was pushed to Chromatic! 🚀https://5e1bf4b385e3fb0020b7073c-apnduxhdvs.chromatic.com/ Chromatic results:
|
jandrade
approved these changes
Dec 11, 2024
packages/wonder-blocks-core/src/components/render-state-context.ts
Outdated
Show resolved
Hide resolved
Comment on lines
-53
to
-58
| if (renderState === RenderState.Root) { | ||
| throw new Error( | ||
| "Components using useUniqueIdWithoutMock() should be descendants of <RenderStateRoot>", | ||
| ); | ||
| } | ||
|
|
There was a problem hiding this comment.
praise: It is great seeing how this got simplified!!
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2387 +/- ##
============================
============================
Continue to review full report in Codecov by Sentry.
|
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.
Summary:
This addresses an issue where
useRenderStatewould returnRenderState.Rootduring initial render to components nested inside ourRenderStateRootcomponent, when they should only ever seeInitialorStandard.I suspect this was happening due to hook execution order and render order. React component render functions are executed from the inside out, and I suspect that because of this, the initial call to
useRenderStateis using the default context value, because the root component hasn't rendered it's value yet - a general flaw in hook-based context access.However, for everything but
RenderStateRootandInitialFallbackcomponents, code doesn't need to know if it's the root render or not. It's an easier API if they just always seeInitialorStandard. This change makes that happen. The only components that need to know are those that need to render the actual context, and our consumers don't need to do that.This addresses an issue where the
useUniqueIdhook and it's initial render fallback version would throw an error on initial render. It's a precursor PR to unblock folks while we work on replacing our unique ID stuff withuseId.Issue: WB-1812
Test plan:
yarn testyarn typecheckI also checked our Wonder Blocks consumers to verify that they don't care about the "root" render state (as they shouldn't).
Release Info:
This is a major release of Core because we are changing the
RenderStateenum to remove a value, and changing the behavior of theuseRenderStatehook. In real terms, consumers should be unaffected, but changing exports like this should be a major release so following protocol.