fix: ensure journey/end is written to fd (#447)

* fix: ensure journey/end is written to fd

* add comment about test

Author: vigneshshanmugam

__tests__/core/logger.test.ts

@@ -690,4 +690,26 @@ describe('runner', () => {
     const collectOrder = events.map(event => event.type);
     expect(collectOrder).toEqual(realEventsOrder);
   });
+
+  /**
+   * TODO: Move this as part of integration test
+   * Its really hard to ensure the journey/end is called for a real world page
+   * without actually testing on a real world webpage.
+   */
+  it('run - ensure journey/end is written for real world pages', async () => {
+    const j1 = journey('journey1', async ({ page }) => {
+      step('load homepage', async () => {
+        await page.goto('https://www.elastic.co');
+      });
+    });
+    runner.addJourney(j1);
+    await runner.run({
+      reporter: 'json',
+      network: true,
+      trace: true,
+      outfd: fs.openSync(dest, 'w'),
+    });
+    const events = readAndCloseStreamJson().map(event => event.type);
+    expect(events[events.length - 1]).toBe('journey/end');
+  });
 });

__tests__/core/runner.test.ts

@@ -57,7 +57,6 @@ describe('base reporter', () => {
   });
 
   it('writes each step to the FD', async () => {
-    const { stream } = new BaseReporter(runner, { fd: fs.openSync(dest, 'w') });
     runner.emit('start', { numJourneys: 1 });
     runner.emit('journey:start', {
       journey: j1,

__tests__/reporters/base.test.ts

@@ -48,7 +48,7 @@
     "playwright-chromium": "=1.14.0",
     "sharp": "^0.29.3",
     "snakecase-keys": "^3.2.1",
-    "sonic-boom": "^2.1.0",
+    "sonic-boom": "^2.6.0",
     "source-map-support": "^0.5.19",
     "ts-node": "^10.2.1",
     "typescript": "^4.3.5"

package-lock.json

@@ -23,20 +23,9 @@
  *
  */
 
-import SonicBoom from 'sonic-boom';
 import { grey, cyan, dim, italic } from 'kleur/colors';
 import { now } from '../helpers';
 
-const defaultFd = process.stdout.fd;
-let logger = new SonicBoom({ fd: defaultFd, sync: true });
-
-export const setLogger = (fd: number) => {
-  if (fd && fd !== defaultFd) {
-    logger = new SonicBoom({ fd });
-  }
-  return logger;
-};
-
 export function log(msg) {
   if (!process.env.DEBUG || !msg) {
     return;
@@ -45,5 +34,5 @@ export function log(msg) {
     msg = JSON.stringify(msg);
   }
   const time = dim(cyan(`at ${parseInt(String(now()))} ms `));
-  logger.write(time + italic(grey(msg)) + '\n');
+  console.log(time + italic(grey(msg)) + '\n');
 }

package.json

@@ -25,7 +25,6 @@
 
 import { runner } from './core';
 import { RunOptions } from './core/runner';
-import { setLogger } from './core/logger';
 import sourceMapSupport from 'source-map-support';
 
 export async function run(options: RunOptions) {
@@ -35,11 +34,6 @@ export async function run(options: RunOptions) {
   sourceMapSupport.install({
     environment: 'node',
   });
-  /**
-   * set up logger with appropriate file descriptor
-   * to capture all the DEBUG logs when run through heartbeat
-   */
-  setLogger(options.outfd);
 
   try {
     return await runner.run(options);

src/core/logger.ts

@@ -64,7 +64,12 @@ export default class BaseReporter {
 
   constructor(public runner: Runner, options: ReporterOptions = {}) {
     this.fd = options.fd || process.stdout.fd;
-    this.stream = new SonicBoom({ fd: this.fd, sync: true });
+    /**
+     * minLength is set to 1 byte to make sure we flush the
+     * content even if its the last byte on the stream buffer
+     * before destroying the pipe with underlying file descriptor
+     */
+    this.stream = new SonicBoom({ fd: this.fd, sync: true, minLength: 1 });
     this._registerListeners();
     this.runner.on('end', () => this.stream.flush());
   }