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

[Cleanup] Avoid importing op-e2e package from op-node #9765

Conversation

mdehoog
Copy link
Contributor

@mdehoog mdehoog commented Mar 7, 2024

Description

(Package import cleanup PR, no logic changes).

Avoid importing the op-e2e package from op-node. This package is primarily for E2E testing and should not be depended on from production code.

Also the op-e2e/config dir contains an init function that breaks everything when not in a testing environment.

Tests

Existing tests.

Additional context

https://github.com/base-org/withdrawer depends on the op-node/withdrawals package and is currently broken due to the init function that is imported as a side-effect from the e2eutils.UseFPAC() call.

@mdehoog mdehoog requested a review from a team as a code owner March 7, 2024 01:42
@mdehoog mdehoog requested a review from ajsutton March 7, 2024 01:42
Copy link
Contributor

coderabbitai bot commented Mar 7, 2024

Walkthrough

Walkthrough

The changes involve refactoring and streamlining the process of proving withdrawal parameters across several files. This includes the introduction of a new package import, adjustments in function calls to utilize a more direct approach, and the division of a key function into two specialized versions for enhanced clarity. The modifications aim to improve code modularity and reduce dependencies, particularly removing unnecessary parameters and simplifying the logic for withdrawal proving.

Changes

Files Change Summary
op-e2e/actions/user.go Added op-e2e package import; replaced withdrawals.ProveWithdrawalParameters with e2e.ProveWithdrawalParameters.
op-e2e/system_tob_test.go Removed optimismPortal usage; updated to call ProveWithdrawalParameters directly.
op-e2e/withdrawal_helper.go Refactored ProveWithdrawal to use ProveWithdrawalParameters with updated parameters.
op-node/withdrawals/utils.go Split ProveWithdrawalParameters into two functions; streamlined logic and updated parameters.

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

op-node/withdrawals/utils.go Show resolved Hide resolved
op-e2e/actions/user.go Show resolved Hide resolved
op-e2e/withdrawal_helper.go Show resolved Hide resolved
@ajsutton
Copy link
Contributor

ajsutton commented Mar 7, 2024

Is there any reason that whole op-node/withdrawals/utils.go file needs to exist in op-node? I can't see anything there used outside of tests. If its possible, I'd much rather just move it to op-e2e/e2eutils/withdrawals.

@ajsutton
Copy link
Contributor

ajsutton commented Mar 7, 2024

ah, while that would clean up the code, it wouldn't help your withdrawer... Otherwise it does look like it works (at least make lint passes after doing the move). I've put up a draft to move these to the e2eutils (#9771) but not entirely sure what the best thing is for the withdrawer. There's a definite lack of testing for this code if we actually intend to treat it as production code.

Copy link
Contributor

@ajsutton ajsutton left a comment

Choose a reason for hiding this comment

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

I think this code with the completely separate paths for fault proof and l2oo withdrawals is strictly better, so will approve and merge this. I am still keen to move all this code out of op-node though and properly reflect that it is actually part of our e2e testing framework.

Interested to hear thoughts on how that impacts the withdrawer and what the right option is to support that. It definitely looks like a useful tool...

@ajsutton ajsutton added this pull request to the merge queue Mar 7, 2024
Merged via the queue into ethereum-optimism:develop with commit 8974714 Mar 7, 2024
69 checks passed
@mdehoog mdehoog deleted the michael/cleanup-withdrawals-package branch March 7, 2024 07:49
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