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

Correct Read Error Format #15223

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Conversation

EasterTheBunny
Copy link
Contributor

Changed error text to be read error instead of rpc error to limit confusion. Batch flag to string corrected to show true|false instead of bool type.

Copy link
Contributor

I see you updated files related to core. Please run pnpm changeset in the root directory to add a changeset as well as in the text include at least one of the following tags:

  • #added For any new functionality added.
  • #breaking_change For any functionality that requires manual action for the node to boot.
  • #bugfix For bug fixes.
  • #changed For any change to the existing functionality.
  • #db_update For any feature that introduces updates to database schema.
  • #deprecation_notice For any upcoming deprecation functionality.
  • #internal For changesets that need to be excluded from the final changelog.
  • #nops For any feature that is NOP facing and needs to be in the official Release Notes for the release.
  • #removed For any functionality/config that is removed.
  • #updated For any functionality that is updated.
  • #wip For any change that is not ready yet and external communication about it should be held off till it is feature complete.

🎖️ No JIRA issue number found in: PR title, commit message, or branch name. Please include the issue ID in one of these.

Comment on lines 49 to 57
if e.Batch {
builder.WriteString(" batch;")
}

Copy link
Contributor

@ilija42 ilija42 Nov 13, 2024

Choose a reason for hiding this comment

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

does it make sense to have an enum for each type of CR read call?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure what you mean. What information would the enum capture?

Copy link
Contributor

Choose a reason for hiding this comment

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

batch/queryKey/GetLatestValue

Copy link
Contributor

github-actions bot commented Nov 13, 2024

AER Report: CI Core

aer_workflow , commit , Detect Changes , Clean Go Tidy & Generate , Scheduled Run Frequency , Find New Flaky Tests In Chainlink Project / Get Tests To Run , lint , Core Tests (go_core_tests) , Core Tests (go_core_tests_integration) , Core Tests (go_core_ccip_deployment_tests) , Core Tests (go_core_race_tests) , Core Tests (go_core_fuzz) , Find New Flaky Tests In Deployment Project , Find New Flaky Tests In Chainlink Project / Run Tests , Find New Flaky Tests In Chainlink Project / Report , Flakey Test Detection , SonarQube Scan

1. Type name stutters:

[A 1 <= 10 words sentence that describes the error]:[job id where the error happened]

Source of Error:

Source of Error:
Golang Lint 2024-11-14T15:30:19.3956876Z ##[error]core/services/relay/evm/read/errors.go:21:6: exported: type name will be used as read.ReadError by other packages, and that stutters; consider calling this Error (revive)
Golang Lint 2024-11-14T15:30:19.3959393Z type ReadError struct {
Golang Lint 2024-11-14T15:30:19.3960121Z ^

Why: The linter revive detected that the type name ReadError stutters when used by other packages (e.g., read.ReadError). This is considered a bad practice in Go as it reduces readability.

Suggested fix: Rename the ReadError struct to Error to avoid stuttering when used by other packages.

2. Issues found:

[A 1 <= 10 words sentence that describes the error]:[job id where the error happened]

Source of Error:

Source of Error:
Golang Lint 2024-11-14T15:30:19.3985220Z ##[error]issues found

Why: The linter found issues in the codebase that need to be addressed.

Suggested fix: Review the linter output and fix the reported issues.

3. Test failures:

[A 1 <= 10 words sentence that describes the error]:[job id where the error happened]

Source of Error:

Source of Error:
Run tests 2024-11-14T15:37:28.1169611Z Encountered test failures.
Run tests 2024-11-14T15:37:28.1170291Z go_core_tests exiting with code 1
Run tests 2024-11-14T15:37:28.1187587Z ##[error]Process completed with exit code 1.

Why: The test suite encountered one or more test failures, causing the job to exit with a non-zero status.

Suggested fix: Investigate the test logs to identify the failing tests and address the underlying issues causing the failures.

AER Report: Operator UI CI ran successfully ✅

aer_workflow , commit

Changed error text to be `read error` instead of `rpc error` to limit confusion.
Batch flag to string corrected to show `true|false` instead of bool type.
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