Skip to content

[Backport] Update topo {Get,Create}Keyspace to prevent invalid keyspace names (#12732)#12771

Merged
frouioui merged 2 commits intovitessio:release-16.0from
planetscale:andrew/bp-12732
Mar 30, 2023
Merged

[Backport] Update topo {Get,Create}Keyspace to prevent invalid keyspace names (#12732)#12771
frouioui merged 2 commits intovitessio:release-16.0from
planetscale:andrew/bp-12732

Conversation

@ajm188
Copy link
Contributor

@ajm188 ajm188 commented Mar 29, 2023

Backports #12732, had to do manually to not pick up #12525

@frouioui
Update topo {Get,Create}Keyspace to prevent invalid keyspace names (v…
2432c42 
…itessio#12732)

* Update topo {Get,Create}Keyspace to prevent invalid keyspace names

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* embarrassing

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* docs, release notes

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* only validate, do not correct

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* broader restrictions via allow-list

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* Revert "broader restrictions via allow-list"

This reverts commit 5354d4f.

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* tighten up release notes scope

Signed-off-by: Andrew Mason <andrew@planetscale.com>

* Update go/vt/topo/keyspace.go

Co-authored-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>

---------

Signed-off-by: Andrew Mason <andrew@planetscale.com>
Co-authored-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>
@vitess-bot vitess-bot bot added the NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work label Mar 29, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Mar 29, 2023

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow should be required, the maintainer team should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from VTop, if used there.

@vitess-bot vitess-bot bot added the NeedsWebsiteDocsUpdate What it says label Mar 29, 2023
mattlord
mattlord reviewed Mar 29, 2023
View reviewed changes
go/vt/topo/keyspace.go Outdated
// ValidateKeyspaceName checks if the provided name is a valid name for a
// keyspace.
//
// As of v17, "all invalid characters" is just the forward slash ("/").
Copy link
Member

@mattlord mattlord Mar 29, 2023

Choose a reason for hiding this comment

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

We should update this to v16.0.2, unless we want to make an exception for this one and get it into v16.0.1 (in code freeze now)?

Copy link
Contributor Author

@ajm188 ajm188 Mar 30, 2023

Choose a reason for hiding this comment

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

@frouioui and i were planning to get this into v16.0.1. will update

Copy link
Member

@frouioui frouioui Mar 30, 2023

Choose a reason for hiding this comment

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

Oh yeah, let's change this to v16.0.1

go/vt/vtorc/inst/keyspace_dao.go
Comment on lines +33 to +35
if err := topo.ValidateKeyspaceName(keyspaceName); err != nil {
return nil, err
}
Copy link
Member

@mattlord mattlord Mar 29, 2023

Choose a reason for hiding this comment

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

In the upstream PR we documented this as a breaking change. And here I can see that it could be. Do we really want to backport this? If so, don't we want the same release notes summary update?

Copy link
Contributor Author

@ajm188 ajm188 Mar 30, 2023

Choose a reason for hiding this comment

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

yes, we want the backport, i'll update the notes!

update notes and comments
6d9b093 
Signed-off-by: Andrew Mason <andrew@planetscale.com>
@frouioui frouioui removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Mar 30, 2023
frouioui
frouioui approved these changes Mar 30, 2023
View reviewed changes
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

Agreed with @mattlord comments. The rest LGTM

rsajwani
rsajwani reviewed Mar 30, 2023
View reviewed changes
go/vt/topo/keyspace.go

// GetKeyspace reads the given keyspace and returns it
func (ts *Server) GetKeyspace(ctx context.Context, keyspace string) (*KeyspaceInfo, error) {
if err := ValidateKeyspaceName(keyspace); err != nil {
Copy link
Contributor

@rsajwani rsajwani Mar 30, 2023

Choose a reason for hiding this comment

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

may be I am missing something here. What will happen to existing keyspaces with "/" ??

@frouioui frouioui merged commit adf1019 into vitessio:release-16.0 Mar 30, 2023
@frouioui frouioui deleted the andrew/bp-12732 branch March 30, 2023 14:23
@hmaurer hmaurer mentioned this pull request Mar 21, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mattlord mattlord mattlord left review comments

@rsajwani rsajwani rsajwani left review comments

@frouioui frouioui frouioui approved these changes

@deepthi deepthi Awaiting requested review from deepthi

@shlomi-noach shlomi-noach Awaiting requested review from shlomi-noach shlomi-noach is a code owner

+1 more reviewer

@GuptaManan100 GuptaManan100 GuptaManan100 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Backport This is a backport Component: Cluster management Type: Bug

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@ajm188 @mattlord @rsajwani @frouioui @GuptaManan100