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

[OTE-840] add missing HasEndBlocker interface #2384

Merged
merged 1 commit into from
Sep 27, 2024
Merged

Conversation

affanv14
Copy link
Contributor

@affanv14 affanv14 commented Sep 27, 2024

Changelist

Endblocker for affiliates was not executing
HasEndBlocker interface added

Test Plan

[Describe how this PR was tested (if applicable)]
tested locally

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

  • New Features

    • Enhanced context management within the module for improved performance.
    • Introduced error handling in the end block process, allowing for better reliability.
  • Bug Fixes

    • Updated method signatures to ensure compatibility and correct functionality.

@affanv14 affanv14 requested a review from a team as a code owner September 27, 2024 00:25
Copy link
Contributor

coderabbitai bot commented Sep 27, 2024

Walkthrough

The pull request introduces modifications to the AppModule structure in the protocol/x/affiliates/module.go file. It updates the context handling by importing the context package and changing the EndBlock method signature to accept a context.Context parameter instead of sdk.Context. The method now returns an error, enhancing error management during the end block process. The body of the EndBlock method calls the existing EndBlocker function with the updated context and concludes by returning nil for successful execution.

Changes

File Path Change Summary
protocol/x/affiliates/module.go Updated EndBlock method signature from func (am AppModule) EndBlock(ctx sdk.Context) to func (am AppModule) EndBlock(ctx context.Context) error. Added error return type and context import.

Possibly related PRs

  • fix lint for affiliates #2255: This PR involves changes to error handling in the UpdateAffiliateTiers function, which is relevant to the modifications made in the AppModule structure in the main PR, as both pertain to the affiliates module and involve improvements in handling function outcomes.

Suggested labels

indexer, protocol

Suggested reviewers

  • dydxwill

Poem

In the code where rabbits play,
New contexts hop along the way.
With errors caught and blocks refined,
A brighter path for all aligned.
So let us cheer, both near and far,
For changes made, our shining star! ✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 60cc7aa and 432c98c.

📒 Files selected for processing (1)
  • protocol/x/affiliates/module.go (3 hunks)
🔇 Additional comments (3)
protocol/x/affiliates/module.go (3)

4-4: Appropriate import of the context package

The addition of the "context" import is necessary due to the updated EndBlock method signature that now accepts a context.Context.


29-29: Implementation of HasEndBlocker interface

Adding the implementation assertion for appmodule.HasEndBlocker confirms that AppModule now correctly implements the EndBlock functionality.


148-153: Ensure proper error handling in EndBlock method

The EndBlock method now returns an error, but currently always returns nil. Please verify if the EndBlocker function can produce an error. If it does, consider capturing and returning the error to ensure proper error propagation.

Run the following script to check if EndBlocker returns an error:


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@affanv14 affanv14 changed the title add missing HasEndBlocker interface [OTE-840] add missing HasEndBlocker interface Sep 27, 2024
Copy link

linear bot commented Sep 27, 2024

@affanv14
Copy link
Contributor Author

https://github.com/Mergifyio backport release/protocol/v7.x

Copy link
Contributor

mergify bot commented Sep 27, 2024

backport release/protocol/v7.x

✅ Backports have been created

@affanv14 affanv14 merged commit 7193a10 into main Sep 27, 2024
22 checks passed
@affanv14 affanv14 deleted the affan/endblocker-fix branch September 27, 2024 01:20
mergify bot pushed a commit that referenced this pull request Sep 27, 2024
affanv14 added a commit that referenced this pull request Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants