Skip to content

Allow configuration of the ofType introspection depth #4317

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

Open
Nols1000 wants to merge 4 commits into
base: 16.x.x
Choose a base branch
from
Open

Allow configuration of the ofType introspection depth #4317

Changes from 2 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
61 changes: 24 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,15 @@ 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. Some servers might restrict the
* maximum query depth. If thats the case, try decreasing this value.
*
* Default: 9
*/
typeDepth?: number;
}

/**
Expand All @@ -52,6 +61,7 @@ export function getIntrospectionQuery(options?: IntrospectionOptions): string {
schemaDescription: false,
inputValueDeprecation: false,
oneOf: false,
typeDepth: 9,
...options,
};

Expand All @@ -70,6 +80,19 @@ 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; 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 +162,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