feat: add ability to stream logs (#1111)

* feat: extract common code to helper

* feat: use functions from helper

* feat: create base pw-test command

* feat: add pw-test command features

* feat: use separator -- for flags

* fix: test

* feat: allow using different package managers

* feat: add tests

* fix: throw error if property is not array

* wip

* wip

* feat: add log streaming

* wip

* wip

* feat: improve log streaming

* fix: timestamp parsing

* fix: remove unused imports

* fix: pr comments

Author: ferrandiaz

packages/cli/src/commands/pw-test.ts

@@ -83,6 +83,10 @@ export default class PwTestCommand extends AuthCommand {
       description: 'Create a Checkly check from the Playwright test.',
       default: false,
     }),
+    'stream-logs': Flags.boolean({
+      description: 'Stream logs from the test run to the console.',
+      default: false,
+    }),
   }
 
   async run (): Promise<void> {
@@ -103,6 +107,7 @@ export default class PwTestCommand extends AuthCommand {
       record,
       'test-session-name': testSessionName,
       'create-check': createCheck,
+      'stream-logs': streamLogs,
     } = flags
     const { configDirectory, configFilenames } = splitConfigFilePath(configFilename)
     const {
@@ -127,6 +132,7 @@ export default class PwTestCommand extends AuthCommand {
       runLocation: runLocation as keyof Region,
       privateRunLocation,
     }, api, config.getAccountId())
+
     const reporterTypes = prepareReportersTypes(reporterFlag as ReporterType, checklyConfig.cli?.reporters)
     const account = this.account
     const { data: availableRuntimes } = await api.runtimes.getAll()
@@ -236,6 +242,7 @@ export default class PwTestCommand extends AuthCommand {
       configDirectory,
       // TODO: ADD PROPER RETRY STRATEGY HANDLING
       null, // testRetryStrategy
+      streamLogs,
     )
 
     runner.on(Events.RUN_STARTED,
@@ -287,6 +294,9 @@ export default class PwTestCommand extends AuthCommand {
       reporters.forEach(r => r.onError(err))
       process.exitCode = 1
     })
+    runner.on(Events.STREAM_LOGS, (check: any, sequenceId: SequenceId, logs) => {
+      reporters.forEach(r => r.onStreamLogs(check, sequenceId, logs))
+    })
     await runner.run()
   }
 

packages/cli/src/reporters/abstract-list.ts

@@ -1,5 +1,6 @@
 import chalk from 'chalk'
 import indentString from 'indent-string'
+import { DateTime } from 'luxon'
 
 import { TestResultsShortLinks } from '../rest/test-sessions'
 import { Reporter } from './reporter'
@@ -20,6 +21,7 @@ export type checkFilesMap = Map<string | undefined, Map<SequenceId, {
   testResultId?: string
   links?: TestResultsShortLinks
   numRetries: number
+  hasStreamedLogs?: boolean
 }>>
 
 export default abstract class AbstractListReporter implements Reporter {
@@ -101,6 +103,37 @@ export default abstract class AbstractListReporter implements Reporter {
     printLn(chalk.red('Unable to run checks: ') + err.message)
   }
 
+  onStreamLogs (check: any, sequenceId: SequenceId, logs: Array<{ timestamp: number, message: string }> | undefined) {
+    const checkFile = this.checkFilesMap!.get(check.getSourceFile?.())!.get(sequenceId)!
+    const logList = logs || []
+
+    // Display the check title if this is the first time we're streaming logs for this check
+    const isFirstLogBatch = !checkFile.hasStreamedLogs
+    checkFile.hasStreamedLogs = true
+    if (isFirstLogBatch) {
+      // For Playwright tests, we need to create a better display name
+      const displayCheck = {
+        ...check,
+        sourceFile: check.getSourceFile?.() || 'Playwright Test',
+        name: check.name || check.logicalId || 'Unknown Test',
+      }
+      printLn(formatCheckTitle(CheckStatus.RUNNING, displayCheck, { includeSourceFile: true }))
+    }
+
+    // Format and display each log with proper indentation and timestamp handling
+    logList.forEach(logEntry => {
+      // Format timestamp from Unix timestamp to HH:mm:ss.SSS format
+      const timestamp = DateTime.fromMillis(logEntry.timestamp).toFormat('HH:mm:ss.SSS')
+      // Handle logs that contain newlines by splitting and prefixing each line with timestamp
+      const messageLines = logEntry.message.split('\n')
+      messageLines.forEach(line => {
+        // Each line gets its own timestamp for clarity
+        const formattedLine = `[${timestamp}] ${line}`
+        printLn(indentString(formattedLine, 4))
+      })
+    })
+  }
+
   // Clear the summary which was printed by _printStatus from stdout
   // TODO: Rather than clearing the whole status bar, we could overwrite the exact lines that changed.
   // This might look a bit smoother and reduce the flickering effects.

packages/cli/src/reporters/reporter.ts

@@ -14,6 +14,7 @@ export interface Reporter {
   onEnd(): void
   onError(err: Error): void
   onSchedulingDelayExceeded(): void
+  onStreamLogs(check: any, sequenceId: SequenceId, logs: Array<{ timestamp: number, message: string }>): void
 }
 
 export type ReporterType = 'list' | 'dot' | 'ci' | 'github' | 'json'

packages/cli/src/rest/test-sessions.ts

@@ -14,6 +14,7 @@ type RunTestSessionRequest = {
   repoInfo?: GitInformation | null
   environment?: string | null
   shouldRecord: boolean
+  streamLogs?: boolean
 }
 
 type TriggerTestSessionRequest = {

packages/cli/src/services/abstract-check-runner.ts

@@ -19,6 +19,7 @@ export enum Events {
   RUN_FINISHED = 'RUN_FINISHED',
   ERROR = 'ERROR',
   MAX_SCHEDULING_DELAY_EXCEEDED = 'MAX_SCHEDULING_DELAY_EXCEEDED',
+  STREAM_LOGS = 'STREAM_LOGS',
 }
 
 export type PrivateRunLocation = {
@@ -160,6 +161,9 @@ export default abstract class AbstractCheckRunner extends EventEmitter {
       this.disableTimeout(sequenceId)
       this.emit(Events.CHECK_FAILED, sequenceId, check, message)
       this.emit(Events.CHECK_FINISHED, check)
+    } else if (subtopic === 'stream-logs') {
+      const { logs } = message
+      this.emit(Events.STREAM_LOGS, check, sequenceId, logs)
     }
   }
 

packages/cli/src/services/test-runner.ts

@@ -20,6 +20,7 @@ export default class TestRunner extends AbstractCheckRunner {
   updateSnapshots: boolean
   baseDirectory: string
   testRetryStrategy: RetryStrategy | null
+  streamLogs: boolean
 
   constructor (
     accountId: string,
@@ -35,6 +36,7 @@ export default class TestRunner extends AbstractCheckRunner {
     updateSnapshots: boolean,
     baseDirectory: string,
     testRetryStrategy: RetryStrategy | null,
+    streamLogs?: boolean,
   ) {
     super(accountId, timeout, verbose)
     this.projectBundle = projectBundle
@@ -47,6 +49,7 @@ export default class TestRunner extends AbstractCheckRunner {
     this.updateSnapshots = updateSnapshots
     this.baseDirectory = baseDirectory
     this.testRetryStrategy = testRetryStrategy
+    this.streamLogs = streamLogs ?? false
   }
 
   async scheduleChecks (
@@ -75,6 +78,7 @@ export default class TestRunner extends AbstractCheckRunner {
         filePath: check.getSourceFile(),
       }
     })
+
     if (!checkRunJobs.length) {
       throw new Error('Unable to find checks to run.')
     }
@@ -87,6 +91,7 @@ export default class TestRunner extends AbstractCheckRunner {
       repoInfo: this.repoInfo,
       environment: this.environment,
       shouldRecord: this.shouldRecord,
+      streamLogs: this.streamLogs,
     })
     const { testSessionId, sequenceIds } = data
     const checks = this.checkBundles.map(({ construct: check }) => {