Add stopAsFailure

lib/core/engine/command/measure.js

@@ -372,6 +372,21 @@ export class Measure {
     }
   }
 
+  /**
+   * Stop the current measurement and mark it as a failure. This stop function will not measure anything on a page. This is useful if you need to stop a measurement in a (try) catch and you
+   * know something has failed.
+   *
+   * @async
+   * @param {string} failureMessage - The message about the failure. This will end up on the HTML report for sitespeed.io so give it a good message so you know what's gone wrong.
+   *  @param {string} optionalURL - The URL of the page that you wanted to test. If you don't know the URL (you clicked on a link etc) skip it.
+   * @returns {Promise} A promise that resolves when the stop process has completed.
+   * @since 21.2.0
+   */
+  async stopAsFailure(failureMessage, optionalURL) {
+    this.areWeMeasuring = false;
+    this._failure(failureMessage);
+    return this.stop(optionalURL, false);
+  }
   /**
    * Stops the measurement process, collects metrics, and handles any post-measurement tasks.
    * It finalizes the URL being tested, manages any URL-specific metadata, stops any ongoing video recordings,
@@ -382,7 +397,7 @@ export class Measure {
    * @throws {Error} Throws an error if there are issues in stopping the measurement or collecting data.
    * @returns {Promise} A promise that resolves with the collected metrics data.
    */
-  async stop(testedStartUrl) {
+  async stop(testedStartUrl, collectMeasurements = true) {
     log.debug('Stop measuring');
     // If we don't have a URL (tested using clicking on link etc) get the URL from the browser
     let url =
@@ -448,7 +463,7 @@ export class Measure {
       await this.tcpDump.stop();
     }
 
-    return this.collect(url);
+    return collectMeasurements === false ? undefined : this.collect(url);
   }
 
   /**

types/core/engine/command/measure.d.ts

@@ -155,6 +155,17 @@ export class Measure {
      * @returns {Promise<void>} A promise that resolves when the start process is complete, or rejects if there are errors.
      */
     start(urlOrAlias: string, optionalAlias?: string): Promise<void>;
+    /**
+     * Stop the current measurement and mark it as a failure. This stop function will not measure anything on a page. This is useful if you need to stop a measurement in a (try) catch and you
+     * know something has failed.
+     *
+     * @async
+     * @param {string} failureMessage - The message about the failure. This will end up on the HTML report for sitespeed.io so give it a good message so you know what's gone wrong.
+     *  @param {string} optionalURL - The URL of the page that you wanted to test. If you don't know the URL (you clicked on a link etc) skip it.
+     * @returns {Promise} A promise that resolves when the stop process has completed.
+     * @since 21.2.0
+     */
+    stopAsFailure(failureMessage: string, optionalURL: string): Promise<any>;
     /**
      * Stops the measurement process, collects metrics, and handles any post-measurement tasks.
      * It finalizes the URL being tested, manages any URL-specific metadata, stops any ongoing video recordings,
@@ -165,7 +176,7 @@ export class Measure {
      * @throws {Error} Throws an error if there are issues in stopping the measurement or collecting data.
      * @returns {Promise} A promise that resolves with the collected metrics data.
      */
-    stop(testedStartUrl: string): Promise<any>;
+    stop(testedStartUrl: string, collectMeasurements?: boolean): Promise<any>;
     /**
      * Adds a custom metric to the current measurement result.
      * This method should be called after a measurement has started and before it has stopped.