lighthouse 8.0.0-dev.20210709 → 8.0.0

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

@@ -1,388 +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';
-
-const assert = require('assert').strict;
-const Util = require('../../renderer/util.js');
-const I18n = require('../../renderer/i18n.js');
-const sampleResult = require('../../../lighthouse-core/test/results/sample_v2.json');
-
-/* eslint-env jest */
-
-describe('util helpers', () => {
-  beforeEach(() => {
-    Util.i18n = new I18n('en', {...Util.UIStrings});
-  });
-
-  afterEach(() => {
-    Util.i18n = undefined;
-  });
-
-  it('calculates a score ratings', () => {
-    assert.equal(Util.calculateRating(0.0), 'fail');
-    assert.equal(Util.calculateRating(0.10), 'fail');
-    assert.equal(Util.calculateRating(0.45), 'fail');
-    assert.equal(Util.calculateRating(0.5), 'average');
-    assert.equal(Util.calculateRating(0.75), 'average');
-    assert.equal(Util.calculateRating(0.80), 'average');
-    assert.equal(Util.calculateRating(0.90), 'pass');
-    assert.equal(Util.calculateRating(1.00), 'pass');
-  });
-
-  it('builds device emulation string', () => {
-    const get = opts => Util.getEmulationDescriptions(opts).deviceEmulation;
-    assert.equal(get({formFactor: 'mobile'}), 'Emulated Moto G4');
-    assert.equal(get({formFactor: 'desktop'}), 'Emulated Desktop');
-  });
-
-  it('builds throttling strings when provided', () => {
-    const descriptions = Util.getEmulationDescriptions({throttlingMethod: 'provided'});
-    assert.equal(descriptions.cpuThrottling, 'Provided by environment');
-    assert.equal(descriptions.networkThrottling, 'Provided by environment');
-  });
-
-  it('builds throttling strings when devtools', () => {
-    const descriptions = Util.getEmulationDescriptions({
-      throttlingMethod: 'devtools',
-      throttling: {
-        cpuSlowdownMultiplier: 4.5,
-        requestLatencyMs: 565,
-        downloadThroughputKbps: 1400.00000000001,
-        uploadThroughputKbps: 600,
-      },
-    });
-
-    // eslint-disable-next-line max-len
-    assert.equal(descriptions.networkThrottling, '565\xa0ms HTTP RTT, 1,400\xa0Kbps down, 600\xa0Kbps up (DevTools)');
-    assert.equal(descriptions.cpuThrottling, '4.5x slowdown (DevTools)');
-  });
-
-  it('builds throttling strings when simulate', () => {
-    const descriptions = Util.getEmulationDescriptions({
-      throttlingMethod: 'simulate',
-      throttling: {
-        cpuSlowdownMultiplier: 2,
-        rttMs: 150,
-        throughputKbps: 1600,
-      },
-    });
-
-    // eslint-disable-next-line max-len
-    assert.equal(descriptions.networkThrottling, '150\xa0ms TCP RTT, 1,600\xa0Kbps throughput (Simulated)');
-    assert.equal(descriptions.cpuThrottling, '2x slowdown (Simulated)');
-  });
-
-  describe('#prepareReportResult', () => {
-    describe('backward compatibility', () => {
-      it('corrects underscored `notApplicable` scoreDisplayMode', () => {
-        const clonedSampleResult = JSON.parse(JSON.stringify(sampleResult));
-
-        let notApplicableCount = 0;
-        Object.values(clonedSampleResult.audits).forEach(audit => {
-          if (audit.scoreDisplayMode === 'notApplicable') {
-            notApplicableCount++;
-            audit.scoreDisplayMode = 'not_applicable';
-          }
-        });
-
-        assert.ok(notApplicableCount > 20); // Make sure something's being tested.
-
-        // Original audit results should be restored.
-        const preparedResult = Util.prepareReportResult(clonedSampleResult);
-
-        assert.deepStrictEqual(preparedResult.audits, sampleResult.audits);
-      });
-
-      it('corrects undefined auditDetails.type to `debugdata`', () => {
-        const clonedSampleResult = JSON.parse(JSON.stringify(sampleResult));
-
-        // Delete debugdata details types.
-        let undefinedCount = 0;
-        for (const audit of Object.values(clonedSampleResult.audits)) {
-          if (audit.details && audit.details.type === 'debugdata') {
-            undefinedCount++;
-            delete audit.details.type;
-          }
-        }
-        assert.ok(undefinedCount > 4); // Make sure something's being tested.
-        assert.notDeepStrictEqual(clonedSampleResult.audits, sampleResult.audits);
-
-        // Original audit results should be restored.
-        const preparedResult = Util.prepareReportResult(clonedSampleResult);
-        assert.deepStrictEqual(preparedResult.audits, sampleResult.audits);
-      });
-
-      it('corrects `diagnostic` auditDetails.type to `debugdata`', () => {
-        const clonedSampleResult = JSON.parse(JSON.stringify(sampleResult));
-
-        // Change debugdata details types.
-        let diagnosticCount = 0;
-        for (const audit of Object.values(clonedSampleResult.audits)) {
-          if (audit.details && audit.details.type === 'debugdata') {
-            diagnosticCount++;
-            audit.details.type = 'diagnostic';
-          }
-        }
-        assert.ok(diagnosticCount > 4); // Make sure something's being tested.
-        assert.notDeepStrictEqual(clonedSampleResult.audits, sampleResult.audits);
-
-        // Original audit results should be restored.
-        const preparedResult = Util.prepareReportResult(clonedSampleResult);
-        assert.deepStrictEqual(preparedResult.audits, sampleResult.audits);
-      });
-
-      it('corrects screenshots in the `filmstrip` auditDetails.type', () => {
-        const clonedSampleResult = JSON.parse(JSON.stringify(sampleResult));
-
-        // Strip filmstrip screenshots of data URL prefix.
-        let filmstripCount = 0;
-        for (const audit of Object.values(clonedSampleResult.audits)) {
-          if (audit.details && audit.details.type === 'filmstrip') {
-            filmstripCount++;
-            for (const screenshot of audit.details.items) {
-              screenshot.data = screenshot.data.slice('data:image/jpeg;base64,'.length);
-            }
-          }
-        }
-        assert.ok(filmstripCount > 0); // Make sure something's being tested.
-        assert.notDeepStrictEqual(clonedSampleResult.audits, sampleResult.audits);
-
-        // Original audit results should be restored.
-        const preparedResult = Util.prepareReportResult(clonedSampleResult);
-        assert.deepStrictEqual(preparedResult.audits, sampleResult.audits);
-      });
-    });
-
-    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 = Util.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);
-    });
-  });
-
-  describe('getTld', () => {
-    it('returns the correct tld', () => {
-      assert.equal(Util.getTld('example.com'), '.com');
-      assert.equal(Util.getTld('example.co.uk'), '.co.uk');
-      assert.equal(Util.getTld('example.com.br'), '.com.br');
-      assert.equal(Util.getTld('example.tokyo.jp'), '.jp');
-    });
-  });
-
-  describe('getRootDomain', () => {
-    it('returns the correct rootDomain from a string', () => {
-      assert.equal(Util.getRootDomain('https://www.example.com/index.html'), 'example.com');
-      assert.equal(Util.getRootDomain('https://example.com'), 'example.com');
-      assert.equal(Util.getRootDomain('https://www.example.co.uk'), 'example.co.uk');
-      assert.equal(Util.getRootDomain('https://example.com.br/app/'), 'example.com.br');
-      assert.equal(Util.getRootDomain('https://example.tokyo.jp'), 'tokyo.jp');
-      assert.equal(Util.getRootDomain('https://sub.example.com'), 'example.com');
-      assert.equal(Util.getRootDomain('https://sub.example.tokyo.jp'), 'tokyo.jp');
-      assert.equal(Util.getRootDomain('http://localhost'), 'localhost');
-      assert.equal(Util.getRootDomain('http://localhost:8080'), 'localhost');
-    });
-
-    it('returns the correct rootDomain from an URL object', () => {
-      assert.equal(Util.getRootDomain(new URL('https://www.example.com/index.html')), 'example.com');
-      assert.equal(Util.getRootDomain(new URL('https://example.com')), 'example.com');
-      assert.equal(Util.getRootDomain(new URL('https://www.example.co.uk')), 'example.co.uk');
-      assert.equal(Util.getRootDomain(new URL('https://example.com.br/app/')), 'example.com.br');
-      assert.equal(Util.getRootDomain(new URL('https://example.tokyo.jp')), 'tokyo.jp');
-      assert.equal(Util.getRootDomain(new URL('https://sub.example.com')), 'example.com');
-      assert.equal(Util.getRootDomain(new URL('https://sub.example.tokyo.jp')), 'tokyo.jp');
-      assert.equal(Util.getRootDomain(new URL('http://localhost')), 'localhost');
-      assert.equal(Util.getRootDomain(new URL('http://localhost:8080')), 'localhost');
-    });
-  });
-
-  describe('#splitMarkdownCodeSpans', () => {
-    it('handles strings with no backticks in them', () => {
-      expect(Util.splitMarkdownCodeSpans('regular text')).toEqual([
-        {isCode: false, text: 'regular text'},
-      ]);
-    });
-
-    it('does not split on a single backtick', () => {
-      expect(Util.splitMarkdownCodeSpans('regular `text')).toEqual([
-        {isCode: false, text: 'regular `text'},
-      ]);
-    });
-
-    it('splits on backticked code', () => {
-      expect(Util.splitMarkdownCodeSpans('regular `code` text')).toEqual([
-        {isCode: false, text: 'regular '},
-        {isCode: true, text: 'code'},
-        {isCode: false, text: ' text'},
-      ]);
-    });
-
-    it('splits on backticked code at the beginning of the string', () => {
-      expect(Util.splitMarkdownCodeSpans('`start code` regular text')).toEqual([
-        {isCode: true, text: 'start code'},
-        {isCode: false, text: ' regular text'},
-      ]);
-    });
-
-    it('splits on backticked code at the end of the string', () => {
-      expect(Util.splitMarkdownCodeSpans('regular text `end code`')).toEqual([
-        {isCode: false, text: 'regular text '},
-        {isCode: true, text: 'end code'},
-      ]);
-    });
-
-    it('does not split on a single backtick after split out backticked code', () => {
-      expect(Util.splitMarkdownCodeSpans('regular text `code` and more `text')).toEqual([
-        {isCode: false, text: 'regular text '},
-        {isCode: true, text: 'code'},
-        {isCode: false, text: ' and more `text'},
-      ]);
-    });
-
-    it('splits on two instances of backticked code', () => {
-      expect(Util.splitMarkdownCodeSpans('regular text `code` more text `and more code`')).toEqual([
-        {isCode: false, text: 'regular text '},
-        {isCode: true, text: 'code'},
-        {isCode: false, text: ' more text '},
-        {isCode: true, text: 'and more code'},
-      ]);
-    });
-
-    it('splits on two directly adjacent instances of backticked code', () => {
-      // eslint-disable-next-line max-len
-      expect(Util.splitMarkdownCodeSpans('regular text `first code``second code` end text')).toEqual([
-        {isCode: false, text: 'regular text '},
-        {isCode: true, text: 'first code'},
-        {isCode: true, text: 'second code'},
-        {isCode: false, text: ' end text'},
-      ]);
-    });
-
-    it('handles text only within backticks', () => {
-      expect(Util.splitMarkdownCodeSpans('`first code``second code`')).toEqual([
-        {isCode: true, text: 'first code'},
-        {isCode: true, text: 'second code'},
-      ]);
-    });
-
-    it('splits on two instances of backticked code separated by only a space', () => {
-      // eslint-disable-next-line max-len
-      expect(Util.splitMarkdownCodeSpans('`first code` `second code`')).toEqual([
-        {isCode: true, text: 'first code'},
-        {isCode: false, text: ' '},
-        {isCode: true, text: 'second code'},
-      ]);
-    });
-  });
-
-  describe('#splitMarkdownLink', () => {
-    it('handles strings with no links in them', () => {
-      expect(Util.splitMarkdownLink('some text')).toEqual([
-        {isLink: false, text: 'some text'},
-      ]);
-    });
-
-    it('does not split on an incomplete markdown link', () => {
-      expect(Util.splitMarkdownLink('some [not link text](text')).toEqual([
-        {isLink: false, text: 'some [not link text](text'},
-      ]);
-    });
-
-    it('splits on a markdown link', () => {
-      expect(Util.splitMarkdownLink('some [link text](https://example.com) text')).toEqual([
-        {isLink: false, text: 'some '},
-        {isLink: true, text: 'link text', linkHref: 'https://example.com'},
-        {isLink: false, text: ' text'},
-      ]);
-    });
-
-    it('splits on an http markdown link', () => {
-      expect(Util.splitMarkdownLink('you should [totally click here](http://never-mitm.com) now')).toEqual([
-        {isLink: false, text: 'you should '},
-        {isLink: true, text: 'totally click here', linkHref: 'http://never-mitm.com'},
-        {isLink: false, text: ' now'},
-      ]);
-    });
-
-    it('does not split on a non-http/https link', () => {
-      expect(Util.splitMarkdownLink('some [link text](ftp://example.com) text')).toEqual([
-        {isLink: false, text: 'some [link text](ftp://example.com) text'},
-      ]);
-    });
-
-    it('does not split on a malformed markdown link', () => {
-      expect(Util.splitMarkdownLink('some [link ]text](https://example.com')).toEqual([
-        {isLink: false, text: 'some [link ]text](https://example.com'},
-      ]);
-
-      expect(Util.splitMarkdownLink('some [link text] (https://example.com')).toEqual([
-        {isLink: false, text: 'some [link text] (https://example.com'},
-      ]);
-    });
-
-    it('does not split on empty link text', () => {
-      expect(Util.splitMarkdownLink('some [](https://example.com) empty link')).toEqual([
-        {isLink: false, text: 'some [](https://example.com) empty link'},
-      ]);
-    });
-
-    it('splits on a markdown link at the beginning of a string', () => {
-      expect(Util.splitMarkdownLink('[link text](https://example.com) end text')).toEqual([
-        {isLink: true, text: 'link text', linkHref: 'https://example.com'},
-        {isLink: false, text: ' end text'},
-      ]);
-    });
-
-    it('splits on a markdown link at the end of a string', () => {
-      expect(Util.splitMarkdownLink('start text [link text](https://example.com)')).toEqual([
-        {isLink: false, text: 'start text '},
-        {isLink: true, text: 'link text', linkHref: 'https://example.com'},
-      ]);
-    });
-
-    it('handles a string consisting only of a markdown link', () => {
-      expect(Util.splitMarkdownLink(`[I'm only a link](https://example.com)`)).toEqual([
-        {isLink: true, text: `I'm only a link`, linkHref: 'https://example.com'},
-      ]);
-    });
-
-    it('handles a string starting and ending with a markdown link', () => {
-      expect(Util.splitMarkdownLink('[first link](https://first.com) other text [second link](https://second.com)')).toEqual([
-        {isLink: true, text: 'first link', linkHref: 'https://first.com'},
-        {isLink: false, text: ' other text '},
-        {isLink: true, text: 'second link', linkHref: 'https://second.com'},
-      ]);
-    });
-
-    it('handles a string with adjacent markdown links', () => {
-      expect(Util.splitMarkdownLink('start text [first link](https://first.com)[second link](https://second.com) and scene')).toEqual([
-        {isLink: false, text: 'start text '},
-        {isLink: true, text: 'first link', linkHref: 'https://first.com'},
-        {isLink: true, text: 'second link', linkHref: 'https://second.com'},
-        {isLink: false, text: ' and scene'},
-      ]);
-    });
-  });
-});

package/report/test/report-generator-test.js

@@ -1,145 +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';
-
-const assert = require('assert').strict;
-const fs = require('fs');
-const jsdom = require('jsdom');
-const ReportGenerator = require('../report-generator.js');
-const reportAssets = require('../report-assets.js');
-const sampleResults = require('../../lighthouse-core/test/results/sample_v2.json');
-const csvValidator = require('csv-validator');
-
-/* eslint-env jest */
-
-describe('ReportGenerator', () => {
-  describe('#replaceStrings', () => {
-    it('should replace all occurrences', () => {
-      const source = '%foo! %foo %bar!';
-      const result = ReportGenerator.replaceStrings(source, [
-        {search: '%foo', replacement: 'hey'},
-        {search: '%bar', replacement: 'you'},
-      ]);
-
-      assert.equal(result, 'hey! hey you!');
-    });
-
-    it('should not replace serial occurences', () => {
-      const result = ReportGenerator.replaceStrings('%1', [
-        {search: '%1', replacement: '%2'},
-        {search: '%2', replacement: 'pwnd'},
-      ]);
-
-      assert.equal(result, '%2');
-    });
-  });
-
-  describe('#generateHtmlReport', () => {
-    it('should return html', () => {
-      const result = ReportGenerator.generateReportHtml({});
-      assert.ok(result.includes('doctype html'), 'includes doctype');
-      assert.ok(result.trim().match(/<\/html>$/), 'ends with HTML tag');
-    });
-
-    it('should inject the report JSON', () => {
-      const code = 'hax\u2028hax</script><script>console.log("pwned");%%LIGHTHOUSE_JAVASCRIPT%%';
-      const result = ReportGenerator.generateReportHtml({code});
-      assert.ok(result.includes('"code":"hax\\u2028'), 'injects the json');
-      assert.ok(result.includes('hax\\u003c/script'), 'escapes HTML tags');
-      assert.ok(result.includes('LIGHTHOUSE_JAVASCRIPT'), 'cannot be tricked');
-    });
-
-    it('should inject the report templates', () => {
-      const page = new jsdom.JSDOM(ReportGenerator.generateReportHtml({}));
-      const templates = new jsdom.JSDOM(reportAssets.REPORT_TEMPLATES);
-      assert.equal(
-        page.window.document.querySelectorAll('template[id^="tmpl-"]').length,
-        templates.window.document.querySelectorAll('template[id^="tmpl-"]').length,
-        'all templates injected'
-      );
-    });
-
-    it('should inject the report CSS', () => {
-      const result = ReportGenerator.generateReportHtml({});
-      assert.ok(!result.includes('/*%%LIGHTHOUSE_CSS%%*/'));
-      assert.ok(result.includes('--color-green'));
-    });
-
-    it('should inject the report renderer javascript', () => {
-      const result = ReportGenerator.generateReportHtml({});
-      assert.ok(result.includes('ReportRenderer'), 'injects the script');
-      assert.ok(result.includes('robustness: \\u003c/script'), 'escapes HTML tags in javascript');
-      assert.ok(result.includes('pre$`post'), 'does not break from String.replace');
-      assert.ok(result.includes('LIGHTHOUSE_JSON'), 'cannot be tricked');
-    });
-  });
-
-  describe('#generateReport', () => {
-    it('creates JSON for results', () => {
-      const jsonOutput = ReportGenerator.generateReport(sampleResults, 'json');
-      assert.doesNotThrow(_ => JSON.parse(jsonOutput));
-    });
-
-    it('creates HTML for results', () => {
-      const htmlOutput = ReportGenerator.generateReport(sampleResults, 'html');
-      assert.ok(/<!doctype/gim.test(htmlOutput));
-      assert.ok(/<html lang="en"/gim.test(htmlOutput));
-    });
-
-    it('creates CSV for results', async () => {
-      const path = './.results-as-csv.csv';
-      const headers = {
-        category: '',
-        name: '',
-        title: '',
-        type: '',
-        score: 42,
-      };
-
-      const csvOutput = ReportGenerator.generateReport(sampleResults, 'csv');
-      fs.writeFileSync(path, csvOutput);
-
-      const lines = csvOutput.split('\n');
-      expect(lines.length).toBeGreaterThan(100);
-      expect(lines.slice(0, 3).join('\n')).toMatchInlineSnapshot(`
-        "requestedUrl,finalUrl,category,name,title,type,score
-        \\"http://localhost:10200/dobetterweb/dbw_tester.html\\",\\"http://localhost:10200/dobetterweb/dbw_tester.html\\",\\"Performance\\",\\"performance-score\\",\\"Overall Performance Category Score\\",\\"numeric\\",\\"0.57\\"
-        \\"http://localhost:10200/dobetterweb/dbw_tester.html\\",\\"http://localhost:10200/dobetterweb/dbw_tester.html\\",\\"Performance\\",\\"first-contentful-paint\\",\\"First Contentful Paint\\",\\"numeric\\",\\"0.24\\"
-        "
-      `);
-
-      try {
-        await csvValidator(path, headers);
-      } catch (err) {
-        assert.fail('CSV parser error:\n' + err.join('\n'));
-      } finally {
-        fs.unlinkSync(path);
-      }
-    });
-
-    it('creates CSV for results including overall category scores', () => {
-      const csvOutput = ReportGenerator.generateReport(sampleResults, 'csv');
-      expect(csvOutput).toContain('performance-score');
-      expect(csvOutput).toContain('accessibility-score');
-      expect(csvOutput).toContain('best-practices-score');
-      expect(csvOutput).toContain('seo-score');
-      expect(csvOutput).toContain('pwa-score');
-    });
-
-    it('writes extended info', () => {
-      const htmlOutput = ReportGenerator.generateReport(sampleResults, 'html');
-      const outputCheck = new RegExp('dobetterweb/dbw_tester.css', 'i');
-      assert.ok(outputCheck.test(htmlOutput));
-    });
-  });
-
-  it('handles array of outputs', () => {
-    const [json, html] = ReportGenerator.generateReport(sampleResults, ['json', 'html']);
-    assert.doesNotThrow(_ => JSON.parse(json));
-    assert.ok(/<!doctype/gim.test(html));
-    assert.ok(/<html lang="en"/gim.test(html));
-  });
-});