lighthouse 8.6.0-dev.20211021 → 8.6.0

package/shared/test/localization/format-test.js

@@ -9,54 +9,10 @@ const path = require('path');
 
 const format = require('../../localization/format.js');
 const i18n = require('../../../lighthouse-core/lib/i18n/i18n.js');
-const constants = require('../../../lighthouse-core/config/constants.js');
-const locales = require('../../localization/locales.js');
 
 /* eslint-env jest */
 
 describe('format', () => {
-  describe('DEFAULT_LOCALE', () => {
-    it('is the same as the default config locale', () => {
-      expect(format.DEFAULT_LOCALE).toBe(constants.defaultSettings.locale);
-    });
-  });
-
-  describe('#getAvailableLocales', () => {
-    it('has all the available locales', () => {
-      const availableLocales = format.getAvailableLocales();
-      for (const locale of ['en', 'es', 'ru', 'zh']) {
-        expect(availableLocales).toContain(locale);
-      }
-
-      const rawLocales = Object.keys(locales).sort();
-      expect(availableLocales.sort()).toEqual(rawLocales);
-    });
-
-    it('contains the default locale', () => {
-      expect(format.getAvailableLocales()).toContain(format.DEFAULT_LOCALE);
-    });
-  });
-
-  describe('#getCanonicalLocales', () => {
-    it('contains some canonical locales', () => {
-      const canonicalLocales = format.getCanonicalLocales();
-      for (const locale of ['en-US', 'es', 'ru', 'zh']) {
-        expect(canonicalLocales).toContain(locale);
-      }
-    });
-
-    it('is a subset of the available locales', () => {
-      const canonicalLocales = format.getCanonicalLocales();
-      const availableLocales = format.getAvailableLocales();
-
-      for (const canonicalLocale of canonicalLocales) {
-        expect(availableLocales).toContain(canonicalLocale);
-      }
-
-      expect(canonicalLocales.length).toBeLessThan(availableLocales.length);
-    });
-  });
-
   describe('#_formatPathAsString', () => {
     it('handles simple paths', () => {
       expect(format._formatPathAsString(['foo'])).toBe('foo');
@@ -407,7 +363,15 @@ describe('format', () => {
       expect(helloInfinityStr).toBeDisplayString('Hello ∞ World');
 
       const helloNaNStr = str_(UIStrings.helloBytesWorld, {in: NaN});
-      expect(helloNaNStr).toBeDisplayString('Hello NaN World');
+      // TODO(COMPAT): workaround can be removed after Node 13 is retired.
+      // expect(helloNaNStr).toBeDisplayString('Hello NaN World');
+
+      // Node 13/V8 7.9 and 8.0 have a bug where `({a: NaN}).a.toLocaleString() === "-NaN"`. It
+      // works correctly in Node 12 and 14, so work around it since NaN isn't essential for
+      // user-facing strings and it will eventually correct itself.
+      const formattedNaNStr = format.getFormatted(helloNaNStr, 'en-US');
+      expect(formattedNaNStr === 'Hello NaN World' || formattedNaNStr === 'Hello -NaN World')
+        .toBe(true);
     });
   });
 });

package/shared/test/localization/swap-locale-test.js

@@ -6,11 +6,23 @@
 'use strict';
 
 const swapLocale = require('../../localization/swap-locale.js');
+const {isNode12SmallIcu} = require('../../../lighthouse-core/test/test-utils.js');
 
 const lhr = require('../../../lighthouse-core/test/results/sample_v2.json');
 
 /* eslint-env jest */
 describe('swap-locale', () => {
+  // COMPAT: Node 12 only has 'en' by default. Skip these tests since they're all about swapping locales.
+  if (isNode12SmallIcu()) {
+    // Jest requires at least one test per suite.
+    it('throws if locale is not supported', () => {
+      // Even though 'pt' is requested, 'en' is all that's available.
+      expect(() => swapLocale(lhr, 'pt')).toThrow('Unsupported locale \'pt\'');
+    });
+
+    return;
+  }
+
   it('does not mutate the original lhr', () => {
     /** @type {LH.Result} */
     const lhrClone = JSON.parse(JSON.stringify(lhr));

package/third-party/download-content-shell/download-content-shell.js

@@ -85,7 +85,7 @@ function deleteOldContentShells() {
   const remainingNumberOfContentShells = MAX_CONTENT_SHELLS / 2;
   const oldContentShellDirs = files.slice(remainingNumberOfContentShells);
   for (let i = 0; i < oldContentShellDirs.length; i++) {
-    fs.rmSync(path.resolve(CACHE_PATH, oldContentShellDirs[i]), {recursive: true, force: true});
+    utils.removeRecursive(path.resolve(CACHE_PATH, oldContentShellDirs[i]));
   }
   console.log(`Removed old content shells: ${oldContentShellDirs}`);
 }
@@ -126,7 +126,7 @@ function findPreviousUploadedPosition(commitPosition) {
 async function prepareContentShellDirectory(folder) {
   const contentShellPath = path.join(CACHE_PATH, folder);
   if (utils.isDir(contentShellPath)) {
-    fs.rmSync(contentShellPath, {recursive: true, force: true});
+    utils.removeRecursive(contentShellPath);
   }
   fs.mkdirSync(contentShellPath);
   return folder;

package/third-party/download-content-shell/utils.js

@@ -96,6 +96,29 @@ function copyRecursive(src, dest) {
   }
 }
 
+function removeRecursive(filePath) {
+  try {
+    if (fs.existsSync(filePath)) {
+      if (isFile(filePath)) {
+        fs.unlinkSync(filePath);
+        return;
+      }
+      const files = fs.readdirSync(filePath);
+      for (let i = 0; i < files.length; i++) {
+        const childPath = path.resolve(filePath, files[i]);
+        if (isDir(childPath)) {
+          removeRecursive(childPath);
+        } else {
+          fs.unlinkSync(childPath);
+        }
+      }
+      fs.rmdirSync(filePath);
+    }
+  } catch (error) {
+    throw new Error(`Received an error: [${error}] while trying to remove: ${filePath}`);
+  }
+}
+
 function includes(sequence, target) {
   return sequence.indexOf(target) > -1;
 }
@@ -122,6 +145,7 @@ module.exports = {
   isDir,
   copy,
   copyRecursive,
+  removeRecursive,
   includes,
   shellOutput,
   parseArgs,

package/tsconfig.json

@@ -58,6 +58,7 @@
     "lighthouse-core/test/gather/gatherers/full-page-screenshot-test.js",
     "lighthouse-core/test/gather/gatherers/global-listeners-test.js",
     "lighthouse-core/test/gather/gatherers/html-without-javascript-test.js",
+    "lighthouse-core/test/gather/gatherers/http-redirect-test.js",
     "lighthouse-core/test/gather/gatherers/js-usage-test.js",
     "lighthouse-core/test/gather/gatherers/link-elements-test.js",
     "lighthouse-core/test/gather/gatherers/offline-test.js",

package/types/artifacts.d.ts

@@ -25,6 +25,7 @@ export interface Artifacts extends BaseArtifacts, GathererArtifacts {}
 
 export type FRArtifacts = StrictOmit<Artifacts,
   | 'Fonts'
+  | 'HTTPRedirect'
   | 'Manifest'
   | 'MixedContent'
   | keyof FRBaseArtifacts
@@ -147,6 +148,8 @@ export interface GathererArtifacts extends PublicGathererArtifacts,LegacyBaseArt
   FullPageScreenshot: Artifacts.FullPageScreenshot | null;
   /** Information about event listeners registered on the global object. */
   GlobalListeners: Array<Artifacts.GlobalListener>;
+  /** Whether the page ended up on an HTTPS page after attempting to load the HTTP version. */
+  HTTPRedirect: {value: boolean};
   /** The issues surfaced in the devtools Issues panel */
   InspectorIssues: Artifacts.InspectorIssues;
   /** JS coverage information for code used during page load. Keyed by network URL. */
@@ -208,7 +211,6 @@ declare module Artifacts {
       target: Array<string>;
       failureSummary?: string;
       node: NodeDetails;
-      relatedNodes: NodeDetails[];
     }>;
     error?: RuleExecutionError;
   }

package/types/enquirer.d.ts

@@ -4,8 +4,6 @@
  * 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 {EventEmitter} from 'events';
-
 declare module 'enquirer' {
   interface ConfirmOption {
     name: string | (() => string);
@@ -14,7 +12,7 @@ declare module 'enquirer' {
     actions?: {'ctrl': {[key: string]: string}}
   }
 
-  class Confirm extends EventEmitter {
+  class Confirm extends NodeJS.EventEmitter {
     constructor(option: ConfirmOption);
     run: () => Promise<boolean>;
     close: () => Promise<void>

package/types/node.d.ts

@@ -4,9 +4,9 @@
  * 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.
  */
 
-declare global {
-  var isDevtools: boolean | undefined;
-  var isLightrider: boolean | undefined;
+declare module NodeJS {
+  interface Global {
+    isDevtools?: boolean;
+    isLightrider?: boolean;
+  }
 }
-
-export {};

package/flow-report/test/wrappers/category-score-test.tsx

@@ -1,87 +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 {FunctionComponent} from 'preact';
-import {render} from '@testing-library/preact';
-
-import {CategoryScore} from '../../src/wrappers/category-score';
-import {FlowResultContext} from '../../src/util';
-import {ReportRendererProvider} from '../../src/wrappers/report-renderer';
-import {I18nProvider} from '../../src/i18n/i18n';
-import {flowResult} from '../sample-flow';
-
-let wrapper: FunctionComponent;
-
-beforeEach(() => {
-  wrapper = ({children}) => (
-    <FlowResultContext.Provider value={flowResult}>
-      <ReportRendererProvider>
-        <I18nProvider>
-          {children}
-        </I18nProvider>
-      </ReportRendererProvider>
-    </FlowResultContext.Provider>
-  );
-});
-
-describe('CategoryScore', () => {
-  it('renders score gauge', () => {
-    const category: any = {
-      id: 'seo',
-      score: 0.95,
-      auditRefs: [],
-    };
-    const root = render(
-      <CategoryScore category={category} href="#seo" gatherMode="navigation"/>,
-      {wrapper}
-    );
-
-    const link = root.getByRole('link') as HTMLAnchorElement;
-
-    expect(link.href).toEqual('file:///Users/example/report.html/#seo');
-    expect(root.getByText('95')).toBeTruthy();
-    expect(root.baseElement.querySelector('.lh-gauge__label')).toBeFalsy();
-  });
-
-  it('renders error gauge', () => {
-    const category: any = {
-      id: 'seo',
-      score: null,
-      auditRefs: [],
-    };
-    const root = render(
-      <CategoryScore category={category} href="#seo" gatherMode="navigation"/>,
-      {wrapper}
-    );
-
-    const link = root.getByRole('link') as HTMLAnchorElement;
-
-    expect(link.href).toEqual('file:///Users/example/report.html/#seo');
-    expect(root.getByText('?')).toBeTruthy();
-  });
-
-  it('renders category fraction', () => {
-    const category: any = {
-      id: 'seo',
-      auditRefs: [
-        {weight: 1, result: {score: 1, scoreDisplayMode: 'binary'}},
-        {weight: 1, result: {score: 1, scoreDisplayMode: 'binary'}},
-        {weight: 1, result: {score: 0, scoreDisplayMode: 'binary'}},
-        {weight: 1, result: {score: 0, scoreDisplayMode: 'binary'}},
-      ],
-    };
-    const root = render(
-      <CategoryScore category={category} href="#seo" gatherMode="timespan"/>,
-      {wrapper}
-    );
-
-    const link = root.getByRole('link') as HTMLAnchorElement;
-
-    expect(link.href).toEqual('file:///Users/example/report.html/#seo');
-    expect(root.getByText('2/4')).toBeTruthy();
-    expect(root.baseElement.querySelector('.lh-fraction__label')).toBeFalsy();
-  });
-});

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

@@ -1,62 +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.
- */
-
-'use strict';
-
-import fs from 'fs';
-
-import jsdom from 'jsdom';
-
-import * as lighthouseRenderer from '../../clients/bundle.js';
-import {LH_ROOT} from '../../../root.js';
-
-const sampleResultsStr =
-  fs.readFileSync(LH_ROOT + '/lighthouse-core/test/results/sample_v2.json', 'utf-8');
-
-
-/* eslint-env jest */
-
-describe('lighthouseRenderer bundle', () => {
-  let document;
-  beforeAll(() => {
-    const {window} = new jsdom.JSDOM();
-    document = window.document;
-
-    global.window = global.self = window;
-    // Stub out matchMedia for Node.
-    global.self.matchMedia = function() {
-      return {
-        addListener: function() {},
-      };
-    };
-  });
-
-  afterAll(() => {
-    global.window = global.self = undefined;
-  });
-
-
-  it('renders an LHR to DOM', () => {
-    const lhr = /** @type {LH.Result} */ JSON.parse(sampleResultsStr);
-    const reportContainer = document.body;
-    reportContainer.classList.add('lh-vars', 'lh-root');
-
-    const dom = new lighthouseRenderer.DOM(reportContainer.ownerDocument);
-    const renderer = new lighthouseRenderer.ReportRenderer(dom);
-    renderer.renderReport(lhr, reportContainer);
-    const features = new lighthouseRenderer.ReportUIFeatures(renderer._dom);
-    features.initFeatures(lhr);
-
-
-    // Check that the report exists and has some content.
-    expect(reportContainer instanceof document.defaultView.Element).toBeTruthy();
-    expect(reportContainer.outerHTML.length).toBeGreaterThan(50000);
-
-    const title = reportContainer.querySelector('.lh-audit-group--metrics')
-      .querySelector('.lh-audit-group__title');
-    expect(title.textContent).toEqual('Metrics');
-  });
-});