fix: fix dry run for base reporter (#827)

Author: shahzad31

src/core/runner.ts

@@ -152,12 +152,12 @@ export default class Runner {
      * Set up the corresponding reporter and fallback
      * to default reporter if not provided
      */
-    const { reporter, outfd } = options;
+    const { reporter, outfd, dryRun } = options;
     const Reporter =
       typeof reporter === 'function'
         ? reporter
         : reporters[reporter] || reporters['default'];
-    this.#reporter = new Reporter({ fd: outfd });
+    this.#reporter = new Reporter({ fd: outfd, dryRun });
   }
 
   async runBeforeAllHook(args: HooksArgs) {

src/reporters/base.ts

@@ -66,14 +66,17 @@ function renderDuration(durationMs) {
 export default class BaseReporter implements Reporter {
   stream: SonicBoom;
   fd: number;
+  dryRun: boolean;
   metrics = {
     succeeded: 0,
     failed: 0,
     skipped: 0,
+    registered: 0,
   };
 
   constructor(options: ReporterOptions = {}) {
     this.fd = options.fd || process.stdout.fd;
+    this.dryRun = options.dryRun ?? false;
     /**
      * minLength is set to 1 byte to make sure we flush the
      * content even if its the last byte on the stream buffer
@@ -82,6 +85,11 @@ export default class BaseReporter implements Reporter {
     this.stream = new SonicBoom({ fd: this.fd, sync: true, minLength: 1 });
   }
 
+  onJourneyRegister(journey: Journey): void {
+    this.write(`\nJourney: ${journey.name}`);
+    this.metrics.registered++;
+  }
+
   onJourneyStart(journey: Journey, {}: JourneyStartResult) {
     this.write(`\nJourney: ${journey.name}`);
   }
@@ -110,9 +118,14 @@ export default class BaseReporter implements Reporter {
   }
 
   onEnd() {
-    const { failed, succeeded, skipped } = this.metrics;
+    const { failed, succeeded, skipped, registered } = this.metrics;
     const total = failed + succeeded + skipped;
 
+    if (this.dryRun) {
+      this.write(`\n${registered} journey(s) registered`);
+      return;
+    }
+
     let message = '\n';
     if (total === 0) {
       message = 'No tests found!';

src/reporters/index.ts

@@ -34,7 +34,11 @@ import {
   StepEndResult,
 } from '../common_types';
 
-export type ReporterOptions = { fd?: number; colors?: boolean };
+export type ReporterOptions = {
+  fd?: number;
+  colors?: boolean;
+  dryRun?: boolean;
+};
 export type BuiltInReporterName = 'default' | 'json' | 'junit';
 export type ReporterInstance = new (opts: ReporterOptions) => Reporter;
 export const reporters: {

src/reporters/json.ts

@@ -317,7 +317,7 @@ export default class JSONReporter extends BaseReporter {
     });
   }
 
-  onJourneyRegister(journey: Journey): void {
+  override onJourneyRegister(journey: Journey): void {
     this.writeJSON({
       type: 'journey/register',
       journey,