lighthouse 8.6.0 → 9.0.0

package/lighthouse-core/scripts/package.json

@@ -1,4 +0,0 @@
-{
-  "type": "module",
-  "//": "Any directory that uses `import ... from` or `export ...` must be type module. Temporary file until root package.json is type: module"
-}

package/report/clients/psi.js

@@ -1,158 +0,0 @@
-/**
- * @license
- * Copyright 2018 The Lighthouse Authors. 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';
-
-import {DetailsRenderer} from '../renderer/details-renderer.js';
-import {DOM} from '../renderer/dom.js';
-import {ElementScreenshotRenderer} from '../renderer/element-screenshot-renderer.js';
-import {I18n} from '../renderer/i18n.js';
-import {openTreemap} from '../renderer/open-tab.js';
-import {PerformanceCategoryRenderer} from '../renderer/performance-category-renderer.js';
-import {ReportUIFeatures} from '../renderer/report-ui-features.js';
-import {Util} from '../renderer/util.js';
-
-/** @typedef {{scoreGaugeEl: Element, perfCategoryEl: Element, finalScreenshotDataUri: string|null, scoreScaleEl: Element, installFeatures: Function}} PrepareLabDataResult */
-
-/**
- * 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 {PrepareLabDataResult}
- */
-export function prepareLabData(LHResult, document) {
-  const lhResult = (typeof LHResult === 'string') ?
-    /** @type {LH.Result} */ (JSON.parse(LHResult)) : LHResult;
-
-  const dom = new DOM(document);
-  const reportLHR = Util.prepareReportResult(lhResult);
-  const i18n = new I18n(reportLHR.configSettings.locale, {
-    // Set missing renderer strings to default (english) values.
-    ...Util.UIStrings,
-    ...reportLHR.i18n.rendererFormattedStrings,
-  });
-  Util.i18n = i18n;
-  Util.reportJson = reportLHR;
-
-  const perfCategory = reportLHR.categories.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 = Util.i18n.strings.labDataTitle;
-  reportLHR.categoryGroups.metrics.description =
-      Util.i18n.strings.lsPerformanceCategoryDescription;
-
-  const fullPageScreenshot =
-    reportLHR.audits['full-page-screenshot'] && reportLHR.audits['full-page-screenshot'].details &&
-    reportLHR.audits['full-page-screenshot'].details.type === 'full-page-screenshot' ?
-    reportLHR.audits['full-page-screenshot'].details : undefined;
-
-  const detailsRenderer = new DetailsRenderer(dom, {fullPageScreenshot});
-  const perfRenderer = new PerformanceCategoryRenderer(dom, detailsRenderer);
-  // PSI environment string will ensure the categoryHeader and permalink elements are excluded
-  const perfCategoryEl = perfRenderer.render(
-    perfCategory,
-    reportLHR.categoryGroups,
-    {environment: 'PSI', gatherMode: lhResult.gatherMode}
-  );
-  perfCategoryEl.append(dom.createComponent('styles'));
-
-  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);
-
-  const clonedScoreTemplate = dom.createComponent('scorescale');
-  const scoreScaleEl = dom.find('.lh-scorescale', clonedScoreTemplate);
-
-  const reportUIFeatures = new ReportUIFeatures(dom);
-  reportUIFeatures.json = lhResult;
-
-  /** @param {HTMLElement} reportEl */
-  const installFeatures = (reportEl) => {
-    if (fullPageScreenshot) {
-      // 1) Add fpss css var to reportEl parent so any thumbnails will work
-      ElementScreenshotRenderer.installFullPageScreenshot(
-        reportEl, fullPageScreenshot.screenshot);
-
-      // 2) Append the overlay element to a specific part of the DOM so that
-      // the sticky tab group element renders correctly. If put in the reportEl
-      // like normal, then the sticky header would bleed through the overlay
-      // element.
-      const screenshotsContainer = document.querySelector('.element-screenshots-container');
-      if (!screenshotsContainer) {
-        throw new Error('missing .element-screenshots-container');
-      }
-
-      const screenshotEl = document.createElement('div');
-      screenshotsContainer.append(screenshotEl);
-      ElementScreenshotRenderer.installOverlayFeature({
-        dom,
-        reportEl,
-        overlayContainerEl: screenshotEl,
-        fullPageScreenshot,
-      });
-      // Not part of the reportEl, so have to install the feature here too.
-      ElementScreenshotRenderer.installFullPageScreenshot(
-        screenshotEl, fullPageScreenshot.screenshot);
-    }
-
-    const showTreemapApp =
-      lhResult.audits['script-treemap-data'] && lhResult.audits['script-treemap-data'].details;
-    const buttonContainer = reportEl.querySelector('.lh-audit-group--metrics');
-    if (showTreemapApp && buttonContainer) {
-      reportUIFeatures.addButton({
-        container: buttonContainer,
-        text: Util.i18n.strings.viewTreemapLabel,
-        icon: 'treemap',
-        onClick: () => openTreemap(lhResult),
-      });
-    }
-  };
-
-  return {scoreGaugeEl, perfCategoryEl, finalScreenshotDataUri, scoreScaleEl, installFeatures};
-}
-
-/**
- * @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;
-  const details = auditRef.result.details;
-  if (!details || details.type !== 'screenshot') return null;
-  return details.data;
-}
-
-// TODO: remove with report API refactor.
-if (typeof window !== 'undefined') {
-  // @ts-expect-error
-  window.prepareLabData = prepareLabData;
-}

package/report/test/clients/psi-test.js

@@ -1,143 +0,0 @@
-/**
- * @license Copyright 2017 The Lighthouse Authors. 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';
-
-import {strict as assert} from 'assert';
-import fs from 'fs';
-
-import jsdom from 'jsdom';
-
-import testUtils from '../../../lighthouse-core/test/test-utils.js';
-import {prepareLabData} from '../../clients/psi.js';
-import {Util} from '../../renderer/util.js';
-import {I18n} from '../../renderer/i18n.js';
-import {DOM} from '../../renderer/dom.js';
-import {CategoryRenderer} from '../../renderer/category-renderer.js';
-import {PerformanceCategoryRenderer} from '../../renderer/performance-category-renderer.js';
-import {DetailsRenderer} from '../../renderer/details-renderer.js';
-import {CriticalRequestChainRenderer} from '../../renderer/crc-details-renderer.js';
-import {ElementScreenshotRenderer} from '../../renderer/element-screenshot-renderer.js';
-import {ReportUIFeatures} from '../../renderer/report-ui-features.js';
-import {LH_ROOT} from '../../../root.js';
-
-const {itIfProtoExists, sampleResultsRoundtripStr} = testUtils.getProtoRoundTrip();
-const sampleResultsStr =
-  fs.readFileSync(LH_ROOT + '/lighthouse-core/test/results/sample_v2.json', 'utf-8');
-
-/* eslint-env jest */
-
-describe('PSI', () => {
-  let document;
-  beforeAll(() => {
-    global.Util = Util;
-    global.I18n = I18n;
-    global.DOM = DOM;
-    global.CategoryRenderer = CategoryRenderer;
-    global.DetailsRenderer = DetailsRenderer;
-    global.PerformanceCategoryRenderer = PerformanceCategoryRenderer;
-    global.CriticalRequestChainRenderer = CriticalRequestChainRenderer;
-    global.ElementScreenshotRenderer = ElementScreenshotRenderer;
-    global.ReportUIFeatures = ReportUIFeatures;
-
-    const {window} = new jsdom.JSDOM();
-    document = window.document;
-  });
-
-  afterAll(() => {
-    global.I18n = undefined;
-    global.Util = undefined;
-    global.DOM = undefined;
-    global.CategoryRenderer = undefined;
-    global.DetailsRenderer = undefined;
-    global.PerformanceCategoryRenderer = undefined;
-    global.CriticalRequestChainRenderer = undefined;
-    global.ElementScreenshotRenderer = undefined;
-    global.ReportUIFeatures = undefined;
-  });
-
-  describe('psi prepareLabData helpers', () => {
-    describe('prepareLabData', () => {
-      itIfProtoExists('succeeds with LHResult object (roundtrip) input', () => {
-        const roundTripLHResult = /** @type {LH.Result} */ JSON.parse(sampleResultsRoundtripStr);
-        const result = prepareLabData(roundTripLHResult, document);
-
-        // Check that the report exists and has some content.
-        assert.ok(result.perfCategoryEl instanceof document.defaultView.Element);
-        assert.ok(result.perfCategoryEl.outerHTML.length > 50000, 'perfCategory HTML is populated');
-        // Assume using default locale.
-        const title = result.perfCategoryEl.querySelector('.lh-audit-group--metrics')
-          .querySelector('.lh-audit-group__title').textContent;
-        assert.equal(title, Util.UIStrings.labDataTitle);
-      });
-
-      it('succeeds with stringified LHResult input', () => {
-        const result = prepareLabData(sampleResultsStr, document);
-        assert.ok(result.scoreGaugeEl instanceof document.defaultView.Element);
-        assert.equal(result.scoreGaugeEl.querySelector('.lh-gauge__wrapper').href, '');
-        assert.ok(result.scoreGaugeEl.outerHTML.includes('<svg'), 'score gauge comes with SVG');
-
-        assert.ok(result.perfCategoryEl instanceof document.defaultView.Element);
-        assert.ok(result.perfCategoryEl.outerHTML.length > 50000, 'perfCategory HTML is populated');
-
-        assert.equal(typeof result.finalScreenshotDataUri, 'string');
-        assert.ok(result.finalScreenshotDataUri.startsWith('data:image/jpeg;base64,'));
-      });
-
-      it('throws if there is no perf category', () => {
-        const lhrWithoutPerf = JSON.parse(sampleResultsStr);
-        delete lhrWithoutPerf.categories.performance;
-        const lhrWithoutPerfStr = JSON.stringify(lhrWithoutPerf);
-
-        assert.throws(() => {
-          prepareLabData(lhrWithoutPerfStr, document);
-        }, /no performance category/i);
-      });
-
-      it('throws if there is no category groups', () => {
-        const lhrWithoutGroups = JSON.parse(sampleResultsStr);
-        delete lhrWithoutGroups.categoryGroups;
-        const lhrWithoutGroupsStr = JSON.stringify(lhrWithoutGroups);
-
-        assert.throws(() => {
-          prepareLabData(lhrWithoutGroupsStr, document);
-        }, /no category groups/i);
-      });
-
-      it('includes custom title and description', () => {
-        const {perfCategoryEl} = prepareLabData(sampleResultsStr, document);
-        const metricsGroupEl = perfCategoryEl.querySelector('.lh-audit-group--metrics');
-
-        // Assume using default locale.
-        // Replacing markdown because ".textContent" will be post-markdown.
-        const expectedDescription = Util.UIStrings.lsPerformanceCategoryDescription
-          .replace('[Lighthouse](https://developers.google.com/web/tools/lighthouse/)', 'Lighthouse');
-
-        // Assume using default locale.
-        const title = metricsGroupEl.querySelector('.lh-audit-group__title').textContent;
-        const description =
-          metricsGroupEl.querySelector('.lh-audit-group__description').textContent;
-        assert.equal(title, Util.UIStrings.labDataTitle);
-        assert.equal(description, expectedDescription);
-      });
-    });
-  });
-
-  describe('_getFinalScreenshot', () => {
-    it('gets a datauri as a string', () => {
-      const datauri = prepareLabData(sampleResultsStr, document).finalScreenshotDataUri;
-      assert.equal(typeof datauri, 'string');
-      assert.ok(datauri.startsWith('data:image/jpeg;base64,'));
-    });
-
-    it('returns null if there is no final-screenshot audit', () => {
-      const clonedResults = JSON.parse(sampleResultsStr);
-      delete clonedResults.audits['final-screenshot'];
-      const LHResultJsonString = JSON.stringify(clonedResults);
-      const datauri = prepareLabData(LHResultJsonString, document).finalScreenshotDataUri;
-      assert.equal(datauri, null);
-    });
-  });
-});