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

release-23.1: cluster-ui: break circular import of rootActions #110256

Merged
merged 1 commit into from
Sep 8, 2023

Conversation

xinhaoz
Copy link
Member

@xinhaoz xinhaoz commented Sep 8, 2023

Backport 1/1 commits from #109720.

/cc @cockroachdb/release


Importing rootActions from reducers.ts in cluster-ui was causing a circular import, preventing one of the redux fields experiencing the cyclic dependency from having their reducer populated, which omitted that field from the store altogether. Currently, this field is uiConfig which is affecting features that rely on checking the sql role of a user, such as displaying the Reset SQL Stats button.

This commit extracts rootActions into its own file to remove the cyclic dependencies created.

Fixes: #97996

Release note (bug fix): On CC, Reset Sql Stats button is now visible if the user has admin role.

Release justification: bug fix for cloud

Using a production buiild 23.1 cluster-ui version:
image

Importing  `rootActions` from `reducers.ts` in cluster-ui was causing a
circular imort, preventing one of the redux fields experiencing the
cyclic dependency from having their reducer populated, which omitted that
field from the store altogether. Currently, this field is `uiConfig` which is
affecting features that rely on checking the sql role of a user, such
as displaying the `Reset SQL Stats` button.

This commit extracts `rootActions` into its own file to remove the cyclic
dependencies created.

Fixes: cockroachdb#97996

Release note (bug fix): On CC, `Rest Sql Stats` button is now
visible if the user has admin role.
@xinhaoz xinhaoz requested a review from a team September 8, 2023 14:42
@blathers-crl
Copy link

blathers-crl bot commented Sep 8, 2023

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues or test-only changes.
  • Patches should not break backwards-compatibility.
  • Patches should change as little code as possible.
  • Patches should not change on-disk formats or node communication protocols.
  • Patches should not add new functionality.
  • Patches must not add, edit, or otherwise modify cluster versions; or add version gates.
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters.
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.

Add a brief release justification to the body of your PR to justify this backport.

Some other things to consider:

  • What did we do to ensure that a user that doesn’t know & care about this backport, has no idea that it happened?
  • Will this work in a cluster of mixed patch versions? Did we test that?
  • If a user upgrades a patch version, uses this feature, and then downgrades, what happens?

@blathers-crl blathers-crl bot added the backport Label PR's that are backports to older release branches label Sep 8, 2023
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@xinhaoz xinhaoz requested a review from a team September 8, 2023 14:54
Copy link
Contributor

@gtr gtr left a comment

Choose a reason for hiding this comment

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

Reviewed 8 of 8 files at r1, all commit messages.
Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (waiting on @xinhaoz)

@xinhaoz xinhaoz merged commit fbcfc73 into cockroachdb:release-23.1 Sep 8, 2023
@xinhaoz xinhaoz deleted the backport23.1-109720 branch September 8, 2023 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Label PR's that are backports to older release branches
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants