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-24.1: ui: alter role events render correctly #126568

Merged
merged 1 commit into from
Jul 24, 2024

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Jul 2, 2024

Backport 1/1 commits from #126354 on behalf of @dhartunian.

/cc @cockroachdb/release


Previously, ALTER ROLE events without role options would render with an "undefined" option in the event log on the DB Console. This change amends the rendering logic to correctly render events without any options.

Resolves #124871
Epic: None

Release note (bug fix,ui change): ALTER ROLE events in the DB Console event log now render correctly when the event does not contain any role options.


Release justification:

@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-24.1-126354 branch from b93be59 to 3c45c01 Compare July 2, 2024 17:06
@blathers-crl blathers-crl bot requested a review from a team as a code owner July 2, 2024 17:06
@blathers-crl blathers-crl bot requested review from nkodali and removed request for a team July 2, 2024 17:06
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Jul 2, 2024
@blathers-crl blathers-crl bot requested review from kyle-a-wong and xinhaoz July 2, 2024 17:06
Copy link
Author

blathers-crl bot commented Jul 2, 2024

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Backports should only be created for serious
    issues
    or test-only changes.
  • Backports should not break backwards-compatibility.
  • Backports should change as little code as possible.
  • Backports should not change on-disk formats or node communication protocols.
  • Backports should not add new functionality (except as defined
    here).
  • Backports must not add, edit, or otherwise modify cluster versions; or add version gates.
  • All backports must be reviewed by the owning areas TL and one additional
    TL. For more information as to how that review should be conducted, please consult the backport
    policy
    .
If your backport adds new functionality, please ensure that the following additional criteria are satisfied:
  • 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. State changes must be further protected such that nodes running old binaries will not be negatively impacted by the new state (with a mixed version test added).
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.
  • Your backport must be accompanied by a post to the appropriate Slack
    channel (#db-backports-point-releases or #db-backports-XX-X-release) for awareness and discussion.

Also, please add a brief release justification to the body of your PR to justify this
backport.

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

This change is Reviewable

Copy link
Collaborator

@rafiss rafiss left a comment

Choose a reason for hiding this comment

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

Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (waiting on @blathers-crl[bot], @kyle-a-wong, and @nkodali)


pkg/ui/workspaces/db-console/src/util/events.ts line 184 at r1 (raw file):

        return `Role Altered: User ${info.User} altered role ${info.RoleName} with options ${info.Options}`;
      } else {
        return `Role Altered: User ${info.User} altered role ${info.RoleName}`;

if options isn't present, then the event will be defined as:

&eventpb.AlterRole{
RoleName: roleName.Normalized(),
SetInfo: []string{"DEFAULTSETTINGS"},
})

it might be worth checking that the SetInfo field is populated, but that would just be a sanity check since that field always will contain a constant string (DEFAULTSETTINGS).

i do think it would be useful for this message to say something more specific, like User %{info.User} altered default session variables for role ${info.RoleName}`. this backport lgtm, but if you agree, that change can be made in a separate PR.

@dhartunian
Copy link
Collaborator

dhartunian commented Jul 15, 2024

ack @rafiss I'll put up a separate PR to iterate on this a second time. Thanks for the advice.

Tracking in #127182

Previously, ALTER ROLE events without role options would render with
an "undefined" option in the event log on the DB Console. This change
amends the rendering logic to correctly render events without any
options.

Resolves #124871
Epic: None

Release note (bug fix,ui change): ALTER ROLE events in the DB Console
event log now render correctly when the event does not contain any
role options.
@dhartunian dhartunian force-pushed the blathers/backport-release-24.1-126354 branch from 6c85f55 to 4bb36a8 Compare July 16, 2024 14:31
@dhartunian dhartunian merged commit a7ec4dd into release-24.1 Jul 24, 2024
18 of 20 checks passed
@dhartunian dhartunian deleted the blathers/backport-release-24.1-126354 branch July 24, 2024 18:57
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 blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants