lighthouse 9.5.0-dev.20220626 → 9.5.0-dev.20220629

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

@@ -4,18 +4,19 @@
  * 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 {jest} from '@jest/globals';
+import jestMock from 'jest-mock';
 import {act, render} from '@testing-library/preact';
 
+import {timers} from '../../lighthouse-core/test/test-env/fake-timers.js';
 import {FlowStepThumbnail} from '../src/common';
 
 let lhr: LH.Result;
 
-jest.useFakeTimers();
+timers.useFakeTimers();
 
 describe('FlowStepThumbnail', () => {
   beforeEach(() => {
-    global.console.warn = jest.fn();
+    global.console.warn = jestMock.fn();
 
     lhr = {
       gatherMode: 'navigation',
@@ -97,7 +98,7 @@ describe('FlowStepThumbnail', () => {
 
     expect(thumbnail.src).toContain('frame1');
     await act(() => {
-      jest.advanceTimersByTime(501);
+      timers.advanceTimersByTime(501);
     });
     expect(thumbnail.src).toContain('frame2');
   });

package/flow-report/test/flow-report-pptr-test.ts

@@ -4,14 +4,11 @@
  * 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 {jest} from '@jest/globals';
 import puppeteer, {Browser, Page} from 'puppeteer';
 
 import ReportGenerator from '../../report/generator/report-generator.js';
 import {flowResult} from './sample-flow';
 
-jest.setTimeout(35_000);
-
 describe('Lighthouse Flow Report', () => {
   console.log('\n✨ Be sure to have recently run this: yarn build-report');
 
@@ -19,7 +16,7 @@ describe('Lighthouse Flow Report', () => {
   let page: Page;
   const pageErrors: Error[] = [];
 
-  beforeAll(async () => {
+  before(async () => {
     browser = await puppeteer.launch({
       headless: true,
     });
@@ -27,14 +24,14 @@ describe('Lighthouse Flow Report', () => {
     page.on('pageerror', pageError => pageErrors.push(pageError));
   });
 
-  afterAll(async () => {
+  after(async () => {
     if (pageErrors.length > 0) console.error(pageErrors);
 
     await browser.close();
   });
 
   describe('Renders the flow report', () => {
-    beforeAll(async () => {
+    before(async () => {
       const html = ReportGenerator.generateFlowReportHtml(flowResult);
       await page.setContent(html);
     });
@@ -43,4 +40,4 @@ describe('Lighthouse Flow Report', () => {
       expect(pageErrors).toHaveLength(0);
     });
   });
-});
+}).timeout(35_000);

package/flow-report/test/run-flow-report-tests.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+##
+# @license Copyright 2022 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.
+##
+
+set -eux
+
+ARGS=(
+  --testMatch='{flow-report/**/*-test.ts,flow-report/**/*-test.tsx}'
+  --require=flow-report/test/setup/env-setup.ts
+  --loader=@esbuild-kit/esm-loader
+  # util-test.tsx won't finish on its own because of an open MessagePort, so help it out.
+  # See https://github.com/jsdom/jsdom/issues/2448#issuecomment-802288244
+  --exit
+)
+
+yarn mocha ${ARGS[*]} "$@"

package/flow-report/test/setup/env-setup.ts

@@ -4,29 +4,49 @@
  * 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 {jest} from '@jest/globals';
+import fs from 'fs';
+import {MessageChannel} from 'worker_threads';
+
+import jestMock from 'jest-mock';
 import {JSDOM} from 'jsdom';
+import * as preact from 'preact';
 
-/**
- * The jest environment "jsdom" does not work when preact is combined with the report renderer.
- * This sets up our own environment with JSDOM globals.
- */
-beforeEach(() => {
-  const {window} = new JSDOM(undefined, {
-    url: 'file:///Users/example/report.html/',
-  });
-  global.window = window as any;
-  global.document = window.document;
-  global.location = window.location;
-  global.self = global.window;
-
-  // Use JSDOM types as necessary.
-  global.Blob = window.Blob;
-  global.HTMLInputElement = window.HTMLInputElement;
-
-  // Functions not implemented in JSDOM.
-  window.Element.prototype.scrollIntoView = jest.fn();
-  global.self.matchMedia = jest.fn<any, any>(() => ({
-    addListener: jest.fn(),
-  }));
-});
+import {LH_ROOT} from '../../../root.js';
+
+// These modules aren't imported correctly if these directories aren't defined to use ES modules.
+// Similar to this, which was resolved but their fix didn't work for us:
+// https://github.com/testing-library/preact-testing-library/issues/36#issuecomment-1136484478
+fs.writeFileSync(`${LH_ROOT}/node_modules/@testing-library/preact/dist/esm/package.json`,
+  '{"type": "module"}');
+fs.writeFileSync(`${LH_ROOT}/node_modules/@testing-library/preact-hooks/src/package.json`,
+  '{"type": "module"}');
+
+// @ts-expect-error
+global.React = preact;
+
+export default {
+  mochaHooks: {
+    beforeEach() {
+      const {window} = new JSDOM(undefined, {
+        url: 'file:///Users/example/report.html/',
+      });
+      global.window = window as any;
+      global.document = window.document;
+      global.location = window.location;
+      global.self = global.window;
+
+      // Use JSDOM types as necessary.
+      global.Blob = window.Blob;
+      global.HTMLInputElement = window.HTMLInputElement;
+
+      // Functions not implemented in JSDOM.
+      window.Element.prototype.scrollIntoView = jestMock.fn();
+      global.self.matchMedia = jestMock.fn<any, any>(() => ({
+        addListener: jestMock.fn(),
+      }));
+
+      // @ts-expect-error: for @testing-library/preact-hooks
+      global.MessageChannel = MessageChannel;
+    },
+  },
+};

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

@@ -12,7 +12,6 @@ import {SidebarHeader, SidebarRuntimeSettings, SidebarSummary} from '../../src/s
 import {FlowResultContext} from '../../src/util';
 import {flowResult} from '../sample-flow';
 
-
 let wrapper: FunctionComponent;
 
 beforeEach(() => {

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

@@ -4,7 +4,7 @@
  * 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 {jest} from '@jest/globals';
+import jestMock from 'jest-mock';
 import {FunctionComponent} from 'preact';
 import {act, render} from '@testing-library/preact';
 
@@ -12,7 +12,7 @@ import {FlowResultContext, OptionsContext} from '../src/util';
 import {I18nProvider} from '../src/i18n/i18n';
 import {Topbar, saveHtml} from '../src/topbar';
 
-const mockSaveFile = jest.fn();
+const mockSaveFile = jestMock.fn();
 const defaultSaveFile = saveHtml.saveFile;
 
 const flowResult = {
@@ -27,7 +27,7 @@ const flowResult = {
 let wrapper: FunctionComponent;
 let options: LH.FlowReportOptions;
 
-beforeEach(() => {
+before(() => {
   mockSaveFile.mockReset();
   options = {};
   wrapper = ({children}) => (
@@ -41,7 +41,7 @@ beforeEach(() => {
   );
 });
 
-afterEach(() => {
+after(() => {
   saveHtml.saveFile = defaultSaveFile;
 });
 
@@ -60,7 +60,7 @@ it('save button opens save dialog for HTML file', async () => {
 });
 
 it('provides save as gist option if defined', async () => {
-  const saveAsGist = jest.fn();
+  const saveAsGist = jestMock.fn();
   options = {saveAsGist};
   const root = render(<Topbar onMenuClick={() => {}}/>, {wrapper});
 

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

@@ -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.
  */
 
-import {jest} from '@jest/globals';
+import jestMock from 'jest-mock';
 import {render} from '@testing-library/preact';
-import {renderHook} from '@testing-library/preact-hooks';
+import {renderHook} from '@testing-library/preact-hooks/src/index';
 import {FunctionComponent} from 'preact';
 import {act} from 'preact/test-utils';
 
@@ -16,7 +16,7 @@ import {flowResult} from './sample-flow';
 let wrapper: FunctionComponent;
 
 beforeEach(() => {
-  global.console.warn = jest.fn();
+  global.console.warn = jestMock.fn();
   wrapper = ({children}) => (
     <FlowResultContext.Provider value={flowResult}>{children}</FlowResultContext.Provider>
   );

package/flow-report/tsconfig.json

@@ -4,7 +4,7 @@
     // Limit to base JS and DOM defs.
     "lib": ["es2020", "dom", "dom.iterable"],
     // Selectively include types from node_modules/.
-    "types": ["node", "jest"],
+    "types": ["node", "mocha"],
 
     "jsx": "react-jsx",
     "jsxImportSource": "preact",
@@ -19,5 +19,8 @@
     "**/*.ts",
     "**/*.tsx",
     "./types",
+    "../types/test.d.ts",
+    "../root.js",
+    "../lighthouse-core/test/test-env/fake-timers.js",
   ],
 }