lighthouse 8.3.0-dev.20210907 → 8.3.0

package/flow-report/test/summary/summary-test.tsx

@@ -1,132 +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 {dirname} from 'path';
-import {fileURLToPath} from 'url';
-
-import {render} from '@testing-library/preact';
-import {FunctionComponent} from 'preact';
-
-import {SummaryHeader, SummaryFlowStep} from '../../src/summary/summary';
-import {FlowResultContext} from '../../src/util';
-import {ReportRendererProvider} from '../../src/wrappers/report-renderer';
-
-const flowResult: LH.FlowResult = JSON.parse(
-  fs.readFileSync(
-    // eslint-disable-next-line max-len
-    `${dirname(fileURLToPath(import.meta.url))}/../../../lighthouse-core/test/fixtures/fraggle-rock/reports/sample-lhrs.json`,
-    'utf-8'
-  )
-);
-
-let wrapper: FunctionComponent;
-
-beforeEach(() => {
-  wrapper = ({children}) => (
-    <FlowResultContext.Provider value={flowResult}>
-      <ReportRendererProvider>
-        {children}
-      </ReportRendererProvider>
-    </FlowResultContext.Provider>
-  );
-});
-
-describe('SummaryHeader', () => {
-  it('renders header content', async () => {
-    const root = render(<SummaryHeader/>, {wrapper});
-
-    const lhrCounts = root.getByText(/·/);
-    expect(root.getByText('Summary')).toBeTruthy();
-    expect(lhrCounts.textContent).toEqual(
-      '2 navigation reports · 1 timespan reports · 1 snapshot reports'
-    );
-  });
-});
-
-describe('SummaryFlowStep', () => {
-  it('renders navigation step', async () => {
-    const root = render(<SummaryFlowStep
-      lhr={flowResult.lhrs[0]}
-      label="Navigation (1)"
-      hashIndex={0}
-    />, {wrapper});
-
-    expect(root.getByTestId('SummaryNavigationHeader')).toBeTruthy();
-
-    expect(root.getByText('Navigation (1)')).toBeTruthy();
-
-    const screenshot = root.getByTestId('SummaryFlowStep__screenshot') as HTMLImageElement;
-    expect(screenshot.src).toMatch(/data:image\/jpeg;base64/);
-
-    const gauges = root.getAllByTestId('Gauge');
-    expect(gauges).toHaveLength(4);
-
-    const links = root.getAllByRole('link') as HTMLAnchorElement[];
-    expect(links.map(a => a.href)).toEqual([
-      'file:///Users/example/report.html/#index=0',
-      'file:///Users/example/report.html/#index=0&anchor=performance',
-      'file:///Users/example/report.html/#index=0&anchor=accessibility',
-      'file:///Users/example/report.html/#index=0&anchor=best-practices',
-      'file:///Users/example/report.html/#index=0&anchor=seo',
-    ]);
-  });
-
-  it('renders timespan step', async () => {
-    const root = render(<SummaryFlowStep
-      lhr={flowResult.lhrs[1]}
-      label="Timespan (1)"
-      hashIndex={1}
-    />, {wrapper});
-
-    expect(() => root.getByTestId('SummaryNavigationHeader')).toThrow();
-
-    expect(root.getByText('Timespan (1)')).toBeTruthy();
-
-    const screenshot = root.getByTestId('SummaryFlowStep__screenshot') as HTMLImageElement;
-    expect(screenshot.src).toBeFalsy();
-
-    expect(root.getByTestId('SummaryCategory__null'));
-    const gauges = root.getAllByTestId('CategoryRatio');
-    expect(gauges).toHaveLength(3);
-
-    const links = root.getAllByRole('link') as HTMLAnchorElement[];
-    expect(links.map(a => a.href)).toEqual([
-      'file:///Users/example/report.html/#index=1',
-      'file:///Users/example/report.html/#index=1&anchor=performance',
-      // Accessibility is missing in timespan.
-      'file:///Users/example/report.html/#index=1&anchor=best-practices',
-      'file:///Users/example/report.html/#index=1&anchor=seo',
-    ]);
-  });
-
-  it('renders snapshot step', async () => {
-    const root = render(<SummaryFlowStep
-      lhr={flowResult.lhrs[2]}
-      label="Snapshot (1)"
-      hashIndex={2}
-    />, {wrapper});
-
-    expect(() => root.getByTestId('SummaryNavigationHeader')).toThrow();
-
-    expect(root.getByText('Snapshot (1)')).toBeTruthy();
-
-    const screenshot = root.getByTestId('SummaryFlowStep__screenshot') as HTMLImageElement;
-    expect(screenshot.src).toMatch(/data:image\/jpeg;base64/);
-
-    const gauges = root.getAllByTestId('CategoryRatio');
-    expect(gauges).toHaveLength(4);
-
-    const links = root.getAllByRole('link') as HTMLAnchorElement[];
-    expect(links.map(a => a.href)).toEqual([
-      'file:///Users/example/report.html/#index=2',
-      'file:///Users/example/report.html/#index=2&anchor=performance',
-      'file:///Users/example/report.html/#index=2&anchor=accessibility',
-      'file:///Users/example/report.html/#index=2&anchor=best-practices',
-      'file:///Users/example/report.html/#index=2&anchor=seo',
-    ]);
-  });
-});

package/flow-report/test/util-test.tsx

@@ -1,109 +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 {dirname} from 'path';
-import {fileURLToPath} from 'url';
-
-import {renderHook} from '@testing-library/preact-hooks';
-import {FunctionComponent} from 'preact';
-import {act} from 'preact/test-utils';
-
-import {FlowResultContext, useCurrentLhr, useDerivedStepNames} from '../src/util';
-
-const flowResult: LH.FlowResult = JSON.parse(
-  fs.readFileSync(
-    // eslint-disable-next-line max-len
-    `${dirname(fileURLToPath(import.meta.url))}/../../lighthouse-core/test/fixtures/fraggle-rock/reports/sample-lhrs.json`,
-    'utf-8'
-  )
-);
-
-let wrapper: FunctionComponent;
-
-beforeEach(() => {
-  wrapper = ({children}) => (
-    <FlowResultContext.Provider value={flowResult}>{children}</FlowResultContext.Provider>
-  );
-});
-
-describe('useCurrentLhr', () => {
-  it('gets current lhr index from url hash', () => {
-    global.location.hash = '#index=1';
-    const {result} = renderHook(() => useCurrentLhr(), {wrapper});
-    expect(result.current).toEqual({
-      index: 1,
-      value: flowResult.lhrs[1],
-    });
-  });
-
-  it('changes on navigation', async () => {
-    global.location.hash = '#index=1';
-    const render = renderHook(() => useCurrentLhr(), {wrapper});
-
-    expect(render.result.current).toEqual({
-      index: 1,
-      value: flowResult.lhrs[1],
-    });
-
-    await act(() => {
-      global.location.hash = '#index=2';
-    });
-    await render.waitForNextUpdate();
-
-    expect(render.result.current).toEqual({
-      index: 2,
-      value: flowResult.lhrs[2],
-    });
-  });
-
-  it('return null if lhr index is unset', () => {
-    const {result} = renderHook(() => useCurrentLhr(), {wrapper});
-    expect(result.current).toBeNull();
-  });
-
-  it('return null if lhr index is out of bounds', () => {
-    global.location.hash = '#index=5';
-    const {result} = renderHook(() => useCurrentLhr(), {wrapper});
-    expect(result.current).toBeNull();
-  });
-
-  it('returns null for invalid value', () => {
-    global.location.hash = '#index=OHNO';
-    const {result} = renderHook(() => useCurrentLhr(), {wrapper});
-    expect(result.current).toBeNull();
-  });
-});
-
-describe('useDerivedStepNames', () => {
-  it('counts up for each mode', () => {
-    const {result} = renderHook(() => useDerivedStepNames(), {wrapper});
-    expect(result.current).toEqual([
-      'Navigation report (www.mikescerealshack.co/)',
-      'Timespan report (www.mikescerealshack.co/search)',
-      'Snapshot report (www.mikescerealshack.co/search)',
-      'Navigation report (www.mikescerealshack.co/corrections)',
-    ]);
-  });
-
-  it('enumerates if multiple in same group', () => {
-    const lhrs = flowResult.lhrs;
-    lhrs[3] = lhrs[2];
-    const newFlowResult = {lhrs};
-    const wrapper: FunctionComponent = ({children}) => (
-      <FlowResultContext.Provider value={newFlowResult}>{children}</FlowResultContext.Provider>
-    );
-
-    const {result} = renderHook(() => useDerivedStepNames(), {wrapper});
-
-    expect(result.current).toEqual([
-      'Navigation report (www.mikescerealshack.co/)',
-      'Timespan report (www.mikescerealshack.co/search)',
-      'Snapshot report 1 (www.mikescerealshack.co/search)',
-      'Snapshot report 2 (www.mikescerealshack.co/search)',
-    ]);
-  });
-});

package/flow-report/tsconfig.json

@@ -1,39 +0,0 @@
-{
-  "compilerOptions": {
-    "composite": true,
-    "outDir": "../.tmp/tsbuildinfo/flow-report",
-    "emitDeclarationOnly": false,
-    "declarationMap": true,
-
-    // Limit to base JS and DOM defs.
-    "lib": ["es2020", "dom", "dom.iterable"],
-    // Selectively include types from node_modules.
-    "types": ["node", "jest"],
-    "target": "es2020",
-    "module": "es2020",
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-
-    "allowJs": true,
-    "checkJs": true,
-    "strict": true,
-    // TODO: remove the next line to be fully `strict`.
-    "useUnknownInCatchVariables": false,
-
-    // "listFiles": true,
-    // "noErrorTruncation": true,
-    "extendedDiagnostics": true,
-
-    "jsx": "react-jsx",
-    "jsxImportSource": "preact",
-  },
-  "include": [
-    "**/*.ts",
-    "**/*.tsx",
-    "./types",
-  ],
-  "references": [
-    {"path": "../types/lhr/"},
-    {"path": "../report"},
-  ],
-}

package/flow-report/types/flow-report.d.ts

@@ -1,27 +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 FlowResult_ from '../../types/lhr/flow';
-import * as Settings from '../../types/lhr/settings';
-
-// Import to augment querySelector/querySelectorAll with stricter type checking.
-import '../../types/query-selector';
-import '../../report/types/html-renderer';
-
-declare global {
-  interface Window {
-    __LIGHTHOUSE_FLOW_JSON__: FlowResult_;
-    __initLighthouseFlowReport__: () => void;
-  }
-
-  // Expose global types in LH namespace.
-  module LH {
-    export type FlowResult = FlowResult_;
-    export type ConfigSettings = Settings.ConfigSettings;
-  }
-}
-
-export {};

package/lighthouse-core/audits/lcp-lazy-loaded.js

@@ -1,83 +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';
-
-const Audit = require('./audit.js');
-const i18n = require('../lib/i18n/i18n.js');
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that provides detail on whether the largest above-the-fold image was loaded with sufficient priority. This descriptive title is shown to users when the image was loaded properly. */
-  title: 'Largest Contentful Paint image was not lazily loaded',
-  /** Title of a Lighthouse audit that provides detail on whether the largest above-the-fold image was loaded with sufficient priority. This descriptive title is shown to users when the image was loaded inefficiently using the `loading=lazy` attribute. */
-  failureTitle: 'Largest Contentful Paint image was lazily loaded',
-  /** Description of a Lighthouse audit that tells the user why the advice is important. This is displayed after a user expands the section to see more. No character length limits. */
-  description: 'Above-the-fold images that are lazily loaded render later in the page lifecycle, which can delay the largest contentful paint. [Learn more](https://web.dev/lcp-lazy-loading/).',
-};
-
-const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
-
-class LargestContentfulPaintLazyLoaded extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'lcp-lazy-loaded',
-      title: str_(UIStrings.title),
-      description: str_(UIStrings.description),
-      supportedModes: ['navigation'],
-      requiredArtifacts: ['TraceElements', 'ViewportDimensions', 'ImageElements'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts.ImageElement} image
-   * @param {LH.Artifacts.ViewportDimensions} viewportDimensions
-   * @return {boolean}
-   */
-  static isImageInViewport(image, viewportDimensions) {
-    const imageTop = image.clientRect.top;
-    const viewportHeight = viewportDimensions.innerHeight;
-    return imageTop < viewportHeight;
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @return {LH.Audit.Product}
-   */
-  static audit(artifacts) {
-    const lcpElement = artifacts.TraceElements
-      .find(element => element.traceEventType === 'largest-contentful-paint');
-    const lcpElementImage = lcpElement ? artifacts.ImageElements.find(elem => {
-      return elem.node.devtoolsNodePath === lcpElement.node.devtoolsNodePath;
-    }) : undefined;
-
-
-    if (!lcpElementImage ||
-      !this.isImageInViewport(lcpElementImage, artifacts.ViewportDimensions)) {
-      return {score: 1, notApplicable: true};
-    }
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'node', itemType: 'node', text: str_(i18n.UIStrings.columnElement)},
-    ];
-
-    const details = Audit.makeTableDetails(headings, [
-      {
-        node: Audit.makeNodeItem(lcpElementImage.node),
-      },
-    ]);
-
-    return {
-      score: lcpElementImage.loading === 'lazy' ? 0 : 1,
-      details,
-    };
-  }
-}
-
-module.exports = LargestContentfulPaintLazyLoaded;
-module.exports.UIStrings = UIStrings;

package/report/.eslintrc.cjs

@@ -1,33 +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';
-
-/**
- * eslint does not support ESM rc files, so this must be a .cjs file.
- * @see https://eslint.org/docs/user-guide/configuring/configuration-files#configuration-file-formats
- * @see https://github.com/eslint/eslint/issues/13481
- */
-
-module.exports = {
-  env: {
-    browser: true,
-  },
-  rules: {
-    // TODO(esmodules): move to root eslint when all code is ESM
-    // or when this is resolved: https://github.com/import-js/eslint-plugin-import/issues/2214
-    'import/order': [2, {
-      'groups': [
-        'builtin',
-        'external',
-        ['sibling', 'parent'],
-        'index',
-        'object',
-        'type',
-      ],
-      'newlines-between': 'always',
-    }],
-  },
-};

package/report/generator/README.md

@@ -1,9 +0,0 @@
-# Lighthouse Report Generator
-
-## Overview
-
-Lighthouse's report generator is the entry point for creating reports from an **LHR** (Lighthouse Result object). It returns results as HTML, JSON, and CSV.
-
-It runs natively in Node.js but can run in the browser after a compile step is applied during our bundling pipeline. That compile step uses `brfs`, which takes any `fs.readFileSync()` calls and replaces them with the stringified file content.
-
-Because it's shared between core and the report, dependencies (both code and types) should be kept minimal.

package/report/generator/flow-report-assets.js

@@ -1,20 +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';
-
-const fs = require('fs');
-
-/* eslint-disable max-len */
-const FLOW_REPORT_TEMPLATE = fs.readFileSync(`${__dirname}/../../flow-report/assets/standalone-flow-template.html`, 'utf8');
-const FLOW_REPORT_CSS = fs.readFileSync(`${__dirname}/../../flow-report/assets/styles.css`, 'utf8');
-const FLOW_REPORT_JAVASCRIPT = fs.readFileSync(`${__dirname}/../../dist/report/flow.js`, 'utf8');
-/* eslint-enable max-len */
-
-module.exports = {
-  FLOW_REPORT_TEMPLATE,
-  FLOW_REPORT_CSS,
-  FLOW_REPORT_JAVASCRIPT,
-};

package/report/generator/package.json

@@ -1,4 +0,0 @@
-{
-  "type": "commonjs",
-  "//": "Preserve commonjs in this directory. Temporary file until converted to type: module"
-}

package/report/generator/tsconfig.json

@@ -1,28 +0,0 @@
-{
-  "compilerOptions": {
-    "composite": true,
-    "outDir": "../../.tmp/tsbuildinfo/report/generator",
-    "emitDeclarationOnly": true,
-    "declarationMap": true,
-
-    "target": "ES2020",
-    "module": "commonjs",
-    "moduleResolution": "node",
-
-    "allowJs": true,
-    "checkJs": true,
-    "strict": true,
-    // TODO: remove the next line to be fully `strict`.
-    "useUnknownInCatchVariables": false,
-
-    // "listFiles": true,
-    // "noErrorTruncation": true,
-    "extendedDiagnostics": true,
-  },
-  "references": [
-    {"path": "../../types/lhr/"},
-  ],
-  "include": [
-    "**/*.js",
-  ],
-}