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: allow gov and proposer to delete invalid output root #120

Merged
merged 1 commit into from
Nov 15, 2024

Conversation

beer-1
Copy link
Contributor

@beer-1 beer-1 commented Nov 8, 2024

Description

This would allow a invalid output to be deleted by gov proposal or bridge operator.


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, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • 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

    • Enhanced permission checks for deleting outputs, allowing both the proposer and challenger to perform the action.
    • Improved error messages for unauthorized access, detailing expected challengers.
  • Bug Fixes

    • Updated test cases to ensure robust handling of unauthorized deletions and valid deletion scenarios.
  • Tests

    • Expanded test coverage for deletion logic, including checks for valid deletions by government authority and proposer, as well as error handling for deleted outputs.

@beer-1 beer-1 self-assigned this Nov 8, 2024
@beer-1 beer-1 requested a review from a team as a code owner November 8, 2024 04:18
Copy link

coderabbitai bot commented Nov 8, 2024

Walkthrough

The changes introduced in this pull request primarily focus on the DeleteOutput method within the MsgServer struct in the msg_server.go file. The permission logic has been updated to allow both the current proposer and the current challenger to delete an output, whereas previously only the challenger could perform this action. Additionally, the error handling for unauthorized deletion attempts has been improved to provide clearer feedback. Corresponding updates have been made to the test cases in msg_server_test.go to ensure robust testing of these new permissions and scenarios.

Changes

File Path Change Summary
x/ophost/keeper/msg_server.go Modified DeleteOutput method to allow both proposer and challenger to delete outputs; enhanced unauthorized error messages.
x/ophost/keeper/msg_server_test.go Updated test cases for DeleteOutput to include checks for unauthorized access, valid deletions by both roles, error handling post-deletion, and resubmission of outputs.

Poem

In the land of hops and playful cheer,
A change was made that brought us near.
Proposers can now join the fray,
Deleting outputs in a new way!
With clearer messages, we now can see,
Who's allowed to act, as it should be! 🐇✨


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.

Copy link

codecov bot commented Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.42%. Comparing base (9a81ba3) to head (ec6f727).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #120      +/-   ##
==========================================
+ Coverage   49.37%   49.42%   +0.04%     
==========================================
  Files          57       57              
  Lines        4249     4249              
==========================================
+ Hits         2098     2100       +2     
+ Misses       1721     1719       -2     
  Partials      430      430              
Files with missing lines Coverage Δ
x/ophost/keeper/msg_server.go 56.60% <100.00%> (ø)

... and 1 file with indirect coverage changes

Copy link

@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

🧹 Outside diff range and nitpick comments (1)
x/ophost/keeper/msg_server_test.go (1)

Line range hint 1-154: Consider adding negative test cases for better coverage.

While the current test coverage is good, consider adding these scenarios:

  1. Attempt to delete an already deleted output
  2. Attempt to delete with an invalid bridge ID
 	_, err = ms.DeleteOutput(ctx, types.NewMsgDeleteOutput(addrsStr[0], 1, 1))
 	require.NoError(t, err)
+
+	// attempt to delete already deleted output
+	_, err = ms.DeleteOutput(ctx, types.NewMsgDeleteOutput(addrsStr[0], 1, 1))
+	require.Error(t, err)
+
+	// attempt to delete with invalid bridge ID
+	_, err = ms.DeleteOutput(ctx, types.NewMsgDeleteOutput(addrsStr[0], 999, 1))
+	require.Error(t, err)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9a81ba3 and ec6f727.

📒 Files selected for processing (2)
  • x/ophost/keeper/msg_server.go (1 hunks)
  • x/ophost/keeper/msg_server_test.go (2 hunks)
🔇 Additional comments (6)
x/ophost/keeper/msg_server_test.go (5)

122-123: LGTM! Unauthorized access test is well implemented.

The test correctly verifies that unauthorized addresses cannot delete outputs.


Line range hint 125-143: LGTM! Challenger deletion flow is thoroughly tested.

The test covers:

  1. Successful deletion by challenger
  2. Verification that the output is deleted
  3. Error handling when accessing deleted output
  4. Resubmission capability
  5. Invalid output index handling

144-146: LGTM! Governance deletion capability is verified.

The test confirms that the governance authority can delete outputs, aligning with the PR objectives.


148-150: LGTM! Resubmission after governance deletion is verified.

The test ensures that outputs can be resubmitted after being deleted by governance.


152-154: LGTM! Proposer deletion capability is verified.

The test confirms that the proposer can delete outputs, which aligns with the PR objectives of allowing proposers to delete invalid output roots.

x/ophost/keeper/msg_server.go (1)

186-188: Verify the impact of batch deletion behavior.

The DeleteOutput function deletes all outputs from the specified index up to the next output index. While this implementation is correct, please ensure that all authorized roles (gov, proposer, and challenger) are aware of this batch deletion behavior, as it could have significant implications on the system state.

Let's verify the usage patterns:

x/ophost/keeper/msg_server.go Show resolved Hide resolved
Copy link
Contributor

@Vritra4 Vritra4 left a comment

Choose a reason for hiding this comment

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

LGTM

@beer-1 beer-1 merged commit 0cbcfed into main Nov 15, 2024
8 checks passed
@beer-1 beer-1 deleted the feat/allow-gov-and-proposer-to-delete-output branch November 15, 2024 06:26
@coderabbitai coderabbitai bot mentioned this pull request Nov 15, 2024
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants