lighthouse 9.5.0-dev.20220613 → 9.5.0-dev.20220614

package/lighthouse-core/fraggle-rock/user-flow.js

@@ -108,13 +108,64 @@ class UserFlow {
    */
   async navigate(requestor, stepOptions) {
     if (this.currentTimespan) throw new Error('Timespan already in progress');
+    if (this.currentNavigation) throw new Error('Navigation already in progress');
 
     const options = this._getNextNavigationOptions(stepOptions);
     const gatherResult = await navigationGather(requestor, options);
 
     this._addGatherStep(gatherResult, options);
+  }
+
+  /**
+   * This is an alternative to `navigate()` that can be used to analyze a navigation triggered by user interaction.
+   * For more on user triggered navigations, see https://github.com/GoogleChrome/lighthouse/blob/master/docs/user-flows.md#triggering-a-navigation-via-user-interactions.
+   *
+   * @param {StepOptions=} stepOptions
+   */
+  async startNavigation(stepOptions) {
+    /** @type {(value: () => void) => void} */
+    let completeSetup;
+    /** @type {(value: any) => void} */
+    let rejectDuringSetup;
+
+    // This promise will resolve once the setup is done
+    // and Lighthouse is waiting for a page navigation to be triggered.
+    const navigationSetupPromise = new Promise((resolve, reject) => {
+      completeSetup = resolve;
+      rejectDuringSetup = reject;
+    });
+
+    // The promise in this callback will not resolve until `continueNavigation` is invoked,
+    // because `continueNavigation` is passed along to `navigateSetupPromise`
+    // and extracted into `continueAndAwaitResult` below.
+    const navigationResultPromise = this.navigate(
+      () => new Promise(continueNavigation => completeSetup(continueNavigation)),
+      stepOptions
+    ).catch(err => {
+      if (this.currentNavigation) {
+        // If the navigation already started, re-throw the error so it is emitted when `navigationResultPromise` is awaited.
+        throw err;
+      } else {
+        // If the navigation has not started, reject the `navigationSetupPromise` so the error throws when it is awaited in `startNavigation`.
+        rejectDuringSetup(err);
+      }
+    });
+
+    const continueNavigation = await navigationSetupPromise;
 
-    return gatherResult;
+    async function continueAndAwaitResult() {
+      continueNavigation();
+      await navigationResultPromise;
+    }
+
+    this.currentNavigation = {continueAndAwaitResult};
+  }
+
+  async endNavigation() {
+    if (this.currentTimespan) throw new Error('Timespan already in progress');
+    if (!this.currentNavigation) throw new Error('No navigation in progress');
+    await this.currentNavigation.continueAndAwaitResult();
+    this.currentNavigation = undefined;
   }
 
   /**
@@ -122,6 +173,7 @@ class UserFlow {
    */
   async startTimespan(stepOptions) {
     if (this.currentTimespan) throw new Error('Timespan already in progress');
+    if (this.currentNavigation) throw new Error('Navigation already in progress');
 
     const options = {...this.options, ...stepOptions};
     const timespan = await startTimespanGather(options);
@@ -130,14 +182,13 @@ class UserFlow {
 
   async endTimespan() {
     if (!this.currentTimespan) throw new Error('No timespan in progress');
+    if (this.currentNavigation) throw new Error('Navigation already in progress');
 
     const {timespan, options} = this.currentTimespan;
     const gatherResult = await timespan.endTimespanGather();
     this.currentTimespan = undefined;
 
     this._addGatherStep(gatherResult, options);
-
-    return gatherResult;
   }
 
   /**
@@ -145,13 +196,12 @@ class UserFlow {
    */
   async snapshot(stepOptions) {
     if (this.currentTimespan) throw new Error('Timespan already in progress');
+    if (this.currentNavigation) throw new Error('Navigation already in progress');
 
     const options = {...this.options, ...stepOptions};
     const gatherResult = await snapshotGather(options);
 
     this._addGatherStep(gatherResult, options);
-
-    return gatherResult;
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lighthouse",
-  "version": "9.5.0-dev.20220613",
+  "version": "9.5.0-dev.20220614",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./lighthouse-core/index.js",
   "bin": {