feat: Nicer console message reporting error in ready or onCrash

Author: zenflow

src/CompositeService.ts

@@ -1,11 +1,7 @@
 import { formatWithOptions } from 'util'
 import mergeStream from 'merge-stream'
 import { Service } from './Service'
-import {
-  NormalizedCompositeServiceConfig,
-  validateAndNormalizeConfig,
-} from './validateAndNormalizeConfig'
-import { CompositeServiceConfig } from './interfaces/CompositeServiceConfig'
+import { NormalizedCompositeServiceConfig } from './validateAndNormalizeConfig'
 import { Logger } from './Logger'
 import { mapStreamLines } from './util/stream'
 
@@ -16,8 +12,8 @@ export class CompositeService {
   private stopping = false
   private logger: Logger
 
-  constructor(config: CompositeServiceConfig) {
-    this.config = validateAndNormalizeConfig(config)
+  constructor(config: NormalizedCompositeServiceConfig) {
+    this.config = config
 
     if (this.config.windowsCtrlCShutdown) {
       require('generate-ctrl-c-event') // make sure this module loads before we even start

src/Service.ts

@@ -61,7 +61,7 @@ export class Service {
     this.ready = promiseTry(() => this.config.ready(ctx))
       .finally(() => this.outputClone.destroy())
       .catch(error => {
-        const prefix = `In \`ready\` function for service '${this.id}'`
+        const prefix = `In \`service.${this.id}.ready\``
         this.handleFatalError(`${prefix}: ${maybeErrorText(error)}`)
         return never()
       })
@@ -103,7 +103,7 @@ export class Service {
     try {
       await this.config.onCrash(ctx)
     } catch (error) {
-      const prefix = `In \`onCrash\` function for service ${this.id}`
+      const prefix = `In \`service.${this.id}.onCrash\``
       this.handleFatalError(`${prefix}: ${maybeErrorText(error)}`)
       await never()
     }

src/startCompositeService.ts

@@ -1,4 +1,5 @@
 import { CompositeServiceConfig } from './interfaces/CompositeServiceConfig'
+import { validateAndNormalizeConfig } from './validateAndNormalizeConfig'
 import { CompositeService } from './CompositeService'
 
 let started = false
@@ -10,6 +11,7 @@ export function startCompositeService(config: CompositeServiceConfig) {
   if (started) {
     throw new Error('Already started a composite service in this process')
   }
-  new CompositeService(config)
+  const normalizedConfig = validateAndNormalizeConfig(config)
+  new CompositeService(normalizedConfig)
   started = true
 }

test/integration/crashing.test.ts

@@ -105,7 +105,7 @@ describe('crashing', () => {
         "first | Started 🚀",
         " (debug) Started service 'first'",
         " (debug) Starting service 'second'...",
-        " (error) Fatal error: In \`ready\` function for service 'second': TypeError: Cannot read property 'bar' of undefined",
+        " (error) Fatal error: In \`service.second.ready\`: TypeError: Cannot read property 'bar' of undefined",
         "<stack trace>",
         " (debug) Stopping composite service...",
         " (debug) Stopping service 'second'...",
@@ -140,7 +140,7 @@ describe('crashing', () => {
         "second | Crashing",
         " (info) Service 'second' crashed",
         "isServiceReady: false",
-        " (error) Fatal error: In \`onCrash\` function for service second: Error: Crash",
+        " (error) Fatal error: In \`service.second.onCrash\`: Error: Crash",
         "<stack trace>",
         " (debug) Stopping composite service...",
         " (debug) Stopping service 'first'...",
@@ -168,7 +168,7 @@ describe('crashing', () => {
         "second | Crashing",
         " (info) Service 'second' crashed",
         "isServiceReady: true",
-        " (error) Fatal error: In \`onCrash\` function for service second: Error: Crash",
+        " (error) Fatal error: In \`service.second.onCrash\`: Error: Crash",
         "<stack trace>",
         " (debug) Stopping composite service...",
         " (debug) Stopping service 'third'...",
@@ -207,7 +207,7 @@ describe('crashing', () => {
         " (info) Restarting service 'second'",
         "second | Crashing",
         " (info) Service 'second' crashed",
-        " (error) Fatal error: In \`onCrash\` function for service second: Error: Crashed three times",
+        " (error) Fatal error: In \`service.second.onCrash\`: Error: Crashed three times",
         "<stack trace>",
         " (debug) Stopping composite service...",
         " (debug) Stopping service 'first'...",