tidy,fix(ui): remove unused coords from params slice #8534
Merged
Conversation
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
psychedelicious
requested review from
blessedcoolant,
maryhipp and
hipsterusername
as code owners
github-actions
bot
added
CI-CD
psychedelicious
changed the title
hipsterusername
approved these changes
Sep 4, 2025
Certain items in redux are ephemeral and omitted from persisted slices. On rehydration, we need to inject these values back into the slice. But there was an issue taht could prevent slice migrations from running during rehydration. The migrations look for the `_version` key in state and migrate the slice accordingly. The logic that merged in the ephemeral values accidentally _also_ merged in the `_version` key if it didn't already exist. This happened _before_ migrations are run. This causes problems for slices that didn't have a `_version` key and then have one added via migration. For example, the params slice didn't have a `_version` key until the previous commit, which added `_version` and changed some other parts of state in a migration. On first load of the updated code, we have a catch-22 kinda situation: - The persisted params slice is the old version. It needs to have both `_version` and some other data added to it. - We deserialize the state and then merge in ephemeral values. This inadvertnetly also merged in the `_version` key. - We run the slice migration. It sees there is a `_version` key and thinks it doesn't need to run. The extra data isn't added to the slice. The slice is parsed against its zod schema and fails because the new data is missing. - Because the parse failed, we treat the user's persisted data as invalid and overwrite it with initial state, potentially causing data loss. The fix is to be more selective when merging in the ephemeral state before migration - this is now done by checking which keys are on the persist denylist and only adding those key.
psychedelicious
force-pushed
the
psyche/tidy/ui/remove-unused-coords-from-params-slice
branch
from
32cc5b4 to
2f46664
Compare
psychedelicious
deleted the
psyche/tidy/ui/remove-unused-coords-from-params-slice
branch
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
While working on something else, I noticed there was some extra data in the params slice that was left-over Invoke v6 (x/y coords). This data was added when we created the Generate tab and gave it its own width and height settings, separate from Canvas. The bbox logic from Canvas was copied over, but we didn't remove the x/y coords.
I removed this data, added a migration, and then noticed there was an issue w/ state rehydration that caused the params slice to be reset. After some investigation I noticed that there was a design issue with state rehydration and redux slice migration in some rare scenarios. I fixed it in this PR.
Fixing this cleanly has a knock-on effect - when adding data to a redux slice, you must write a slice migration, else rehydration will fail and reset the user's data! I've updated the PR template so we are reminded to not miss this step when making changes in the future.
Related Issues / Discussions
n/a
QA Instructions
n/a
Merge Plan
n/a
Checklist
What's Newcopy (if doing a release after this PR)