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.

Sign up for GitHub

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

Jump to bottom

report: updates for devtools roll #5326

Merged
merged 10 commits into from
May 24, 2018
Merged

report: updates for devtools roll #5326

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
22b9565
short header for devtools
paulirish May 22, 2018
5f1b788
whitespace tweaks.
paulirish May 22, 2018
a6c3c66
add margin on top
paulirish May 22, 2018
e8a9ecc
cleanup of displayValue
paulirish May 22, 2018
ddaa310
data tables can go narrow. tooltips stay on screen.
paulirish May 23, 2018
e074cba
sample json
paulirish May 23, 2018
e62e292
feedback. sticky. isDevTools
paulirish May 23, 2018
2771b95
naming feedback.
paulirish May 23, 2018
7681ff6
css sizing of table columns. gonna write a blog post about you.
paulirish May 24, 2018
a8c26ec
brendan feedback
paulirish May 24, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lighthouse-core/audits/dobetterweb/no-vulnerable-libraries.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,9 +171,9 @@ class NoVulnerableLibrariesAudit extends Audit {

let displayValue = '';
if (totalVulns > 1) {
displayValue = `${totalVulns} vulnerabilities detected.`;
displayValue = `${totalVulns} vulnerabilities detected`;
} else if (totalVulns === 1) {
displayValue = `${totalVulns} vulnerability was detected.`;
displayValue = `${totalVulns} vulnerability was detected`;
}

const headings = [
Expand Down
4 changes: 2 additions & 2 deletions lighthouse-core/audits/dobetterweb/uses-http2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ class UsesHTTP2Audit extends Audit {
let displayValue = '';
if (resources.length > 1) {
displayValue =
`${Util.formatNumber(resources.length)} requests were not handled over HTTP/2`;
`${Util.formatNumber(resources.length)} requests not served via HTTP/2`;
Copy link
Member

Choose a reason for hiding this comment

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

keep the 'were'?

Copy link
Member Author

Choose a reason for hiding this comment

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

I deliberately omitted it for brevity. If it were a sentence i'd keep 'were' but it's just a lil string on the end of the line. wdyt

Copy link
Member

Choose a reason for hiding this comment

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

I don't care much, but it is a little weird since the audit touched above keeps the verb :)

} else if (resources.length === 1) {
displayValue = `${resources.length} request was not handled over HTTP/2`;
displayValue = `${resources.length} request not served via HTTP/2`;
}

const headings = [
Expand Down
7 changes: 7 additions & 0 deletions lighthouse-core/report/html/renderer/dom.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,13 @@ class DOM {
return this._document;
}

/**
* @return {boolean}
*/
isDevTools() {
Copy link
Member

Choose a reason for hiding this comment

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

add a TODO (maybe here?) for the future DT override cleanup?

return !!this._document.querySelector('.lh-devtools');
}

/**
* Guaranteed context.querySelector. Always returns an element or throws if
* nothing matches query.
Expand Down
55 changes: 40 additions & 15 deletions lighthouse-core/report/html/renderer/report-renderer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,19 +60,35 @@ class ReportRenderer {
* @return {DocumentFragment}
*/
_renderReportHeader(report) {
const header = this._dom.cloneTemplate('#tmpl-lh-heading', this._templateContext);
this._dom.find('.lh-config__timestamp', header).textContent =
const el = this._dom.cloneTemplate('#tmpl-lh-heading', this._templateContext);
const domFragment = this._dom.cloneTemplate('#tmpl-lh-scores-wrapper', this._templateContext);
const placeholder = this._dom.find('.lh-scores-wrapper-placeholder', el);
/** @type {HTMLDivElement} */ (placeholder.parentNode).replaceChild(domFragment, placeholder);

this._dom.find('.lh-config__timestamp', el).textContent =
Util.formatDateTime(report.fetchTime);
this._dom.find('.lh-product-info__version', header).textContent = report.lighthouseVersion;
const url = /** @type {HTMLAnchorElement} */ (this._dom.find('.lh-metadata__url', header));
const toolbarUrl = /** @type {HTMLAnchorElement}*/ (this._dom.find('.lh-toolbar__url', header));
url.href = url.textContent = toolbarUrl.href = toolbarUrl.textContent = report.finalUrl;
this._dom.find('.lh-product-info__version', el).textContent = report.lighthouseVersion;
const metadataUrl = /** @type {HTMLAnchorElement} */ (this._dom.find('.lh-metadata__url', el));
const toolbarUrl = /** @type {HTMLAnchorElement}*/ (this._dom.find('.lh-toolbar__url', el));
metadataUrl.href = metadataUrl.textContent = report.finalUrl;
toolbarUrl.href = toolbarUrl.textContent = report.finalUrl;

const emulationDescriptions = Util.getEmulationDescriptions(report.configSettings || {});
this._dom.find('.lh-config__emulation', header).textContent = emulationDescriptions.summary;
return header;
this._dom.find('.lh-config__emulation', el).textContent = emulationDescriptions.summary;
return el;
}

/**
* @return {Element}
*/
_renderReportShortHeader() {
const shortHeaderContainer = this._dom.createElement('div', 'lh-header-container');
const wrapper = this._dom.cloneTemplate('#tmpl-lh-scores-wrapper', this._templateContext);
shortHeaderContainer.appendChild(wrapper);
return shortHeaderContainer;
}


/**
* @param {ReportJSON} report
* @return {DocumentFragment}
Expand Down Expand Up @@ -124,12 +140,19 @@ class ReportRenderer {
* @return {DocumentFragment}
*/
_renderReport(report) {
const headerStickyContainer = this._dom.createElement('div', 'lh-header-sticky');
headerStickyContainer.appendChild(this._renderReportHeader(report));
const scoreContainer = this._dom.find('.lh-scores-container', headerStickyContainer);
let header;
const headerContainer = this._dom.createElement('div');
if (this._dom.isDevTools()) {
headerContainer.classList.add('lh-header-plain');
header = this._renderReportShortHeader();
} else {
headerContainer.classList.add('lh-header-sticky');
header = this._renderReportHeader(report);
}
headerContainer.appendChild(header);
const scoresContainer = this._dom.find('.lh-scores-container', headerContainer);

const container = this._dom.createElement('div', 'lh-container');

const reportSection = container.appendChild(this._dom.createElement('div', 'lh-report'));

reportSection.appendChild(this._renderReportWarnings(report));
Expand All @@ -138,6 +161,8 @@ class ReportRenderer {
const isSoloCategory = report.reportCategories.length === 1;
if (!isSoloCategory) {
scoreHeader = this._dom.createElement('div', 'lh-scores-header');
} else {
headerContainer.classList.add('lh-header--solo-category');
}

const detailsRenderer = new DetailsRenderer(this._dom);
Expand All @@ -162,14 +187,14 @@ class ReportRenderer {

if (scoreHeader) {
const scoreScale = this._dom.cloneTemplate('#tmpl-lh-scorescale', this._templateContext);
scoreContainer.appendChild(scoreHeader);
scoreContainer.appendChild(scoreScale);
scoresContainer.appendChild(scoreHeader);
scoresContainer.appendChild(scoreScale);
}

reportSection.appendChild(this._renderReportFooter(report));

const reportFragment = this._dom.createFragment();
reportFragment.appendChild(headerStickyContainer);
reportFragment.appendChild(headerContainer);
reportFragment.appendChild(container);

return reportFragment;
Expand Down
2 changes: 2 additions & 0 deletions lighthouse-core/report/html/renderer/report-ui-features.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ class ReportUIFeatures {
* @param {ReportJSON} report
*/
initFeatures(report) {
if (this._dom.isDevTools()) return;

this.json = report;
this._setupMediaQueryListeners();
this._setupExportButton();
Expand Down
41 changes: 33 additions & 8 deletions lighthouse-core/report/html/report-styles.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@
--lh-audit-group-vpadding: 8px;
--lh-section-vpadding: 12px;
--chevron-size: 12px;

/* Voodoo magic here to get narrow columns. 0 doesn't size the column like our friend 1px does */
--bytes-col-width: 1px;

--pass-icon-url: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 48 48"><title>check</title><path fill="hsl(139, 70%, 30%)" d="M24 4C12.95 4 4 12.95 4 24c0 11.04 8.95 20 20 20 11.04 0 20-8.96 20-20 0-11.05-8.96-20-20-20zm-4 30L10 24l2.83-2.83L20 28.34l15.17-15.17L38 16 20 34z"/></svg>');
--average-icon-url: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 48 48"><title>info</title><path fill="hsl(31, 100%, 45%)" d="M24 4C12.95 4 4 12.95 4 24s8.95 20 20 20 20-8.95 20-20S35.05 4 24 4zm2 30h-4V22h4v12zm0-16h-4v-4h4v4z"/></svg>');
--fail-icon-url: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 48 48"><title>warn</title><path fill="hsl(1, 73%, 45%)" d="M2 42h44L24 4 2 42zm24-6h-4v-4h4v4zm0-8h-4v-8h4v8z"/></svg>');
Expand Down Expand Up @@ -93,8 +97,8 @@
--caption-font-size: 11px;
--caption-line-height: 14px;
--default-padding: 12px;
--section-padding: 16px;
--section-indent: 16px;
--section-padding: 12px;
--section-indent: 8px;
--audit-group-indent: 16px;
--audit-indent: 16px;
--expandable-indent: 16px;
Expand All @@ -105,7 +109,6 @@
--lh-section-vpadding: 8px;
}


@keyframes fadeIn {
0% { opacity: 0;}
100% { opacity: 0.6;}
Expand Down Expand Up @@ -610,6 +613,10 @@
z-index: 2;
will-change: transform;
}
.lh-header-plain {
margin-top: var(--section-padding);
}

.lh-header-container {
display: block;
margin: 0 auto;
Expand Down Expand Up @@ -696,6 +703,11 @@
background-color: var(--fail-color);
}

/* Hide category score gauages if it's a single category report */
.lh-header--solo-category .lh-scores-wrapper {
display: none;
}


.lh-categories {
width: 100%;
Expand Down Expand Up @@ -819,8 +831,6 @@ summary.lh-passed-audits-summary {
.lh-table {
--image-preview-size: 24px;
border-collapse: collapse;

--url-col-max-width: 450px;
}

.lh-table thead {
Expand Down Expand Up @@ -854,7 +864,13 @@ summary.lh-passed-audits-summary {
text-align: left;
min-width: 250px;
white-space: nowrap;
max-width: var(--url-col-max-width);
max-width: 0;
}

/* Keep bytes columns narrow if they follow the URL column */
.lh-table-column--url + th.lh-table-column--bytes,
.lh-table-column--url + .lh-table-column--bytes + th.lh-table-column--bytes {
width: var(--bytes-col-width);
}

.lh-table-column--code {
Expand Down Expand Up @@ -938,13 +954,22 @@ summary.lh-passed-audits-summary {
position: absolute;
display: none; /* Don't retain these layers when not needed */
opacity: 0;

background: #ffffff;
min-width: 23em;
min-width: 246px;
max-width: 275px;
padding: 15px;
border-radius: 5px;
text-align: initial;
}
/* shrink tooltips to not be cutoff on left edge of narrow viewports
45vw is chosen to be ~= width of the left column of metrics
*/
@media screen and (max-width: 535px) {
.tooltip {
min-width: 45vw;
padding: 3vw;
Copy link
Collaborator

Choose a reason for hiding this comment

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

feels a bit weird to scale the padding as well, looks pretty good though so 👍

}
}

.tooltip-boundary:hover {
background-color: #F8F9FA;
Expand Down
79 changes: 48 additions & 31 deletions lighthouse-core/report/html/templates.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,39 @@
</div>
</template>


<!-- Lighthouse score container -->
<template id="tmpl-lh-scores-wrapper">
<style>
.lh-scores-wrapper__background,
.lh-scores-wrapper__shadow {
position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;
background: white;
border-radius: 8px;
}
.lh-scores-wrapper__shadow {
border-radius: 0;
box-shadow: rgba(0, 0, 0, 0.2) 0px 3px 0px -2px
}
.lh-scores-container {
padding-bottom: calc(var(--section-indent) / 2);
position: relative;
width: 100%;
}
</style>
<div class="lh-scores-wrapper">
<div class="lh-scores-container">
<div class="lh-scores-wrapper__background"></div>
<div class="lh-scores-wrapper__shadow"></div>
</div>
</div>
</template>


<!-- Lighthouse header -->
<template id="tmpl-lh-heading">
<style>
Expand Down Expand Up @@ -149,39 +182,25 @@
margin-top: -30px;
transform: translateZ(1px);
}
.lh-scores-wrapper__shadow {
opacity: 0;
}
.lh-scores-wrapper__background,
.lh-scores-wrapper__shadow {
position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;
background: white;
box-shadow: 0 1px 3px 1px rgba(0, 0, 0, 0.1);
opacity: 1;
border-radius: 8px;
will-change: opacity, transform;
transform-origin: top;
}
.lh-scores-wrapper__shadow {
opacity: 0;
border-radius: 0;
box-shadow: rgba(0, 0, 0, 0.2) 0px 3px 0px -2px
}
.lh-scores-container {
padding-bottom: calc(var(--section-indent) / 2);
position: relative;
width: 100%;
}

.lh-product-info, .lh-toolbar__metadata {
align-items: center;
white-space: nowrap;
color: #5F6369;
display: flex;
font-size: 12px;
left: var(--section-indent);
font-size: calc(var(--body-font-size) * 0.9);
margin-left: var(--section-indent);
opacity: 0;
position: absolute;
top: 50%;
transform: translateY(-50%);
will-change: opacity;
}
Expand All @@ -192,18 +211,20 @@
.lh-toolbar {
height: 50px;
position: absolute;
top: 0;
width: 100%;
top: 25px;
will-change: transform;
display: flex;
width: calc(100% - 70px); /* give room for export */
}
.lh-toolbar__metadata {
left: 25%;
overflow: hidden;
text-overflow: ellipsis;
width: 100%;
}
.lh-toolbar__url {
color: currentColor;
display: block;
white-space: nowrap;
font-size: 14px;
margin-right: 2px;
}
.lh-export {
Expand Down Expand Up @@ -355,12 +376,7 @@
</div>
</div>

<div class="lh-scores-wrapper">
<div class="lh-scores-container">
<div class="lh-scores-wrapper__background"></div>
<div class="lh-scores-wrapper__shadow"></div>
</div>
</div>
<div class="lh-scores-wrapper-placeholder"></div>

<div class="lh-toolbar">
<div class="lh-product-info">
Expand Down Expand Up @@ -389,6 +405,7 @@
</div>
</template>


<!-- Lighthouse footer -->
<template id="tmpl-lh-footer">
<style>
Expand Down
4 changes: 2 additions & 2 deletions lighthouse-core/test/results/sample_v2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2450,7 +2450,7 @@
"score": 0,
"scoreDisplayMode": "binary",
"rawValue": false,
"displayValue": "1 vulnerability was detected.",
"displayValue": "1 vulnerability was detected",
"details": {
"type": "table",
"headings": [
Expand Down Expand Up @@ -2561,7 +2561,7 @@
"score": 0,
"scoreDisplayMode": "binary",
"rawValue": false,
"displayValue": "15 requests were not handled over HTTP/2",
"displayValue": "15 requests not served via HTTP/2",
"details": {
"type": "table",
"headings": [
Expand Down