lighthouse 9.5.0-dev.20220828 → 9.5.0-dev.20220829

package/cli/test/smokehouse/config/exclusions.js

@@ -0,0 +1,31 @@
+/**
+ * @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.
+ */
+
+/**
+ * List of smoke tests excluded per runner. eg: 'cli': ['a11y', 'dbw']
+ * @type {Record<string, Array<string>>}
+ */
+const exclusions = {
+  'bundle': [],
+  'cli': [],
+  'devtools': [
+    // Disabled because normal Chrome usage makes DevTools not function on
+    // these poorly constructed pages
+    'errors-expired-ssl', 'errors-infinite-loop', 'dbw' /* dialog prompt */,
+    // Disabled because Chrome will follow the redirect first, and Lighthouse will
+    // only ever see/run the final URL.
+    'redirects-client-paint-server', 'redirects-multiple-server',
+    'redirects-single-server', 'redirects-single-client',
+    'redirects-history-push-state', 'redirects-scripts',
+    // Disabled because these tests use settings that cannot be fully configured in
+    // DevTools (e.g. throttling method "provided").
+    'metrics-tricky-tti', 'metrics-tricky-tti-late-fcp', 'screenshot',
+    // Disabled because of differences that need further investigation
+    'byte-efficiency', 'byte-gzip', 'perf-preload',
+  ],
+};
+
+export default exclusions;

package/cli/test/smokehouse/frontends/smokehouse-bin.js

@@ -24,6 +24,7 @@ import log from 'lighthouse-logger';
 import {runSmokehouse, getShardedDefinitions} from '../smokehouse.js';
 import {updateTestDefnFormat} from './back-compat-util.js';
 import {LH_ROOT} from '../../../../root.js';
+import exclusions from '../config/exclusions.js';
 
 const coreTestDefnsPath =
   path.join(LH_ROOT, 'cli/test/smokehouse/core-tests.js');
@@ -69,6 +70,7 @@ function getDefinitionsToRun(allTestDefns, requestedIds, {invertMatch}) {
   });
   if (unmatchedIds.length) {
     console.log(log.redify(`Smoketests not found for: ${unmatchedIds.join(' ')}`));
+    console.log(`Check test exclusions (${requestedIds.join(' ')})\n`);
     console.log(usage);
   }
 
@@ -193,8 +195,11 @@ async function begin() {
   const requestedTestIds = argv._;
   const {default: rawTestDefns} = await import(url.pathToFileURL(testDefnPath).href);
   const allTestDefns = updateTestDefnFormat(rawTestDefns);
+  const excludedTests = new Set(exclusions[argv.runner] || []);
+  const filteredTestDefns = allTestDefns.filter(test => !excludedTests.has(test.id));
   const invertMatch = argv.invertMatch;
-  const requestedTestDefns = getDefinitionsToRun(allTestDefns, requestedTestIds, {invertMatch});
+  const requestedTestDefns = getDefinitionsToRun(filteredTestDefns,
+    requestedTestIds, {invertMatch});
   const testDefns = getShardedDefinitions(requestedTestDefns, argv.shard);
 
   let smokehouseResult;

package/dist/report/bundle.esm.js

@@ -5773,6 +5773,16 @@ function swapLocale(lhr, requestedLocale) {
 function registerLocaleData(locale, lhlMessages) {
   // Stub function only included for types
 }
-const format = {registerLocaleData};
+
+/**
+ * Returns whether the requestedLocale is registered and available for use
+ * @param {LH.Locale} requestedLocale
+ * @return {boolean}
+ */
+function hasLocale(requestedLocale) {
+  // Stub function only included for types
+  return false;
+}
+const format = {registerLocaleData, hasLocale};
 
 export { DOM, ReportRenderer, ReportUIFeatures, format, renderReport, swapLocale };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lighthouse",
   "type": "module",
-  "version": "9.5.0-dev.20220828",
+  "version": "9.5.0-dev.20220829",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./core/index.js",
   "bin": {

package/report/test-assets/faux-psi-template.html

@@ -133,7 +133,7 @@ body {
 </head>
 <body >
   <noscript>PSI requires JavaScript. Please enable.</noscript>
-  <button type=button id="translate">→ Español</button>
+  <button type=button id="translate">rotate locale</button>
   <div class="page">
     <button type=button id="reanalyze">Reanalyze</button>
     <div class="tabset">

package/report/test-assets/faux-psi.js

@@ -13,77 +13,84 @@ const lighthouseRenderer = window['report'];
 
 const wait = (ms = 100) => new Promise(resolve => setTimeout(resolve, ms));
 
-
 (async function __initPsiReports__() {
-  renderLHReport();
-
   document.querySelector('button#reanalyze')?.addEventListener('click', () => {
-    renderLHReport();
+    __initPsiReports__();
   });
 
   document.querySelector('button#translate')?.addEventListener('click', async () => {
-    await swapLhrLocale('es');
-    renderLHReport();
+    const hash = location.hash.slice(1);
+    const someLocales = ['es', 'ja', 'ru', 'ar', 'en-US'];
+    // Just rotate to the next one
+    const nextLocale = someLocales[(someLocales.indexOf(hash) + 1) % someLocales.length];
+    location.hash = `#${nextLocale}`;
+    location.reload();
   });
-})();
 
-async function renderLHReport() {
-  // @ts-expect-error
-  const mobileLHR = window.__LIGHTHOUSE_JSON__;
-  const desktopLHR = JSON.parse(JSON.stringify(mobileLHR));
+  const hash = location.hash.slice(1);
+  if (hash) {
+    // @ts-expect-error Can't do string to LH.Locale
+    await swapLhrLocale(hash);
+  }
 
-  const lhrs = {
-    'mobile': mobileLHR,
-    'desktop': desktopLHR,
-  };
+  // We deliberately want the non-blocking await behavior w/ forEach
+  ['mobile', 'desktop'].forEach(async id => {
+    const container = document.querySelector(`section#${id} .reportContainer`);
+    if (!container) throw new Error('Unexpected DOM. Bailing.');
+    container.textContent = 'Analyzing…';
+    await wait(id === 'desktop' ? 3000 : 500);
 
-  for (const [tabId, lhr] of Object.entries(lhrs)) {
-    await distinguishLHR(lhr, tabId);
+    // @ts-expect-error
+    const lhr = JSON.parse(JSON.stringify(window.__LIGHTHOUSE_JSON__));
+    await distinguishLHR(lhr, id);
 
-    const container = document.querySelector(`section#${tabId} .reportContainer`);
-    if (!container) throw new Error('Unexpected DOM. Bailing.');
+    renderLHReport(lhr, container);
+  });
+})();
 
-    try {
-      container.textContent = 'Analyzing…';
-      await wait(500);
-      for (const el of container.childNodes) el.remove();
-
-      const reportRootEl = lighthouseRenderer.renderReport(lhr, {
-        omitTopbar: true,
-        disableFireworks: true,
-        disableDarkMode: true,
-      });
-      // TODO: display warnings if appropriate.
-      for (const el of reportRootEl.querySelectorAll('.lh-warnings--toplevel')) {
-        el.setAttribute('hidden', 'true');
-      }
-
-      // Move env block
-      const metaItemsEl = reportRootEl.querySelector('.lh-meta__items');
-      if (metaItemsEl) {
-        reportRootEl.querySelector('.lh-metrics-container')?.parentNode?.insertBefore(
-          metaItemsEl,
-          reportRootEl.querySelector('.lh-buttons')
-        );
-        reportRootEl.querySelector('.lh-metrics-container')?.closest('.lh-category')?.classList
-            .add('lh--hoisted-meta');
-      }
-
-      container.append(reportRootEl);
-
-      // Override some LH styles. (To find .lh-vars we must descend from reportRootEl's parent)
-      for (const el of container.querySelectorAll('article.lh-vars')) {
-        // Ensure these css var names are not stale.
-        el.style.setProperty('--report-content-max-width', '100%');
-        el.style.setProperty('--edge-gap-padding', '0');
-      }
-      for (const el of reportRootEl.querySelectorAll('footer.lh-footer')) {
-        el.style.display = 'none';
-      }
-    } catch (e) {
-      console.error(e);
-      container.textContent = 'Error: LHR failed to render.';
+/**
+ * @param {any} lhr
+ * @param {Element} container
+ */
+async function renderLHReport(lhr, container) {
+  try {
+    for (const el of container.childNodes) el.remove();
+
+    const reportRootEl = lighthouseRenderer.renderReport(lhr, {
+      omitTopbar: true,
+      disableFireworks: true,
+      disableDarkMode: true,
+    });
+    // TODO: display warnings if appropriate.
+    for (const el of reportRootEl.querySelectorAll('.lh-warnings--toplevel')) {
+      el.setAttribute('hidden', 'true');
     }
+
+    // Move env block
+    const metaItemsEl = reportRootEl.querySelector('.lh-meta__items');
+    if (metaItemsEl) {
+      reportRootEl.querySelector('.lh-metrics-container')?.parentNode?.insertBefore(
+        metaItemsEl,
+        reportRootEl.querySelector('.lh-buttons')
+      );
+      reportRootEl.querySelector('.lh-metrics-container')?.closest('.lh-category')?.classList
+          .add('lh--hoisted-meta');
+    }
+
+    container.append(reportRootEl);
+
+    // Override some LH styles. (To find .lh-vars we must descend from reportRootEl's parent)
+    for (const el of container.querySelectorAll('article.lh-vars')) {
+      // Ensure these css var names are not stale.
+      el.style.setProperty('--report-content-max-width', '100%');
+      el.style.setProperty('--edge-gap-padding', '0');
+    }
+    for (const el of reportRootEl.querySelectorAll('footer.lh-footer')) {
+      el.style.display = 'none';
+    }
+  } catch (e) {
+    console.error(e);
+    container.textContent = 'Error: LHR failed to render.';
   }
 }
 
@@ -91,13 +98,20 @@ async function renderLHReport() {
  * @param {LH.Locale} locale
  */
 async function swapLhrLocale(locale) {
-  const response = await fetch(`https://www.gstatic.com/pagespeed/insights/ui/locales/${locale}.json`);
-  /** @type {import('../../shared/localization/locales').LhlMessages} */
-  const lhlMessages = await response.json();
-  console.log(lhlMessages);
-  if (!lhlMessages) throw new Error(`could not fetch data for locale: ${locale}`);
-
-  lighthouseRenderer.format.registerLocaleData(locale, lhlMessages);
+  // @ts-expect-error LHR global
+  const lhrLocale = window.__LIGHTHOUSE_JSON__['configSettings']['locale'];
+
+  // Only fetch and swapLocale if necessary.
+  if (lhrLocale === locale) return;
+
+  if (!lighthouseRenderer.format.hasLocale(locale)) {
+    // Requires running a server in LH root and viewing localhost:XXXX/dist/sample-reports/⌣.psi.english/index.html
+    const response = await fetch(`/shared/localization/locales/${locale}.json`);
+    /** @type {import('../../shared/localization/locales').LhlMessages} */
+    const lhlMessages = await response.json();
+    if (!lhlMessages) throw new Error(`could not fetch data for locale: ${locale}`);
+    lighthouseRenderer.format.registerLocaleData(locale, lhlMessages);
+  }
   // @ts-expect-error LHR global
   window.__LIGHTHOUSE_JSON__ = lighthouseRenderer.swapLocale(window.__LIGHTHOUSE_JSON__, locale)
     .lhr;

package/shared/localization/format.js

@@ -381,7 +381,7 @@ function _getLocaleMessages(locale) {
 }
 
 /**
- * Returns whether the `requestedLocale` can be used.
+ * Returns whether the `requestedLocale` is registered and available for use
  * @param {LH.Locale} requestedLocale
  * @return {boolean}
  */