feat(x/accounts): Add schema caching feature and corresponding test case #20055

meetrick · 2024-04-16T06:24:36Z

Description

Add schema caching feature and corresponding test case

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

included the correct type prefix in the PR title
confirmed ! in the type prefix if API or client breaking change
targeted the correct branch (see PR Targeting)
provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary
included the necessary unit and integration tests
added a changelog entry to CHANGELOG.md
updated the relevant documentation or specification, including comments for documenting Go code
confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

confirmed the correct type prefix in the PR title
confirmed all author checklist items have been addressed
reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

New Features
- Added new concurrency settings for GitHub Actions workflows to improve execution efficiency.
- Implemented branch filtering for pull requests in GitHub Actions to streamline CI processes.
- Introduced a new job in the test workflow to enhance testing specificity and efficiency.
Enhancements
- Updated GitHub Actions to newer versions for better performance and reliability.
- Removed embedded grpc-web proxy in favor of a standalone solution, enhancing server performance and compatibility.
Documentation
- Updated CHANGELOG with comprehensive details on recent changes and deprecations affecting users.
Refactor
- Streamlined the build process in Makefile by focusing solely on the build step, removing linting and testing from the default build sequence.
Bug Fixes
- Addressed issues with grpc-web proxy integration by transitioning to a standalone proxy setup.
Chores
- Removed outdated comments and annotations from various API files to clean up and modernize the codebase.

Signed-off-by: Hwangjae Lee <meetrick@gmail.com>

coderabbitai · 2024-04-16T06:24:43Z

Warning

Rate Limit Exceeded

@meetrick has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 16 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between e15cae8 and 28f3431.

Walkthrough

The repository updates primarily focus on enhancing GitHub workflows by adding concurrency settings and branch filtering, updating dependencies in workflow files, and refining the cosmos-sdk with interface adjustments and deprecations. Additionally, there are significant changes in API files, including the removal of version comments and reorganization of struct fields. The Makefile and query_server.go also see modifications to streamline processes and improve struct functionalities.

Changes

Files	Change Summary
`.github/workflows/...`	Added concurrency settings, branch filtering, and updated action versions.
`CHANGELOG.md`, `UPGRADING.md`	Documented deprecations, interface changes, and enhancements in `cosmos-sdk`.
`Makefile`, `x/accounts/query_server.go`	Simplified build process in `Makefile`; refactored `queryServer` in `x/accounts/query_server.go`.
`api/cosmos/...`	Removed version comments, updated import statements, and reorganized fields in various API files.

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.

This commit modifies the queryServer struct methods to avoid copying the entire struct by adding a mutex lock. Instead of changing the receiver to a pointer, a mutex named 'mu' is introduced to synchronize access to the struct's fields. This approach minimizes the impact on other functions while ensuring safe concurrent access to the methods. Signed-off-by: Hwangjae Lee <meetrick@gmail.com>

Signed-off-by: Hwangjae Lee <meetrick@gmail.com>

meetrick · 2024-04-17T08:55:32Z

@tac0turtle Hi, Could you add another reviewer as an assignee? It seems like @testinginprod hasn't been able to review since last week.
If @testinginprod's review is absolutely necessary, I'll be happy to wait.

cool-develope · 2024-04-21T20:41:57Z

x/accounts/query_server.go

+		return schema, nil
+	}
+
+	// If not cached, generate and cache the schema


I have not much context of it, but seems like it is not a good solution, why not initialize schemas in the constructor NewQueryServer?

@cool-develope Thanks for the review. I wanted to make as few changes to the code as possible, but ended up with some ambiguous code. Following your advice to improve the code, there were many modifications. Could you review it again?

hmm, I think we need more research of it, leave the decision to @testinginprod

Thanks for your opinion!

- Updated all methods of the queryServer struct to use pointer receivers, ensuring compliance with the v1.QueryServer interface. - Refactored the NewQueryServer function to precalculate and store schemas for efficient schema retrieval. - Initialized the schemaCache with a precomputed length based on the length of precalculated schemas, ensuring efficient memory usage. - Added a schemas field to the queryServer struct to store precalculated schemas. - Updated the AccountQuery and Schema methods to use pointer receivers. - Added comments to describe the purpose of the Schema method. - Ensured the AccountType and AccountNumber methods use pointer receivers. Signed-off-by: Hwangjae Lee <meetrick@gmail.com>

facundomedica · 2024-04-25T18:53:11Z

Would it be possible not to use a mutex? I don't think this is something we'd like to have here

testinginprod · 2024-04-29T08:52:42Z

x/accounts/query_server.go

 func NewQueryServer(k Keeper) v1.QueryServer {
-	return &queryServer{k}
+	// Pre-calculate schemas for efficient retrieval.
+	schemas := v1.MakeAccountsSchemas(k.accounts)


Since schemas are already pre-calculated here, there's no need for a mutex, nor a schemaCache.

schemas is already the cache.

Oh, nice to see you! You finally gave your opinion. Unnecessary code has sprung up as I've been modifying the code. Thanks for the review.

@testinginprod Could you code review again? I updated PR by your opinion

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

…osmos#20115) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

Signed-off-by: guoguangwu <guoguangwug@gmail.com>

Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Marko <marko@baricevic.me>

…smos#20165) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

….5.0 (cosmos#20164) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Signed-off-by: cuithon <dscs@outlook.com>

Signed-off-by: Hwangjae Lee <meetrick@gmail.com>

coderabbitai

Actionable comments posted: 1

x/accounts/query_server.go

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

meetrick · 2024-04-29T10:02:05Z

Would it be possible not to use a mutex? I don't think this is something we'd like to have here

@julienrbrt I removed it, Thanks

feat(x/accounts): Add schema caching feature and corresponding test case

0070d42

Signed-off-by: Hwangjae Lee <meetrick@gmail.com>

meetrick requested a review from a team as a code owner April 16, 2024 06:24

github-actions bot added the C:x/accounts label Apr 16, 2024

meetrick added 2 commits April 16, 2024 15:36

Initialize mu as a pointer

4a20c00

Signed-off-by: Hwangjae Lee <meetrick@gmail.com>

tac0turtle assigned sontrinh16 and testinginprod Apr 16, 2024

sontrinh16 approved these changes Apr 16, 2024

View reviewed changes

Merge branch 'main' into 20240416_2

9169303

Merge branch 'main' into 20240416_2

33fc9f8

cool-develope reviewed Apr 21, 2024

View reviewed changes

meetrick added 2 commits April 22, 2024 10:05

Merge branch 'main' into 20240416_2

718cd59

testinginprod reviewed Apr 29, 2024

View reviewed changes

tac0turtle and others added 13 commits April 29, 2024 18:11

chore: remove grpc-web (cosmos#20140)

5ff10e3

docs: add authz reference info in the circuit antehandler (cosmos#20146)

8ea9ff5

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

chore: reduce codeql time (cosmos#20158)

0b4e783

fix(client/v2): close json file (cosmos#20120)

30f9375

Signed-off-by: guoguangwu <guoguangwug@gmail.com>

fix: Fix data race test coverage. (cosmos#20156)

d8ec18f

fix(simapp): store key override accounts (cosmos#20163)

2d90252

refactor(lockup account): Add tests for lockup account (cosmos#19772)

2d614a1

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Marko <marko@baricevic.me>

build(deps): Bump bufbuild/buf-setup-action from 1.30.1 to 1.31.0 (co…

ff88c22

…smos#20165) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

build(deps): Bump amannn/action-semantic-pull-request from 5.4.0 to 5…

21a2269

….5.0 (cosmos#20164) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

docs(x/authz): Update Staking Module Broken Link (cosmos#20157)

c604ffd

chore: fix function names (cosmos#20170)

fd02ae0

Signed-off-by: cuithon <dscs@outlook.com>

Removed cache operation in Schema()

e15cae8

Signed-off-by: Hwangjae Lee <meetrick@gmail.com>

coderabbitai bot reviewed Apr 29, 2024

View reviewed changes

x/accounts/query_server.go Outdated Show resolved Hide resolved

Update x/accounts/query_server.go

28f3431

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(x/accounts): Add schema caching feature and corresponding test case #20055

feat(x/accounts): Add schema caching feature and corresponding test case #20055

meetrick commented Apr 16, 2024 •

edited by coderabbitai bot

coderabbitai bot commented Apr 16, 2024 •

edited

Rate Limit Exceeded

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

meetrick commented Apr 17, 2024 •

edited

cool-develope Apr 21, 2024

meetrick Apr 22, 2024

cool-develope Apr 24, 2024

meetrick Apr 24, 2024

facundomedica commented Apr 25, 2024

testinginprod Apr 29, 2024

meetrick Apr 29, 2024

meetrick Apr 29, 2024

coderabbitai bot left a comment

meetrick commented Apr 29, 2024 •

edited

feat(x/accounts): Add schema caching feature and corresponding test case #20055

Are you sure you want to change the base?

feat(x/accounts): Add schema caching feature and corresponding test case #20055

Conversation

meetrick commented Apr 16, 2024 • edited by coderabbitai bot

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Apr 16, 2024 • edited

Rate Limit Exceeded

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

meetrick commented Apr 17, 2024 • edited

cool-develope Apr 21, 2024

Choose a reason for hiding this comment

meetrick Apr 22, 2024

Choose a reason for hiding this comment

cool-develope Apr 24, 2024

Choose a reason for hiding this comment

meetrick Apr 24, 2024

Choose a reason for hiding this comment

facundomedica commented Apr 25, 2024

testinginprod Apr 29, 2024

Choose a reason for hiding this comment

meetrick Apr 29, 2024

Choose a reason for hiding this comment

meetrick Apr 29, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

meetrick commented Apr 29, 2024 • edited

meetrick commented Apr 16, 2024 •

edited by coderabbitai bot

coderabbitai bot commented Apr 16, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)

meetrick commented Apr 17, 2024 •

edited

meetrick commented Apr 29, 2024 •

edited