feat: add support for screenshot toggle

src/common_types.ts

@@ -114,13 +114,15 @@ export type PluginOutput = {
   metrics?: PerfMetrics;
 };
 
+export type ScreenshotOptions = 'on' | 'off' | 'only-on-failure';
+
 export type CliArgs = {
   capability?: Array<string>;
   config?: string;
   environment?: string;
   outfd?: number;
   headless?: boolean;
-  screenshots?: boolean;
+  screenshots?: ScreenshotOptions;
   ssblocks?: boolean;
   metrics?: boolean;
   filmstrips?: boolean;

src/core/runner.ts

@@ -107,7 +107,7 @@ interface Events {
     JourneyResult &
     PluginOutput & {
       journey: Journey;
-      ssblocks?: boolean;
+      options: RunOptions;
     };
   'journey:end:reported': unknown;
   'step:start': { journey: Journey; step: Step };
@@ -207,25 +207,29 @@ export default class Runner extends EventEmitter {
       data.error = error;
     } finally {
       data.url ??= driver.page.url();
-      if (screenshots) {
+      if (screenshots !== 'off') {
         await driver.page.waitForLoadState('load');
-        const buffer = await driver.page.screenshot({
-          type: 'jpeg',
-          quality: 80,
-        });
+        const buffer = await driver.page
+          .screenshot({
+            type: 'jpeg',
+            quality: 80,
+          })
+          .catch(() => {});
         /**
          * Write the screenshot image buffer with additional details (step
          * information) which could be extracted at the end of
          * each journey without impacting the step timing information
          */
-        const fileName = now().toString() + '.json';
-        writeFileSync(
-          join(this.screenshotPath, fileName),
-          JSON.stringify({
-            step,
-            data: buffer.toString('base64'),
-          })
-        );
+        if (buffer) {
+          const fileName = now().toString() + '.json';
+          writeFileSync(
+            join(this.screenshotPath, fileName),
+            JSON.stringify({
+              step,
+              data: buffer.toString('base64'),
+            })
+          );
+        }
       }
     }
     log(`Runner: end step (${step.name})`);
@@ -292,15 +296,15 @@ export default class Runner extends EventEmitter {
       params,
       start,
       end: monotonicTimeInSeconds(),
-      ssblocks: options.ssblocks,
+      options,
       ...pluginOutput,
       browserconsole: status == 'failed' ? pluginOutput.browserconsole : [],
     });
     /**
      * Wait for the all the reported events to be consumed aschronously
      * by reporter.
      */
-    if (options.reporter == 'json') {
+    if (options.reporter === 'json') {
       await once(this, 'journey:end:reported');
     }
   }

src/parse_args.ts

@@ -59,7 +59,12 @@ program
     '--capability <features...>',
     'Enable capabilities through feature flags'
   )
-  .option('--screenshots', 'take screenshot for each step')
+  .addOption(
+    new Option('--screenshots [flag]', 'take screenshots at end of each step')
+      .choices(['on', 'off', 'only-on-failure'])
+      .default('on')
+  )
+  .option('--screenshots [flag]', 'take screenshot for each step')
   .option('--network', 'capture network information for all journeys')
   .option(
     '--dry-run',
@@ -98,7 +103,7 @@ const options = command.opts() as CliArgs;
  */
 if (options.richEvents) {
   options.reporter = options.reporter ?? 'json';
-  options.screenshots = true;
+  options.screenshots = 'on';
   options.network = true;
 }
 

src/reporters/json.ts

@@ -415,42 +415,48 @@ export default class JSONReporter extends BaseReporter {
         metrics,
         status,
         error,
-        ssblocks,
+        options,
       }) => {
-        await gatherScreenshots(
-          join(CACHE_PATH, 'screenshots'),
-          async (step, data) => {
-            if (ssblocks) {
-              const { blob_mime, blocks, reference } =
-                await getScreenshotBlocks(Buffer.from(data, 'base64'));
-              for (let i = 0; i < blocks.length; i++) {
-                const block = blocks[i];
+        const { ssblocks, screenshots } = options;
+        const writeScreenshots =
+          screenshots === 'on' ||
+          (screenshots === 'only-on-failure' && status === 'failed');
+        if (writeScreenshots) {
+          await gatherScreenshots(
+            join(CACHE_PATH, 'screenshots'),
+            async (step, data) => {
+              if (ssblocks) {
+                const { blob_mime, blocks, reference } =
+                  await getScreenshotBlocks(Buffer.from(data, 'base64'));
+                for (let i = 0; i < blocks.length; i++) {
+                  const block = blocks[i];
+                  this.writeJSON({
+                    type: 'screenshot/block',
+                    _id: block.id,
+                    blob: block.blob,
+                    blob_mime,
+                  });
+                }
                 this.writeJSON({
-                  type: 'screenshot/block',
-                  _id: block.id,
-                  blob: block.blob,
-                  blob_mime,
+                  type: 'step/screenshot_ref',
+                  journey,
+                  step,
+                  root_fields: {
+                    screenshot_ref: reference,
+                  },
+                });
+              } else {
+                this.writeJSON({
+                  type: 'step/screenshot',
+                  journey,
+                  step,
+                  blob: data,
+                  blob_mime: 'image/jpeg',
                 });
               }
-              this.writeJSON({
-                type: 'step/screenshot_ref',
-                journey,
-                step,
-                root_fields: {
-                  screenshot_ref: reference,
-                },
-              });
-            } else {
-              this.writeJSON({
-                type: 'step/screenshot',
-                journey,
-                step,
-                blob: data,
-                blob_mime: 'image/jpeg',
-              });
             }
-          }
-        );
+          );
+        }
 
         if (networkinfo) {
           networkinfo.forEach(ni => {
@@ -504,7 +510,7 @@ export default class JSONReporter extends BaseReporter {
             status,
           },
         });
-        this.runner.emit('journey:end:reported', {});
+        process.nextTick(() => this.runner.emit('journey:end:reported', {}));
       }
     );
   }