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.

Sign up for GitHub

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

Jump to bottom

[topo] Disallow the slash character in shard names #12843

Merged
merged 4 commits into from
Apr 6, 2023
Merged

[topo] Disallow the slash character in shard names #12843

merged 4 commits into from
Apr 6, 2023

Conversation

ajm188
Copy link
Contributor

@ajm188 ajm188 commented Apr 5, 2023 •
edited
Loading

Description

Gives echos of #12732

"demo" of this erroring out in vtadmin:

Screen Shot 2023-04-05 at 2 01 52 PM

Related Issue(s)

Fixes #12842.

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

Disallow the slash character in shard names
77c2e29 
Fixes vitessio#12842.

Signed-off-by: Andrew Mason <andrew@planetscale.com>
@ajm188 ajm188 added this to In progress in VTAdmin via automation Apr 5, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Apr 5, 2023 •
edited by deepthi
Loading

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 NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Apr 5, 2023
@github-actions github-actions bot added this to the v17.0.0 milestone Apr 5, 2023
notfelineit
notfelineit approved these changes Apr 5, 2023
View reviewed changes
Copy link
Contributor

@notfelineit notfelineit left a comment

Choose a reason for hiding this comment

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

🥳

add release note
978ead8 
Signed-off-by: Andrew Mason <andrew@planetscale.com>
deepthi
deepthi reviewed Apr 5, 2023
View reviewed changes
changelog/17.0/17.0.0/summary.md Outdated Show resolved Hide resolved
go/vt/topo/shard.go Outdated
@@ -121,6 +121,10 @@ func IsShardUsingRangeBasedSharding(shard string) bool {
// ValidateShardName takes a shard name and sanitizes it, and also returns
// the KeyRange.
func ValidateShardName(shard string) (string, *topodatapb.KeyRange, error) {
if strings.Contains(shard, "/") {
return "", nil, vterrors.Errorf(vtrpc.Code_INVALID_ARGUMENT, "invalid shardId, may not contain '-': %v", shard)
Copy link
Member

Choose a reason for hiding this comment

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

I see that the error code here is the correct one - INVALID_ARGUMENT. Why does the client display Unknown?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

that's the vtadmin-web level of reporting, it's INVALID_ARGUMENT all the way through to vtadmin-api

Copy link
Contributor Author

Choose a reason for hiding this comment

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

https://github.com/vitessio/vitess/blob/main/go/vt/vtadmin/http/response.go#L41-L61

Copy link
Member

Choose a reason for hiding this comment

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

Do we convert all RPC errors to Unknown errors? It just seems misleading to be claiming that it is an unknown rpc error when it is not.
Or is this deliberate obfuscation?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it depends (NOT_FOUND gets converted to 404, for example), but that's something we can address separately if you feel it's an issue

deepthi
deepthi reviewed Apr 5, 2023
View reviewed changes
go/vt/topo/shard.go Outdated Show resolved Hide resolved
ajm188 and others added 2 commits April 5, 2023 19:27
@ajm188 @deepthi
Update go/vt/topo/shard.go
d148903 
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
Signed-off-by: Andrew Mason <amason@hey.com>
@ajm188 @deepthi
Update changelog/17.0/17.0.0/summary.md
927453c 
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
Signed-off-by: Andrew Mason <amason@hey.com>
@deepthi deepthi removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Apr 6, 2023
@deepthi deepthi merged commit 361b958 into vitessio:main Apr 6, 2023
VTAdmin automation moved this from In progress to Done Apr 6, 2023
@deepthi deepthi deleted the andrew/disallow-slash-in-shard-name branch April 6, 2023 19:34
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Apr 6, 2023

I was unable to backport this Pull Request to the following branches: release-16.0.

ajm188 pushed a commit to planetscale/vitess that referenced this pull request Apr 6, 2023
@deepthi
[topo] Disallow the slash character in shard names (vitessio#12843)
26cf001 
* Disallow the slash character in shard names

Fixes vitessio#12842.

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

* add release note

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

* Update go/vt/topo/shard.go

Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
Signed-off-by: Andrew Mason <amason@hey.com>

* Update changelog/17.0/17.0.0/summary.md

Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
Signed-off-by: Andrew Mason <amason@hey.com>

---------

Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <amason@hey.com>
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
@ajm188 ajm188 mentioned this pull request Apr 6, 2023
Merged
deepthi added a commit that referenced this pull request Apr 12, 2023
@deepthi
Backport: [topo] Disallow the slash character in shard names #12843 (#…
9dcbd7d 
…12858)

* [topo] Disallow the slash character in shard names (#12843)

* Disallow the slash character in shard names

Fixes #12842.

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

* add release note

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

* Update go/vt/topo/shard.go

Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
Signed-off-by: Andrew Mason <amason@hey.com>

* Update changelog/17.0/17.0.0/summary.md

Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
Signed-off-by: Andrew Mason <amason@hey.com>

---------

Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <amason@hey.com>
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>

* add changelog stub

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

* fix version name

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

---------

Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <amason@hey.com>
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
@dbussink dbussink mentioned this pull request Apr 18, 2023
Merged
4 tasks
@GoVulnBot GoVulnBot mentioned this pull request May 11, 2023
Closed
@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

@deepthi deepthi deepthi approved these changes

@notfelineit notfelineit notfelineit approved these changes

@mattlord mattlord Awaiting requested review from mattlord mattlord is a code owner

@rsajwani rsajwani Awaiting requested review from rsajwani

Assignees
No one assigned
Labels
Component: Cluster management Type: Bug
Projects
VTAdmin
Done
v17.0.0
Status: Done
Milestone
v17.0.0
Development

Successfully merging this pull request may close these issues.

Bug Report: CreateShard allows shard names with "/", which breaks other commands/components
3 participants
@ajm188 @deepthi @notfelineit