vtctldclient,grpcvtctldserver ApplySchema: return unknown params from grpcvtctldserver.ApplySchema, log them in vtctldclient.ApplySchema

[maxenglander]

Description

#12476 modified vtctl ApplyVSchema to log unknown vindex params. This makes an equivalent change to vtctld.ApplyVSchema.

vtctld returns VindexUnknownParams in the ApplyVSchema GRPC response. vtctldclient will print them out like this:

Unknown param in vindex lookup1: hello

Note that this changes the DryRun behavior a little bit. DryRun will now return an error if vindexes.BuildKeyspace fails to process the supplied VSchema body (e.g. if an invalid vindex type supplied).

Related Issue(s)

• Fixes: RFC: surface warnings and/or errors for unknown vindex params #13041

Checklist

• "Backport to:" labels have been added if this change should not 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

[vitess-bot]

Review Checklist

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

General

• Ensure that the Pull Request has a descriptive title.
• Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

• Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

• Apply the release notes (needs details) label if users need to know about this change.
• New features should be documented.
• There should be some code comments as to why things are implemented the way they are.
• There should be a comment at the top of each new or modified test to explain what the test does.

New flags

• Is this flag really necessary?
• Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

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

Backward compatibility

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

[ajm188]

lgtm

[ajm188]

naming nit: let's call this type UnknownVindexParams and the field accordingly

[maxenglander]

For what it's worth we call it VindexUnknownParameters, elsewhere but I will make the change

grep -R "VindexUnknown" go
go/vt/vtgate/vtgate_test.go:func TestVSchemaVindexUnknownParams(t *testing.T) {
go/vt/vtgate/vtgate.go: vindexUnknownParams = stats.NewGauge("VindexUnknownParameters", "Number of parameterss unrecognized by Vindexes")
go/vt/vtgate/executor.go:                       unknownParams += ks.VindexUnknownParamsCount
go/vt/vtgate/vschema_stats.go:  VindexUnknownParamsCount int
go/vt/vtgate/vschema_stats.go:                                  s.VindexUnknownParamsCount += len(pv.UnknownParams())
go/vt/vtgate/vschema_stats.go:    <td>{{$ks.VindexUnknownParamsCount}}</td>

[ajm188]

ah i didn't realize that (i would have voted against that name too haha) sorry!

[shlomi-noach]

Can you please add a comment to this field (UnknownVindexParams is ...) and can you please explain the format/structure here? I'm not sure I understand what in this map[string]([]string).

[maxenglander]

Added a comment in 5e4fa13

In terms of what goes in here. The VSchema allows you defined params on Vindexes in the form of map[string]string. This makes it very easy for users to put in parameters that aren't recognized, e.g. due to typos. Until relatively recently, Vitess would happily accept unknown vindex params, and not report it as an issue. Vitess now has the internal ability to track and report unknown params. However, vtctld has not yet caught up.

This PR addresses that by adding a map[string, ParamList] field to the ApplyVSchema gRPC response. This contents will map the name(s) of user-defined vindex(es) to the names of any unknown params found in the params block of those vindexes. The somewhat awkward way of defining a "map to a list of strings" here is due to limitations in protobuf.

[mattlord]

LGTM. Thanks, @maxenglander !