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

core/tracker: improved reasons wording #3033

Merged
merged 2 commits into from
Apr 12, 2024
Merged

Conversation

pinebit
Copy link
Contributor

@pinebit pinebit commented Apr 11, 2024

Improved operator UX by renaming tracker reasons to be more descriptive.

Verified Obol infra alerts and Dashboard V3 - these do not use the affected identifiers explicitly.

category: refactor
ticket: #2488

Copy link

sonarcloud bot commented Apr 11, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

Copy link

codecov bot commented Apr 11, 2024

Codecov Report

Attention: Patch coverage is 88.23529% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 54.80%. Comparing base (79e2b27) to head (2880cc8).

Files Patch % Lines
core/tracker/tracker.go 88.23% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3033      +/-   ##
==========================================
- Coverage   54.80%   54.80%   -0.01%     
==========================================
  Files         206      206              
  Lines       28837    28837              
==========================================
- Hits        15805    15804       -1     
- Misses      11213    11215       +2     
+ Partials     1819     1818       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

- *Summary*: couldn`t aggregate attestation due to insufficient partial beacon committee selections
- *Details*: Reason `fetcher_aggregator_few_prepares` indicates an attestation aggregation duty failed in the fetcher step since it couldn`t fetch the prerequisite aggregated beacon committee selections. This indicates the associated prepare aggregation duty failed due to insufficient partial beacon committee selections submitted by the cluster validator clients.
- *Details*: Reason `insufficient_aggregator_selections` indicates an attestation aggregation duty failed in the fetcher step since it couldn`t fetch the prerequisite aggregated beacon committee selections. This indicates the associated prepare aggregation duty failed due to insufficient partial beacon committee selections submitted by the cluster validator clients.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- *Details*: Reason `insufficient_aggregator_selections` indicates an attestation aggregation duty failed in the fetcher step since it couldn`t fetch the prerequisite aggregated beacon committee selections. This indicates the associated prepare aggregation duty failed due to insufficient partial beacon committee selections submitted by the cluster validator clients.
- *Details*: Reason `insufficient_aggregator_selections` indicates an attestation aggregation duty failed in the fetcher step since it couldn't fetch the prerequisite aggregated beacon committee selections. This indicates the associated prepare aggregation duty failed due to insufficient partial beacon committee selections submitted by the cluster validator clients.

There might be more instances of back ticks used as apostrophes, it will break Markdown parsing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

reasons.md is generated from reason.go. I cannot patch it manually as it will break the test.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

image

it does not seem break the markdown.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We're lucky then! Backticks are used for inline code, weird that it doesn't break.

I'm approving then!

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 believe it looks for the second backtick on the same line. This is not triggered in this case.
Also, note that in our test, we explicitly replace all ' with ` here https://github.com/ObolNetwork/charon/blob/main/cmd/markdown_internal_test.go#L195
The source text (reason.go) contains '

@pinebit pinebit added the merge when ready Indicates bulldozer bot may merge when all checks pass label Apr 12, 2024
@obol-bulldozer obol-bulldozer bot merged commit 40877fe into main Apr 12, 2024
11 of 12 checks passed
@obol-bulldozer obol-bulldozer bot deleted the pinebit/improved-reasons branch April 12, 2024 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge when ready Indicates bulldozer bot may merge when all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants