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

fix: lint suggestions #3720

Merged
merged 1 commit into from
Jul 23, 2024
Merged

fix: lint suggestions #3720

merged 1 commit into from
Jul 23, 2024

Conversation

ninabarbakadze
Copy link
Member

Overview

There were non-blocking lint suggestions shown on every run. This pr addresses those suggestions so we don't have to keep seeing the red lines.

@ninabarbakadze ninabarbakadze requested a review from a team as a code owner July 23, 2024 09:29
@ninabarbakadze ninabarbakadze requested review from staheri14 and rach-id and removed request for a team July 23, 2024 09:29
Copy link
Contributor

coderabbitai bot commented Jul 23, 2024

Walkthrough

Walkthrough

The recent changes focus on simplifying error handling and control flow in the Node struct's methods within the test/e2e/testnet/node.go file. By eliminating unnecessary intermediate error checks, the refactored methods enhance code readability and maintainability, while preserving their original functionality.

Changes

File Change Summary
test/e2e/testnet/node.go Refactored Start, StartAsync, and Upgrade methods to simplify error handling by removing intermediate checks and directly returning results, enhancing readability and reducing complexity.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Node
    participant Instance

    Client->>Node: Start()
    Node->>Instance: WaitUntilStartedAndForwardPorts()
    Instance-->>Node: Result
    Node-->>Client: Result

    Client->>Node: StartAsync()
    Node->>Instance: StartAsync()
    Instance-->>Node: Result
    Node-->>Client: Result

    Client->>Node: Upgrade()
    Node->>Instance: WaitInstanceIsRunning()
    Instance-->>Node: Result
    Node-->>Client: Result
Loading

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between acf7fc1 and 34e3efb.

Files selected for processing (1)
  • test/e2e/testnet/node.go (2 hunks)
Additional comments not posted (3)
test/e2e/testnet/node.go (3)

306-307: LGTM! Simplified error handling.

The refactoring in the Start method enhances readability by directly returning the result of WaitUntilStartedAndForwardPorts().


311-311: LGTM! Simplified error handling.

The refactoring in the StartAsync method enhances readability by directly returning the result of n.Instance.StartAsync().


358-358: LGTM! Simplified error handling.

The refactoring in the Upgrade method enhances readability by directly returning the result of WaitInstanceIsRunning().


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@celestia-bot celestia-bot requested a review from a team July 23, 2024 09:29
Copy link
Member

@rach-id rach-id left a comment

Choose a reason for hiding this comment

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

Can you link where these lints have been showing?

@ninabarbakadze
Copy link
Member Author

showing

run make lint on main

Copy link
Member

@rach-id rach-id left a comment

Choose a reason for hiding this comment

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

@ninabarbakadze

~/Celestia/celestia-core on main *2 > make lint                                                                                                                                                     took 19s
--> Running linter
~/Celestia/celestia-core on main *2 >     

It's not showing anything locally. I guess that I have a different version.

Generally, if we want to enforce specific linting rule, we should add a workflow that runs the linter and complains if there are any changes to the repo. Otherwise, we will need to make this change manually every time, and not expect contributors to do it themselves.

Not blocking on this tho, thanks for handling it 🙏

@ninabarbakadze ninabarbakadze merged commit 4b4e9aa into main Jul 23, 2024
35 checks passed
@ninabarbakadze ninabarbakadze deleted the nina/fix-linter branch July 23, 2024 13:08
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.

3 participants