Disallow synchronous handlers in type definition #308
Merged
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.
Which problem is this pull request solving?
The type definition of
Handler
(orBaseHandler
, more specifically) allows handlers to by synchronous.I wrote some Netlify functions, which worked as expected locally through Netlify CLI. On production, however, the function produced the following:
This seems to have been caused by the functions returning a
Response
(directly) rather than aPromise<Response>
in some branches. Synchronous handlers are allowed by (Netlify CLI, as well as) the type definition, but not actually by Netlify.List other issues or pull requests related to this problem
(none that I could find)
Describe the solution you've chosen
Removed the synchronous version from the union that is the return type of
BaseHandler
.Describe alternatives you've considered
Add support for synchronous handlers to the Netlify platform.
Checklist