lighthouse 10.0.0 → 10.0.1

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

@@ -1,124 +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 {render} from '@testing-library/preact';
-import {FunctionComponent} from 'preact';
-
-import {I18nProvider} from '../../src/i18n/i18n';
-import {SummaryHeader, SummaryFlowStep} from '../../src/summary/summary';
-import {FlowResultContext} from '../../src/util';
-import {flowResult} from '../sample-flow';
-
-let wrapper: FunctionComponent;
-
-beforeEach(() => {
-  wrapper = ({children}) => (
-    <FlowResultContext.Provider value={flowResult}>
-      <I18nProvider>
-        {children}
-      </I18nProvider>
-    </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 report · 1 snapshot report'
-    );
-  });
-});
-
-describe('SummaryFlowStep', () => {
-  it('renders navigation step', async () => {
-    const root = render(<SummaryFlowStep
-      lhr={flowResult.steps[0].lhr}
-      label="Navigation (1)"
-      hashIndex={0}
-    />, {wrapper});
-
-    expect(root.getByTestId('SummaryNavigationHeader')).toBeTruthy();
-
-    expect(root.getByText('Navigation (1)')).toBeTruthy();
-
-    const screenshot =
-      root.getByAltText('Screenshot of a page tested by Lighthouse') as HTMLImageElement;
-    expect(screenshot.src).toMatch(/data:image\/jpeg;base64/);
-
-    const gauges = root.getAllByTestId('CategoryScore');
-    expect(gauges).toHaveLength(4);
-
-    const links = root.getAllByRole('link') as HTMLAnchorElement[];
-    expect(links.map(a => a.href)).toEqual([
-      'https://www.mikescerealshack.co/',
-      '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.steps[1].lhr}
-      label="Timespan (1)"
-      hashIndex={1}
-    />, {wrapper});
-
-    expect(() => root.getByTestId('SummaryNavigationHeader')).toThrow();
-
-    expect(root.getByText('Timespan (1)')).toBeTruthy();
-
-    expect(() => root.getByAltText('Screenshot of a page tested by Lighthouse')).toThrow();
-
-    // Accessibility and SEO are missing in timespan.
-    const nullCategories = root.getAllByTestId('SummaryCategory__null');
-    expect(nullCategories).toHaveLength(2);
-
-    const gauges = root.getAllByTestId('CategoryScore');
-    expect(gauges).toHaveLength(2);
-
-    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',
-      'file:///Users/example/report.html/#index=1&anchor=best-practices',
-    ]);
-  });
-
-  it('renders snapshot step', async () => {
-    const root = render(<SummaryFlowStep
-      lhr={flowResult.steps[2].lhr}
-      label="Snapshot (1)"
-      hashIndex={2}
-    />, {wrapper});
-
-    expect(() => root.getByTestId('SummaryNavigationHeader')).toThrow();
-
-    expect(root.getByText('Snapshot (1)')).toBeTruthy();
-
-    const screenshot =
-      root.getByAltText('Screenshot of a page tested by Lighthouse') as HTMLImageElement;
-    expect(screenshot.src).toMatch(/data:image\/webp;base64/);
-
-    const gauges = root.getAllByTestId('CategoryScore');
-    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/topbar-test.d.ts

@@ -1,7 +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.
- */
-export {};
-//# sourceMappingURL=topbar-test.d.ts.map

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

@@ -1,84 +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 jestMock from 'jest-mock';
-import {FunctionComponent} from 'preact';
-import {act, render} from '@testing-library/preact';
-
-import {FlowResultContext, OptionsContext} from '../src/util';
-import {I18nProvider} from '../src/i18n/i18n';
-import {Topbar, saveHtml} from '../src/topbar';
-
-const mockSaveFile = jestMock.fn();
-const defaultSaveFile = saveHtml.saveFile;
-
-const flowResult = {
-  name: 'User flow',
-  steps: [{lhr: {
-    fetchTime: '2021-09-14T22:24:22.462Z',
-    configSettings: {locale: 'en-US'},
-    i18n: {rendererFormattedStrings: {}},
-  }}],
-} as any;
-
-let wrapper: FunctionComponent;
-let options: LH.FlowReportOptions;
-
-before(() => {
-  mockSaveFile.mockReset();
-  options = {};
-  wrapper = ({children}) => (
-    <OptionsContext.Provider value={options}>
-      <FlowResultContext.Provider value={flowResult}>
-        <I18nProvider>
-          {children}
-        </I18nProvider>
-      </FlowResultContext.Provider>
-    </OptionsContext.Provider>
-  );
-});
-
-after(() => {
-  saveHtml.saveFile = defaultSaveFile;
-});
-
-it('save button opens save dialog for HTML file', async () => {
-  saveHtml.saveFile = mockSaveFile;
-  options = {getReportHtml: () => '<html></html>'};
-  const root = render(<Topbar onMenuClick={() => {}}/>, {wrapper});
-
-  const saveButton = root.getByText('Save');
-  saveButton.click();
-
-  expect(mockSaveFile).toHaveBeenCalledWith(
-    expect.any(Blob),
-    'User-flow_2021-09-14_22-24-22.html'
-  );
-});
-
-it('provides save as gist option if defined', async () => {
-  const saveAsGist = jestMock.fn();
-  options = {saveAsGist};
-  const root = render(<Topbar onMenuClick={() => {}}/>, {wrapper});
-
-  const saveButton = root.getByText('Save as Gist');
-  saveButton.click();
-
-  expect(saveAsGist).toHaveBeenCalledWith(flowResult);
-});
-
-it('toggles help dialog', async () => {
-  const root = render(<Topbar onMenuClick={() => {}}/>, {wrapper});
-
-  expect(root.queryByText(/Use Navigation reports to/)).toBeFalsy();
-  const helpButton = root.getByText('Understanding Flows');
-
-  await act(() => helpButton.click());
-  expect(root.getByText(/Use Navigation reports to/)).toBeTruthy();
-
-  await act(() => helpButton.click());
-  expect(root.queryByText(/Use Navigation reports to/)).toBeFalsy();
-});

package/flow-report/test/util-test.d.ts

@@ -1,7 +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.
- */
-export {};
-//# sourceMappingURL=util-test.d.ts.map

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

@@ -1,133 +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 jestMock from 'jest-mock';
-import {render} from '@testing-library/preact';
-import {renderHook} from '@testing-library/preact-hooks/src/index';
-import {FunctionComponent} from 'preact';
-import {act} from 'preact/test-utils';
-
-import {FlowResultContext, useExternalRenderer, useHashState} from '../src/util';
-import {flowResult} from './sample-flow';
-
-let wrapper: FunctionComponent;
-
-beforeEach(() => {
-  global.console.warn = jestMock.fn();
-  wrapper = ({children}) => (
-    <FlowResultContext.Provider value={flowResult}>{children}</FlowResultContext.Provider>
-  );
-});
-
-describe('useHashState', () => {
-  it('gets current lhr index from url hash', () => {
-    global.location.hash = '#index=1';
-    const {result} = renderHook(() => useHashState(), {wrapper});
-    expect(console.warn).not.toHaveBeenCalled();
-    expect(result.current).toEqual({
-      index: 1,
-      currentLhr: flowResult.steps[1].lhr,
-      anchor: null,
-    });
-  });
-
-  it('gets anchor id from url hash', () => {
-    global.location.hash = '#index=1&anchor=seo';
-    const {result} = renderHook(() => useHashState(), {wrapper});
-    expect(console.warn).not.toHaveBeenCalled();
-    expect(result.current).toEqual({
-      index: 1,
-      currentLhr: flowResult.steps[1].lhr,
-      anchor: 'seo',
-    });
-  });
-
-  it('changes on navigation', async () => {
-    global.location.hash = '#index=1';
-    const render = renderHook(() => useHashState(), {wrapper});
-
-    expect(render.result.current).toEqual({
-      index: 1,
-      currentLhr: flowResult.steps[1].lhr,
-      anchor: null,
-    });
-
-    await act(() => {
-      global.location.hash = '#index=2&anchor=seo';
-    });
-    await render.waitForNextUpdate();
-
-    expect(console.warn).not.toHaveBeenCalled();
-    expect(render.result.current).toEqual({
-      index: 2,
-      currentLhr: flowResult.steps[2].lhr,
-      anchor: 'seo',
-    });
-  });
-
-  it('return null if lhr index is unset', () => {
-    const {result} = renderHook(() => useHashState(), {wrapper});
-    expect(console.warn).not.toHaveBeenCalled();
-    expect(result.current).toBeNull();
-  });
-
-  it('return null if lhr index is out of bounds', () => {
-    global.location.hash = '#index=5';
-    const {result} = renderHook(() => useHashState(), {wrapper});
-    expect(console.warn).toHaveBeenCalled();
-    expect(result.current).toBeNull();
-  });
-
-  it('returns null for invalid value', () => {
-    global.location.hash = '#index=OHNO';
-    const {result} = renderHook(() => useHashState(), {wrapper});
-    expect(console.warn).toHaveBeenCalled();
-    expect(result.current).toBeNull();
-  });
-
-  it('returns null for invalid value with valid anchor', () => {
-    global.location.hash = '#index=OHNO&anchor=seo';
-    const {result} = renderHook(() => useHashState(), {wrapper});
-    expect(console.warn).toHaveBeenCalled();
-    expect(result.current).toBeNull();
-  });
-});
-
-describe('useExternalRenderer', () => {
-  it('attaches DOM subtree of render callback', () => {
-    const Container: FunctionComponent = () => {
-      const ref = useExternalRenderer<HTMLDivElement>(() => {
-        const el = document.createElement('div');
-        el.textContent = 'Some text';
-        return el;
-      });
-      return <div ref={ref}/>;
-    };
-
-    const root = render(<Container/>);
-
-    expect(root.getByText('Some text')).toBeTruthy();
-  });
-
-  it('re-renders DOM subtree when input changes', () => {
-    const Container: FunctionComponent<{text: string}> = ({text}) => {
-      const ref = useExternalRenderer<HTMLDivElement>(() => {
-        const el = document.createElement('div');
-        el.textContent = text;
-        return el;
-      }, [text]);
-      return <div ref={ref}/>;
-    };
-
-    const root = render(<Container text="Some text"/>);
-
-    expect(root.getByText('Some text')).toBeTruthy();
-
-    root.rerender(<Container text="New text"/>);
-
-    expect(root.getByText('New text')).toBeTruthy();
-  });
-});

package/flow-report/test/wrappers/category-score-test.d.ts

@@ -1,7 +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.
- */
-export {};
-//# sourceMappingURL=category-score-test.d.ts.map

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

@@ -1,84 +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 {I18nProvider} from '../../src/i18n/i18n';
-import {flowResult} from '../sample-flow';
-
-let wrapper: FunctionComponent;
-
-beforeEach(() => {
-  wrapper = ({children}) => (
-    <FlowResultContext.Provider value={flowResult}>
-      <I18nProvider>
-        {children}
-      </I18nProvider>
-    </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/flow-report/test/wrappers/markdown-test.d.ts

@@ -1,7 +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.
- */
-export {};
-//# sourceMappingURL=markdown-test.d.ts.map

package/flow-report/test/wrappers/markdown-test.tsx

@@ -1,17 +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 {render} from '@testing-library/preact';
-
-import {Markdown} from '../../src/wrappers/markdown';
-
-describe('Markdown', () => {
-  it('renders markdown text', () => {
-    const root = render(<Markdown text="Some `fancy` text"/>);
-    const text = root.getByText(/^Some.*text$/);
-    expect(text.innerHTML).toEqual('Some <code>fancy</code> text');
-  });
-});

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

@@ -1,65 +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 jsdom from 'jsdom';
-import jestMock from 'jest-mock';
-
-import * as lighthouseRenderer from '../../clients/bundle.js';
-import {LH_ROOT} from '../../../root.js';
-
-const sampleResultsStr =
-  fs.readFileSync(LH_ROOT + '/core/test/results/sample_v2.json', 'utf-8');
-
-describe('lighthouseRenderer bundle', () => {
-  let document;
-  before(() => {
-    global.console.warn = jestMock.fn();
-
-    const {window} = new jsdom.JSDOM();
-    document = window.document;
-
-    global.window = global.self = window;
-    global.window.requestAnimationFrame = fn => fn();
-    global.HTMLInputElement = window.HTMLInputElement;
-    // Stub out matchMedia for Node.
-    global.self.matchMedia = function() {
-      return {
-        addListener: function() {},
-      };
-    };
-    global.window.ResizeObserver = class ResizeObserver {
-      observe() { }
-      unobserve() { }
-    };
-  });
-
-  after(() => {
-    global.window = global.self = undefined;
-    global.HTMLInputElement = 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');
-  });
-});

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

@@ -1,27 +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 assert from 'assert/strict';
-
-import {getLhrFilenamePrefix} from '../../generator/file-namer.js';
-
-describe('file-namer helper', () => {
-  it('generates filename prefixes', () => {
-    const results = {
-      finalDisplayedUrl: 'https://testexample.com',
-      fetchTime: '2017-01-06T02:34:56.217Z',
-    };
-    const str = getLhrFilenamePrefix(results);
-    // we want the filename to match user timezone, however these tests will run on multiple TZs
-    assert.ok(str.startsWith('testexample.com'), 'hostname is missing');
-    assert.ok(str.includes('2017-'), 'full year is missing');
-    assert.ok(str.endsWith('-56'), 'seconds value is not at the end');
-    // regex of hostname_YYYY-MM-DD_HH-MM-SS
-    const regex = /testexample\.com_\d{4}-[0-1][[0-9]-[0-1][[0-9]_[0-2][0-9]-[0-5][0-9]-[0-5][0-9]/;
-    assert.ok(regex.test(str), `${str} doesn't match pattern: hostname_YYYY-MM-DD_HH-MM-SS`);
-  });
-});