Address additional feedback from 08-wasm refactor pr #6176

DimitrisJim · 2024-04-16T23:19:13Z

Description

also made GetQueryPlugins and SetQueryPlugins private. Others could also be made private and added to export_test.go (probably).

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.

Summary by CodeRabbit

Refactor
- Improved method naming and internal control flow for managing query plugins.
- Updated error handling in contract migration tests.
- Renamed variables for clarity in client state management functions.

coderabbitai · 2024-04-16T23:19:21Z

Walkthrough

The recent updates focus on refining the management and accessibility of query plugins within the Wasm light client modules. Functions related to query plugins have been renamed for internal use, and their accessibility in tests has been enhanced through wrapper functions. Additionally, there are updates to error handling in tests and variable renaming for clarity in the light client module logic.

Changes

File Path	Change Summary
`.../08-wasm/keeper/export_test.go`	Added wrapper functions for direct method calls in tests.
`.../08-wasm/keeper/keeper.go` `.../08-wasm/keeper/keeper_vm.go` `.../08-wasm/keeper/options.go`	Renamed query plugin functions for internal use and updated method calls.
`.../08-wasm/keeper/msg_server_test.go`	Updated error type from `ErrClientTypeNotFound` to `ErrClientNotFound`.
`.../08-wasm/light_client_module.go`	Renamed variables for clarity and updated references in `RecoverClient` function.

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.

DimitrisJim · 2024-04-16T23:22:39Z

modules/light-clients/08-wasm/keeper/keeper.go

@@ -142,32 +142,27 @@ func (k Keeper) storeWasmCode(ctx sdk.Context, code []byte, storeFn func(code wa
 // migrateContractCode migrates the contract for a given light client to one denoted by the given new checksum. The checksum we
 // are migrating to must first be stored using storeWasmCode and must not match the checksum currently stored for this light client.
 func (k Keeper) migrateContractCode(ctx sdk.Context, clientID string, newChecksum, migrateMsg []byte) error {
-	wasmClientState, err := k.GetWasmClientState(ctx, clientID)


merging of two functions here resulted in this. In both cases we look up the same wasmClientState. Using ClientStore + GetClientState (instead of GetWasmClientState) is more efficient since we already need to grab a reference to the store to pass to WasmMigrate (though see #6103 (comment))

damiannolan · 2024-04-17T08:52:51Z

modules/light-clients/08-wasm/keeper/export_test.go

+}
+
+// SetQueryPlugins is a wrapper around k.setQueryPlugins to allow the method to be directly called in tests.
+func (k *Keeper) SetQueryPlugins(plugins QueryPlugins) {


Are these called directly in tests somewhere? 🤔 (don't see any diffs which use them in this PR)

If they're not needed, I'd be in favouring of deleting them - not the biggest fan of export_test

yea, in options_test.go atm (though options.go is tiny and merging it in keeper.go could be another option if we wanted!)

def don't really like export_test.go too

sonarcloud · 2024-04-17T10:03:56Z

Quality Gate passed for 'ibc-go'

Issues
7 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

crodriguezvega

Thanks, @DimitrisJim!

crodriguezvega · 2024-04-17T20:51:12Z

modules/light-clients/08-wasm/keeper/keeper.go

@@ -68,18 +68,18 @@ func (k Keeper) GetChecksums() collections.KeySet[[]byte] {
 	return k.checksums
 }

-// GetQueryPlugins returns the set query plugins.
-func (k Keeper) GetQueryPlugins() QueryPlugins {


This is API breaking for 08-wasm, right? I added this PR to the list of PRs to go through when updating the docs and migration docs, but should we at least reflect that is API breaking in the title of the PR?

these were in internal before so not exposed to api thankfully! This comment should apply for the other PR though (I unfortunately tend to be forgetful of adding these to the title)

chore: address some additional nits.

8c76097

DimitrisJim requested review from colin-axner, AdityaSripal, damiannolan, charleenfei, chatton, srdtrk and crodriguezvega as code owners April 16, 2024 23:19

DimitrisJim changed the title ~~chore: address some additional nits.~~ Address additional feedback from 08-wasm refactor pr Apr 16, 2024

DimitrisJim commented Apr 16, 2024

View reviewed changes

damiannolan approved these changes Apr 17, 2024

View reviewed changes

Merge branch 'main' into jim/further-refactor-nits

5ccda68

DimitrisJim added the 08-wasm label Apr 17, 2024

DimitrisJim mentioned this pull request Apr 17, 2024

Remove usage of globals from 08-wasm #6103

Merged

10 tasks

crodriguezvega mentioned this pull request Apr 17, 2024

Update 08-wasm documentation and migration docs for v0.4.x #6139

Closed

crodriguezvega approved these changes Apr 17, 2024

View reviewed changes

DimitrisJim merged commit 4d3623d into main Apr 17, 2024
84 of 86 checks passed

DimitrisJim deleted the jim/further-refactor-nits branch April 17, 2024 22:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Address additional feedback from 08-wasm refactor pr #6176

Address additional feedback from 08-wasm refactor pr #6176

DimitrisJim commented Apr 16, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 16, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

DimitrisJim Apr 16, 2024

damiannolan Apr 17, 2024

DimitrisJim Apr 17, 2024

DimitrisJim Apr 17, 2024

sonarcloud bot commented Apr 17, 2024

crodriguezvega left a comment

crodriguezvega Apr 17, 2024

DimitrisJim Apr 17, 2024

Address additional feedback from 08-wasm refactor pr #6176

Address additional feedback from 08-wasm refactor pr #6176

Conversation

DimitrisJim commented Apr 16, 2024 • edited by coderabbitai bot Loading

Description

Summary by CodeRabbit

coderabbitai bot commented Apr 16, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

DimitrisJim Apr 16, 2024

Choose a reason for hiding this comment

damiannolan Apr 17, 2024

Choose a reason for hiding this comment

DimitrisJim Apr 17, 2024

Choose a reason for hiding this comment

DimitrisJim Apr 17, 2024

Choose a reason for hiding this comment

sonarcloud bot commented Apr 17, 2024

Quality Gate passed for 'ibc-go'

crodriguezvega left a comment

Choose a reason for hiding this comment

crodriguezvega Apr 17, 2024

Choose a reason for hiding this comment

DimitrisJim Apr 17, 2024

Choose a reason for hiding this comment

DimitrisJim commented Apr 16, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 16, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)