You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
feat: add a summary column for any check the map reports - #14
Written by an AI agent on behalf of @HugoRCD. @HugoRCD has not reviewed it yet.
The job summary only had columns for the 10 check ids hardcoded in report.mjs. If @evlog/cli added a check in 1.x, the action would drop it from the table until someone updated the list. The summary now also reads the ids from routes[].checks in the map. The known ids keep their order (the CLI's rule order, still the same 10 on evlog's v3), and any other id comes after them. The map can't supply the order itself: the CLI writes checks keys in a different order per route.
This came out of the evlog CLI 1.0 audit (EVL-574), as one of the things the action needs before it pins 1.0.0.
Same input, a route whose only failing check is one the action doesn't list (node against renderSummary, exit 0 both):
The new test in test/report.test.mjs fails on main (88 pass, 1 fail) and passes with this change. npm test: 89 pass. npm run check: clean.
ELI5
The action draws a table with one column per check. It used to know only the checks it was written with, so a newer check could fail without showing up. It now adds a column for any check the scan reports.
Summary by CodeRabbit
New Features
Report summaries now include checks found in route results, even when they are not part of the predefined check list. These checks appear after the standard checks and follow the existing visibility settings.
No actionable comments were generated in the recent review.
Walkthrough
renderSummary now includes eligible checks found in route results after the predefined checks. A test verifies the order and failing status display for a route-only check.
Changes: Summary check columns
Layer / File(s)
Summary
Collect and render route checks src/lib/report.mjs, test/report.test.mjs
renderSummary appends check IDs found in route results that are not in CHECKS. The existing visibility filter applies to the combined list. The test verifies that trace-propagation follows wide-event and context and displays ✗ for a failing status.
The summary table now shows columns for checks that appear only in the map, after the existing columns. The change is small and covered by a new test, and no merge-blocking risk was found.
Pre-merge checks: 4
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title says the PR adds a summary column for any check the map reports. The raw summary says renderSummary now includes check IDs from route results and appends IDs not in CHECKS after the predefin…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title says the PR adds a summary column for any check the map reports. The raw summary says renderSummary now includes check IDs from route results and appends IDs not in CHECKS after the predefined checks. The added test covers a non-hardcoded check (trace-propagation) that appears in route data. The title matches the main change, so this check passes.
Finishing Touches
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
File: No configuration file from this repository applied
Commit: Unavailable
Layers: defaults
Review profile: CHILL
Plan: Advanced
Run ID: b566582a-25f4-4ea5-83fe-f1c51a1d2044
Commits
Reviewing files that changed from the base of the PR and between 9e0020f and 0aa5a2a.
Files selected for processing: 2
src/lib/report.mjs
test/report.test.mjs
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The job summary only had columns for the 10 check ids hardcoded in
report.mjs. If@evlog/cliadded a check in 1.x, the action would drop it from the table until someone updated the list. The summary now also reads the ids fromroutes[].checksin the map. The known ids keep their order (the CLI's rule order, still the same 10 onevlog'sv3), and any other id comes after them. The map can't supply the order itself: the CLI writescheckskeys in a different order per route.This came out of the evlog CLI 1.0 audit (EVL-574), as one of the things the action needs before it pins 1.0.0.
Same input, a route whose only failing check is one the action doesn't list (
nodeagainstrenderSummary, exit 0 both):Before (
main):After:
The new test in
test/report.test.mjsfails onmain(88 pass, 1 fail) and passes with this change.npm test: 89 pass.npm run check: clean.ELI5
The action draws a table with one column per check. It used to know only the checks it was written with, so a newer check could fail without showing up. It now adds a column for any check the scan reports.
Summary by CodeRabbit