refactor: use res.json or sendStatus for objects or empty body #424
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.
Problem
Usage of
res.send
creates the risk of HTML injection attacks if not used with care. Usingres.json
is better practice.Solution
This PR addresses the cases where changing from
res.status
tores.json
orres.sendStatus
should be risk-free.When
res.send
is called with an object, it behaves the same way as ifres.json
is called, since Express just callsres.json
internally. Moreover, whenres.send
is called with no argument, it is (almost) equivalent to callingres.sendStatus
, since the client should not be doing anything with the empty response body. This PR addresses these two cases throughout the codebase by changingres.send
tores.json
orres.sendStatus
as necessary.