feat: adds degraded state to reporters [sc-00] (#1020)

Author: tnolet

packages/cli/src/reporters/__tests__/__snapshots__/util.spec.ts.snap

@@ -208,6 +208,8 @@ exports[`formatCheckResult() Browser Check result formats a Browser Check result
 
 exports[`formatCheckResult() Browser Check result formats a basic Browser Check result : browser-check-result-basic-format 1`] = `""`;
 
+exports[`formatCheckTitle() should print a degraded check title: degraded-check-title 1`] = `"⚠ /test/test-file.check.ts > Test Check (11s)"`;
+
 exports[`formatCheckTitle() should print a failed check title: failed-check-title 1`] = `"✖ /test/test-file.check.ts > Test Check (11s)"`;
 
 exports[`formatCheckTitle() should print a passed check title: passed-check-title 1`] = `"✔ /test/test-file.check.ts > Test Check (11s)"`;

packages/cli/src/reporters/__tests__/util.spec.ts

@@ -1,4 +1,4 @@
-import { formatCheckTitle, formatCheckResult, CheckStatus } from '../util'
+import { formatCheckTitle, formatCheckResult, CheckStatus, resultToCheckStatus } from '../util'
 import { simpleCheckFixture } from './fixtures/simple-check'
 import { apiCheckResult } from './fixtures/api-check-result'
 import { browserCheckResult } from './fixtures/browser-check-result'
@@ -23,6 +23,10 @@ describe('formatCheckTitle()', () => {
     expect(stripAnsi(formatCheckTitle(CheckStatus.SUCCESSFUL, simpleCheckFixture, { includeSourceFile: true })))
       .toMatchSnapshot('passed-check-title')
   })
+  it('should print a degraded check title', () => {
+    expect(stripAnsi(formatCheckTitle(CheckStatus.DEGRADED, simpleCheckFixture, { includeSourceFile: true })))
+      .toMatchSnapshot('degraded-check-title')
+  })
   it('should print a running check title', () => {
     expect(stripAnsi(formatCheckTitle(CheckStatus.RUNNING, simpleCheckFixture, { includeSourceFile: true })))
       .toMatchSnapshot('running-check-title')
@@ -85,3 +89,22 @@ describe('formatCheckResult()', () => {
     })
   })
 })
+
+describe('resultToCheckStatus()', () => {
+  it('returns a successful status', () => {
+    expect(resultToCheckStatus({ hasFailures: false, isDegraded: false, hasErrors: false }))
+      .toBe(CheckStatus.SUCCESSFUL)
+  })
+  it('returns a failed status', () => {
+    expect(resultToCheckStatus({ hasFailures: true, isDegraded: false, hasErrors: false }))
+      .toBe(CheckStatus.FAILED)
+  })
+  it('returns a failed status when also degraded', () => {
+    expect(resultToCheckStatus({ hasFailures: true, isDegraded: true, hasErrors: false }))
+      .toBe(CheckStatus.FAILED)
+  })
+  it('returns a degraded status', () => {
+    expect(resultToCheckStatus({ hasFailures: false, isDegraded: true, hasErrors: false }))
+      .toBe(CheckStatus.DEGRADED)
+  })
+})

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

@@ -3,8 +3,8 @@ import indentString from 'indent-string'
 
 import { TestResultsShortLinks } from '../rest/test-sessions'
 import { Reporter } from './reporter'
-import { CheckStatus, formatCheckTitle, getTestSessionUrl, printLn } from './util'
-import type { SequenceId, RunLocation } from '../services/abstract-check-runner'
+import { CheckStatus, formatCheckTitle, getTestSessionUrl, printLn, resultToCheckStatus } from './util'
+import type { RunLocation, SequenceId } from '../services/abstract-check-runner'
 import { Check } from '../constructs/check'
 import { testSessions } from '../rest/api'
 
@@ -86,7 +86,7 @@ export default abstract class AbstractListReporter implements Reporter {
     checkStatus.result = checkResult
     checkStatus.links = links
     checkStatus.testResultId = testResultId
-    checkStatus.checkStatus = checkResult.hasFailures ? CheckStatus.FAILED : CheckStatus.SUCCESSFUL
+    checkStatus.checkStatus = resultToCheckStatus(checkResult)
     checkStatus.titleString = formatCheckTitle(checkStatus.checkStatus, checkResult, {
       includeSourceFile: false,
     })
@@ -104,7 +104,7 @@ export default abstract class AbstractListReporter implements Reporter {
   }
 
   _printSummary (opts: { skipCheckCount?: boolean} = {}) {
-    const counts = { numFailed: 0, numPassed: 0, numRunning: 0, numRetrying: 0, scheduling: 0 }
+    const counts = { numFailed: 0, numPassed: 0, numDegraded: 0, numRunning: 0, numRetrying: 0, scheduling: 0 }
     const status = []
     if (this.checkFilesMap!.size === 1 && this.checkFilesMap!.has(undefined)) {
       status.push(chalk.bold('Summary:'))
@@ -120,6 +120,8 @@ export default abstract class AbstractListReporter implements Reporter {
           counts.numRunning++
         } else if (result.hasFailures) {
           counts.numFailed++
+        } else if (result.isDegraded) {
+          counts.numDegraded++
         } else {
           counts.numPassed++
         }
@@ -134,6 +136,7 @@ export default abstract class AbstractListReporter implements Reporter {
         counts.numRunning ? chalk.bold.magenta(`${counts.numRunning} running`) : undefined,
         counts.numRetrying ? chalk.bold(`${counts.numRetrying} retrying`) : undefined,
         counts.numFailed ? chalk.bold.red(`${counts.numFailed} failed`) : undefined,
+        counts.numDegraded ? chalk.bold.yellow(`${counts.numDegraded} degraded`) : undefined,
         counts.numPassed ? chalk.bold.green(`${counts.numPassed} passed`) : undefined,
         `${this.numChecks} total`,
       ].filter(Boolean).join(', '))
@@ -153,14 +156,16 @@ export default abstract class AbstractListReporter implements Reporter {
   }
 
   _printBriefSummary () {
-    const counts = { numFailed: 0, numPassed: 0, numPending: 0 }
+    const counts = { numFailed: 0, numDegraded: 0, numPassed: 0, numPending: 0 }
     const status = []
     for (const [, checkMap] of this.checkFilesMap!.entries()) {
       for (const [_, { result }] of checkMap.entries()) {
         if (!result) {
           counts.numPending++
         } else if (result.hasFailures) {
           counts.numFailed++
+        } else if (result.isDegraded) {
+          counts.numDegraded++
         } else {
           counts.numPassed++
         }
@@ -169,6 +174,7 @@ export default abstract class AbstractListReporter implements Reporter {
     status.push('')
     status.push([
       counts.numFailed ? chalk.bold.red(`${counts.numFailed} failed`) : undefined,
+      counts.numDegraded ? chalk.bold.yellow(`${counts.numDegraded} degraded`) : undefined,
       counts.numPassed ? chalk.bold.green(`${counts.numPassed} passed`) : undefined,
       counts.numPending ? chalk.bold.magenta(`${counts.numPending} pending`) : undefined,
       `${this.numChecks} total`,

packages/cli/src/reporters/ci.ts

@@ -1,7 +1,7 @@
 import indentString from 'indent-string'
 
 import AbstractListReporter from './abstract-list'
-import { formatCheckTitle, formatCheckResult, CheckStatus, printLn } from './util'
+import { formatCheckTitle, formatCheckResult, CheckStatus, printLn, resultToCheckStatus } from './util'
 import { SequenceId } from '../services/abstract-check-runner'
 import { TestResultsShortLinks } from '../rest/test-sessions'
 
@@ -27,7 +27,7 @@ export default class CiReporter extends AbstractListReporter {
 
   onCheckEnd (sequenceId: SequenceId, checkResult: any) {
     super.onCheckEnd(sequenceId, checkResult)
-    printLn(formatCheckTitle(checkResult.hasFailures ? CheckStatus.FAILED : CheckStatus.SUCCESSFUL, checkResult))
+    printLn(formatCheckTitle(resultToCheckStatus(checkResult), checkResult))
 
     if (this.verbose || checkResult.hasFailures) {
       printLn(indentString(formatCheckResult(checkResult), 4), 2, 1)

packages/cli/src/reporters/dot.ts

@@ -18,6 +18,8 @@ export default class DotReporter extends AbstractListReporter {
     super.onCheckEnd(sequenceId, checkResult)
     if (checkResult.hasFailures) {
       print(`${chalk.red('F')}`)
+    } else if (checkResult.isDegraded) {
+      print(`${chalk.yellow('D')}`)
     } else {
       print(`${chalk.green('.')}`)
     }

packages/cli/src/reporters/github.ts

@@ -3,7 +3,7 @@ import * as path from 'path'
 
 import AbstractListReporter, { checkFilesMap } from './abstract-list'
 import { SequenceId } from '../services/abstract-check-runner'
-import { formatDuration, printLn, getTestSessionUrl } from './util'
+import { CheckStatus, formatDuration, getTestSessionUrl, printLn, resultToCheckStatus } from './util'
 
 const outputFile = './checkly-github-report.md'
 
@@ -64,8 +64,9 @@ export class GithubMdBuilder {
 
     for (const [_, checkMap] of this.checkFilesMap.entries()) {
       for (const [_, { result, testResultId }] of checkMap.entries()) {
+        const checkStatus = resultToCheckStatus(result)
         const tableRow: Array<string> = [
-          `${result.hasFailures ? '❌ Fail' : '✅ Pass'}`,
+          `${checkStatus === CheckStatus.FAILED ? '❌ Fail' : checkStatus === CheckStatus.DEGRADED ? '⚠️ Degraded' : '✅ Pass'}`,
           `${result.name}`,
           `${result.checkType}`,
           this.hasFilenames ? `\`${result.sourceFile}\`` : undefined,

packages/cli/src/reporters/json.ts

@@ -3,7 +3,7 @@ import * as path from 'path'
 
 import AbstractListReporter, { checkFilesMap } from './abstract-list'
 import { CheckRunId, SequenceId } from '../services/abstract-check-runner'
-import { printLn, getTestSessionUrl } from './util'
+import { CheckStatus, getTestSessionUrl, printLn, resultToCheckStatus } from './util'
 
 const outputFile = './checkly-json-report.json'
 
@@ -41,8 +41,9 @@ export class JsonBuilder {
     for (const [_, checkMap] of this.checkFilesMap.entries()) {
       // eslint-disable-next-line @typescript-eslint/no-unused-vars
       for (const [_, { result, testResultId, numRetries }] of checkMap.entries()) {
+        const checkStatus = resultToCheckStatus(result)
         const check: any = {
-          result: result.hasFailures ? 'Fail' : 'Pass',
+          result: checkStatus === CheckStatus.FAILED ? 'Fail' : checkStatus === CheckStatus.DEGRADED ? 'Degraded' : 'Pass',
           name: result.name,
           checkType: result.checkType,
           durationMilliseconds: result.responseTime ?? null,

packages/cli/src/reporters/list.ts

@@ -3,7 +3,7 @@ import chalk from 'chalk'
 
 import AbstractListReporter from './abstract-list'
 import { SequenceId } from '../services/abstract-check-runner'
-import { formatCheckTitle, formatCheckResult, CheckStatus, printLn } from './util'
+import { formatCheckTitle, formatCheckResult, CheckStatus, printLn, resultToCheckStatus } from './util'
 import { TestResultsShortLinks } from '../rest/test-sessions'
 
 export default class ListReporter extends AbstractListReporter {
@@ -58,13 +58,17 @@ export default class ListReporter extends AbstractListReporter {
     this._clearSummary()
 
     if (this.verbose) {
-      printLn(formatCheckTitle(checkResult.hasFailures ? CheckStatus.FAILED : CheckStatus.SUCCESSFUL, checkResult))
+      printLn(formatCheckTitle(resultToCheckStatus(checkResult), checkResult))
       printLn(indentString(formatCheckResult(checkResult), 4), 2, 1)
     } else {
       if (checkResult.hasFailures) {
         printLn(formatCheckTitle(CheckStatus.FAILED, checkResult))
         printLn(indentString(formatCheckResult(checkResult), 4), 2, 1)
       }
+      if (checkResult.isDegraded) {
+        printLn(formatCheckTitle(CheckStatus.DEGRADED, checkResult))
+        printLn(indentString(formatCheckResult(checkResult), 4), 2, 1)
+      }
     }
 
     if (links) {

packages/cli/src/reporters/util.ts

@@ -13,6 +13,7 @@ export enum CheckStatus {
   RETRIED,
   FAILED,
   SUCCESSFUL,
+  DEGRADED,
 }
 
 export function formatDuration (ms: number): string {
@@ -44,6 +45,9 @@ export function formatCheckTitle (
   } else if (status === CheckStatus.FAILED) {
     statusString = logSymbols.error
     format = chalk.bold.red
+  } else if (status === CheckStatus.DEGRADED) {
+    statusString = logSymbols.warning
+    format = chalk.bold.yellow
   } else if (status === CheckStatus.SCHEDULING) {
     statusString = '~'
     format = chalk.bold.dim
@@ -440,6 +444,14 @@ function toString (val: any): string {
   }
 }
 
+export function resultToCheckStatus (checkResult: any): CheckStatus {
+  return checkResult.hasFailures
+    ? CheckStatus.FAILED
+    : checkResult.isDegraded
+      ? CheckStatus.DEGRADED
+      : CheckStatus.SUCCESSFUL
+}
+
 export function print (text: string) {
   process.stdout.write(text)
 }