Event object passed as object within object

[trulysinclair]

Package version

6.12.1

Describe the bug

When setting up a class-event system for a health check report to kick off multiple actions, the report: HealthCheckReport is passed to class-listeners as I guess an event object instead of the flat object.

import HealthCheckReportCreated from '#events/health_check_report_created'
const SendHealthCheckReport = () => import('#listeners/send_health_check_report')
emitter.on(HealthCheckReportCreated, [SendHealthCheckReport])

export default class HealthCheckReportCreated extends BaseEvent {
  /**
   * Accept event data as constructor parameters
   */
  constructor(public report: HealthCheckReport) {
    logger.info(report, 'HealthCheckReportCreated')
    super()
  }
}

This is what it should look like according to Class-based listeners

export default class SendHealthCheckReport {
  async handle(report: HealthCheckReport) {
    logger.info(report, 'SendHealthCheckReport')
    await mail.send(new HealthCheckReportNotification(report), {
      tags: [{ name: 'category', type: 'health_check' }],
    })
  }
}

This must be done to get the expected output

export default class SendHealthCheckReport {
  async handle({ report }: { report: HealthCheckReport }) {
    logger.info(report, 'SendHealthCheckReport')
    await mail.send(new HealthCheckReportNotification(report), {
      tags: [{ name: 'category', type: 'health_check' }],
    })
  }
}

Here's the output log, we see that instead of getting report we get what I assume to be event.report if we were to use a function instead of a class-based listener, referenced here.

[19:12:28.949] INFO (7664): started HTTP server on 0.0.0.0:3333
[19:14:49.687] INFO (7664): HealthCheckReportCreated
    isHealthy: false
    status: "error"
    finishedAt: "2024-07-25T19:14:49.682Z"
    debugInfo: {
      "pid": 7664,
      "ppid": 9456,
      "platform": "win32",
      "uptime": 143.5209261,
      "version": "v20.14.0"
    }
    checks: [
      {
        "name": "Disk space check",
        "isCached": false,
        "message": "Disk usage is 85%, which is above the threshold of 80%",
        "status": "error",
        "finishedAt": "2024-07-25T19:14:49.682Z",
        "meta": {
          "sizeInPercentage": {
            "used": 85,
            "failureThreshold": 80,
            "warningThreshold": 75
          }
        }
      },
      {
        "name": "Memory heap check",
        "isCached": false,
        "message": "Heap usage is under defined thresholds",
        "status": "ok",
        "finishedAt": "2024-07-25T19:14:49.432Z",
        "meta": {
          "memoryInBytes": {
            "used": 49046512,
            "failureThreshold": 314572800,
            "warningThreshold": 262144000
          }
        }
      },
      {
        "name": "Database health check (sqlite)",
        "isCached": false,
        "message": "Successfully connected to the database server",
        "status": "ok",
        "finishedAt": "2024-07-25T19:14:49.437Z",
        "meta": {
          "connection": {
            "name": "sqlite",
            "dialect": "better-sqlite3"
          }
        }
      }
    ]
[19:14:50.157] INFO (7664): SendHealthCheckReport
    report: {
      "isHealthy": false,
      "status": "error",
      "finishedAt": "2024-07-25T19:14:49.682Z",
      "debugInfo": {
        "pid": 7664,
        "ppid": 9456,
        "platform": "win32",
        "uptime": 143.5209261,
        "version": "v20.14.0"
      },
      "checks": [
        {
          "name": "Disk space check",
          "isCached": false,
          "message": "Disk usage is 85%, which is above the threshold of 80%",
          "status": "error",
          "finishedAt": "2024-07-25T19:14:49.682Z",
          "meta": {
            "sizeInPercentage": {
              "used": 85,
              "failureThreshold": 80,
              "warningThreshold": 75
            }
          }
        },
        {
          "name": "Memory heap check",
          "isCached": false,
          "message": "Heap usage is under defined thresholds",
          "status": "ok",
          "finishedAt": "2024-07-25T19:14:49.432Z",
          "meta": {
            "memoryInBytes": {
              "used": 49046512,
              "failureThreshold": 314572800,
              "warningThreshold": 262144000
            }
          }
        },
        {
          "name": "Database health check (sqlite)",
          "isCached": false,
          "message": "Successfully connected to the database server",
          "status": "ok",
          "finishedAt": "2024-07-25T19:14:49.437Z",
          "meta": {
            "connection": {
              "name": "sqlite",
              "dialect": "better-sqlite3"
            }
          }
        }
      ]
    }

Reproduction repo

No response

[thetutlage]

Can you show where you are emitting the event?

[thetutlage]

Also, the handle method receives the event. So this is how the code should be.

export default class SendHealthCheckReport {
  async handle(event: HealthCheckReportCreated) {
    console.log(event.report)
  }
}

[trulysinclair]

Currently I have this setup, simply passing the report object to the dispatch method. I see where I went wrong. Instead of expecting the event, I was expected the object directly. Your snippet shows that. However, I was following the class-based listeners docs and saw handle(user: User) {} and that's where I made the misconception about how the report would be passed down

export default class HealthChecksController {
  async handle({ response, logger }: HttpContext) {
    const report = await healthChecks.run()

    if (report.isHealthy) {
      logger.info('Health Check passed')
      await HealthCheckReportCreated.dispatch(report)
      return response.ok(report)
    }

    await HealthCheckReportCreated.dispatch(report)
    logger.error('Health Check failed')
    return response.serviceUnavailable(report)
  }
}