1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
/**
* @license
* Copyright 2018 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS-IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
/* globals self DOM PerformanceCategoryRenderer Util DetailsRenderer */
/**
* Returns all the elements that PSI needs to render the report
* We expose this helper method to minimize the 'public' API surface of the renderer
* and allow us to refactor without two-sided patches.
*
* const {scoreGaugeEl, perfCategoryEl, finalScreenshotDataUri} = prepareLabData(
* LHResultJsonString,
* document
* );
*
* @param {LH.Result | string} LHResult The stringified version of {LH.Result}
* @param {Document} document The host page's window.document
* @return {{scoreGaugeEl: Element, perfCategoryEl: Element, finalScreenshotDataUri: string|null}}
*/
function prepareLabData(LHResult, document) {
const lhResult = (typeof LHResult === 'string') ?
/** @type {LH.Result} */ (JSON.parse(LHResult)) : LHResult;
const dom = new DOM(document);
// Assume fresh styles needed on every call, so mark all template styles as unused.
dom.resetTemplates();
const reportLHR = Util.prepareReportResult(lhResult);
const perfCategory = reportLHR.reportCategories.find(cat => cat.id === 'performance');
if (!perfCategory) throw new Error(`No performance category. Can't make lab data section`);
if (!reportLHR.categoryGroups) throw new Error(`No category groups found.`);
// Use custom title and description.
reportLHR.categoryGroups.metrics.title = lhResult.i18n.rendererFormattedStrings.labDataTitle;
reportLHR.categoryGroups.metrics.description =
lhResult.i18n.rendererFormattedStrings.lsPerformanceCategoryDescription;
const perfRenderer = new PerformanceCategoryRenderer(dom, new DetailsRenderer(dom));
// PSI environment string will ensure the categoryHeader and permalink elements are excluded
const perfCategoryEl = perfRenderer.render(perfCategory, reportLHR.categoryGroups, 'PSI');
const scoreGaugeEl = dom.find('.lh-score__gauge', perfCategoryEl);
scoreGaugeEl.remove();
const scoreGaugeWrapperEl = dom.find('.lh-gauge__wrapper', scoreGaugeEl);
scoreGaugeWrapperEl.classList.add('lh-gauge__wrapper--huge');
// Remove navigation link on gauge
scoreGaugeWrapperEl.removeAttribute('href');
const finalScreenshotDataUri = _getFinalScreenshot(perfCategory);
return {scoreGaugeEl, perfCategoryEl, finalScreenshotDataUri};
}
/**
* @param {LH.ReportResult.Category} perfCategory
* @return {null|string}
*/
function _getFinalScreenshot(perfCategory) {
const auditRef = perfCategory.auditRefs.find(audit => audit.id === 'final-screenshot');
if (!auditRef || !auditRef.result || auditRef.result.scoreDisplayMode === 'error') return null;
return auditRef.result.details.data;
}
if (typeof module !== 'undefined' && module.exports) {
module.exports = prepareLabData;
} else {
self.prepareLabData = prepareLabData;
}
|
