fix: correctly check "undefined" as response body type #1824
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
kettanaito
commented
Nov 1, 2023
| @@ -30,7 +30,7 @@ export interface RequestHandlerInternalInfo { | |||
| export type ResponseResolverReturnType< | |||
| BodyType extends DefaultBodyType = undefined, | |||
| > = | |||
| | (BodyType extends undefined ? Response : StrictResponse<BodyType>) | |||
There was a problem hiding this comment.
T extends undefined is not the correct way to check if a generic was provided in TypeScript. Instead, one must resort to a hack:
[T] extends [never] ? 'NOT PROVIDED' : 'PROVIDED'The previous implementation was giving false positives, making the custom response body type and the body type in ResponseResolverReturnType incompatible.
kettanaito
commented
Nov 1, 2023
|
|
||
| function myHandler<CustomResponseBodyType extends DefaultBodyType>(path: Path) { | ||
| return (response: CustomResponseBodyType) => { | ||
| http.get(path, () => HttpResponse.json(response)) |
There was a problem hiding this comment.
Also adding a typing regression test to make sure this doesn't happen again.
4 tasks
kettanaito
force-pushed
the
fix/resolver-return-never
branch
from
00b3791 to
40f026f
Compare
kettanaito
changed the title
kettanaito
commented
Nov 4, 2023
| @@ -265,7 +265,7 @@ export abstract class RequestHandler< | |||
|
|
|||
| // Clone the previously stored response from the generator | |||
| // so that it could be read again. | |||
| return this.resolverGeneratorResult.clone() | |||
| return this.resolverGeneratorResult.clone() as StrictResponse<any> | |||
There was a problem hiding this comment.
A bit hacky. Suggestions are welcome.
Released: v2.0.3 🎉This has been released in v2.0.3! Make sure to always update to the latest version ( Predictable release automation by @ossjs/release. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why still check if
[undefined] and not[never]?Because
neveris an explicit "this response must not have any body". This is a narrower response body type and it must use theStrictResponse<never>internal type if it's provided.undefinedis the default (fallback) response body type. This means that by default, we don't know what type the response body will be, soundefinedis equivalent to a plainResponse.