[Linting] fix outstanding linter errors #684

bryanchriswhite · 2024-07-11T08:26:27Z

Summary

Fix linter errors exposed in #674

Issue

[TODO] Blockers @okdas #674

Type of change

Select one or more:

Testing

Documentation changes (only if making doc changes)

make docusaurus_start; only needed if you make doc changes

Local Testing (only if making code changes)

Unit Tests: make go_develop_and_test
LocalNet E2E Tests: make test_e2e
See quickstart guide for instructions

PR Testing (only if making code changes)

DevNet E2E Tests: Add the devnet-test-e2e label to the PR.
- THIS IS VERY EXPENSIVE, so only do it after all the reviews are complete.
- Optionally run make trigger_ci if you want to re-trigger tests without any code changes
- If tests fail, try re-running failed tests only using the GitHub UI as shown here

Sanity Checklist

I have tested my changes using the available tooling
I have commented my code
I have performed a self-review of my own code; both comments & source code
I create and reference any new tickets, if applicable
I have left TODOs throughout the codebase, if applicable

coderabbitai · 2024-07-11T08:26:32Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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

bryanchriswhite · 2024-07-11T08:30:48Z

pkg/appgateserver/server.go

@@ -300,13 +300,13 @@ func (app *appGateServer) ServePprof(ctx context.Context, addr string) error {
 	// If no error, start the server in a new goroutine
 	go func() {
 		app.logger.Info().Str("endpoint", addr).Msg("starting a pprof endpoint")
-		server.ListenAndServe()
+		_ = server.ListenAndServe()


Should we do something here if there's an error?

(cc @red-0ne)

Let's add an error log here. That way, the user/operator can know why the endpoint is not available if something goes wrong (such as a port already in use).

bryanchriswhite · 2024-07-11T08:30:53Z

pkg/relayer/relayminer.go

@@ -121,13 +121,13 @@ func (rel *relayMiner) ServePprof(ctx context.Context, addr string) error {
 	// If no error, start the server in a new goroutine
 	go func() {
 		rel.logger.Info().Str("endpoint", addr).Msg("starting a pprof endpoint")
-		server.ListenAndServe()
+		_ = server.ListenAndServe()


Should we do something here if there's an error?

(cc @red-0ne)

Let's log the error.

github-actions · 2024-07-11T08:34:25Z

The image is going to be pushed after the next commit.

You can use make trigger_ci to push an empty commit.

If you also want to run E2E tests, please add devnet-test-e2e label.

github-actions · 2024-07-11T08:34:25Z

The CI will now also run the e2e tests on devnet, which increases the time it takes to complete all CI checks.

You may need to run make trigger_ci to submit an empty commit that'll trigger the tests.

GCP workloads (requires changing the namespace to 684)
Grafana network dashboard for devnet-issue-{issue-id}

bryanchriswhite · 2024-07-11T08:51:05Z

testutil/testproxy/relayerproxy.go

-				go func() { server.ListenAndServe() }()
+				go func() {
+					err := server.ListenAndServe()
+					require.NoError(test.t, err)


This seems to be surfacing new bind: address already in use errors 🤔 :

There were a couple of issues:

We tried to create new proxies with the same config while already having one running for the duration of whole test.

We did not cleanup the servers properly.

The fix incoming! :)

okdas

Thank you so much for taking an initiative on this effort!
LGTM, and test seem to pass now.

If you're good with the changes I added - let's merge this in.

chore: fix linter errors

442c60b

bryanchriswhite added the code health Cleans up some code label Jul 11, 2024

bryanchriswhite added this to the Shannon Beta TestNet Launch milestone Jul 11, 2024

bryanchriswhite self-assigned this Jul 11, 2024

bryanchriswhite commented Jul 11, 2024

View reviewed changes

bryanchriswhite marked this pull request as ready for review July 11, 2024 08:33

bryanchriswhite added push-image CI related - pushes images to ghcr.io devnet-test-e2e labels Jul 11, 2024

bryanchriswhite requested review from red-0ne and okdas July 11, 2024 08:34

github-actions bot added the devnet label Jul 11, 2024

bryanchriswhite mentioned this pull request Jul 11, 2024

[TODO] Blockers @okdas #674

Merged

14 tasks

Empty commit

2b2b86b

bryanchriswhite commented Jul 11, 2024

View reviewed changes

bryanchriswhite and others added 3 commits July 11, 2024 10:54

fix: context issue

36fe598

fixup: HEAD^

c003503

address test issues and log erros

70f7bff

okdas force-pushed the issues/587/fix/linter-errors branch from 10f2634 to 70f7bff Compare July 13, 2024 00:40

okdas approved these changes Jul 13, 2024

View reviewed changes

bryanchriswhite merged commit 1f6d8f9 into issue-587-todos Jul 15, 2024
3 of 4 checks passed

bryanchriswhite deleted the issues/587/fix/linter-errors branch July 15, 2024 08:56

bryanchriswhite linked an issue Jul 15, 2024 that may be closed by this pull request

[Code Health] Standardize & enforce golang import linting #270

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Linting] fix outstanding linter errors #684

[Linting] fix outstanding linter errors #684

bryanchriswhite commented Jul 11, 2024 •

edited

Loading

coderabbitai bot commented Jul 11, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

bryanchriswhite Jul 11, 2024 •

edited

Loading

okdas Jul 11, 2024

bryanchriswhite Jul 11, 2024 •

edited

Loading

okdas Jul 11, 2024

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 11, 2024

bryanchriswhite Jul 11, 2024 •

edited

Loading

okdas Jul 13, 2024

okdas left a comment

[Linting] fix outstanding linter errors #684

[Linting] fix outstanding linter errors #684

Conversation

bryanchriswhite commented Jul 11, 2024 • edited Loading

Summary

Issue

Type of change

Testing

Sanity Checklist

coderabbitai bot commented Jul 11, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

bryanchriswhite Jul 11, 2024 • edited Loading

Choose a reason for hiding this comment

okdas Jul 11, 2024

Choose a reason for hiding this comment

bryanchriswhite Jul 11, 2024 • edited Loading

Choose a reason for hiding this comment

okdas Jul 11, 2024

Choose a reason for hiding this comment

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 11, 2024

bryanchriswhite Jul 11, 2024 • edited Loading

Choose a reason for hiding this comment

okdas Jul 13, 2024

Choose a reason for hiding this comment

okdas left a comment

Choose a reason for hiding this comment

bryanchriswhite commented Jul 11, 2024 •

edited

Loading

coderabbitai bot commented Jul 11, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

bryanchriswhite Jul 11, 2024 •

edited

Loading

bryanchriswhite Jul 11, 2024 •

edited

Loading

bryanchriswhite Jul 11, 2024 •

edited

Loading