refactor(08-wasm)!: Move internal wasm types to internal folder. #6177

DimitrisJim · 2024-04-17T00:02:20Z

Description

Decided to move it in its own internal/types package. Completely open to renaming/moving to ibcwasm if folks prefer.

closes: #XXXX

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

New Features
- Introduced a dual-read capability for data stores, enhancing data access while maintaining write restrictions based on key prefixes.
Bug Fixes
- Updated code size validation to ensure proper checks during operations.
Refactor
- Streamlined store handling for more efficient client state retrieval and checksum creation.
- Consolidated internal type usage across various modules for improved consistency and maintenance.
Tests
- Expanded test suite with new functions and test cases to cover updated store operations and internal type integrations.

coderabbitai · 2024-04-17T00:02:32Z

Walkthrough

The updates involve restructuring the 08-wasm module to enhance store operations and client state management. Changes include introducing a new store type for combined functionality, updating test setups, and refining internal type usage across files to streamline operations and testing within the module.

Changes

Files	Change Summary
`modules/light-clients/08-wasm/internal/types/store.go`, `store_test.go`	Introduced `MergedClientStore` for combined store functionality and updated tests for new store operations.
`modules/light-clients/08-wasm/keeper/contract_keeper.go`, `keeper/keeper.go`, `light_client_module.go`	Updated internal type usage and key prefixes for consistency and integration improvements.
`modules/light-clients/08-wasm/keeper/msg_server_test.go`, `snapshotter.go`	Adjusted function calls related to store operations and code size validation.
`modules/light-clients/08-wasm/types/msgs_test.go`, `store.go`, `validation.go`, `validation_test.go`	Streamlined store interactions, client state operations, and validation logic for wasm code.

Possibly related issues

Remove 08-wasm globals #5833: The restructuring in the 08-wasm module could indirectly address the issue of removing globals by encapsulating functionality within the LightClientModule type.
Restructure 02-client to a more generalized light client handler #5084: Enhancements in client state handling and type modifications align with the goal of making 08-wasm a more generalized light client handler as outlined in the issue.

Recent Review Details

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 215e5c8 and bffa74b.

Files selected for processing (1)

modules/light-clients/08-wasm/light_client_module.go (2 hunks)

Files skipped from review as they are similar to previous changes (1)

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

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-17T00:02:59Z

modules/light-clients/08-wasm/internal/types/store.go

+
+// SplitPrefix splits the key into the prefix and the key itself, if the key is prefixed with either "subject/" or "substitute/".
+// If the key is not prefixed with either "subject/" or "substitute/", the prefix is nil.
+func SplitPrefix(key []byte) ([]byte, []byte) {


no real reason to not have these public now.

modules/light-clients/08-wasm/types/msgs_test.go

modules/light-clients/08-wasm/internal/types/store.go

+// NewStoreAdapter constructor
+func NewStoreAdapter(s storetypes.KVStore) *StoreAdapter {
+	if s == nil {
+		panic(errors.New("types must not be nil"))


damiannolan

Looks great, just left some suggestions on naming and such. Curious to hear what you think

modules/light-clients/08-wasm/types/msgs_test.go

modules/light-clients/08-wasm/internal/types/store.go

modules/light-clients/08-wasm/internal/types/store_test.go

…it to top of test file.

damiannolan

Beautiful!

crodriguezvega

There are also some API breaking changes for 08-wasm here, so would be nice to reflect that in the PR title with a conventional commit.

crodriguezvega · 2024-04-17T20:53:24Z

modules/light-clients/08-wasm/internal/types/store.go

+// Both stores are used for reads, but only the subjectStore is used for writes. For all operations, the key
+// is checked to determine which types to use and must be prefixed with either "subject/" or "substitute/" accordingly.
+// If the key is not prefixed with either "subject/" or "substitute/", a default action is taken (e.g. no-op for Set/Delete).
+type MergedClientStore struct {


Not sure about this name... Merging for me implies that two things are combined into one, but it's not really the case here, we are just grouping two things together... I actually don't dislike the name we had before...

I'm def still feeling the point of not overloading the migrate term but fine to revert. Thoughts @damiannolan?

But two things are combined into one! 😛

This is a struct with two storetypes.KVStore fields defined within it!

The previous name gave a clear indication of where this type is used, while the new one is more generic. Since probably we will not use this anywhere else, I think it would make sense to be more explicit. If I think of merging, I would think of both stores merging into one, which is not the case. But I am fine, if you guys are happy with this naming.

I'll merge as is for now and discussion can be done in slack or an issue. Type is private now so renaming would have no API implications and would be easy to do.

ClientRecoveryStore would probably get the ronseal approval award - does exactly what it says on the tin. I'm not really fussed as long as it doesn't overlap with other naming constructs

sonarcloud · 2024-04-18T09:09:19Z

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

chore: move internal types to internal folder.

4297fa2

DimitrisJim requested review from colin-axner, AdityaSripal, damiannolan, charleenfei, chatton, srdtrk and crodriguezvega as code owners April 17, 2024 00:02

DimitrisJim commented Apr 17, 2024

View reviewed changes

github-advanced-security bot found potential problems Apr 17, 2024

View reviewed changes

damiannolan reviewed Apr 17, 2024

View reviewed changes

DimitrisJim added 4 commits April 17, 2024 13:16

nit: remove MaxWasmByteSize function and just export the constant.

d63045d

nit: Rename to MergedClientStore, add go-doc for constructor, move in…

8e2c116

…it to top of test file.

Merge branch 'main' into jim/internal_wasm_types

508869b

nit: fix references to removed function in e2e module.

8b605b3

DimitrisJim added the 08-wasm label Apr 17, 2024

damiannolan approved these changes Apr 17, 2024

View reviewed changes

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 changed the title ~~Move internal wasm types to internal folder.~~ refactor(08-wasm)!: Move internal wasm types to internal folder. Apr 17, 2024

DimitrisJim added 2 commits April 18, 2024 01:19

Merge branch 'main' into jim/internal_wasm_types

215e5c8

nit: fix merge failure.

bffa74b

DimitrisJim merged commit 2080273 into main Apr 18, 2024
87 of 88 checks passed

DimitrisJim deleted the jim/internal_wasm_types branch April 18, 2024 11:59

DimitrisJim mentioned this pull request Apr 18, 2024

Decide on naming of client store used in 08-wasm migration #6182

Closed

3 tasks

crodriguezvega mentioned this pull request Apr 19, 2024

08-wasm: rename client store #6187

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(08-wasm)!: Move internal wasm types to internal folder. #6177

refactor(08-wasm)!: Move internal wasm types to internal folder. #6177

DimitrisJim commented Apr 17, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 17, 2024 •

edited

Loading

Walkthrough

Changes

Possibly related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

DimitrisJim Apr 17, 2024

damiannolan left a comment

damiannolan left a comment

crodriguezvega left a comment

crodriguezvega Apr 17, 2024

DimitrisJim Apr 17, 2024

damiannolan Apr 18, 2024

crodriguezvega Apr 18, 2024

DimitrisJim Apr 18, 2024

damiannolan Apr 18, 2024 •

edited

Loading

sonarcloud bot commented Apr 18, 2024

refactor(08-wasm)!: Move internal wasm types to internal folder. #6177

refactor(08-wasm)!: Move internal wasm types to internal folder. #6177

Conversation

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

Description

Summary by CodeRabbit

coderabbitai bot commented Apr 17, 2024 • edited Loading

Walkthrough

Changes

Possibly related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

DimitrisJim Apr 17, 2024

Choose a reason for hiding this comment

damiannolan left a comment

Choose a reason for hiding this comment

damiannolan left a comment

Choose a reason for hiding this comment

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

damiannolan Apr 18, 2024

Choose a reason for hiding this comment

crodriguezvega Apr 18, 2024

Choose a reason for hiding this comment

DimitrisJim Apr 18, 2024

Choose a reason for hiding this comment

damiannolan Apr 18, 2024 • edited Loading

Choose a reason for hiding this comment

sonarcloud bot commented Apr 18, 2024

Quality Gate passed for 'ibc-go'

DimitrisJim commented Apr 17, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 17, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

damiannolan Apr 18, 2024 •

edited

Loading