Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

formatResponse: Fix typings and provide full request context. #3431

Merged
merged 4 commits into from
Oct 23, 2019
Merged

formatResponse: Fix typings and provide full request context. #3431

merged 4 commits into from
Oct 23, 2019

Conversation

abernix
Copy link
Member

@abernix abernix commented Oct 21, 2019

Previously, the formatResponse was only typed as a Function. However, since it's expected that the function return a GraphQLResponse (the same thing that it receives, that typing seems a bit too generic. This changes the typing to more accurately reflect the way it should be used, and also provides it the complete requestContext rather than just the cherry-picked context property.

@abernix
Adjust formatResponse typings to be more accurate.
3e67cc9 
Previously, this was only typed as a `Function`, which means we lost all the
typings on the return side of that method.
@abernix
Provide the entire context to formatResponse.
5c8970f
@abernix
Changelog.
92037ca
trevor-scheer
trevor-scheer reviewed Oct 22, 2019
View reviewed changes
packages/apollo-server-core/src/requestPipeline.ts
Comment on lines -388 to +391
{
context: requestContext.context,
},
requestContext,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well that was easy 😄I read the PR and thought - "how's he gonna get out of that breaking change?" Interesting and convenient that this was passed in as an object before!

@abernix abernix merged commit 8059326 into master Oct 23, 2019
@abernix abernix deleted the abernix/adjust-formatResponse-typings branch October 23, 2019 07:13
@nwalters512 nwalters512 mentioned this pull request Mar 8, 2021
Closed
glasser added a commit that referenced this pull request Apr 6, 2021
@glasser
Fix formatResponse typings
fd9ef3d 
This typing was added in #3431; it looks like we put the `| null` in the wrong
place. Fortunately, a function that's OK with accepting a null argument and will
never return null can still typecheck with the new type.

Fixes #5009.
@glasser glasser mentioned this pull request Apr 6, 2021
Merged
glasser added a commit that referenced this pull request Apr 6, 2021
@glasser
Fix formatResponse typings
e79c8d9 
This typing was added in #3431; it looks like we put the `| null` in the wrong
place. Fortunately, a function that's OK with accepting a null argument and will
never return null can still typecheck with the new type.

Fixes #5009.
glasser added a commit that referenced this pull request Apr 6, 2021
@glasser
Fix formatResponse typings
9825c40 
This typing was added in #3431; it looks like we put the `| null` in the wrong
place. Fortunately, a function that's OK with accepting a null argument and will
never return null can still typecheck with the new type.

Fixes #5009.
glasser added a commit that referenced this pull request Apr 6, 2021
@glasser
Fix formatResponse typings (#5089)
ad4c3ac 
This typing was added in #3431; it looks like we put the `| null` in the wrong
place. Fortunately, a function that's OK with accepting a null argument and will
never return null can still typecheck with the new type.

Fixes #5009.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@trevor-scheer trevor-scheer trevor-scheer approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@abernix @trevor-scheer