fix: uncaughtException needs more best practices

[SgtPooki]

Tasks

Preview Give feedback

1. default ALLOW_UNHANDLED_ERROR_RECOVERY to false
2. Add warning in readme
3. Add default known-recoverable uncaughtExceptions
4. Add listener to req & resp for ERR_STREAM_PREMATURE_CLOSE

helia-http-gateway/src/index.ts

Lines 273 to 280 in 6f10038

	const uncaughtHandler = (error: any): void => {
	log.error('Uncaught Exception:', error)
	if (ALLOW_UNHANDLED_ERROR_RECOVERY && (RECOVERABLE_ERRORS === 'all' || RECOVERABLE_ERRORS.includes(error?.code) || RECOVERABLE_ERRORS.includes(error?.name))) {
	log.trace('Ignoring error')
	return
	}
	void closeGracefully('SIGTERM')
	}

related:

• fix: helia-docker container dies when running in tiros #18
• fix: catch uncaught exceptions & gc handles request aborts #102 (comment)

cc @achingbrain

[achingbrain]

Add default known-recoverable uncaughtExceptions

There are no recoverable uncaught exceptions. This is clearly documented:

The event should not be used as an equivalent to On Error Resume Next. Unhandled exceptions inherently mean that an application is in an undefined state. Attempting to resume application code without properly recovering from the exception can cause additional unforeseen and unpredictable issues.

The correct use of 'uncaughtException' is to perform synchronous cleanup of allocated resources (e.g. file descriptors, handles, etc) before shutting down the process. It is not safe to resume normal operation after 'uncaughtException'.

https://nodejs.org/api/process.html#warning-using-uncaughtexception-correctly

Note:

It is not safe to resume normal operation after 'uncaughtException'.

yet this is exactly what #102 does.

[achingbrain]

Fixed by #154