`request` `closed` `error` tags

[joshkel]

Module version

21.3.12

What documentation problem did you notice?

According to the documentation at https://hapi.dev/api/?v=21.3.12#-request-event, an internally generated error with tags request closed error indicates that "the request closed prematurely."

In my own application, I've seen tags of request error close, which apparently (also?) indicate that the request closed prematurely. I believe that this is logged from https://github.com/hapijs/hapi/blob/v21.3.12/lib/request.js#L720. This set of tags does not appear to be documented.

Therefore, I think that one of the following is true:

1. request error close is undocumented and should be added to API.md.
2. request closed error is a mistake, and it's actually request error close / request close error (depending on whether tag order is intended to matter).

(I think it's the second, because I don't see in the source code where it can emit a tag of closed - but I could easily be mistaken. request error close is also more consistent with the documented response error close.)

[kanongil]

Thanks for the report. This does indeed seem to be an unintended rename.

'closed' used to be emitted instead, as can be seen from this v16 code:

hapi/lib/request.js

Lines 185 to 192 in 467e8de

	this._onClose = () => {
	this._log(['request', 'closed', 'error']);
	this._isPayloadPending = false;
	this._isBailed = true;
	};
	this.raw.req.once('close', this._onClose);

Given that 'close' is now used in practice, I think the best fix will be to correct the documentation.

The ordering should probably also be updated to match, though it should not matter for processing inside hapi (but might for external tools that handle a logged line). The request abort error docs should also be updated with the new ordering.