Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 55 commits into from
May 17, 2024

Conversation

meetrick
Copy link
Contributor

@meetrick meetrick commented Apr 16, 2024

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 concurrency settings for workflow execution, including the ability to cancel in-progress runs.
    • Introduced branch filtering for pull requests in GitHub Actions workflows.
  • Updates

    • Updated amannn/action-semantic-pull-request to version v5.5.2.
    • Updated bufbuild/buf-setup-action to version v1.31.0.
    • Added a new job test-x-accounts-lockup for specific file testing in the workflow.
  • Bug Fixes

    • Removed embedded grpc-web proxy in favor of a standalone grpc-web proxy using Envoy Proxy.
  • Documentation

    • Updated CHANGELOG.md and UPGRADING.md with new changes and deprecations.
  • Chores

    • Removed linting, testing, and vulnerability checks from the Makefile build process.

Signed-off-by: Hwangjae Lee <meetrick@gmail.com>
@meetrick meetrick requested a review from a team as a code owner April 16, 2024 06:24
Copy link
Contributor

coderabbitai bot commented Apr 16, 2024

Walkthrough

The recent updates primarily focus on enhancing the efficiency and functionality of GitHub Actions workflows and improving various modules within the cosmos-sdk. Key changes include adding concurrency settings, updating action versions, refining module interfaces, and removing deprecated comments. Additionally, the Makefile build process has been streamlined, and significant modifications have been made to schema handling and genesis state fields.

Changes

File Change Summary
.github/workflows/codeql-analysis.yml Added concurrency settings for workflow execution, including a group definition and the ability to cancel in-progress runs.
.github/workflows/gosec.yml Introduced branch filtering for pull requests, added concurrency settings, and included a cancel-in-progress option.
.github/workflows/lint-pr.yml Updated amannn/action-semantic-pull-request from v5.4.0 to v5.5.2.
.github/workflows/proto.yml Updated bufbuild/buf-setup-action from v1.30.1 to v1.31.0.
.github/workflows/test.yml Added a new job test-x-accounts-lockup to run tests for specific files in the x/accounts/defaults/lockup directory.
CHANGELOG.md Included updates and deprecations in cosmos-sdk modules, enhancements to key management commands, and bug fixes.
Makefile Simplified the build process by removing linting, testing, and vulnerability checks from the all target.
UPGRADING.md Suggested using Envoy proxy for grpc-web functionality and highlighted changes to InitGenesis and ExportGenesis methods.
api/cosmos/auth/v1beta1/auth.pulsar.go No change in declarations.
api/cosmos/auth/v1beta1/tx.pulsar.go Removed versioning comments and reorganized fields in MsgUpdateParams and MsgUpdateParamsResponse structs.
api/cosmos/authz/v1beta1/query.pulsar.go Updated some byte values.
api/cosmos/bank/v1beta1/authz.pulsar.go Removed versioning comments and adjusted field lengths in SendAuthorization struct.
api/cosmos/bank/v1beta1/bank.pulsar.go Removed version annotations from Metadata struct fields.
api/cosmos/bank/v1beta1/genesis.pulsar.go Removed SendEnabled field from GenesisState struct.
api/cosmos/base/query/v1beta1/pagination.pulsar.go Added import for github.com/cosmos/cosmos-proto and removed version comment from PageRequest struct.
api/cosmos/consensus/v1/tx.pulsar.go No change in declarations.
api/cosmos/crisis/v1beta1/tx.pulsar.go Removed version comments and updated byte values.
api/cosmos/evidence/v1beta1/query.pulsar.go Added import for github.com/cosmos/cosmos-proto and removed version comment from QueryEvidenceRequest struct.
api/cosmos/feegrant/v1beta1/query.pulsar.go Removed version comments from QueryAllowancesByGranterRequest and QueryAllowancesByGranterResponse structs.
api/cosmos/feegrant/v1beta1/tx.pulsar.go Removed version comments from MsgPruneAllowances and MsgPruneAllowancesResponse structs.
api/cosmos/gov/v1/genesis.pulsar.go Added import for github.com/cosmos/cosmos-proto and removed Params and Constitution fields from GenesisState struct.
api/cosmos/mint/v1beta1/tx.pulsar.go Removed version comments and adjusted protobuf message sizes and field numbers.
api/cosmos/params/v1beta1/query.pulsar.go Added import for github.com/cosmos/cosmos-proto and removed version comments from structs.
api/cosmos/slashing/v1beta1/tx.pulsar.go Removed version comments from MsgUpdateParams and MsgUpdateParamsResponse types.
api/cosmos/staking/v1beta1/authz.pulsar.go Removed version comment and updated tag value for max_tokens field in StakeAuthorization struct.
x/accounts/query_server.go Refactored queryServer struct to include schemaCache and schemas for efficient schema retrieval, and updated method receivers to pointers.

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
Copy link
Contributor Author

meetrick commented Apr 17, 2024

@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.

return schema, nil
}

// If not cached, generate and cache the schema
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

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

tac0turtle and others added 13 commits April 29, 2024 18:11
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>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

x/accounts/query_server.go Outdated Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@meetrick
Copy link
Contributor Author

meetrick commented Apr 29, 2024

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

Copy link
Contributor

@testinginprod testinginprod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, need to remove schema cache as it's not needed.

schemas := v1.MakeAccountsSchemas(k.accounts)
return &queryServer{
k: k,
schemaCache: make(map[string]*v1.SchemaResponse, len(schemas)), // Initialize with precomputed length
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SchemaCache field is not needed anymore

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, It is removed

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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between e15cae8 and ecb8d3f.
Files selected for processing (1)
  • x/accounts/query_server.go (3 hunks)
Additional Context Used
Path-based Instructions (1)
x/accounts/query_server.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (5)
x/accounts/query_server.go (5)

13-21: The NewQueryServer function correctly initializes the schemas field. Ensure no references to schemaCache remain.


Line range hint 30-55: The AccountQuery method handles errors and responses correctly. No issues found.


59-67: The Schema method correctly retrieves the schema from the precalculated schemas and handles errors appropriately. No issues found.


Line range hint 71-81: The AccountType method handles errors and responses correctly. No issues found.


Line range hint 85-93: The AccountNumber method handles errors and responses correctly. No issues found.

x/accounts/query_server.go Outdated Show resolved Hide resolved
Signed-off-by: Hwangjae Lee <meetrick@gmail.com>
@meetrick
Copy link
Contributor Author

@sontrinh16 Could you add this PR to the merge queue?

@sontrinh16 sontrinh16 added this pull request to the merge queue May 17, 2024
Merged via the queue into cosmos:main with commit 06c9c54 May 17, 2024
59 checks passed
alpe added a commit that referenced this pull request May 23, 2024
* main: (95 commits)
  fix(x/accounts): check for overflows in multisig weights and votes (#20384)
  docs(x/account/auth): Improve error handling and comments in fee.go (#20426)
  docs: fix some markdown syntax (#20432)
  revert: bank change module to account change (#20427)
  fix: nil pointer panic when store don't exists in historical version (#20425)
  fix(store/v2): Remove should not error on miss (#20423)
  chore: upstream more changes from v2 (#20387)
  docs(x/auth/ante): fixed typo  in TxWithTimeoutHeight interface name (#20418)
  fix: avoid default sendenabled for module accounts (#20419)
  docs(x/auth): fixed typo in command example for multisign transaction (#20417)
  build(deps): Bump bufbuild/buf-setup-action from 1.31.0 to 1.32.0 (#20413)
  build(deps): Bump github.com/hashicorp/go-plugin from 1.6.0 to 1.6.1 in /store (#20414)
  feat(x/accounts): Add schema caching feature and corresponding test case (#20055)
  refactor(runtime/v2): remove dependency on sdk (#20389)
  refactor!: turn MsgsV2 into ReflectMessages to make it less confusing (#19839)
  docs: Enhanced the ParsePagination method documentation (#20385)
  refactor(runtime,core): split router service (#20401)
  chore: fix spelling errors (#20400)
  docs: Documented error handling in OfferSnapshot method (#20380)
  build(deps): Bump google.golang.org/grpc from 1.63.2 to 1.64.0 (#20390)
  ...
@meetrick meetrick deleted the 20240416_2 branch September 26, 2024 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.