Enable widget's OnLoadAction to handle storage-bound input bindings and prevent premature rendering#1087
Open
anserwaseem wants to merge 2 commits intomainfrom
Open
Conversation
…nd prevent premature rendering
🦋 Changeset detectedLatest commit: e3ff145 The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 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 |
Contributor
|
Visit the preview URL for this PR (updated for commit e3ff145): https://react-kitchen-sink-dev--pr1087-1086-widgets-onload-psim3td7.web.app (expires Fri, 18 Jul 2025 12:47:48 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 6267897ade2ba783b6db70a53a60fc3946d625e9 |
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
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.
Describe your changes
The issue was a timing race condition between storage initialization and
onLoadaction execution:OnLoadActionuseEffectfires immediatelyensemble.storage.getdoesn't returns value from storagesessionStorage→screenStorageAtomgets hydratedWhy Widget Properties Worked But onLoad Didn't
Solution Implemented
1: Storage Timing Fix
Modified
OnLoadActioncomponent to wait for storage-bound inputs to be properly evaluated before executing the onLoad action:2: Prevent Flash of Unwanted Content
Enhanced the solution to prevent children from rendering until onLoad completes, eliminating visual flash:
Technical Flow (After Fix)
Impact
setTimeout(..., 0)delay for widgets with storage-bound inputsFailing Test
✕ onLoad action executes after widget inputs are properly evaluated (23 ms) ● Custom Widget › onLoad action has access to widget inputs bound to storage expect(jest.fn()).toHaveBeenCalledWith(...expected) Expected: "userFilters in onLoad:", {"priority": "high", "status": "active"} Received 1 "userFilters in onLoad:", - Object { - "priority": "high", - "status": "active", - } + Object {}, 2: "userFilters type:", "object" 3: "userFilters JSON:", "{}"Screenshots [Optional]
Issue ticket number and link
Closes #1086
Checklist before requesting a review
pnpm changeset add