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(accounts): Add methods to check if an account accepts certain messages or queries (interface assertion) #19361

Merged
merged 2 commits into from
Feb 6, 2024

Conversation

testinginprod
Copy link
Contributor

@testinginprod testinginprod commented Feb 6, 2024

Description

Adds methods in the internal implementation to check if an account accepts certain messages or queries, this can be used as a way to check for interface implementation.


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
    • Introduced new capabilities to check if an account can execute specific actions such as messages, queries, or initialization processes.

@testinginprod testinginprod requested a review from a team as a code owner February 6, 2024 14:01
Copy link
Contributor

coderabbitai bot commented Feb 6, 2024

Walkthrough

Walkthrough

The update introduces three new methods (HasExec, HasQuery, and HasInit) to the Implementation struct in the accounts module, enhancing its functionality to determine if an account is capable of executing specific types of messages. Additionally, the update includes the creation of test cases for these methods to ensure their correct behavior across different scenarios.

Changes

Files Change Summary
.../implementation.go, .../implementation_test.go Added HasExec, HasQuery, and HasInit methods to Implementation struct. Added corresponding test cases in TestImplementation 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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

github-actions bot commented Feb 6, 2024

@testinginprod your pull request is missing a changelog!

@testinginprod testinginprod mentioned this pull request Feb 6, 2024
44 tasks
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.

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between c91660e and 8e50ee3.
Files selected for processing (2)
  • x/accounts/internal/implementation/implementation.go (1 hunks)
  • x/accounts/internal/implementation/implementation_test.go (1 hunks)
Additional comments: 3
x/accounts/internal/implementation/implementation.go (3)
  • 129-133: The HasExec method correctly checks if a message can be executed by looking up the message name in the ExecuteHandlersSchema. This implementation is efficient and follows best practices.
  • 135-139: The HasQuery method implementation is consistent with the HasExec method, correctly checking the ability to execute a query based on the message name. This maintains consistency and clarity in the codebase.
  • 141-144: The HasInit method uses a direct comparison to check if the account uses the provided init message, which is a straightforward and efficient approach. Ensure that the InitHandlerSchema.RequestSchema.Name is always correctly set during initialization to avoid false negatives.

Comment on lines +60 to +78
t.Run("Has* methods", func(t *testing.T) {
ok := impl.HasExec(&types.StringValue{})
require.True(t, ok)

ok = impl.HasExec(&types.Duration{})
require.False(t, ok)

ok = impl.HasQuery(&types.StringValue{})
require.True(t, ok)

ok = impl.HasQuery(&types.Duration{})
require.False(t, ok)

ok = impl.HasInit(&types.StringValue{})
require.True(t, ok)

ok = impl.HasInit(&types.Duration{})
require.False(t, ok)
})
Copy link
Contributor

Choose a reason for hiding this comment

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

The test cases for HasExec, HasQuery, and HasInit methods are correctly implemented, ensuring that these methods behave as expected for different message types. However, consider adding negative test cases or edge cases, if any, to cover more scenarios.

@testinginprod testinginprod added this pull request to the merge queue Feb 6, 2024
Merged via the queue into main with commit d26fe65 Feb 6, 2024
61 of 62 checks passed
@testinginprod testinginprod deleted the tip/accounts/assert_interface branch February 6, 2024 16:55
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.

3 participants