feat: add support to configure health checks via configure command

Author: thetutlage

commands/configure.ts

@@ -7,6 +7,7 @@
  * file that was distributed with this source code.
  */
 
+import { stubsRoot } from '../stubs/main.js'
 import type { CommandOptions } from '../types/ace.js'
 import { args, BaseCommand, flags } from '../modules/ace/main.js'
 
@@ -97,6 +98,17 @@ export default class Configure extends BaseCommand {
     })
   }
 
+  /**
+   * Configure health checks
+   */
+  async #configureHealthChecks() {
+    const codemods = await this.createCodemods()
+    await codemods.makeUsingStub(stubsRoot, 'make/health/main.stub', {
+      flags: this.parsed.flags,
+      entity: this.app.generators.createEntity('health'),
+    })
+  }
+
   /**
    * Creates codemods as per configure command options
    */
@@ -117,6 +129,9 @@ export default class Configure extends BaseCommand {
     if (this.name === 'edge') {
       return this.#configureEdge()
     }
+    if (this.name === 'health_checks') {
+      return this.#configureHealthChecks()
+    }
 
     const packageExports = await this.#getPackageSource(this.name)
     if (!packageExports) {

stubs/make/health/main.stub

@@ -0,0 +1,16 @@
+{{#var preloadFileName = string(entity.name).snakeCase().removeExtension().ext('.ts').toString()}}
+{{{
+  exports({
+    to: app.startPath(entity.path, preloadFileName)
+  })
+}}}
+import {
+  HealthChecks,
+  DiskSpaceHealthCheck,
+  MemoryHeapHealthCheck,
+} from '@adonisjs/core/health'
+
+export const healthChecks = new HealthChecks().register([
+  new DiskSpaceHealthCheck(),
+  new MemoryHeapHealthCheck(),
+])

tests/commands/configure.spec.ts

@@ -411,3 +411,33 @@ test.group('Configure command | edge', (group) => {
     )
   })
 })
+
+test.group('Configure command | health checks', (group) => {
+  group.each.disableTimeout()
+
+  test('create start/health file with some default checks', async ({ assert, fs }) => {
+    const ace = await new AceFactory().make(fs.baseUrl)
+    await ace.app.init()
+    ace.ui.switchMode('raw')
+
+    await fs.createJson('tsconfig.json', {})
+    await fs.create('adonisrc.ts', 'export default defineConfig({})')
+
+    const command = await ace.create(Configure, ['health_checks'])
+
+    await command.run()
+
+    assert.deepEqual(command.ui.logger.getLogs(), [
+      {
+        message: 'green(DONE:)    create start/health.ts',
+        stream: 'stdout',
+      },
+    ])
+
+    await assert.fileContains('start/health.ts', [
+      'new DiskSpaceHealthCheck()',
+      'new MemoryHeapHealthCheck()',
+      'export const healthChecks = ',
+    ])
+  })
+})