report(psi): add lab data summary sentence #5961
Merged
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
paulirish
requested changes
Sep 5, 2018
| @@ -57,7 +65,8 @@ function prepareLabData(LHResultJsonString, document) { | |||
| scoreGaugeWrapperEl.removeAttribute('href'); | |||
|
|
|||
| const finalScreenshotDataUri = _getFinalScreenshot(perfCategory); | |||
| return {scoreGaugeEl, perfCategoryEl, finalScreenshotDataUri}; | |||
| const psiDescription = lhResult.i18n.rendererFormattedStrings.psiDescription; | |||
There was a problem hiding this comment.
instead, let's just provide this in the right spot so they dont have to.
here, el is the perfCategoryEl:
i was writing this but maybe you want to do it differently:
const descriptionText = lhResult.i18n.rendererFormattedStrings.psiDescription;
const descriptionEl = dom.convertMarkdownLinkSnippets(descriptionText);
const catDescriptionEl = dom.find('.lh-category-header__description', perfCategoryEl);
catDescriptionEl.appendChild(descriptionEl);| @@ -481,6 +481,9 @@ Util.UIStrings = { | |||
| crcInitialNavigation: 'Initial Navigation', | |||
| /** Label of value shown in the summary of critical request chains. Refers to the total amount of time (milliseconds) of the longest critical path chain/sequence of network requests. Example value: 2310 ms */ | |||
| crcLongestDurationLabel: 'Maximum critical path latency:', | |||
|
|
|||
| /** Explanation shown to users below performance results to inform them that the test was done with a 3G network connection and to warn them that the numbers they see will likely change slightly the next time they run Lighthouse. 'Lighthouse' becomes link text to additional documentation. */ | |||
| psiDescription: '[Lighthouse](https://developers.google.com/web/tools/lighthouse/) analysis of the current page on emulated 3G. Values are estimated and may vary.', | |||
There was a problem hiding this comment.
naming tweak: lsPerformanceCategoryDescription .. more inline with the ones we have in default-config.js
| @@ -57,7 +65,8 @@ function prepareLabData(LHResultJsonString, document) { | |||
| scoreGaugeWrapperEl.removeAttribute('href'); | |||
|
|
|||
| const finalScreenshotDataUri = _getFinalScreenshot(perfCategory); | |||
| return {scoreGaugeEl, perfCategoryEl, finalScreenshotDataUri}; | |||
| const psiDescription = lhResult.i18n.rendererFormattedStrings.psiDescription; | |||
There was a problem hiding this comment.
and we gotta do the markdown conversion :)
|
updated. Now uses the metrics title/description to include these custom strings since that's where we actually want them. |
brendankenny
commented
Sep 5, 2018
|
|
||
| // Description supports markdown links, so take everything after the last link. | ||
| const descriptionEnd = /[^)]+$/.exec(Util.UIStrings.lsPerformanceCategoryDescription)[0]; | ||
| assert.ok(descriptionEnd.length > 6); // If this gets too short, pick a different comparison :) |
There was a problem hiding this comment.
this is a little silly, but difficult to test it isn't accidentally using a default description (if we ever add one to metrics) and support i18n otherwise :)
(could just create a local version of dom using jsdom, I suppose)
paulirish
approved these changes
Sep 5, 2018
|
looks ace. |
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.
fixes #5882