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

Allow configuration of the ofType introspection depth #4317

Open
wants to merge 4 commits into
base: 16.x.x
Choose a base branch
from
+33 −37
Open

Allow configuration of the ofType introspection depth #4317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
388d405
Update getIntrospectionQuery.ts to allow configuration of the type qu…
Nols1000 Dec 31, 2024
366de1f
Update template function to handle formatting
Nols1000 Jan 3, 2025
a6cb5cd
Apply suggestions from code review
Nols1000 Jan 12, 2025
1881e0f
Add tests
Nols1000 Jan 12, 2025
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
6 changes: 6 additions & 0 deletions src/utilities/__tests__/getIntrospectionQuery-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,4 +138,10 @@ describe('getIntrospectionQuery', () => {
2,
);
});

it('throw error if typeDepth is too high', () => {
expect(() => getIntrospectionQuery({ typeDepth: 101 })).to.throw(
'Please set typeDepth to a reasonable value between 0 and 100; the default is 9.',
);
});
});
64 changes: 27 additions & 37 deletions src/utilities/getIntrospectionQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,16 @@ export interface IntrospectionOptions {
* Default: false
*/
oneOf?: boolean;

/**
* How deep to recurse into nested types, larger values will result in more
* accurate results, but have a higher load on the server.
* Some servers might restrict the maximum query depth or complexity.
* If that's the case, try decreasing this value.
*
* Default: 9
*/
typeDepth?: number;
}

/**
Expand All @@ -52,6 +62,7 @@ export function getIntrospectionQuery(options?: IntrospectionOptions): string {
schemaDescription: false,
inputValueDeprecation: false,
oneOf: false,
typeDepth: 9,
Copy link
Member

Choose a reason for hiding this comment

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

so this default is a breaking change. If we want this to land in v16 then we should do Infinity and in v17 we can restrict the limits.

Copy link
Author

@Nols1000 Nols1000 Jan 2, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Why is that a breaking change? The behaviour is exactly the same as before. Infinity would lead to an infinite recursive loop.

Copy link
Member

Choose a reason for hiding this comment

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

@saihaj I think you may have misunderstood which depth this relates to - it's the ofType { ofType { ofType { ... } } } depth of the generated query. We couldn't set that to infinity.

...options,
};

Expand All @@ -70,6 +81,21 @@ export function getIntrospectionQuery(options?: IntrospectionOptions): string {
return optionsWithDefault.inputValueDeprecation ? str : '';
}
const oneOf = optionsWithDefault.oneOf ? 'isOneOf' : '';
function ofType(level: number, indent: string): string {
if (level <= 0) {
return '';
}
if (level > 100) {
throw new Error(
'Please set typeDepth to a reasonable value between 0 and 100; the default is 9.',
);
}
return `
${indent}ofType {
${indent} name
${indent} kind${ofType(level - 1, indent + ' ')}
${indent}}`;
}

return `
query IntrospectionQuery {
Expand Down Expand Up @@ -139,43 +165,7 @@ export function getIntrospectionQuery(options?: IntrospectionOptions): string {

fragment TypeRef on __Type {
kind
name
ofType {
kind
name
ofType {
kind
name
ofType {
kind
name
ofType {
kind
name
ofType {
kind
name
ofType {
kind
name
ofType {
kind
name
ofType {
kind
name
ofType {
kind
name
}
}
}
}
}
}
}
}
}
name${ofType(optionsWithDefault.typeDepth ?? 9, ' ')}
}
`;
}
Expand Down