Add ADR 031 BaseApp and codec infrastructure #7519

amaury1093 · 2020-10-12T16:42:27Z

InterfaceRegistry now inherits jsonpb.AnyResolver
add RegisterCustomTypeURL method to InterfaceRegistry to support ADR 031 packing of Anys in a way that works nicely with JSON
add ServiceMsgRouter to BaseApp
add sdk.ServiceMsg and sdk.MsgRequest types
add AnyResolver as a required parameter to RejectUnknownFields

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

…os/cosmos-sdk into am-7500-servicemsg

…500-servicemsg

codecov · 2020-10-12T16:48:28Z

Codecov Report

Merging #7519 into master will increase coverage by 0.57%.
The diff coverage is 72.72%.

@@            Coverage Diff             @@
##           master    #7519      +/-   ##
==========================================
+ Coverage   54.82%   55.40%   +0.57%     
==========================================
  Files         597      462     -135     
  Lines       37996    28072    -9924     
==========================================
- Hits        20833    15554    -5279     
+ Misses      15049    10829    -4220     
+ Partials     2114     1689     -425

baseapp/msg_service.go

…500-servicemsg

types/msg_service.go

baseapp/msg_service_router.go

baseapp/baseapp.go

baseapp/msg_service_router.go

codec/types/interface_registry.go

baseapp/baseapp.go

alexanderbez · 2020-10-14T13:01:52Z

baseapp/baseapp.go

+		var msgType string
+
+		if svcMsg, ok := msg.(sdk.ServiceMsg); ok {
+			msgType = svcMsg.MethodName


Field is called MethodName yet the var is called msgType.

Renamed to msgFqName

baseapp/grpcrouter_helpers.go

alexanderbez · 2020-10-14T13:04:12Z

baseapp/msg_service_router.go

+	handler, found := msr.routes[methodName]
+	if !found {
+		return nil
+	}
+
+	return handler


Why not just return h, _ := msr.routes[methodName]? Unless a key would exist w/o a handler somehow.

Unless a key would exist w/o a handler somehow.

even if a key exists w/o a handler, then h will still be nil, right? so we're good with your suggestion

baseapp/msg_service_router.go

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

blushi

LGTM, just some small nits.

codec/types/interface_registry.go

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>

alexanderbez

utACK

* Refactor RegisterQueryServices -> RegisterServices * Cleaner proto files * Fix tests * Add MsgServer * Fix lint * Remove MsgServer from configurator for now * Remove useless file * Fix build * typo * Add router * Fix test * WIP * Add router * Remove test helper * Add beginning of test * Move test to simapp? * ServiceMsg implement sdk.Msg * Add handler by MsgServiceRouter * Correct signature * Add full test * use TxEncoder * Update baseapp/msg_service_router.go Co-authored-by: Aaron Craelius <aaron@regen.network> * Push changes * WIP on ServiceMsg unpacking * Make TestMsgService test pass * Fix tests * Tidying up * Tidying up * Tidying up * Add JSON test * Add comments * Tidying * Lint * Register MsgRequest interface * Rename * Fix tests * RegisterCustomTypeURL * Add changelog entries * Put in features * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Address review comments * Address nit * Fix lint * Update codec/types/interface_registry.go Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> * godoc Co-authored-by: Aaron Craelius <aaronc@users.noreply.github.com> Co-authored-by: Aaron Craelius <aaron@regen.network> Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>

* Refactor RegisterQueryServices -> RegisterServices (#7518) * Refactor RegisterQueryServices -> RegisterServices * Fix tests * Add ADR 031 BaseApp and codec infrastructure (#7519) * Refactor RegisterQueryServices -> RegisterServices * Cleaner proto files * Fix tests * Add MsgServer * Fix lint * Remove MsgServer from configurator for now * Remove useless file * Fix build * typo * Add router * Fix test * WIP * Add router * Remove test helper * Add beginning of test * Move test to simapp? * ServiceMsg implement sdk.Msg * Add handler by MsgServiceRouter * Correct signature * Add full test * use TxEncoder * Update baseapp/msg_service_router.go Co-authored-by: Aaron Craelius <aaron@regen.network> * Push changes * WIP on ServiceMsg unpacking * Make TestMsgService test pass * Fix tests * Tidying up * Tidying up * Tidying up * Add JSON test * Add comments * Tidying * Lint * Register MsgRequest interface * Rename * Fix tests * RegisterCustomTypeURL * Add changelog entries * Put in features * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Address review comments * Address nit * Fix lint * Update codec/types/interface_registry.go Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> * godoc Co-authored-by: Aaron Craelius <aaronc@users.noreply.github.com> Co-authored-by: Aaron Craelius <aaron@regen.network> Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> * Refactor x/bank according to ADR 031 (#7520) * Refactor x/bank according to ADR 031 * Add comment * Update comment * Add comment * Add tests, address edge cases * Imports Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Refactor x/{gov, crisis} according to ADR 031 (#7533) * Refactor x/gov according to ADR 31 * fix tests * Refactor x/crisis according to ADR 031 * fix lint * lint * lint * review changes * lint * review change * fic doc Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Refactor x/distribution according to ADR 031 (#7524) * Refactor x/distribution according to ADR 31 * lint * removed unused * Apply suggestions from code review Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: Aaron Craelius <aaron@regen.network> Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * [x/slashing] Implement Protobuf Msg Services (#7557) * Update x/slashing to use proto msg service * Fix proto-gen Co-authored-by: Aaron Craelius <aaron@regen.network> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Refactor x/auth/vesting to use ADR-031 (#7551) * update auth/vesting module to use proto msg services * rm accidental tmp files * Update x/auth/vesting/msg_server.go Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> * golangci-lint fix Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: Aaron Craelius <aaron@regen.network> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Refactor x/staking according to ADR 031 (#7556) * Refactor x/staking according to ADR 031 * lint * review changes * review changes * review changes Co-authored-by: Aaron Craelius <aaron@regen.network> * Add MsgServer to Configurator for ADR 031 wiring (#7584) * Add MsgServer to Configurator for ADR 031 wiring * Add docs, wire up evidence & staking * Add integration test * Add comments * Doc strings * Update types/module/configurator.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update types/module/configurator.go Co-authored-by: Cory <cjlevinson@gmail.com> * Wire up vesting * Update CHANGELOG.md Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> Co-authored-by: Cory <cjlevinson@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Refactor x/evidence to ADR-031 (#7538) * Refactor x/evidence to ADR-031 * Add hash in response * Update changelog * Update x/evidence/keeper/keeper.go * Update proto/cosmos/evidence/v1beta1/tx.proto Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> * Use msgServer struct Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> * Refactor x/ibc to ADR 031 (#7576) * WIP: Refactor x/ibc to ADR 031 * updated handler * removed unsued * fix * Add proto service for ibc/transfer * lint * remove old upgrade handler * added doc * review changes * fix tests * formatter * Add MsgServer wiring in RegisterServices Co-authored-by: Aaron Craelius <aaronc@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * add changelog entries for non-nil Result.Data fields in message responses Co-authored-by: Aaron Craelius <aaron@regen.network> Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> Co-authored-by: Aaron Craelius <aaronc@users.noreply.github.com> Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: atheeshp <59333759+atheeshp@users.noreply.github.com>

* Refactor RegisterQueryServices -> RegisterServices * Cleaner proto files * Fix tests * Add MsgServer * Fix lint * Remove MsgServer from configurator for now * Remove useless file * Fix build * typo * Add router * Fix test * WIP * Add router * Remove test helper * Add beginning of test * Move test to simapp? * ServiceMsg implement sdk.Msg * Add handler by MsgServiceRouter * Correct signature * Add full test * use TxEncoder * Update baseapp/msg_service_router.go Co-authored-by: Aaron Craelius <aaron@regen.network> * Push changes * WIP on ServiceMsg unpacking * Make TestMsgService test pass * Fix tests * Tidying up * Tidying up * Tidying up * Add JSON test * Add comments * Tidying * Lint * Register MsgRequest interface * Rename * Fix tests * RegisterCustomTypeURL * Add changelog entries * Put in features * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Address review comments * Address nit * Fix lint * Update codec/types/interface_registry.go Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> * godoc Co-authored-by: Aaron Craelius <aaronc@users.noreply.github.com> Co-authored-by: Aaron Craelius <aaron@regen.network> Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>

aaronc and others added 11 commits October 12, 2020 11:51

Refactor RegisterQueryServices -> RegisterServices

64c76d2

Cleaner proto files

d9b8a1d

Fix tests

889025b

Merge branch 'aaronc/7500-register-services' of ssh://github.com/cosm…

b3c301d

…os/cosmos-sdk into am-7500-servicemsg

Add MsgServer

e1482f2

Fix lint

6c77f06

Remove MsgServer from configurator for now

c746a2b

Merge branch 'master' of ssh://github.com/cosmos/cosmos-sdk into am-7…

ac713d2

…500-servicemsg

Remove useless file

59ebc3b

Fix build

f18f4e3

typo

1ed29df

amaury1093 commented Oct 12, 2020

View reviewed changes

baseapp/msg_service.go Outdated Show resolved Hide resolved

amaury1093 mentioned this pull request Oct 12, 2020

Implement ADR 031: Protobuf Msg Services #7500

Closed

16 tasks

amaury1093 added 12 commits October 13, 2020 10:50

Add router

0d9efc4

Fix test

be1a26b

Merge branch 'master' of ssh://github.com/cosmos/cosmos-sdk into am-7…

b35ce5d

…500-servicemsg

WIP

fef78cf

Add router

ff05343

Merge branch 'master' of ssh://github.com/cosmos/cosmos-sdk into am-7…

c323889

…500-servicemsg

Remove test helper

13b8dbd

Add beginning of test

ab00ebf

Move test to simapp?

797ddd3

ServiceMsg implement sdk.Msg

a65ab55

Add handler by MsgServiceRouter

759b2a5

Correct signature

931ca66

amaury1093 commented Oct 13, 2020

View reviewed changes

types/msg_service.go Outdated Show resolved Hide resolved

baseapp/msg_service_router.go Outdated Show resolved Hide resolved

baseapp/baseapp.go Outdated Show resolved Hide resolved

amaury1093 added 2 commits October 13, 2020 15:44

Add full test

f21b332

use TxEncoder

24fa6f0

aaronc reviewed Oct 13, 2020

View reviewed changes

baseapp/msg_service_router.go Outdated Show resolved Hide resolved

Put in features

791097a

aaronc reviewed Oct 14, 2020

View reviewed changes

codec/types/interface_registry.go Outdated Show resolved Hide resolved

alexanderbez suggested changes Oct 14, 2020

View reviewed changes

amaury1093 and others added 11 commits October 14, 2020 15:15

Update baseapp/msg_service_router.go

62a887f

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

Update baseapp/msg_service_router.go

98fa5d2

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

Update baseapp/msg_service_router.go

c63105d

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

Update baseapp/msg_service_router.go

2be1a61

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

Update baseapp/msg_service_router.go

105b04a

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

Update baseapp/msg_service_router.go

c306dff

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

Update baseapp/msg_service_router.go

eaebd7e

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

Address review comments

7cbc9f9

Merge branch 'master' into am-7500-servicemsg

dfb6cf6

Address nit

8624ad7

Fix lint

880c7cb

blushi approved these changes Oct 14, 2020

View reviewed changes

codec/types/interface_registry.go Show resolved Hide resolved

codec/types/interface_registry.go Outdated Show resolved Hide resolved

aaronc added the A:automerge Automatically merge PR once all prerequisites pass. label Oct 14, 2020

aaronc requested a review from alexanderbez October 14, 2020 20:24

amaury1093 and others added 2 commits October 15, 2020 10:40

Update codec/types/interface_registry.go

304e937

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>

godoc

ca9258c

alexanderbez approved these changes Oct 15, 2020

View reviewed changes

Merge branch 'master' into am-7500-servicemsg

d6120af

mergify bot merged commit 55242a6 into master Oct 15, 2020

mergify bot deleted the am-7500-servicemsg branch October 15, 2020 13:08

aaronc mentioned this pull request Oct 15, 2020

ADR 031: Add MsgServer to Configurator and wire up modules #7568

Closed

clevinson mentioned this pull request Oct 19, 2020

Implement Protobuf Msg Services #7540

Closed

16 tasks

clevinson mentioned this pull request Oct 19, 2020

[backport/v0.40.x] Implement ADR031 #7599

Merged

9 tasks

aaronc mentioned this pull request Oct 23, 2020

Register MsgServer type URLs in AppModuleBasic.RegisterInterfaces #7647

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ADR 031 BaseApp and codec infrastructure #7519

Add ADR 031 BaseApp and codec infrastructure #7519

amaury1093 commented Oct 12, 2020 •

edited

Loading

codecov bot commented Oct 12, 2020 •

edited

Loading

alexanderbez Oct 14, 2020

amaury1093 Oct 14, 2020

alexanderbez Oct 14, 2020

amaury1093 Oct 14, 2020 •

edited

Loading

blushi left a comment

alexanderbez left a comment

Add ADR 031 BaseApp and codec infrastructure #7519

Add ADR 031 BaseApp and codec infrastructure #7519

Conversation

amaury1093 commented Oct 12, 2020 • edited Loading

codecov bot commented Oct 12, 2020 • edited Loading

Codecov Report

alexanderbez Oct 14, 2020

Choose a reason for hiding this comment

amaury1093 Oct 14, 2020

Choose a reason for hiding this comment

alexanderbez Oct 14, 2020

Choose a reason for hiding this comment

amaury1093 Oct 14, 2020 • edited Loading

Choose a reason for hiding this comment

blushi left a comment

Choose a reason for hiding this comment

alexanderbez left a comment

Choose a reason for hiding this comment

amaury1093 commented Oct 12, 2020 •

edited

Loading

codecov bot commented Oct 12, 2020 •

edited

Loading

amaury1093 Oct 14, 2020 •

edited

Loading