Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes to DashContainerModel state handling + renders #3839

Merged
merged 1 commit into from
Nov 23, 2024

Conversation

amcclain
Copy link
Member

  • State updates were being dropped if new state applied during re-render, when ref not available.
  • Observed in use case with ViewManager, where the parent component was being moved in the layout at same time as new dash state applied.
  • Don't ignore state updates if not rendered - store and save for later application.
  • But improve ref reaction and async state application code to avoid unintended / overlapping application of state when both state and render changing at the same time.

Hoist P/R Checklist

Pull request authors: Review and check off the below. Items that do not apply can also be
checked off to indicate they have been considered. If unclear if a step is relevant, please leave
unchecked and note in comments.

  • Caught up with develop branch as of last change.
  • Added CHANGELOG entry, or determined not required.
  • Reviewed for breaking changes, added breaking-change label + CHANGELOG if so.
  • Updated doc comments / prop-types, or determined not required.
  • Reviewed and tested on Mobile, or determined not required.
  • Created Toolbox branch / PR, or determined not required.

If your change is still a WIP, please use the "Create draft pull request" option in the split
button below to indicate it is not ready yet for a final review.

Pull request reviewers: when merging this P/R, please consider using a squash commit to
collapse multiple intermediate commits into a single commit representing the overall feature
change. This helps keep the commit log clean and easy to scan across releases. PRs containing a
single commit should be rebased when possible.

+ State updates were being dropped if new state applied during re-render, when ref not available.
+ Observed in use case with ViewManager, where the parent component was being moved in the layout at same time as new dash state applied.
+ Don't ignore state updates if not rendered - store and save for later application.
+ But improve ref reaction and async state application code to avoid unintended / overlapping application of state when both state and render changing at the same time.
@@ -214,8 +214,12 @@ export class DashContainerModel
// Initialize GoldenLayout with initial state once ref is ready
this.addReaction(
{
track: () => [this.containerRef.current, this.layoutLocked],
run: () => this.loadStateAsync(this.state)
track: () => [this.containerRef.current, this.layoutLocked] as const,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not test the layoutLocked change path, but good to ensure that all working as expected

@lbwexler lbwexler merged commit ca6810a into develop Nov 23, 2024
2 checks passed
@lbwexler lbwexler deleted the dashContainerState branch November 23, 2024 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants