lighthouse 9.6.7 → 10.0.0

package/lighthouse-core/config/desktop-config.js

@@ -1,21 +0,0 @@
-/**
- * @license Copyright 2020 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 constants = require('./constants.js');
-
-/** @type {LH.Config.Json} */
-const config = {
-  extends: 'lighthouse:default',
-  settings: {
-    formFactor: 'desktop',
-    throttling: constants.throttling.desktopDense4G,
-    screenEmulation: constants.screenEmulationMetrics.desktop,
-    emulatedUserAgent: constants.userAgents.desktop,
-  },
-};
-
-module.exports = config;

package/lighthouse-core/config/experimental-config.js

@@ -1,30 +0,0 @@
-/**
- * @license Copyright 2020 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';
-
-/**
- * @fileoverview Config for new audits that aren't quite ready for
- * being enabled by default.
- */
-
-/** @type {LH.Config.Json} */
-const config = {
-  extends: 'lighthouse:default',
-  audits: [
-    'autocomplete',
-  ],
-  categories: {
-    // @ts-ignore: `title` is required in CategoryJson. setting to the same value as the default
-    // config is awkward - easier to omit the property here. Will defer to default config.
-    'best-practices': {
-      auditRefs: [
-        {id: 'autocomplete', weight: 0, group: 'best-practices-ux'},
-      ],
-    },
-  },
-};
-
-module.exports = config;

package/lighthouse-core/config/full-config.js

@@ -1,14 +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';
-
-/** @type {LH.Config.Json} */
-const fullConfig = {
-  extends: 'lighthouse:default',
-  settings: {},
-};
-
-module.exports = fullConfig;

package/lighthouse-core/config/lr-desktop-config.js

@@ -1,25 +0,0 @@
-/**
- * @license Copyright 2018 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 constants = require('./constants.js');
-
-/** @type {LH.Config.Json} */
-const config = {
-  extends: 'lighthouse:default',
-  settings: {
-    maxWaitForFcp: 15 * 1000,
-    maxWaitForLoad: 35 * 1000,
-    formFactor: 'desktop',
-    throttling: constants.throttling.desktopDense4G,
-    screenEmulation: constants.screenEmulationMetrics.desktop,
-    emulatedUserAgent: constants.userAgents.desktop,
-    // Skip the h2 audit so it doesn't lie to us. See https://github.com/GoogleChrome/lighthouse/issues/6539
-    skipAudits: ['uses-http2'],
-  },
-};
-
-module.exports = config;

package/lighthouse-core/config/lr-mobile-config.js

@@ -1,31 +0,0 @@
-/**
- * @license Copyright 2018 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';
-
-/** @type {LH.Config.Json} */
-const config = {
-  extends: 'lighthouse:default',
-  settings: {
-    maxWaitForFcp: 15 * 1000,
-    maxWaitForLoad: 35 * 1000,
-    // lighthouse:default is mobile by default
-    // Skip the h2 audit so it doesn't lie to us. See https://github.com/GoogleChrome/lighthouse/issues/6539
-    skipAudits: ['uses-http2'],
-  },
-  audits: [
-    'metrics/first-contentful-paint-3g',
-  ],
-  categories: {
-    // TODO(bckenny): type extended Config where e.g. category.title isn't required
-    performance: /** @type {LH.Config.CategoryJson} */({
-      auditRefs: [
-        {id: 'first-contentful-paint-3g', weight: 0},
-      ],
-    }),
-  },
-};
-
-module.exports = config;

package/lighthouse-core/config/metrics-to-audits.js

@@ -1,61 +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';
-
-// go/lh-audit-metric-mapping
-const fcpRelevantAudits = [
-  'server-response-time',
-  'render-blocking-resources',
-  'redirects',
-  'critical-request-chains',
-  'uses-text-compression',
-  'uses-rel-preconnect',
-  'uses-rel-preload',
-  'font-display',
-  'unminified-javascript',
-  'unminified-css',
-  'unused-css-rules',
-];
-
-const lcpRelevantAudits = [
-  ...fcpRelevantAudits,
-  'largest-contentful-paint-element',
-  'preload-lcp-image',
-  'unused-javascript',
-  'efficient-animated-content',
-  'total-byte-weight',
-];
-
-const tbtRelevantAudits = [
-  'long-tasks',
-  'third-party-summary',
-  'third-party-facades',
-  'bootup-time',
-  'mainthread-work-breakdown',
-  'dom-size',
-  'duplicated-javascript',
-  'legacy-javascript',
-  'viewport',
-];
-
-const clsRelevantAudits = [
-  'layout-shift-elements',
-  'non-composited-animations',
-  'unsized-images',
-  // 'preload-fonts', // actually in BP, rather than perf
-];
-
-const inpRelevantAudits = [
-  'work-during-interaction',
-];
-
-module.exports = {
-  fcpRelevantAudits,
-  lcpRelevantAudits,
-  tbtRelevantAudits,
-  clsRelevantAudits,
-  inpRelevantAudits,
-};

package/lighthouse-core/config/perf-config.js

@@ -1,17 +0,0 @@
-/**
- * @license Copyright 2018 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';
-
-/** @type {LH.Config.Json} */
-const perfConfig = {
-  extends: 'lighthouse:default',
-  settings: {
-    throttlingMethod: 'devtools',
-    onlyCategories: ['performance'],
-  },
-};
-
-module.exports = perfConfig;

package/lighthouse-core/fraggle-rock/api.js

@@ -1,77 +0,0 @@
-/**
- * @license Copyright 2020 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 {UserFlow, auditGatherSteps} = require('./user-flow.js');
-const {snapshotGather} = require('./gather/snapshot-runner.js');
-const {startTimespanGather} = require('./gather/timespan-runner.js');
-const {navigationGather} = require('./gather/navigation-runner.js');
-const {generateFlowReportHtml} = require('../../report/generator/report-generator.js');
-const Runner = require('../runner.js');
-
-/**
- * @param {import('puppeteer').Page} page
- * @param {ConstructorParameters<LH.UserFlow>[1]} [options]
- */
-async function startFlow(page, options) {
-  return new UserFlow(page, options);
-}
-
-/**
- * @param  {Parameters<navigationGather>} params
- * @return {Promise<LH.RunnerResult|undefined>}
- */
-async function navigation(...params) {
-  const gatherResult = await navigationGather(...params);
-  return Runner.audit(gatherResult.artifacts, gatherResult.runnerOptions);
-}
-
-/**
- * @param  {Parameters<snapshotGather>} params
- * @return {Promise<LH.RunnerResult|undefined>}
- */
-async function snapshot(...params) {
-  const gatherResult = await snapshotGather(...params);
-  return Runner.audit(gatherResult.artifacts, gatherResult.runnerOptions);
-}
-
-/**
- * @param  {Parameters<startTimespanGather>} params
- * @return {Promise<{endTimespan: () => Promise<LH.RunnerResult|undefined>}>}
- */
-async function startTimespan(...params) {
-  const {endTimespanGather} = await startTimespanGather(...params);
-  const endTimespan = async () => {
-    const gatherResult = await endTimespanGather();
-    return Runner.audit(gatherResult.artifacts, gatherResult.runnerOptions);
-  };
-  return {endTimespan};
-}
-
-/**
- * @param {LH.FlowResult} flowResult
- */
-async function generateFlowReport(flowResult) {
-  return generateFlowReportHtml(flowResult);
-}
-
-/**
- * @param {LH.UserFlow.FlowArtifacts} flowArtifacts
- * @param {LH.Config.Json} [config]
- */
-async function auditFlowArtifacts(flowArtifacts, config) {
-  const {gatherSteps, name} = flowArtifacts;
-  return await auditGatherSteps(gatherSteps, {name, config});
-}
-
-module.exports = {
-  snapshot,
-  startTimespan,
-  navigation,
-  startFlow,
-  generateFlowReport,
-  auditFlowArtifacts,
-};

package/lighthouse-core/fraggle-rock/config/config.js

@@ -1,281 +0,0 @@
-/**
- * @license Copyright 2020 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 path = require('path');
-const log = require('lighthouse-logger');
-const Runner = require('../../runner.js');
-const defaultConfig = require('./default-config.js');
-const {defaultNavigationConfig, nonSimulatedPassConfigOverrides} = require('../../config/constants.js'); // eslint-disable-line max-len
-const {
-  isFRGathererDefn,
-  throwInvalidDependencyOrder,
-  isValidArtifactDependency,
-  throwInvalidArtifactDependency,
-  assertArtifactTopologicalOrder,
-  assertValidConfig,
-} = require('./validation.js');
-const {filterConfigByGatherMode, filterConfigByExplicitFilters} = require('./filters.js');
-const {
-  deepCloneConfigJson,
-  resolveSettings,
-  resolveAuditsToDefns,
-  resolveGathererToDefn,
-  mergePlugins,
-  mergeConfigFragment,
-  mergeConfigFragmentArrayByKey,
-} = require('../../config/config-helpers.js');
-const defaultConfigPath = path.join(__dirname, './default-config.js');
-
-/** @typedef {LH.Config.FRContext & {gatherMode: LH.Gatherer.GatherMode}} ConfigContext */
-
-/**
- * @param {LH.Config.Json|undefined} configJSON
- * @param {{configPath?: string}} context
- * @return {{configWorkingCopy: LH.Config.Json, configDir?: string, configPath?: string}}
- */
-function resolveWorkingCopy(configJSON, context) {
-  let {configPath} = context;
-
-  if (configPath && !path.isAbsolute(configPath)) {
-    throw new Error('configPath must be an absolute path');
-  }
-
-  if (!configJSON) {
-    configJSON = defaultConfig;
-    configPath = defaultConfigPath;
-  }
-
-  // The directory of the config path, if one was provided.
-  const configDir = configPath ? path.dirname(configPath) : undefined;
-
-  return {
-    configWorkingCopy: deepCloneConfigJson(configJSON),
-    configPath,
-    configDir,
-  };
-}
-
-/**
- * @param {LH.Config.Json} configJSON
- * @return {LH.Config.Json}
- */
-function resolveExtensions(configJSON) {
-  if (!configJSON.extends) return configJSON;
-
-  if (configJSON.extends !== 'lighthouse:default') {
-    throw new Error('`lighthouse:default` is the only valid extension method.');
-  }
-
-  const {artifacts, navigations, ...extensionJSON} = configJSON;
-  const defaultClone = deepCloneConfigJson(defaultConfig);
-  const mergedConfig = mergeConfigFragment(defaultClone, extensionJSON);
-
-  mergedConfig.artifacts = mergeConfigFragmentArrayByKey(
-    defaultClone.artifacts,
-    artifacts,
-    artifact => artifact.id
-  );
-  mergedConfig.navigations = mergeConfigFragmentArrayByKey(
-    defaultClone.navigations,
-    navigations,
-    navigation => navigation.id
-  );
-
-  return mergedConfig;
-}
-
-/**
- * Looks up the required artifact IDs for each dependency, throwing if no earlier artifact satisfies the dependency.
- *
- * @param {LH.Config.ArtifactJson} artifact
- * @param {LH.Config.AnyFRGathererDefn} gatherer
- * @param {Map<Symbol, LH.Config.AnyArtifactDefn>} artifactDefnsBySymbol
- * @return {LH.Config.AnyArtifactDefn['dependencies']}
- */
-function resolveArtifactDependencies(artifact, gatherer, artifactDefnsBySymbol) {
-  if (!('dependencies' in gatherer.instance.meta)) return undefined;
-
-  const dependencies = Object.entries(gatherer.instance.meta.dependencies).map(
-      ([dependencyName, artifactSymbol]) => {
-        const dependency = artifactDefnsBySymbol.get(artifactSymbol);
-
-        // Check that dependency was defined before us.
-        if (!dependency) throwInvalidDependencyOrder(artifact.id, dependencyName);
-
-        // Check that the phase relationship is OK too.
-        const validDependency = isValidArtifactDependency(gatherer, dependency.gatherer);
-        if (!validDependency) throwInvalidArtifactDependency(artifact.id, dependencyName);
-
-        return [dependencyName, {id: dependency.id}];
-      }
-  );
-
-  return Object.fromEntries(dependencies);
-}
-
-/**
- *
- * @param {LH.Config.ArtifactJson[]|null|undefined} artifacts
- * @param {string|undefined} configDir
- * @return {LH.Config.AnyArtifactDefn[] | null}
- */
-function resolveArtifactsToDefns(artifacts, configDir) {
-  if (!artifacts) return null;
-
-  const status = {msg: 'Resolve artifact definitions', id: 'lh:config:resolveArtifactsToDefns'};
-  log.time(status, 'verbose');
-
-  /** @type {Map<Symbol, LH.Config.AnyArtifactDefn>} */
-  const artifactDefnsBySymbol = new Map();
-
-  const coreGathererList = Runner.getGathererList();
-  const artifactDefns = artifacts.map(artifactJson => {
-    /** @type {LH.Config.GathererJson} */
-    // @ts-expect-error - remove when legacy runner path is removed.
-    const gathererJson = artifactJson.gatherer;
-
-    const gatherer = resolveGathererToDefn(gathererJson, coreGathererList, configDir);
-    if (!isFRGathererDefn(gatherer)) {
-      throw new Error(`${gatherer.instance.name} gatherer does not have a Fraggle Rock meta obj`);
-    }
-
-    /** @type {LH.Config.AnyArtifactDefn} */
-    // @ts-expect-error - Typescript can't validate the gatherer and dependencies match
-    // even though it knows that they're each valid on their own.
-    const artifact = {
-      id: artifactJson.id,
-      gatherer,
-      dependencies: resolveArtifactDependencies(artifactJson, gatherer, artifactDefnsBySymbol),
-    };
-
-    const symbol = artifact.gatherer.instance.meta.symbol;
-    if (symbol) artifactDefnsBySymbol.set(symbol, artifact);
-    return artifact;
-  });
-
-  log.timeEnd(status);
-  return artifactDefns;
-}
-
-/**
- * Overrides the settings that may not apply to the chosen gather mode.
- *
- * @param {LH.Config.Settings} settings
- * @param {ConfigContext} context
- */
-function overrideSettingsForGatherMode(settings, context) {
-  if (context.gatherMode === 'timespan') {
-    if (settings.throttlingMethod === 'simulate') {
-      settings.throttlingMethod = 'devtools';
-    }
-  }
-}
-
-/**
- * Overrides the quiet windows when throttlingMethod requires observation.
- *
- * @param {LH.Config.NavigationDefn} navigation
- * @param {LH.Config.Settings} settings
- */
-function overrideNavigationThrottlingWindows(navigation, settings) {
-  if (navigation.disableThrottling) return;
-  if (settings.throttlingMethod === 'simulate') return;
-
-  navigation.cpuQuietThresholdMs = Math.max(
-    navigation.cpuQuietThresholdMs || 0,
-    nonSimulatedPassConfigOverrides.cpuQuietThresholdMs
-  );
-  navigation.networkQuietThresholdMs = Math.max(
-    navigation.networkQuietThresholdMs || 0,
-    nonSimulatedPassConfigOverrides.networkQuietThresholdMs
-  );
-  navigation.pauseAfterFcpMs = Math.max(
-    navigation.pauseAfterFcpMs || 0,
-    nonSimulatedPassConfigOverrides.pauseAfterFcpMs
-  );
-  navigation.pauseAfterLoadMs = Math.max(
-    navigation.pauseAfterLoadMs || 0,
-    nonSimulatedPassConfigOverrides.pauseAfterLoadMs
-  );
-}
-
-/**
- *
- * @param {LH.Config.NavigationJson[]|null|undefined} navigations
- * @param {LH.Config.AnyArtifactDefn[]|null|undefined} artifactDefns
- * @param {LH.Config.Settings} settings
- * @return {LH.Config.NavigationDefn[] | null}
- */
-function resolveNavigationsToDefns(navigations, artifactDefns, settings) {
-  if (!navigations) return null;
-  if (!artifactDefns) throw new Error('Cannot use navigations without defining artifacts');
-
-  const status = {msg: 'Resolve navigation definitions', id: 'lh:config:resolveNavigationsToDefns'};
-  log.time(status, 'verbose');
-
-  const artifactsById = new Map(artifactDefns.map(defn => [defn.id, defn]));
-
-  const navigationDefns = navigations.map(navigation => {
-    const navigationWithDefaults = {...defaultNavigationConfig, ...navigation};
-    const navId = navigationWithDefaults.id;
-    const artifacts = navigationWithDefaults.artifacts.map(id => {
-      const artifact = artifactsById.get(id);
-      if (!artifact) throw new Error(`Unrecognized artifact "${id}" in navigation "${navId}"`);
-      return artifact;
-    });
-
-    const resolvedNavigation = {...navigationWithDefaults, artifacts};
-    overrideNavigationThrottlingWindows(resolvedNavigation, settings);
-    return resolvedNavigation;
-  });
-
-  assertArtifactTopologicalOrder(navigationDefns);
-
-  log.timeEnd(status);
-  return navigationDefns;
-}
-
-/**
- * @param {LH.Config.Json|undefined} configJSON
- * @param {ConfigContext} context
- * @return {{config: LH.Config.FRConfig, warnings: string[]}}
- */
-function initializeConfig(configJSON, context) {
-  const status = {msg: 'Initialize config', id: 'lh:config'};
-  log.time(status, 'verbose');
-
-  let {configWorkingCopy, configDir} = resolveWorkingCopy(configJSON, context); // eslint-disable-line prefer-const
-
-  configWorkingCopy = resolveExtensions(configWorkingCopy);
-  configWorkingCopy = mergePlugins(configWorkingCopy, configDir, context.settingsOverrides);
-
-  const settings = resolveSettings(configWorkingCopy.settings || {}, context.settingsOverrides);
-  overrideSettingsForGatherMode(settings, context);
-
-  const artifacts = resolveArtifactsToDefns(configWorkingCopy.artifacts, configDir);
-  const navigations = resolveNavigationsToDefns(configWorkingCopy.navigations, artifacts, settings);
-
-  /** @type {LH.Config.FRConfig} */
-  let config = {
-    artifacts,
-    navigations,
-    audits: resolveAuditsToDefns(configWorkingCopy.audits, configDir),
-    categories: configWorkingCopy.categories || null,
-    groups: configWorkingCopy.groups || null,
-    settings,
-  };
-
-  const {warnings} = assertValidConfig(config);
-
-  config = filterConfigByGatherMode(config, context.gatherMode);
-  config = filterConfigByExplicitFilters(config, settings);
-
-  log.timeEnd(status);
-  return {config, warnings};
-}
-
-module.exports = {resolveWorkingCopy, initializeConfig};