PMM-9377: Upgrade to grpc-gateway to version 2

[idoqo]

PMM-9377

Build: SUBMODULES-2355

This upgrades the grpc-gateway package to v2 based on the migration guide.

• PMM-9377 add compatibility with updated pmm pmm-agent#323
• PMM-9377 add compatibility with updated grpc-gateway v2 pmm-managed#1005
• PMM-9377 Add compatibility with grpc-gateway v2 pmm-admin#186

[it-percona-cla]

All committers have signed the CLA.

[BupycHuk]

please revert api.descriptor, we need it to validate backward compatibility of your changes.
Also in swagger.json I see that all fields were changed from snake_case to camelCase, please fix it.

Thanks

[idoqo]

please revert api.descriptor, we need it to validate backward compatibility of your changes.

I don't really expect it to be fully compatible since v2 renames some options (e.g protoc_gen_swagger.options.openapiv2_swagger => protoc_gen_openapiv2.options.openapiv2_swagger).

Also in swagger.json I see that all fields were changed from snake_case to camelCase, please fix it.

I've modified the prototool config to preserve snake_case, saw that grpc-gateway now defaults to camelCase and was wondering if that affects us.

[palash25]

Looks OK, please fix the CI

[idoqo]

Looks OK, please fix the CI

Yeah, not sure how to do this yet without updating api.descriptor as it seems to be modified after this upgrade.

[palash25]

not able to figure out why break check (even though it passes locally) fails in the CI, other people have also faced this error uber/prototool#550 but there seems to be no solution. If we are not able to fix this prototool error i suggest that we simply migrate to buf in this PR, there is no point in using prototool anymore it has been unmaintained for 2 years and will keep causing us trouble.

i also think there is some codegen missing in your PR, for e.g. i don't see any modifications to *.pb.gw.go files in this diff, i pulled this branch and ran make gen and there were more changes that are absent from this PR #827 , please fix that @idoqo

[idoqo]

I think this actually breaks compatibility with existing PMM clients (pmm-agent and pmm-managed) and we may have to pend this till v3 when we are ready to break compatibility between different PMM server and client versions.

Here's the part of the output from running make test in pmm-managed against this branch (starting managed with make env-up also outputs similar errors):

./main.go:307:11: cannot use serverpb.RegisterServerHandlerFromEndpoint (type func(context.Context, *"github.com/grpc-ecosystem/grpc-gateway/v2/runtime".ServeMux, string, []"google.golang.org/grpc".DialOption) error) as type registrar in slice literal
./main.go:309:14: cannot use inventorypb.RegisterNodesHandlerFromEndpoint (type func(context.Context, *"github.com/grpc-ecosystem/grpc-gateway/v2/runtime".ServeMux, string, []"google.golang.org/grpc".DialOption) error) as type registrar in slice literal
./main.go:310:14: cannot use inventorypb.RegisterServicesHandlerFromEndpoint (type func(context.Context, *"github.com/grpc-ecosystem/grpc-gateway/v2/runtime".ServeMux, string, []"google.golang.org/grpc".DialOption) error) as type registrar in slice literal
./main.go:311:14: cannot use inventorypb.RegisterAgentsHandlerFromEndpoint (type func(context.Context, *"github.com/grpc-ecosystem/grpc-gateway/v2/runtime".ServeMux, string, []"google.golang.org/grpc".DialOption) error) as type registrar in slice literal
./main.go:313:15: cannot use managementpb.RegisterNodeHandlerFromEndpoint (type func(context.Context, *"github.com/grpc-ecosystem/grpc-gateway/v2/runtime".ServeMux, string, []"google.golang.org/grpc".DialOption) error) as type registrar in slice literal
./main.go:318:15: too many errors

The error happens because grpc-gateway v2 changes the signature of runtime.AnnotateIncomingContext

Also, pmm-agent tests break with this:

agentlocal/agent_local.go:279:62: cannot use proxyMux (type *"github.com/grpc-ecosystem/grpc-gateway/runtime".ServeMux) as type *"github.com/grpc-ecosystem/grpc-gateway/v2/runtime".ServeMux in argument to agentlocalpb.RegisterAgentLocalHandlerFromEndpoint
FAIL    github.com/percona/pmm-agent [build failed]
ok      github.com/percona/pmm-agent/actions    1.196s
# github.com/percona/pmm-agent/agentlocal [github.com/percona/pmm-agent/agentlocal.test]
agentlocal/agent_local.go:279:62: cannot use proxyMux (type *"github.com/grpc-ecosystem/grpc-gateway/runtime".ServeMux) as type *"github.com/grpc-ecosystem/grpc-gateway/v2/runtime".ServeMux in argument to agentlocalpb.RegisterAgentLocalHandlerFromEndpoint
FAIL    github.com/percona/pmm-agent/agentlocal [build failed]

[artemgavrilov]

I don't really expect it to be fully compatible since v2 renames some options (e.g protoc_gen_swagger.options.openapiv2_swagger => protoc_gen_openapiv2.options.openapiv2_swagger).

I'm not sure that we want it then. One of key concepts that we trying to follow is backward compatibility.
After this PR will our API compatible with existing tools/scripts? Will latest PMM server work with old PMM clients?

[BupycHuk]

LGTM, please check if error responses works the same way. pmm-admin shows correct error messages

[BupycHuk]

looks like failing tests in FB are related to dissapeared error field which was used by pmm-admin to show errors.

[idoqo]

looks like failing tests in FB are related to dissapeared error field which was used by pmm-admin to show errors.

Right, percona/pmm-admin#186 updates pmm-admin to use the Message field too - though that makes one extra incompatible client. Looks to me like FB client tests are also resolved now.