feat: allow module safe queries in ICA (backport #5785) #6065

mergify · 2024-03-27T10:31:58Z

Description

closes: #5784

Commit Message / Changelog Entry

feat: allow module safe queries in ICA

see the guidelines for commit messages. (view raw markdown for examples)

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 the 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 and Go style guide.
Wrote unit and integration tests.
Updated relevant documentation (docs/) or specification (x/<module>/spec/).
Added relevant godoc comments.
Provide a commit message to be used for the changelog entry in the PR description for review.
Re-reviewed Files changed in the Github PR explorer.
Review Codecov Report in the comment section below once CI passes.

Summary by CodeRabbit

New Features
- Implemented a mechanism for whitelisting safe queries to enhance module query safety.
- Added a new message structure for defining query requests by interchain accounts.
- Introduced an RPC handler for safe queries with payload and response message definitions.
Tests
- Expanded test coverage to validate module query safety and successful execution of specific queries.
- Introduced test functions to ensure the correct functioning of query safelisting and transaction handling.
Documentation
- Updated the codec setup function to include interface registration for improved transaction handling.

This is an automatic backport of pull request #5785 done by [Mergify](https://mergify.com).

* imp: initial modification of tx.proto * imp: ran 'make proto-all' * fix: compiler errors * imp: added query router interface * imp: added queryRouter to icahost keeper * imp: improved proto definitions * imp: ran 'make proto-all' * imp: added sdk.Msg helpers * feat: basic implementation * style: improved field names * imp: ran 'make proto-all' * fix: compiler errors * imp: ran gofumpt * feat: tests passing * feat: tests improved * test: removed unneeded code * imp: improved 'IsModuleSafe' function * imp: added IsModuleQuerySafe to msg_server * imp: added more test cases * fix: callbacks compiler * fix: non determinancy issues * fix: added query msg to codec * imp: whitelist logic added * e2e: new test added * fix: new test * fix: test * fix: e2e * fix: e2e * imp(e2e): added the QueryTxsByEvents function * fix: e2e * e2e: lint fix * fix: e2e * e2e: debug * fix: e2e * test: debug helpers * debug * test: added codec_test case * imp: additional test case * imp: added important unit test * r4r * e2e: debug * imp: added logs * fix: e2e * fix: e2e * fix: e2e * imp: added height to proto response * imp: ran 'make proto-all' * imp: added height * e2e: updated e2e to test height * imp: review suggestions * e2e: remove unneeded log * refactor: refactored 'ExtractValueFromEvents' * e2e: review item * imp: review item * nit: review item * docs: added godocs * test: unit test for mqsWhitelist added * imp: added logging * style: rename to allow list * add changelog --------- Co-authored-by: Carlos Rodriguez <carlos@interchain.io> (cherry picked from commit eecfa5c) # Conflicts: # CHANGELOG.md # e2e/testsuite/codec.go # e2e/testsuite/tx.go # modules/apps/27-interchain-accounts/host/types/msgs.go # modules/light-clients/08-wasm/testing/simapp/app.go

mergify · 2024-03-27T10:32:00Z

Cherry-pick of eecfa5c has failed:

On branch mergify/bp/release/v8.2.x/pr-5785
Your branch is up to date with 'origin/release/v8.2.x'.

You are currently cherry-picking commit eecfa5c0.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	new file:   e2e/tests/interchain_accounts/query_test.go
	modified:   modules/apps/27-interchain-accounts/host/keeper/export_test.go
	modified:   modules/apps/27-interchain-accounts/host/keeper/keeper.go
	modified:   modules/apps/27-interchain-accounts/host/keeper/keeper_test.go
	modified:   modules/apps/27-interchain-accounts/host/keeper/msg_server.go
	modified:   modules/apps/27-interchain-accounts/host/keeper/msg_server_test.go
	modified:   modules/apps/27-interchain-accounts/host/keeper/relay_test.go
	modified:   modules/apps/27-interchain-accounts/host/types/codec.go
	modified:   modules/apps/27-interchain-accounts/host/types/codec_test.go
	modified:   modules/apps/27-interchain-accounts/host/types/host.pb.go
	modified:   modules/apps/27-interchain-accounts/host/types/tx.pb.go
	modified:   modules/apps/27-interchain-accounts/types/router.go
	modified:   modules/apps/callbacks/testing/simapp/app.go
	modified:   proto/ibc/applications/interchain_accounts/host/v1/host.proto
	modified:   proto/ibc/applications/interchain_accounts/host/v1/tx.proto
	modified:   testing/simapp/app.go

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both modified:   CHANGELOG.md
	deleted by us:   e2e/testsuite/codec.go
	deleted by us:   e2e/testsuite/tx.go
	both modified:   modules/apps/27-interchain-accounts/host/types/msgs.go
	deleted by us:   modules/light-clients/08-wasm/testing/simapp/app.go

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

coderabbitai · 2024-03-27T10:32:15Z

Important

Auto Review Skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

crodriguezvega · 2024-03-27T22:20:25Z

It might be easier to review the individual commits on this PR, since that's the diff with respect to the original PR.

crodriguezvega · 2024-04-08T11:38:38Z

Needs #6105

modules/apps/27-interchain-accounts/host/types/msgs.go

srdtrk · 2024-04-08T15:36:49Z

Is there any way to have panic on chain startup if queryRouter is not set?

damiannolan · 2024-04-09T19:25:19Z

Is there any way to have panic on chain startup if queryRouter is not set?

good question, and consideration! Normally we do it in NewKeeper on main, right? but since this is adding it in a non-api breaking way we use WithQueryRouter.

This does seem like a feature a lot of users would like to pick up and it would be unfortunate to start nodes with somebody missing this (it would lead to panic on nil pointer) on the host chain when msgs are delivered - we could potentially add a panic in hostkeeper/msg_server.go in the NewMsgServerImpl() func: https://github.com/cosmos/ibc-go/pull/6065/files#diff-13a052f2a68bb6a94ffe300852c0b625ff0340a3c524f68ddb6a1256f7b55f4bL22-L24

This would panic in RegisterServices() of the module which would bubble up to app.go - ModuleManager.RegisterServices()

DimitrisJim · 2024-04-09T19:52:57Z

we could potentially add a panic in hostkeeper/msg_server.go in the NewMsgServerImpl() func

another candidate seems to be NewAppModule but going through RegisterServices seems best since its already guarded by an if checking if host keeper is set.

crodriguezvega · 2024-04-10T08:16:04Z

Is there any way to have panic on chain startup if queryRouter is not set?

good question, and consideration! Normally we do it in NewKeeper on main, right? but since this is adding it in a non-api breaking way we use WithQueryRouter.

This does seem like a feature a lot of users would like to pick up and it would be unfortunate to start nodes with somebody missing this (it would lead to panic on nil pointer) on the host chain when msgs are delivered - we could potentially add a panic in hostkeeper/msg_server.go in the NewMsgServerImpl() func: https://github.com/cosmos/ibc-go/pull/6065/files#diff-13a052f2a68bb6a94ffe300852c0b625ff0340a3c524f68ddb6a1256f7b55f4bL22-L24

This would panic in RegisterServices() of the module which would bubble up to app.go - ModuleManager.RegisterServices()

@damiannolan @srdtrk like this?

If we want to enforce that a query router is set, is it enough to document this in the release notes or do we need to add a migration doc for v7.5 and document it there as well?

damiannolan

Thanks @crodriguezvega! 🚀

damiannolan · 2024-04-11T10:09:27Z

modules/apps/27-interchain-accounts/host/keeper/msg_server.go

 func NewMsgServerImpl(keeper *Keeper) types.MsgServer {
+	if keeper.queryRouter == nil {
+		panic("query router must not be nil")
+	}
 	return &msgServer{Keeper: keeper}
 }


ACK this change looks good to me! As long as we put something into the release notes which document that users should use app.HostKeeper.WithQueryRouter in app.go, otherwise nodes won't start!

mergify bot added the conflicts label Mar 27, 2024

mergify bot requested review from colin-axner, AdityaSripal and damiannolan as code owners March 27, 2024 10:31

mergify bot requested review from srdtrk, crodriguezvega, charleenfei, chatton and DimitrisJim as code owners March 27, 2024 10:32

crodriguezvega self-assigned this Mar 27, 2024

Carlos Rodriguez added 5 commits March 27, 2024 12:07

fix conflicts + add GetSigners to message

271202f

delete e2e and 08-wasm folders

add262f

add tests for message functions

4e9427e

use boolean for expected test result

e72b46f

revert API breaking change in ica host NewKeeper

6a0aa73

crodriguezvega removed the conflicts label Mar 27, 2024

lint

5599bb5

crodriguezvega added the priority PRs that need prompt reviews label Mar 27, 2024

crodriguezvega marked this pull request as draft March 28, 2024 19:28

crodriguezvega removed the priority PRs that need prompt reviews label Mar 28, 2024

crodriguezvega changed the base branch from release/v8.2.x to release/v8.3.x April 8, 2024 07:56

Merge branch 'release/v8.3.x' into mergify/bp/release/v8.2.x/pr-5785

6d7afd0

crodriguezvega marked this pull request as ready for review April 8, 2024 07:57

crodriguezvega marked this pull request as draft April 8, 2024 08:19

Merge branch 'release/v8.3.x' into mergify/bp/release/v8.2.x/pr-5785

a778f80

crodriguezvega marked this pull request as ready for review April 8, 2024 12:30

crodriguezvega added the priority PRs that need prompt reviews label Apr 8, 2024

Merge branch 'release/v8.3.x' into mergify/bp/release/v8.2.x/pr-5785

a2c0456

damiannolan approved these changes Apr 8, 2024

View reviewed changes

modules/apps/27-interchain-accounts/host/types/msgs.go Show resolved Hide resolved

Merge branch 'release/v8.3.x' into mergify/bp/release/v8.2.x/pr-5785

b725666

panic if query router is nil

c70c9c6

Merge branch 'release/v8.3.x' into mergify/bp/release/v8.2.x/pr-5785

44e7c4e

damiannolan approved these changes Apr 11, 2024

View reviewed changes

Merge branch 'release/v8.3.x' into mergify/bp/release/v8.2.x/pr-5785

4e0c331

crodriguezvega approved these changes Apr 11, 2024

View reviewed changes

crodriguezvega merged commit 759897b into release/v8.3.x Apr 11, 2024
19 checks passed

crodriguezvega deleted the mergify/bp/release/v8.2.x/pr-5785 branch April 11, 2024 11:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: allow module safe queries in ICA (backport #5785) #6065

feat: allow module safe queries in ICA (backport #5785) #6065

mergify bot commented Mar 27, 2024

mergify bot commented Mar 27, 2024

coderabbitai bot commented Mar 27, 2024 •

edited

Loading

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

crodriguezvega commented Mar 27, 2024

crodriguezvega commented Apr 8, 2024

srdtrk commented Apr 8, 2024

damiannolan commented Apr 9, 2024

DimitrisJim commented Apr 9, 2024

crodriguezvega commented Apr 10, 2024

damiannolan left a comment

damiannolan Apr 11, 2024

feat: allow module safe queries in ICA (backport #5785) #6065

feat: allow module safe queries in ICA (backport #5785) #6065

Conversation

mergify bot commented Mar 27, 2024

Description

Commit Message / Changelog Entry

Summary by CodeRabbit

mergify bot commented Mar 27, 2024

coderabbitai bot commented Mar 27, 2024 • edited Loading

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

crodriguezvega commented Mar 27, 2024

crodriguezvega commented Apr 8, 2024

srdtrk commented Apr 8, 2024

damiannolan commented Apr 9, 2024

DimitrisJim commented Apr 9, 2024

crodriguezvega commented Apr 10, 2024

damiannolan left a comment

Choose a reason for hiding this comment

damiannolan Apr 11, 2024

Choose a reason for hiding this comment

coderabbitai bot commented Mar 27, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)