chore(errors): amend errors so user-input derived issues are info level logged, the error is logged in full, and other refactoring

[iainsproat]

Description & motivation

All errors classes extended from BaseError define an http status code. This is defined regardless of whether the error is used in handling an http request as it allows the correct log level to be selected.

All generic throw new Error (in non-test, non-mock) is replaced with a more specific error class, extended from BaseError.

The graphql error logger has been updated to use the statusCode to define which error level is used in logging.

Changes:

• the default error handler for express now ensures the error is included in the request context. The pino-http logger now ensures that the error from the request context is included in the logged message.
• logging of graphql errors now determine which level an error should be logged at. User-input derived errors are logged as 'info', and internal system errors as 'error'.
• status codes are added to all errors extended from BaseError.
• fixes error in logging, where graphql_operation_value was expected but was not a parameter available in the structured log. Replaces with graphql_operation_name.
• Moves common code between graphql and graphql subscriptions to a function shouldLogAsInfoLevel
• Errors where stream, projects, invites, commits etc. cannot be found should result in a X_NOT_FOUND error code, which should be logged as info level.
• introduces a ObjectNotFoundError. (TODO, complete this list)
• replaces throw new Error with a specific class.
• configuration of S3 uses the envHelpers.
• Where error messages include dynamic context, these values are added to the options.info parameter when the error is constructed.

To-do before merge:

Screenshots:

Requests now log the full error message, whether logging as info or error:

Validation of changes:

Checklist:

• My pull request follows the guidelines in the Contributing guide?
• My pull request does not duplicate any other open Pull Requests for the same update/change?
• My commits are related to the pull request and do not amend unrelated code or documentation.
• My code follows a similar style to existing code.
• I have added appropriate tests.
• I have updated or added relevant documentation.

References

[iainsproat]

didEncounterErrors method continues to log error level for graphql errors which should be info logged: