fix(postgrest): preserve nullability when using JSON path #1939
+1
−1
Conversation
This file contains hidden or 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
mandarini
changed the title
…upabase#1635) The JSON path resolver (JsonPathToType) stripped `null` using Exclude<T, null> but never added it back to the resulting type. This caused `.select('col->a')` to infer a non-nullable type even when the underlying JSON column was nullable. Example: json_col: { a: string } | null .select('json_col->a') // inferred `string` instead of `string | null` This patch re-attaches `| null` when the root JSON column contains null, ensuring correct type inference for nullable JSON columns and nullable nested paths. Fixes: supabase#1635
mandarini
force-pushed
the
fix/Null-should-be-included-in-return-type
branch
from
60a5dcc to
621e051
Compare
Contributor
|
Thanks for the fix @dev-hari-prasad ! This correctly addresses the nullability issue in #1635. However, since this changes type inference in a way that could cause compilation errors for existing users (nullable JSON paths will now correctly return Before merging, could you please:
I'll tag this for v3 (next major release). And we can merge it when the time comes! |
mandarini
changed the title
mandarini
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description:
What changed?
Fixed the type inference for JSON path selections (
->) by adding| nullwhen the underlying JSON column can be null.Why was this change needed?
When selecting a JSON path from a nullable JSON column, the generated TypeScript types incorrectly assumed the value could never be null.
In reality, the runtime returns
nullwhen the whole column is null, so the types were unsafe.This patch brings the inferred type in line with actual behavior.
Closes/Fixes #1635
Screenshots/Examples:
N/A since it is a type-only change.
Breaking changes:
This PR contains no breaking changes.
📋 Checklist:
<type>(<scope>): <description>npx nx formatto ensure consistent code formattingAdditional notes:
The change is intentionally minimal and only affects the nullable branch of
JsonPathToType.It preserves existing behavior for non-nullable JSON columns while correctly reflecting actual return values for nullable ones.
CC @avallete & @mandarini