lighthouse 9.5.0-dev.20221020 → 9.5.0-dev.20221022

package/core/user-flow.js

@@ -11,6 +11,7 @@ import {navigationGather} from './gather/navigation-runner.js';
 import {Runner} from './runner.js';
 import {initializeConfig} from './config/config.js';
 import {getFormatted} from '../shared/localization/format.js';
+import {mergeConfigFragment, deepClone} from './config/config-helpers.js';
 import * as i18n from './lib/i18n/i18n.js';
 
 /** @typedef {WeakMap<LH.UserFlow.GatherStep, LH.Gatherer.FRGatherResult['runnerOptions']>} GatherStepRunnerOptions */
@@ -67,30 +68,39 @@ class UserFlow {
   }
 
   /**
-   * @param {LH.UserFlow.StepFlags} [flags]
+   * @param {LH.UserFlow.StepFlags|undefined} flags
+   * @return {LH.UserFlow.StepFlags|undefined}
+   */
+  _getNextFlags(flags) {
+    const clonedFlowFlags = this._options?.flags && deepClone(this._options?.flags);
+    if (!flags) return clonedFlowFlags;
+    return mergeConfigFragment(clonedFlowFlags || {}, flags, true);
+  }
+
+  /**
+   * @param {LH.UserFlow.StepFlags|undefined} flags
    * @return {LH.UserFlow.StepFlags}
    */
   _getNextNavigationFlags(flags) {
-    const newStepFlags = {...flags};
+    const nextFlags = this._getNextFlags(flags) || {};
 
-    if (newStepFlags.skipAboutBlank === undefined) {
-      newStepFlags.skipAboutBlank = true;
+    if (nextFlags.skipAboutBlank === undefined) {
+      nextFlags.skipAboutBlank = true;
     }
 
     // On repeat navigations, we want to disable storage reset by default (i.e. it's not a cold load).
     const isSubsequentNavigation = this._gatherSteps
       .some(step => step.artifacts.GatherContext.gatherMode === 'navigation');
     if (isSubsequentNavigation) {
-      if (newStepFlags.disableStorageReset === undefined) {
-        newStepFlags.disableStorageReset = true;
+      if (nextFlags.disableStorageReset === undefined) {
+        nextFlags.disableStorageReset = true;
       }
     }
 
-    return newStepFlags;
+    return nextFlags;
   }
 
   /**
-   *
    * @param {LH.Gatherer.FRGatherResult} gatherResult
    * @param {LH.UserFlow.StepFlags} [flags]
    */
@@ -111,13 +121,13 @@ class UserFlow {
     if (this.currentTimespan) throw new Error('Timespan already in progress');
     if (this.currentNavigation) throw new Error('Navigation already in progress');
 
-    const newStepFlags = this._getNextNavigationFlags(flags);
+    const nextFlags = this._getNextNavigationFlags(flags);
     const gatherResult = await navigationGather(this._page, requestor, {
       config: this._options?.config,
-      flags: newStepFlags,
+      flags: nextFlags,
     });
 
-    this._addGatherStep(gatherResult, newStepFlags);
+    this._addGatherStep(gatherResult, nextFlags);
   }
 
   /**
@@ -179,11 +189,13 @@ class UserFlow {
     if (this.currentTimespan) throw new Error('Timespan already in progress');
     if (this.currentNavigation) throw new Error('Navigation already in progress');
 
+    const nextFlags = this._getNextFlags(flags);
+
     const timespan = await startTimespanGather(this._page, {
       config: this._options?.config,
-      flags: flags,
+      flags: nextFlags,
     });
-    this.currentTimespan = {timespan, flags};
+    this.currentTimespan = {timespan, flags: nextFlags};
   }
 
   async endTimespan() {
@@ -204,12 +216,14 @@ class UserFlow {
     if (this.currentTimespan) throw new Error('Timespan already in progress');
     if (this.currentNavigation) throw new Error('Navigation already in progress');
 
+    const nextFlags = this._getNextFlags(flags);
+
     const gatherResult = await snapshotGather(this._page, {
       config: this._options?.config,
-      flags: flags,
+      flags: nextFlags,
     });
 
-    this._addGatherStep(gatherResult, flags);
+    this._addGatherStep(gatherResult, nextFlags);
   }
 
   /**

package/flow-report/src/app.tsx

@@ -16,7 +16,7 @@ import {Header} from './header';
 import {I18nProvider} from './i18n/i18n';
 import {Styles} from './wrappers/styles';
 
-function getAnchorElement(hashState: LH.FlowResult.HashState|null) {
+function getAnchorElement(hashState: LH.HashState|null) {
   if (!hashState || !hashState.anchor) return null;
   return document.getElementById(hashState.anchor);
 }

package/flow-report/src/header.tsx

@@ -29,7 +29,7 @@ const HeaderThumbnail: FunctionComponent<{
   );
 };
 
-export const Header: FunctionComponent<{hashState: LH.FlowResult.HashState}> =
+export const Header: FunctionComponent<{hashState: LH.HashState}> =
 ({hashState}) => {
   const flowResult = useFlowResult();
   const {index} = hashState;

package/flow-report/src/util.ts

@@ -97,7 +97,7 @@ function useHashParams(...params: string[]) {
   return paramValues;
 }
 
-function useHashState(): LH.FlowResult.HashState|null {
+function useHashState(): LH.HashState|null {
   const flowResult = useFlowResult();
   const [indexString, anchor] = useHashParams('index', 'anchor');
 

package/flow-report/src/wrappers/report.tsx

@@ -29,7 +29,7 @@ function convertAnchor(link: HTMLAnchorElement, index: number) {
   link.replaceWith(newLink);
 }
 
-export const Report: FunctionComponent<{hashState: LH.FlowResult.HashState}> =
+export const Report: FunctionComponent<{hashState: LH.HashState}> =
 ({hashState}) => {
   const ref = useExternalRenderer<HTMLDivElement>(() => {
     return renderReport(hashState.currentLhr, {

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

@@ -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 FlowResult_ from '../../types/lhr/flow';
+import FlowResult_ from '../../types/lhr/flow-result';
 import * as Settings from '../../types/lhr/settings';
 
 // Import to augment querySelector/querySelectorAll with stricter type checking.
@@ -20,11 +20,18 @@ declare global {
   // Expose global types in LH namespace.
   module LH {
     export type ConfigSettings = Settings.ConfigSettings;
+
     export interface FlowReportOptions {
       getReportHtml?: (flowResult: FlowResult_) => string;
       saveAsGist?: (flowResult: FlowResult_) => void;
     }
 
+    export interface HashState {
+      currentLhr: Result;
+      index: number;
+      anchor: string|null;
+    }
+
     export import FlowResult = FlowResult_;
   }
 }

package/package.json

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

package/report/generator/report-generator.js

@@ -8,7 +8,7 @@
 import {reportAssets} from './report-assets.js';
 
 /** @typedef {import('../../types/lhr/lhr').default} LHResult */
-/** @typedef {import('../../types/lhr/flow').default} FlowResult */
+/** @typedef {import('../../types/lhr/flow-result').default} FlowResult */
 
 class ReportGenerator {
   /**

package/shared/types/shared.d.ts

@@ -6,10 +6,10 @@
 
 import {IcuMessage as IcuMessage_} from '../../types/lhr/i18n';
 import LHResult from '../../types/lhr/lhr';
-import FlowResult_ from '../../types/lhr/flow';
+import FlowResult_ from '../../types/lhr/flow-result';
 
 import {Locale as Locale_} from '../../types/lhr/settings';
- 
+
 declare global {
   // Expose global types in LH namespace.
   module LH {

package/types/global-lh.d.ts

@@ -16,7 +16,7 @@ import Gatherer_ from './gatherer';
 import * as I18n from './lhr/i18n';
 import {LighthouseError as LighthouseError_} from '../core/lib/lh-error.js';
 import LHResult from './lhr/lhr';
-import FlowResult_ from './lhr/flow';
+import FlowResult_ from './lhr/flow-result';
 import Protocol_ from './protocol';
 import * as Settings from './lhr/settings';
 import Treemap_ from './lhr/treemap';

package/types/lhr/{flow.d.ts → flow-result.d.ts}

@@ -8,15 +8,11 @@ import Result from './lhr';
 
 declare module FlowResult {
   interface Step {
+    /** Lighthouse report for this flow step. */
     lhr: Result;
+    /** Display name of this flow step. */
     name: string;
   }
-
-  interface HashState {
-    currentLhr: Result;
-    index: number;
-    anchor: string|null;
-  }
 }
 
 /**
@@ -25,7 +21,7 @@ declare module FlowResult {
 interface FlowResult {
   /** Ordered list of flow steps, each corresponding to a navigation, timespan, or snapshot. */
   steps: FlowResult.Step[];
-  /** Name given to this user flow. */
+  /** Display name of this user flow. */
   name: string;
 }
 

package/types/user-flow.d.ts

@@ -7,11 +7,16 @@ declare module UserFlow {
   }
 
   export interface Options {
-    config: LH.Config.Json;
+    /** Config to use for each flow step. */
+    config?: LH.Config.Json;
+    /** Base flags to use for each flow step. Step specific flags will override these flags. */
+    flags?: LH.Flags;
+    /** Display name for this user flow. */
     name?: string;
   }
 
   export interface StepFlags extends LH.Flags {
+    /** Display name for this flow step. */
     name?: string;
   }
 
@@ -21,6 +26,6 @@ declare module UserFlow {
   }
 }
 
-type UserFlow = typeof UserFlow_;
+type UserFlow = InstanceType<typeof UserFlow_>;
 
 export default UserFlow;