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

chain-mon restructuring #10246

Merged
merged 3 commits into from
Apr 24, 2024
Merged

chain-mon restructuring #10246

merged 3 commits into from
Apr 24, 2024

Conversation

Ethnical
Copy link
Contributor

Description
Restructuring Chain-mon with the new architecture and pass the test accordingly.

@Ethnical Ethnical requested review from a team as code owners April 22, 2024 06:56
@Ethnical Ethnical requested review from refcell and zhwrd April 22, 2024 06:56
Copy link
Contributor

coderabbitai bot commented Apr 22, 2024

Walkthrough

Walkthrough

The recent changes aim to enhance the project structure and functionality of blockchain monitoring and messaging systems. These updates involve optimizing import paths for better organization, reorganizing export locations for improved accessibility, and strengthening testing capabilities for cross-domain messaging through the introduction of new functions and enhancements in failure handling mechanisms.

Changes

File Path Change Summary
.../multisig-mon/internal/multisig-mon/service.ts Updated import paths for IGnosisSafe and OptimismPortal ABI files.
.../chain-mon/src/index.ts Reorganized exports to different directories.
.../contracts-bedrock/test/L1/L1CrossDomainMessenger.t.sol Added new functions for message testing, logic modifications, and introduced doNotRevert variable.
.../docker/Dockerfile.packages Altered WORKDIR paths in the container to align with project structure changes.
.github/CODEOWNERS Updated path for balance-mon within chain-mon package from src to internal.

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 4fa7919 and 33921a6.
Files selected for processing (1)
  • .github/CODEOWNERS (1 hunks)
Additional comments not posted (1)
.github/CODEOWNERS (1)

3-3: Update the path for the balance-mon directory to reflect its new location under internal.

Ensure that the new directory structure is correctly reflected in all relevant documentation and integration points.


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.

@Ethnical Ethnical marked this pull request as draft April 22, 2024 07:12
@Ethnical Ethnical force-pushed the Ethni/restruct-chain-mon branch from 2cb9ea6 to 478cfb6 Compare April 22, 2024 08:32
@zchn zchn requested review from raffaele-oplabs and removed request for a team and refcell April 23, 2024 13:46
@Ethnical Ethnical marked this pull request as ready for review April 23, 2024 13:50
@zchn zchn enabled auto-merge April 23, 2024 14:27
Copy link
Collaborator

@raffaele-oplabs raffaele-oplabs left a comment

Choose a reason for hiding this comment

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

ops/docker/Dockerfile.packages
would needs to change according to the new structure of the folders.

Copy link
Contributor

@zhwrd zhwrd left a comment

Choose a reason for hiding this comment

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

initialized-upgraded-mon should potentially be an internal service, as it was developed recently and is used internally, cc @zchn

but otherwise lgtm

@zchn
Copy link
Contributor

zchn commented Apr 23, 2024

initialized-upgraded-mon should potentially be an internal service, as it was developed recently and is used internally, cc @zchn

but otherwise lgtm

Sgtm

@zchn
Copy link
Contributor

zchn commented Apr 23, 2024

initialized-upgraded-mon should potentially be an internal service, as it was developed recently and is used internally, cc @zchn
but otherwise lgtm

Sgtm

Also need to update the code owner path for balance mon and add initialized-upgraded-mon unless it is owned by security :

/packages/chain-mon/src/balance-mon @ethereum-optimism/infra-reviewers

@Ethnical Ethnical requested a review from a team as a code owner April 23, 2024 20:29
@Ethnical Ethnical requested a review from trianglesphere April 23, 2024 20:29
Copy link
Contributor

semgrep-app bot commented Apr 23, 2024

Semgrep found 13 sol-style-notice-over-dev-natspec findings:

Prefer @notice over @dev in natspec comments

Ignore this finding from sol-style-notice-over-dev-natspec.

Semgrep found 5 golang_fmt_errorf_no_params findings:

No fmt.Errorf invocations without fmt arguments allowed

Ignore this finding from golang_fmt_errorf_no_params.

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: 0

Out of diff range and nitpick comments (1)
ops/docker/Dockerfile.packages (1)

98-98: Consider updating the comment about deleting unused images to reflect current usage or plans.

This comment suggests that there are still unused images that might be cleaned up. It would be beneficial to either update this comment to reflect the current state of the project or to actually remove any unused Docker images to streamline the Dockerfile.

@zchn zchn added this pull request to the merge queue Apr 24, 2024
Merged via the queue into develop with commit 6b23176 Apr 24, 2024
75 checks passed
@zchn zchn deleted the Ethni/restruct-chain-mon branch April 24, 2024 14:16
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.

4 participants