Health checks cannot be performed as commands

[trulysinclair]

Package version

6.12.1

Describe the bug

When attempting to create a command that can run a health check, in my case for automated weekly reports sent to our IT email, I get a variety of issues that prevent any such action. I've attempted to make sure that the server is started, expecting that it would just... work. The connection to the SQLite db is the initial issue it seems, and removing that checks only returns an undefined report object.

This is my command setup, trying both ready events.

export default class HealthCheckReport extends BaseCommand {
  static commandName = 'health-check'
  static description = 'Generate health check report'

  static options: CommandOptions = {
    startApp: true,
  }

  async run() {
    if (app.isReady) {
      const report = await healthChecks.run()
      await HealthCheckReportCreated.dispatch(report)
      logger.info(report, 'app ready')
    }

    await app.ready(async () => {
      const report = await healthChecks.run()
      logger.info(report, 'app ready')
    })
  }
}

This is my simple start/health.ts

export const healthChecks = new HealthChecks().register([
  new DiskSpaceCheck().cacheFor('1 hour'),
  new MemoryHeapCheck(),
  new DbCheck(db.connection()).cacheFor('1 hour'),
  // TODO future RedisCheck impl
])

and this is the output

~\source\repos\crisis-tower git:[setup-mailing]
node ace health-check

   TypeError: Cannot read properties of undefined (reading 'connection')
 
   at anonymous start\health.ts:7
    2|   import { DbCheck } from '@adonisjs/lucid/database'
    3|   import db from '@adonisjs/lucid/services/db'
    4|   
    5|   export const healthChecks = new HealthChecks().register([
    6|     new DiskSpaceCheck().cacheFor('1 hour'),
 >  7|     new MemoryHeapCheck(),
    8|     new DbCheck(db.connection()).cacheFor('1 hour'),
    9|     // TODO future RedisCheck impl
   10|  ])
   11|  

Reproduction repo

No response

[trulysinclair]

I'd like to add that when running the server as normal and using a /health endpoint it works as expected. But I was looking to setup a simple health-check command that can be run by adonisjs-scheduler once a week.

[thetutlage]

Your code does not include how do you import the healthChecks file. Make sure it is a dynamic import inside the handle method.

[trulysinclair]

Thank you, this is working fine now

export default class HealthCheckReport extends BaseCommand {
  static commandName = 'health-check'
  static description = 'Generate health check report'

  static options: CommandOptions = {
    startApp: true,
  }

  async run() {
    const { healthChecks } = await import('#start/health')
    const report = await healthChecks.run()
    await HealthCheckReportCreated.dispatch(report)
  }
}