gRPC: fix server reflection #8945

fdymylja · 2021-03-19T15:46:33Z

Description

closes: #8927

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards.
Wrote unit and integration tests
Updated relevant documentation (docs/) or specification (x/<module>/spec/)
Added relevant godoc comments.
Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
Re-reviewed Files changed in the Github PR explorer
Review Codecov Report in the comment section below once CI passes

orijbot · 2021-03-19T15:50:25Z

Benchmark beginning. Status page: https://github.orijtech.com/benchmark/status?commit=cb219124c14feea9155d596e7854608bf7e650f7

orijbot · 2021-03-19T15:50:57Z

Benchmark beginning. Status page: https://github.orijtech.com/benchmark/status?commit=9b2800f8613e04ebc403961bc8c6352a0a9e9ae4

…lection' into fdymylja/issue-8927-fix-grpc-reflection

codecov · 2021-03-22T11:26:34Z

Codecov Report

Merging #8945 (ba4698c) into master (5bd93bf) will decrease coverage by 0.40%.
The diff coverage is 15.93%.

❗ Current head ba4698c differs from pull request most recent head def738b. Consider uploading reports for the commit def738b to get more accurate results

@@            Coverage Diff             @@
##           master    #8945      +/-   ##
==========================================
- Coverage   59.27%   58.87%   -0.41%     
==========================================
  Files         571      574       +3     
  Lines       31827    32114     +287     
==========================================
+ Hits        18867    18906      +39     
- Misses      10757    10993     +236     
- Partials     2203     2215      +12

Impacted Files	Coverage Δ
server/grpc/gogoreflection/serverreflection.go	`2.81% <2.81%> (ø)`
server/grpc/gogoreflection/fix_registration.go	`29.09% <29.09%> (ø)`
x/staking/simulation/operations.go	`73.16% <60.00%> (-0.30%)`	⬇️
server/grpc/server.go	`62.50% <100.00%> (ø)`
x/genutil/client/cli/migrate.go	`68.42% <100.00%> (ø)`
x/gov/legacy/v043/json.go	`100.00% <100.00%> (ø)`
x/gov/legacy/v043/store.go	`85.71% <100.00%> (+1.09%)`	⬆️
x/staking/types/msg.go	`55.55% <100.00%> (+0.62%)`	⬆️
... and 1 more

amaury1093

Wow, this is pretty cool, thanks @fdymylja.

I tested:

grpcurl -plaintext localhost:9090 list
grpcurl -plaintext localhost:9090 describe cosmos.authz.v1beta1.Query
grpcurl -plaintext localhost:9090 describe cosmos.authz.v1beta1.Query.Authorization

they all work.

Before approving, can you update docs/run-node/interact-node.md and add a changelog?

I also added the backport label, as I see this as a nice bugfix.

jgimeno

TOP! Thanks @fdymylja

…lection' into fdymylja/issue-8927-fix-grpc-reflection

fdymylja · 2021-03-22T12:44:03Z

@AmauryM @jgimeno I've added support for extensions reflection and updated the docs.

amaury1093 · 2021-03-22T14:26:53Z

A changelog would be nice! After that feel free to put automerge on

robert-zaremba

Left few cosmetic comments. Thanks!

server/grpc/gogoreflection/fix_registration.go

robert-zaremba · 2021-03-22T18:38:31Z

server/grpc/gogoreflection/fix_registration.go

+// but are imported by other files in a different way.
+// NOTE(fdymylja): This fix should not be needed and should be addressed in some CI.
+// Currently every cosmos-sdk proto file is importing gogo.proto as gogoproto/gogo.proto,
+// but gogo.proto registers itself as gogo.proto, same goes for cosmos.proto.


Do you know why this happens? Maybe we should fix it in github.com/regen-network/cosmos-proto?
@aaronc

I mean - let's create an issue if there is a bug we can easily fix in cosmos-proto

it's not a bug per se, it's a shortcoming when it comes to combo together reflection and proto imports. protofiles register themselve in the registry with a path, but then are imported with another path. this makes reflection fail, because it cannot find certain files.

this would mean either forking gogoproto and changing how we feed the file to protoc, or changing the third_party structure in the sdk, edit how every file imports gogoproto.

and im not sure if this is a breaking change, descriptor wise it is.

probably this should be a blob of work which should be reorganized during the transition to protov2

server/grpc/gogoreflection/fix_registration.go

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

fdymylja · 2021-03-22T19:11:24Z

@aaronc, @alessio it's the 5th iteration of github actions re-run I am currently doing.. and each of them takes about 30mins to 1 hour. Could we please merge this manually instead of relying on automerge? As there is other work depending on this PR..

alessio · 2021-03-22T19:17:40Z

@fdymylja yes, we are experiencing many issues with gh actions currently. AFAIK @marbar3778 is looking into what's wrong there...

Meanwhile, it'd be great if you could address @robert-zaremba's comments (some are minor, another would just take to open a new issue), then I'd be super happy to merge this manually 👍

fdymylja · 2021-03-22T19:34:06Z

@fdymylja yes, we are experiencing many issues with gh actions currently. AFAIK @marbar3778 is looking into what's wrong there...

Meanwhile, it'd be great if you could address @robert-zaremba's comments (some are minor, another would just take to open a new issue), then I'd be super happy to merge this manually 👍

I'll open a follow up PR regarding proto file registrations. But as I've written in the comment I think it should end up in a bigger batch of work during the transition to protov2.

robert-zaremba · 2021-03-22T21:25:24Z

Thanks for creating the issue @fdymylja .

amaury1093 · 2021-05-03T14:33:41Z

@Mergifyio backport release/v0.42.x

* add: gogoreflection * fix: server reflection * fix: make tests resolve imports in a transitive way * chore: cleanup getMessageType * chore: lint * add: extensions reflection * chore: update interact-node.md docs * chore: update CHANGELOG.md * Update server/grpc/gogoreflection/fix_registration.go Co-authored-by: Robert Zaremba <robert@zaremba.ch> Co-authored-by: Jonathan Gimeno <jgimeno@gmail.com> Co-authored-by: Alessio Treglia <alessio@tendermint.com> Co-authored-by: Robert Zaremba <robert@zaremba.ch> (cherry picked from commit ac48ffe) # Conflicts: # CHANGELOG.md # go.mod # go.sum

mergify · 2021-05-03T14:35:02Z

Command backport release/v0.42.x: success

Backports have been created

#9253 gRPC: fix server reflection (backport #8945) has been created for branch release/v0.42.x

fdymylja added 3 commits March 19, 2021 12:15

add: gogoreflection

d4db860

fix: server reflection

5c11486

fix: make tests resolve imports in a transitive way

034b0d8

fdymylja requested review from aaronc, alessio and alexanderbez as code owners March 19, 2021 15:46

fdymylja requested review from amaury1093, sahith-narahari and gsora March 19, 2021 15:46

chore: cleanup getMessageType

cb21912

Merge branch 'master' into fdymylja/issue-8927-fix-grpc-reflection

9b2800f

fdymylja and others added 4 commits March 22, 2021 10:09

Merge branch 'master' into fdymylja/issue-8927-fix-grpc-reflection

0d82b78

chore: lint

79d481e

Merge remote-tracking branch 'origin/fdymylja/issue-8927-fix-grpc-ref…

5875f01

…lection' into fdymylja/issue-8927-fix-grpc-reflection

Merge branch 'master' into fdymylja/issue-8927-fix-grpc-reflection

d1a1ff9

amaury1093 reviewed Mar 22, 2021

View reviewed changes

amaury1093 added the backport/0.42.x (Stargate) label Mar 22, 2021

jgimeno approved these changes Mar 22, 2021

View reviewed changes

fdymylja added 3 commits March 22, 2021 13:33

add: extensions reflection

6567491

chore: update interact-node.md docs

716a145

Merge remote-tracking branch 'origin/fdymylja/issue-8927-fix-grpc-ref…

03f2c8d

…lection' into fdymylja/issue-8927-fix-grpc-reflection

alessio approved these changes Mar 22, 2021

View reviewed changes

Merge branch 'master' into fdymylja/issue-8927-fix-grpc-reflection

ed0cd48

chore: update CHANGELOG.md

b7c26e4

fdymylja added the A:automerge Automatically merge PR once all prerequisites pass. label Mar 22, 2021

fdymylja and others added 3 commits March 22, 2021 15:46

Merge branch 'master' into fdymylja/issue-8927-fix-grpc-reflection

a0a7f84

Merge branch 'master' into fdymylja/issue-8927-fix-grpc-reflection

ba4698c

Merge branch 'master' into fdymylja/issue-8927-fix-grpc-reflection

b26b502

robert-zaremba reviewed Mar 22, 2021

View reviewed changes

Update server/grpc/gogoreflection/fix_registration.go

def738b

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

mergify bot merged commit ac48ffe into master Mar 22, 2021

mergify bot deleted the fdymylja/issue-8927-fix-grpc-reflection branch March 22, 2021 19:40

fdymylja mentioned this pull request Mar 22, 2021

Restructure proto imports to match how they register themselve in the generated code #8951

Closed

mergify bot mentioned this pull request May 3, 2021

gRPC: fix server reflection (backport #8945) #9253

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gRPC: fix server reflection #8945

gRPC: fix server reflection #8945

fdymylja commented Mar 19, 2021 •

edited by jgimeno

Loading

orijbot commented Mar 19, 2021

orijbot commented Mar 19, 2021

codecov bot commented Mar 22, 2021 •

edited

Loading

amaury1093 left a comment •

edited

Loading

jgimeno left a comment

fdymylja commented Mar 22, 2021

amaury1093 commented Mar 22, 2021

robert-zaremba left a comment

robert-zaremba Mar 22, 2021

robert-zaremba Mar 22, 2021

fdymylja Mar 22, 2021

fdymylja commented Mar 22, 2021 •

edited

Loading

alessio commented Mar 22, 2021

fdymylja commented Mar 22, 2021

robert-zaremba commented Mar 22, 2021

amaury1093 commented May 3, 2021

mergify bot commented May 3, 2021

gRPC: fix server reflection #8945

gRPC: fix server reflection #8945

Conversation

fdymylja commented Mar 19, 2021 • edited by jgimeno Loading

Description

orijbot commented Mar 19, 2021

orijbot commented Mar 19, 2021

codecov bot commented Mar 22, 2021 • edited Loading

Codecov Report

amaury1093 left a comment • edited Loading

Choose a reason for hiding this comment

jgimeno left a comment

Choose a reason for hiding this comment

fdymylja commented Mar 22, 2021

amaury1093 commented Mar 22, 2021

robert-zaremba left a comment

Choose a reason for hiding this comment

robert-zaremba Mar 22, 2021

Choose a reason for hiding this comment

robert-zaremba Mar 22, 2021

Choose a reason for hiding this comment

fdymylja Mar 22, 2021

Choose a reason for hiding this comment

fdymylja commented Mar 22, 2021 • edited Loading

alessio commented Mar 22, 2021

fdymylja commented Mar 22, 2021

robert-zaremba commented Mar 22, 2021

amaury1093 commented May 3, 2021

mergify bot commented May 3, 2021

fdymylja commented Mar 19, 2021 •

edited by jgimeno

Loading

codecov bot commented Mar 22, 2021 •

edited

Loading

amaury1093 left a comment •

edited

Loading

fdymylja commented Mar 22, 2021 •

edited

Loading