lighthouse 10.0.0 → 10.0.1

package/report/test/renderer/report-utils-test.js

@@ -1,219 +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.
- */
-
-import assert from 'assert/strict';
-
-import {ReportUtils} from '../../renderer/report-utils.js';
-import {I18nFormatter} from '../../renderer/i18n-formatter.js';
-import {readJson} from '../../../core/test/test-utils.js';
-import {Globals} from '../../renderer/report-globals.js';
-
-const sampleResult = readJson('../../../core/test/results/sample_v2.json', import.meta);
-
-describe('util helpers', () => {
-  beforeEach(() => {
-    Globals.apply({
-      providedStrings: {},
-      i18n: new I18nFormatter('en'),
-      reportJson: null,
-    });
-  });
-
-  afterEach(() => {
-    Globals.i18n = undefined;
-  });
-
-  it('calculates a score ratings', () => {
-    assert.equal(ReportUtils.calculateRating(0.0), 'fail');
-    assert.equal(ReportUtils.calculateRating(0.10), 'fail');
-    assert.equal(ReportUtils.calculateRating(0.45), 'fail');
-    assert.equal(ReportUtils.calculateRating(0.5), 'average');
-    assert.equal(ReportUtils.calculateRating(0.75), 'average');
-    assert.equal(ReportUtils.calculateRating(0.80), 'average');
-    assert.equal(ReportUtils.calculateRating(0.90), 'pass');
-    assert.equal(ReportUtils.calculateRating(1.00), 'pass');
-  });
-
-  it('builds device emulation string', () => {
-    const get = settings => ReportUtils.getEmulationDescriptions(settings).deviceEmulation;
-    /* eslint-disable max-len */
-    assert.equal(get({formFactor: 'mobile', screenEmulation: {disabled: false, mobile: true}}), 'Emulated Moto G Power');
-    assert.equal(get({formFactor: 'mobile', screenEmulation: {disabled: true, mobile: true}}), 'No emulation');
-    assert.equal(get({formFactor: 'mobile', screenEmulation: {disabled: true, mobile: true}, channel: 'devtools'}), 'Emulated Moto G Power');
-    assert.equal(get({formFactor: 'desktop', screenEmulation: {disabled: false, mobile: false}}), 'Emulated Desktop');
-    assert.equal(get({formFactor: 'desktop', screenEmulation: {disabled: true, mobile: false}}), 'No emulation');
-    assert.equal(get({formFactor: 'desktop', screenEmulation: {disabled: true, mobile: true}, channel: 'devtools'}), 'Emulated Desktop');
-    /* eslint-enable max-len */
-  });
-
-  it('builds throttling strings when provided', () => {
-    const descriptions = ReportUtils.getEmulationDescriptions({
-      throttlingMethod: 'provided',
-      screenEmulation: {disabled: true},
-    });
-    assert.equal(descriptions.cpuThrottling, 'Provided by environment');
-    assert.equal(descriptions.networkThrottling, 'Provided by environment');
-    assert.equal(descriptions.screenEmulation, undefined);
-  });
-
-  it('builds throttling strings when devtools', () => {
-    const descriptions = ReportUtils.getEmulationDescriptions({
-      throttlingMethod: 'devtools',
-      throttling: {
-        cpuSlowdownMultiplier: 4.5,
-        requestLatencyMs: 565,
-        downloadThroughputKbps: 1400.00000000001,
-        uploadThroughputKbps: 600,
-      },
-      screenEmulation: {disabled: true},
-    });
-
-    // eslint-disable-next-line max-len
-    assert.equal(descriptions.networkThrottling, '565\xa0ms HTTP RTT, 1,400\xa0kb/s down, 600\xa0kb/s up (DevTools)');
-    assert.equal(descriptions.cpuThrottling, '4.5x slowdown (DevTools)');
-  });
-
-  it('builds throttling strings when simulate', () => {
-    const descriptions = ReportUtils.getEmulationDescriptions({
-      throttlingMethod: 'simulate',
-      throttling: {
-        cpuSlowdownMultiplier: 2,
-        rttMs: 150,
-        throughputKbps: 1600,
-      },
-      screenEmulation: {width: 100, height: 100, deviceScaleFactor: 2},
-    });
-
-    // eslint-disable-next-line max-len
-    assert.equal(descriptions.networkThrottling, '150\xa0ms TCP RTT, 1,600\xa0kb/s throughput (Simulated)');
-    assert.equal(descriptions.cpuThrottling, '2x slowdown (Simulated)');
-    assert.equal(descriptions.screenEmulation, '100x100, DPR 2');
-  });
-
-  describe('#prepareReportResult', () => {
-    it('appends stack pack descriptions to auditRefs', () => {
-      const clonedSampleResult = JSON.parse(JSON.stringify(sampleResult));
-      const iconDataURL = 'data:image/svg+xml,%3Csvg xmlns="http://www.w3.org/2000/svg"%3E%3C/svg%3E';
-      clonedSampleResult.stackPacks = [{
-        id: 'snackpack',
-        title: 'SnackPack',
-        iconDataURL,
-        descriptions: {
-          'unused-css-rules': 'Consider using snacks in packs.',
-        },
-      }];
-      const preparedResult = ReportUtils.prepareReportResult(clonedSampleResult);
-
-      const perfAuditRefs = preparedResult.categories.performance.auditRefs;
-      const unusedCssRef = perfAuditRefs.find(ref => ref.id === 'unused-css-rules');
-      assert.deepStrictEqual(unusedCssRef.stackPacks, [{
-        title: 'SnackPack',
-        iconDataURL,
-        description: 'Consider using snacks in packs.',
-      }]);
-
-      // No stack pack on audit wth no stack pack.
-      const interactiveRef = perfAuditRefs.find(ref => ref.id === 'interactive');
-      assert.strictEqual(interactiveRef.stackPacks, undefined);
-    });
-
-    it('identifies entities on items of tables with urls', () => {
-      const clonedSampleResult = JSON.parse(JSON.stringify(sampleResult));
-
-      const auditsWithTableDetails = Object.values(clonedSampleResult.audits)
-        .filter(audit => audit.details?.type === 'table');
-      assert.notEqual(auditsWithTableDetails.length, 0);
-
-      // collect audit names that might have urls
-      const auditsThatDontHaveUrls = ['bf-cache', 'font-size']; // no urls in data-set
-      const auditsWithUrls = auditsWithTableDetails.filter(audit => {
-        if (auditsThatDontHaveUrls.includes(audit.id)) return false;
-        const urlFields = ['url', 'source-location'];
-        return audit.details.headings.some(heading =>
-          urlFields.includes(heading.valueType) ||
-          urlFields.includes(heading.subItemsHeading?.valueType)
-        );
-      }).map(audit => audit.id);
-      assert.notEqual(auditsWithUrls.length, 0);
-
-      const preparedResult = ReportUtils.prepareReportResult(clonedSampleResult);
-
-      // ensure each audit that had urls detected to have marked entities.
-      for (const id of auditsWithUrls) {
-        const foundEntities = preparedResult.audits[id].details.items.some(item => item.entity);
-        assert.equal(foundEntities, true);
-      }
-    });
-  });
-
-  describe('#shouldDisplayAsFraction', () => {
-    it('returns true for timespan and snapshot', () => {
-      expect(ReportUtils.shouldDisplayAsFraction('navigation')).toEqual(false);
-      expect(ReportUtils.shouldDisplayAsFraction('timespan')).toEqual(true);
-      expect(ReportUtils.shouldDisplayAsFraction('snapshot')).toEqual(true);
-      expect(ReportUtils.shouldDisplayAsFraction(undefined)).toEqual(false);
-    });
-  });
-
-  describe('#calculateCategoryFraction', () => {
-    it('returns passed audits and total audits', () => {
-      const category = {
-        id: 'performance',
-        auditRefs: [
-          {weight: 3, result: {score: 1, scoreDisplayMode: 'binary'}, group: 'metrics'},
-          {weight: 2, result: {score: 1, scoreDisplayMode: 'binary'}, group: 'metrics'},
-          {weight: 0, result: {score: 1, scoreDisplayMode: 'binary'}, group: 'metrics'},
-          {weight: 1, result: {score: 0, scoreDisplayMode: 'binary'}, group: 'metrics'},
-        ],
-      };
-      const fraction = ReportUtils.calculateCategoryFraction(category);
-      expect(fraction).toEqual({
-        numPassableAudits: 4,
-        numPassed: 3,
-        numInformative: 0,
-        totalWeight: 6,
-      });
-    });
-
-    it('ignores manual audits, N/A audits, and hidden audits', () => {
-      const category = {
-        id: 'performance',
-        auditRefs: [
-          {weight: 1, result: {score: 1, scoreDisplayMode: 'binary'}, group: 'metrics'},
-          {weight: 1, result: {score: 1, scoreDisplayMode: 'binary'}, group: 'hidden'},
-          {weight: 1, result: {score: 0, scoreDisplayMode: 'manual'}, group: 'metrics'},
-          {weight: 1, result: {score: 0, scoreDisplayMode: 'notApplicable'}, group: 'metrics'},
-        ],
-      };
-      const fraction = ReportUtils.calculateCategoryFraction(category);
-      expect(fraction).toEqual({
-        numPassableAudits: 1,
-        numPassed: 1,
-        numInformative: 0,
-        totalWeight: 1,
-      });
-    });
-
-    it('tracks informative audits separately', () => {
-      const category = {
-        id: 'performance',
-        auditRefs: [
-          {weight: 1, result: {score: 1, scoreDisplayMode: 'binary'}, group: 'metrics'},
-          {weight: 1, result: {score: 1, scoreDisplayMode: 'binary'}, group: 'metrics'},
-          {weight: 0, result: {score: 1, scoreDisplayMode: 'informative'}, group: 'metrics'},
-          {weight: 1, result: {score: 0, scoreDisplayMode: 'informative'}, group: 'metrics'},
-        ],
-      };
-      const fraction = ReportUtils.calculateCategoryFraction(category);
-      expect(fraction).toEqual({
-        numPassableAudits: 2,
-        numPassed: 2,
-        numInformative: 2,
-        totalWeight: 2,
-      });
-    });
-  });
-});

package/report/test/renderer/snippet-renderer-test.js

@@ -1,291 +0,0 @@
-/**
- * @license Copyright 2019 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.
- */
-
-import assert from 'assert/strict';
-
-import jsdom from 'jsdom';
-
-import {I18nFormatter} from '../../renderer/i18n-formatter.js';
-import {DOM} from '../../renderer/dom.js';
-import {SnippetRenderer} from '../../renderer/snippet-renderer.js';
-import {Globals} from '../../renderer/report-globals.js';
-
-/* Generates a snippet lines array like this (for a single range from 1 to 4):
-  [
-    {number: 1, content 'L1'},
-    {number: 2, content 'L2'},
-    {number: 3, content 'L3'},
-    {number: 4, content 'L4'}
-  ];
-*/
-function generateAvailableLinesArray(availableLineRanges) {
-  const lines = [];
-  availableLineRanges.forEach(({from, to}) => {
-    for (let i = from; i <= to; i++) {
-      lines.push({
-        lineNumber: i,
-        content: 'L' + i,
-      });
-    }
-  });
-  return lines;
-}
-
-function makeSnippetDetails({
-  lineMessages,
-  generalMessages,
-  lines = null,
-  title = 'Snippet',
-  lineCount,
-}) {
-  return {
-    type: 'snippet',
-    title: title,
-    lines: lines,
-    lineMessages,
-    generalMessages,
-    lineCount,
-  };
-}
-
-describe('DetailsRenderer', () => {
-  let dom;
-
-  before(() => {
-    Globals.apply({
-      providedStrings: {},
-      i18n: new I18nFormatter('en'),
-      reportJson: null,
-    });
-    const {document} = new jsdom.JSDOM().window;
-    dom = new DOM(document);
-  });
-
-  after(() => {
-    Globals.i18n = undefined;
-  });
-
-  function renderSnippet(details) {
-    const el = SnippetRenderer.render(dom, details, {});
-
-    return {
-      el,
-      contentLines: el.querySelectorAll('.lh-snippet__line--content'),
-      highlightedContentLines: el.querySelectorAll('.lh-snippet__line--content-highlighted'),
-      collapsedContentLines: el.querySelectorAll(
-        '.lh-snippet__line--content.lh-snippet__show-if-expanded'
-      ),
-      uncollapsedContentLines: el.querySelectorAll(
-        '.lh-snippet__line--content:not(.lh-snippet__show-if-expanded)'
-      ),
-      messageLines: el.querySelectorAll('.lh-snippet__line--message'),
-      omittedLinesIndicatorsWhenExpanded: el.querySelectorAll(
-        '.lh-snippet__line--placeholder:not(.lh-snippet__show-if-collapsed)'
-      ),
-      omittedLinesIndicatorsWhenCollapsed: el.querySelectorAll(
-        '.lh-snippet__line--placeholder:not(.lh-snippet__show-if-expanded)'
-      ),
-      title: el.querySelector('.lh-snippet__title'),
-      toggleExpandButton: el.querySelector('.lh-snippet__toggle-expand'),
-    };
-  }
-
-  it('Renders snippet with a message at the very top', () => {
-    const details = makeSnippetDetails({
-      lineMessages: [
-        {
-          lineNumber: 1,
-          message: 'Error',
-        },
-      ],
-      generalMessages: [],
-      lines: generateAvailableLinesArray([{from: 1, to: 6}]),
-      lineCount: 100,
-    });
-    const {contentLines, messageLines, collapsedContentLines} = renderSnippet(details);
-
-    // 5 lines are visible, 1 is collapsed
-    assert.equal(collapsedContentLines.length, 1);
-    // All available lines are shown on expansion
-    assert.equal(contentLines.length, 6);
-    // 100 lines in total, so lines towards the end won't be shown
-    const lastLine = contentLines[contentLines.length - 1];
-    assert.equal(lastLine.nextSibling.textContent.trim(), '…');
-
-    // Shows message for second line
-    assert.equal(messageLines[0].textContent.trim(), 'Error');
-    assert.equal(messageLines[0].previousSibling.textContent.replace(/\s/g, ''), '1L1');
-  });
-
-  it('Renders first few lines if there are no messages', () => {
-    const details = makeSnippetDetails({
-      lineMessages: [],
-      generalMessages: [],
-      lines: generateAvailableLinesArray([{from: 1, to: 6}]),
-      lineCount: 100,
-    });
-    const {
-      uncollapsedContentLines,
-      omittedLinesIndicatorsWhenExpanded,
-      omittedLinesIndicatorsWhenCollapsed,
-      highlightedContentLines,
-    } = renderSnippet(details);
-    const lastUncollapsedLine = uncollapsedContentLines[uncollapsedContentLines.length - 1];
-
-    // Shows first 5 visible lines
-    assert.equal(lastUncollapsedLine.textContent.replace(/\s/g, ''), '5L5');
-    // "..." after the available lines, but only shows in expanded state
-    assert.equal(omittedLinesIndicatorsWhenExpanded.length, 1);
-    assert.equal(omittedLinesIndicatorsWhenCollapsed.length, 0);
-    // nothing is highlighted
-    assert.equal(highlightedContentLines.length, 0);
-  });
-
-  it('Renders first few lines if there are no messages for specific lines', () => {
-    const details = makeSnippetDetails({
-      lineMessages: [],
-      generalMessages: [
-        {
-          message: 'General error',
-        },
-      ],
-      lines: generateAvailableLinesArray([{from: 1, to: 6}]),
-      lineCount: 100,
-    });
-    const {uncollapsedContentLines, messageLines, highlightedContentLines} = renderSnippet(details);
-    const lastUncollapsedLine = uncollapsedContentLines[uncollapsedContentLines.length - 1];
-
-    // Shows message
-    assert.equal(messageLines.length, 1);
-
-    // Shows first 5 visible lines
-    assert.equal(lastUncollapsedLine.textContent.replace(/\s/g, ''), '5L5');
-
-    // highlight everything (i.e. the 6 lines that are rendered)
-    assert.equal(highlightedContentLines.length, 6);
-  });
-
-  it('Renders snippet with multiple messages surrounded by other lines', () => {
-    const details = makeSnippetDetails({
-      lineMessages: [
-        {
-          lineNumber: 40,
-          message: 'Error 1',
-        },
-        {
-          lineNumber: 70,
-          message: 'Error 2',
-        },
-      ],
-      generalMessages: [],
-      lines: generateAvailableLinesArray([
-        {
-          from: 30,
-          to: 50,
-        },
-        {
-          from: 60,
-          to: 80,
-        },
-      ]),
-      lineCount: 100,
-    });
-    const {
-      collapsedContentLines,
-      omittedLinesIndicatorsWhenCollapsed,
-      omittedLinesIndicatorsWhenExpanded,
-      highlightedContentLines,
-    } = renderSnippet(details);
-
-    // first available line is collapsed
-    assert.equal(collapsedContentLines[0].textContent.replace(/\s/g, ''), '30L30');
-
-    // puts omitted lines placeholder between the two messages
-    assert.equal(omittedLinesIndicatorsWhenCollapsed.length, 1);
-    // puts omitted lines placeholder between the two messages and around the whole snippet
-    assert.equal(omittedLinesIndicatorsWhenExpanded.length, 3);
-
-    // both lines with messages are highlighted
-    assert.equal(highlightedContentLines.length, 2);
-  });
-
-  it('Can render both line-specific and non line-specific messages in one snippet', () => {
-    const details = makeSnippetDetails({
-      lineMessages: [
-        {
-          lineNumber: 5,
-          message: 'Error on line',
-        },
-      ],
-      generalMessages: [
-        {
-          message: 'General error',
-        },
-      ],
-      lines: generateAvailableLinesArray([{from: 1, to: 6}]),
-      lineCount: 100,
-    });
-    const {messageLines} = renderSnippet(details);
-
-    assert.equal(messageLines.length, 2);
-  });
-
-  it('Renders a snippet header and allows toggling the expanded state', () => {
-    const details = makeSnippetDetails({
-      title: 'Test Snippet',
-      lineMessages: [],
-      generalMessages: [],
-      lines: generateAvailableLinesArray([{from: 1, to: 6}]),
-      lineCount: 100,
-    });
-    const {title, toggleExpandButton, el} = renderSnippet(details);
-
-    // Renders title
-    assert.ok(title.textContent.includes('Test Snippet'));
-    // Renders toggle button
-    assert.ok(toggleExpandButton);
-    assert.ok(!el.classList.contains('lh-snippet--expanded'));
-
-    toggleExpandButton.click();
-    assert.ok(el.classList.contains('lh-snippet--expanded'));
-  });
-
-  it('Does not render toggle button if all available lines are already visible', () => {
-    const details = makeSnippetDetails({
-      title: 'Test Snippet',
-      lineMessages: [],
-      generalMessages: [],
-      // We show all 5 lines by default, so there's nothing to expand
-      lines: generateAvailableLinesArray([{from: 1, to: 5}]),
-    });
-    const {toggleExpandButton} = renderSnippet(details);
-
-    assert.ok(!toggleExpandButton);
-  });
-
-  it('Adds ... to lines that have been truncated', () => {
-    const details = makeSnippetDetails({
-      lineMessages: [],
-      generalMessages: [],
-      lines: [
-        {
-          content: 'abc',
-          lineNumber: 1,
-          truncated: true,
-        },
-        {
-          content: 'xyz',
-          lineNumber: 2,
-        },
-      ],
-      lineCount: 2,
-    });
-    const {contentLines} = renderSnippet(details);
-
-    assert.ok(contentLines[0].textContent.includes('…'));
-    assert.ok(!contentLines[1].textContent.includes('…'));
-  });
-});

package/report/test/renderer/text-encoding-test.js

@@ -1,43 +0,0 @@
-/**
- * @license Copyright 2021 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.
- */
-
-import fs from 'fs';
-
-import pako from 'pako';
-
-import {TextEncoding} from '../../renderer/text-encoding.js';
-import {LH_ROOT} from '../../../root.js';
-
-describe('TextEncoding', () => {
-  before(() => {
-    global.window = {pako};
-  });
-
-  after(() => {
-    global.window = undefined;
-  });
-
-  /** @type {string} */
-  async function test(str) {
-    for (const gzip of [false, true]) {
-      const binary = await TextEncoding.toBase64(str, {gzip});
-      const roundtrip = TextEncoding.fromBase64(binary, {gzip});
-      expect(roundtrip.length).toEqual(str.length);
-      expect(roundtrip).toEqual(str);
-    }
-  }
-
-  it('works', async () => {
-    await test('');
-    await test('hello');
-    await test('😃');
-    await test('{åß∂œ∑´}');
-    await test('Some examples of emoji are 😃, 🧘🏻‍♂️, 🌍, 🍞, 🚗, 📞, 🎉, ♥️, 🍆, and 🏁.');
-    await test('.'.repeat(125183));
-    await test('😃'.repeat(125183));
-    await test(fs.readFileSync(LH_ROOT + '/treemap/app/debug.json', 'utf-8'));
-  });
-});

package/report/test-assets/faux-psi.d.ts

@@ -1,34 +0,0 @@
-/**
- * @param {any} lhr
- * @param {Element} container
- */
-declare function renderLHReport(lhr: any, container: Element): Promise<void>;
-/**
- * @param {LH.Locale} locale
- */
-declare function swapLhrLocale(locale: LH.Locale): Promise<void>;
-/**
- * Tweak the LHR to make the desktop and mobile reports easier to identify.
- * Adjusted: Perf category name and score, and emoji placed on top of key screenshots.
- * @param {LH.Result} lhr
- * @param {string} tabId
- */
-declare function distinguishLHR(lhr: LH.Result, tabId: string): Promise<void>;
-/**
- * Add 📱 and 💻 emoji on top of screenshot
- * @param {string} datauri
- * @param {string} tabId
- */
-declare function decorateScreenshot(datauri: string, tabId: string): Promise<string>;
-type lighthouseRenderer = typeof import("../clients/bundle.js");
-/**
- * @license Copyright 2021 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.
- */
-/** @fileoverview This file exercises two LH reports within the same DOM. */
-/** @typedef {import('../clients/bundle.js')} lighthouseRenderer */
-/** @type {lighthouseRenderer} */
-declare const lighthouseRenderer: lighthouseRenderer;
-declare function wait(ms?: number): Promise<any>;
-//# sourceMappingURL=faux-psi.d.ts.map