x-request-id header missing in empty body responses

[diego-sepulveda-lavin]

Package version

@adonisjs/http-server@7.7.0

Describe the bug

When using generateRequestId:true in config/app.ts, the expected behaviour is that the Request has the id property (this is working fine) see request docs. In the Response we should have the x-response-id header which is working fine except for responses without body, like noContent, created, etc, where the header is missing. Documentation does not mention exceptions for these cases see response docs.

Here I have two endpoints, one with empty body and the other with body 👇

Empty body endpoint has no x-response-id header 👇

With body endpoint has a x-response-id header 👇

Reproduction repo

No response

[ThisIsMissEm]

Have opened a fix in #111

[thetutlage]

Do we have any spec around this. Just want to make sure that we follow it and not accidentally set the header for empty responses

[ThisIsMissEm]

There's not really a standard for it, though it should be present on all responses from what I can tell:

• https://devcenter.heroku.com/articles/http-request-id
• https://dev.to/kittipat1413/understanding-request-id-why-its-essential-for-modern-apis-1916

There are articles saying that it should be Request-ID instead of X-Request-ID because of a misunderstanding of RFC 6648, which mostly refers standards-track headers.

[ThisIsMissEm]

The implementation in Rails seems to not care either: https://github.com/rails/rails/blob/main/actionpack/test/dispatch/request_id_test.rb

[ThisIsMissEm]

X-Correlation-ID is also pretty commonly used at one point, but now consensus in industry tends to be "use open telemetry instead of logs"

[thetutlage]

Fixed in the related PR