Fix Lambda context function typing
#5481
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
trevor-scheer
approved these changes
Jul 14, 2021
CHANGELOG.md
Outdated
| @@ -9,6 +9,8 @@ The version headers in this history reflect the versions of Apollo Server itself | |||
|
|
|||
| ## vNEXT | |||
|
|
|||
| - `apollo-server-lambda`: Fix TypeScript types for `context` function. (In 3.0.0, the TS types for the `context` function were accidentally inherited from `apollo-server-express` instead of using the correct Lambda-specific types). [PR #XXXX](https://github.com/apollographql/apollo-server/pull/XXXX) | |||
There was a problem hiding this comment.
Suggested change
| - `apollo-server-lambda`: Fix TypeScript types for `context` function. (In 3.0.0, the TS types for the `context` function were accidentally inherited from `apollo-server-express` instead of using the correct Lambda-specific types). [PR #XXXX](https://github.com/apollographql/apollo-server/pull/XXXX) | |
| - `apollo-server-lambda`: Fix TypeScript types for `context` function. (In 3.0.0, the TS types for the `context` function were accidentally inherited from `apollo-server-express` instead of using the correct Lambda-specific types). [PR #5481](https://github.com/apollographql/apollo-server/pull/5481) |
There was a problem hiding this comment.
Thanks, applied directly.
glasser
force-pushed
the
glasser/lambda-context-fix
branch
2 times, most recently
from
79ca410
to
758450c
Compare
In AS3 we made apollo-server-lambda inherit from apollo-server-express, but didn't realize that it also inherited the more precise TS typings on its constructor that meant that its `context` function would take Express-specific parameters (rather than the default unconstrained parameter). This change makes it easier for any ApolloServer subclass to declare its context function typing, and updates apollo-server-express and apollo-server-lambda to do so. The other integrations are left with the vaguer defaults. Tests didn't catch this before because they didn't pass a `context` function *directly* to the Lambda ApolloServer constructor, just via a function with a looser signature. An earlier version of this PR attempted to add the context object type (ie TContext) to the ApolloServer generics as well. But it didn't actually connect through to the TContext on processHTTPRequest and trying to link those up ran into some technical issues, so I decided to leave it out. Fixes #5480.
glasser
force-pushed
the
glasser/lambda-context-fix
branch
from
758450c
to
3310405
Compare
|
Rather than add a TContext generic that isn't actually connected to the one used when actually calling the context function, I ended up removing it. Trying to connect them ran into various issues (like the default value of |
|
Fix released in 3.0.1. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
In AS3 we made apollo-server-lambda inherit from apollo-server-express,
but didn't realize that it also inherited the more precise TS typings on
its constructor that meant that its
contextfunction would takeExpress-specific parameters (rather than the default unconstrained
parameter).
This change makes it easier for any ApolloServer subclass to declare its
context function typing, and updates apollo-server-express and
apollo-server-lambda to do so. The other integrations are left with the
vaguer defaults.
Tests didn't catch this before because they didn't pass a
contextfunction directly to the Lambda ApolloServer constructor, just via a
function with a looser signature.
Fixes #5480.