CI Reporter Infrastructure and expandedJson reports
#111
Conversation
This file contains 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
The v1Report flag makes it possible to opt-in to a richer reporting option.
This adds the metrics to the report. The metrics are:
largest-contentful-paint
cumulative-layout-shift
first-contentful-paint
total-blocking-time
max-potential-fid
interactive
expandedJson reports
expandedJson reportsexpandedJson reports
Closed
mastoj
reviewed
May 20, 2023
|
|
||
| You may want to generate reports that can be consumed by other tools. To do you can use the reporter options: | ||
| - `jsonSimple` - A simple JSON report which contains the URL and score. This is the default. | ||
| - `jsonExpanded` - A full JSON report which contains the URL, score, metric and category breakdowns. |
There was a problem hiding this comment.
Should also mention summary.
| import { reportJsonExpanded } from './jsonExpanded' | ||
| import type { ReportJsonExpanded, ReportJsonSimple } from './types' | ||
|
|
||
| export function generateReportPayload(reporter: 'jsonExpanded', reports: UnlighthouseRouteReport[]): ReportJsonExpanded |
There was a problem hiding this comment.
This was a nice way of overloading the function and still being sure the right one was called.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This builds off of the great work started by @mastoj. The main refactoring changes are to support multiple reporting providers.
The main report generated will default to
jsonExpandedin v1 of Unlighthouse as a breaking change. For now thejsonSimpleis the default, this allows users to opt-in to different reporting strategies.You can generate the new expandedJson report using
--reporter expandedJsonorci.reporter: 'expandedJson'Linked Issues
#98
Additional context
#107