Add a comment to avoid throwing errors from within logger.log() #536
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ticket
Changes
Context
In #471, we identified that uncaught errors will cause the application to display an unrendered and untranslated 500 error page. After researching this issue, I came to the conclusion that there isn't an easy technical solution. We have already put all of our function calls inside
try/catch
blocks.It is possible to generate an uncaught error if you
throw new Error()
inside oflogger.log()
. That's what caused the issue in #471. However, we have already removed that throw. This PR adds a comment tologger.log()
to warn future developers away from accidentally re-introducing this issue.