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

skip unmasking for types without fragments #12152

Merged
merged 6 commits into from
Nov 20, 2024
Merged

skip unmasking for types without fragments #12152

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f94d0de
skip unmasking for types without fragments
phryneas Nov 20, 2024
6857a6d
change approach
phryneas Nov 20, 2024
82cc3e2
Swap order of check for fragmentRefs
jerelmiller Nov 20, 2024
5573ba7
Move helper to internal types and rename to ContainsFragmentRefs
jerelmiller Nov 20, 2024
dc98710
Merge branch 'release-3.12' into pr/skip-unrelated-unmasking
jerelmiller Nov 20, 2024
906919d
Clean up Prettier, Size-limit, and Api-Extractor
jerelmiller Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion src/masking/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,17 @@ export type MaybeMasked<TData> =
*/
export type Unmasked<TData> =
TData extends object ?
UnwrapFragmentRefs<RemoveMaskedMarker<RemoveFragmentName<TData>>>
FastForwardUnmask<RemoveMaskedMarker<RemoveFragmentName<TData>>>
: TData;

/**
* This type will skip going through the unmasking algorithm until it reaches
* the first fragment reference.
* This is useful for types that are not code-generated.
*/
type FastForwardUnmask<T> =
T extends Record<string, any> ?
T extends { " $fragmentRefs"?: any } ?
UnwrapFragmentRefs<T>
: { [K in keyof T]: FastForwardUnmask<T[K]> }
: T;
Copy link
Member

Choose a reason for hiding this comment

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

I think we might need to handle arrays in here, otherwise if the type is buried in an array, I think it might miss it. Does this work with this type?

type Query = {
  posts: Array<{
    __typename: "Post",
    id: string;
  } & { " $fragmentRefs"?: {...}>
}

Copy link
Member Author

Choose a reason for hiding this comment

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

Object mapping works recursively over arrays, too, if it's a "simple object mapping", meaning without renaming keys etc.

So in most cases we should not need any extra handling.

Loading