feat: Add ServiceConfig.crashesLength property, default to 0

Author: zenflow

README.md

@@ -168,6 +168,8 @@ startCompositeService({
       // Do "something async" before restarting the service
       await doSomethingAsync()
     },
+    // Set max length of `ctx.crash.logTail` used above (default is 0)
+    logTailLength: 5,
   },
 })
 ```

TODO.md

@@ -1,24 +1,7 @@
 # TODO
 
-remove minimumRestartDelay
-default logTailLength = 5
-default crashesLength = 3
-
 simplify test utils by using `stream-line-reader` packge
-ugly output for crashing from error in onCrash/ready
 
-- bugs
-    - without windowsCtrlCShutdown=true, composed service programs like `nodemon` (which have their own child process) cannot be stopped on Windows
-      - make note that windowsCtrlCShutdown may be needed if your service has it's own subprocesses
-- docs
-    - http gateway
-        - warnings about using http gateway for production:
-        "http gateway is useful for getting up & running quickly,
-        and does a pretty good job performing it's function,
-        but may not be suitable for serious production deployments.
-        Check out https://github.com/awesome-selfhosted/awesome-selfhosted#proxy"
-        - https://v2.docusaurus.io/docs/markdown-features#line-highlighting
-        - more examples in guide on configuring http-proxy-middleware
 - community
     - https://github.com/zenflow/composite-service/community
     - PR to add composite-service example to https://docs.docker.com/config/containers/multi-service_container/

src/Service.ts

@@ -92,7 +92,12 @@ export class Service {
       date: new Date(),
       logTail: proc.logTail,
     }
-    this.crashes.push(crash)
+    if (this.config.crashesLength > 0) {
+      this.crashes.push(crash)
+      if (this.crashes.length > this.config.crashesLength) {
+        this.crashes.shift()
+      }
+    }
     const isServiceReady = await isResolved(this.ready!)
     const ctx: OnCrashContext = {
       serviceId: this.id,

src/interfaces/OnCrashContext.ts

@@ -20,7 +20,9 @@ export interface OnCrashContext {
   crash: ServiceCrash
 
   /**
-   * Array of objects representing all crashes, past and present
+   * Objects representing latest crashes, ordered from oldest to newest
+   *
+   * Maximum length is determined by {@link ServiceConfig.crashesLength}.
    */
   crashes: ServiceCrash[]
 }

src/interfaces/ServiceConfig.ts

@@ -82,10 +82,19 @@ export interface ServiceConfig {
   onCrash?: (ctx: OnCrashContext) => void | Promise<void>
 
   /**
-   * Maximum number of lines to keep from the tail of each child process's log output.
+   * Maximum number of latest crashes to keep record of.
    * Defaults to `0`.
    *
-   * The log lines for each crashed process can be accessed in your {@link ServiceConfig.onCrash} function,
+   * The recorded crashes can be accessed in your {@link ServiceConfig.onCrash} function,
+   * as `ctx.crashes`.
+   */
+  crashesLength?: number
+
+  /**
+   * Maximum number of lines to keep from the tail of the child process's console output.
+   * Defaults to `0`.
+   *
+   * The log lines for can be accessed in your {@link ServiceConfig.onCrash} function,
    * as `ctx.crash.logTail` or `ctx.crashes[i].logTail`.
    */
   logTailLength?: number

src/interfaces/ServiceCrash.ts

@@ -7,7 +7,7 @@ export interface ServiceCrash {
    */
   date: Date
   /**
-   * Tail of the service's log output
+   * Tail of the process's log output
    *
    * Maximum length is determined by {@link ServiceConfig.logTailLength}.
    */

src/validateAndNormalizeConfig.ts

@@ -21,6 +21,7 @@ export interface NormalizedServiceConfig {
   ready: (ctx: ReadyContext) => Promise<void>
   forceKillTimeout: number
   onCrash: (ctx: OnCrashContext) => void
+  crashesLength: number
   logTailLength: number
   minimumRestartDelay: number
 }
@@ -87,6 +88,7 @@ function processServiceConfig(
     onCrash: (ctx: OnCrashContext) => {
       if (!ctx.isServiceReady) throw new Error('Crashed before becoming ready')
     },
+    crashesLength: 0,
     logTailLength: 0,
     minimumRestartDelay: 0,
     ...removeUndefinedProperties(defaults),

test/integration/crashing.test.ts

@@ -184,6 +184,7 @@ describe('crashing', () => {
   it('restarts service on successful pre-ready onCrash', async () => {
     const script = getScript(`
       config.services.second.command = ['node', '-e', 'console.log("Crashing")'];
+      config.services.second.crashesLength = 3;
       config.services.second.onCrash = ctx => {
         if (ctx.crashes.length === 3) throw new Error('Crashed three times');
       };
@@ -220,6 +221,7 @@ describe('crashing', () => {
   })
   it('restarts service on successful post-ready onCrash', async () => {
     const script = getScript(`
+      config.services.second.crashesLength = 2;
       config.services.second.logTailLength = 1;
       config.services.second.onCrash = async ctx => {
         const tests = [
@@ -282,5 +284,25 @@ describe('crashing', () => {
         "second | Started 🚀",
       ]
     `)
+
+    // crash again
+    expect(await fetchText('http://localhost:8002/?crash')).toBe('crashing')
+    // allow time for restart again
+    await delay(500)
+    // make sure it restarted again
+    expect(await fetchText('http://localhost:8002/')).toBe('second')
+    // correct output for 3rd crash
+    expect(proc.flushOutput()).toMatchInlineSnapshot(`
+      Array [
+        "second | Crashing",
+        " (info) Service 'second' crashed",
+        "number of crashes: 2",
+        "crash logTail: [\\"Crashing\\\\n\\"]",
+        "Handling crash...",
+        "Done handling crash",
+        " (info) Restarting service 'second'",
+        "second | Started 🚀",
+      ]
+    `)
   })
 })