Skip to content

Add unionTypes and interfaceTypes to the json-modern IR #2050

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

Merged
hwillson merged 1 commit into from
Jul 30, 2020
Merged

Add unionTypes and interfaceTypes to the json-modern IR #2050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
- `apollo-codegen-typescript`
- <First `apollo-codegen-typescript` related entry goes here>
- `apollo-codegen-core`
- <First `apollo-codegen-core` related entry goes here>
- Add new `unionTypes` and `interfaceTypes` properties to the exported IR JSON (when using the `json-modern` target), that list all unions and their types, as well as all interfaces and their implementing types [#2050](https://github.com/apollographql/apollo-tooling/pull/2050).
- `apollo-env`
- <First `apollo-env` related entry goes here>
- `apollo-graphql`
Expand Down
301 changes: 297 additions & 4 deletions packages/apollo-codegen-core/src/__tests__/__snapshots__/jsonOutput.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,9 @@ exports[`JSON output should generate JSON output for a mutation with an enum and
}
]
}
]
],
\\"unionTypes\\": [],
\\"interfaceTypes\\": []
}"
`;

Expand Down Expand Up @@ -300,7 +302,17 @@ exports[`JSON output should generate JSON output for a query with a fragment spr
]
}
],
\\"typesUsed\\": []
\\"typesUsed\\": [],
\\"unionTypes\\": [],
\\"interfaceTypes\\": [
{
\\"name\\": \\"Character\\",
\\"types\\": [
\\"Human\\",
\\"Droid\\"
]
}
]
}"
`;

Expand Down Expand Up @@ -377,7 +389,17 @@ exports[`JSON output should generate JSON output for a query with a nested selec
}
],
\\"fragments\\": [],
\\"typesUsed\\": []
\\"typesUsed\\": [],
\\"unionTypes\\": [],
\\"interfaceTypes\\": [
{
\\"name\\": \\"Character\\",
\\"types\\": [
\\"Human\\",
\\"Droid\\"
]
}
]
}"
`;

Expand Down Expand Up @@ -468,6 +490,16 @@ exports[`JSON output should generate JSON output for a query with an enum variab
}
]
}
],
\\"unionTypes\\": [],
\\"interfaceTypes\\": [
{
\\"name\\": \\"Character\\",
\\"types\\": [
\\"Human\\",
\\"Droid\\"
]
}
]
}"
`;
Expand Down Expand Up @@ -538,7 +570,9 @@ exports[`JSON output should generate JSON output for a subscription 1`] = `
}
],
\\"fragments\\": [],
\\"typesUsed\\": []
\\"typesUsed\\": [],
\\"unionTypes\\": [],
\\"interfaceTypes\\": []
}"
`;

Expand Down Expand Up @@ -658,6 +692,265 @@ exports[`JSON output should generate JSON output for an input object type with d
}
]
}
],
\\"unionTypes\\": [],
\\"interfaceTypes\\": []
}"
`;

exports[`JSON output should list all interfaces and their implementing types under a \`interfaceTypes\` property 1`] = `
"{
\\"operations\\": [
{
\\"filePath\\": \\"GraphQL request\\",
\\"operationName\\": \\"HeroForEpisode\\",
\\"operationType\\": \\"query\\",
\\"rootType\\": \\"Query\\",
\\"variables\\": [],
\\"source\\": \\"query HeroForEpisode {\\\\n hero(episode: JEDI) {\\\\n __typename\\\\n name\\\\n ... on Droid {\\\\n primaryFunction\\\\n }\\\\n }\\\\n}\\",
\\"fields\\": [
{
\\"responseName\\": \\"hero\\",
\\"fieldName\\": \\"hero\\",
\\"type\\": \\"Character\\",
\\"args\\": [
{
\\"name\\": \\"episode\\",
\\"value\\": \\"JEDI\\",
\\"type\\": \\"Episode\\"
}
],
\\"isConditional\\": false,
\\"isDeprecated\\": false,
\\"fields\\": [
{
\\"responseName\\": \\"__typename\\",
\\"fieldName\\": \\"__typename\\",
\\"type\\": \\"String!\\",
\\"isConditional\\": false,
\\"isDeprecated\\": false
},
{
\\"responseName\\": \\"name\\",
\\"fieldName\\": \\"name\\",
\\"type\\": \\"String!\\",
\\"isConditional\\": false,
\\"description\\": \\"The name of the character\\",
\\"isDeprecated\\": false
}
],
\\"fragmentSpreads\\": [],
\\"inlineFragments\\": [
{
\\"typeCondition\\": \\"Droid\\",
\\"possibleTypes\\": [
\\"Droid\\"
],
\\"fields\\": [
{
\\"responseName\\": \\"__typename\\",
\\"fieldName\\": \\"__typename\\",
\\"type\\": \\"String!\\",
\\"isConditional\\": false,
\\"isDeprecated\\": false
},
{
\\"responseName\\": \\"name\\",
\\"fieldName\\": \\"name\\",
\\"type\\": \\"String!\\",
\\"isConditional\\": false,
\\"description\\": \\"What others call this droid\\",
\\"isDeprecated\\": false
},
{
\\"responseName\\": \\"primaryFunction\\",
\\"fieldName\\": \\"primaryFunction\\",
\\"type\\": \\"String\\",
\\"isConditional\\": false,
\\"description\\": \\"This droid's primary function\\",
\\"isDeprecated\\": false
}
],
\\"fragmentSpreads\\": []
}
]
}
],
\\"fragmentSpreads\\": [],
\\"inlineFragments\\": [],
\\"fragmentsReferenced\\": [],
\\"sourceWithFragments\\": \\"query HeroForEpisode {\\\\n hero(episode: JEDI) {\\\\n __typename\\\\n name\\\\n ... on Droid {\\\\n primaryFunction\\\\n }\\\\n }\\\\n}\\",
\\"operationId\\": \\"173a7ebf41abd014f3fc54ddd007f6182fca738bd44a1e2d1bb75503c8bf79f6\\"
}
],
\\"fragments\\": [],
\\"typesUsed\\": [],
\\"unionTypes\\": [],
\\"interfaceTypes\\": [
{
\\"name\\": \\"Character\\",
\\"types\\": [
\\"Human\\",
\\"Droid\\"
Copy link
Copy Markdown
Contributor

@designatednerd designatednerd Jul 24, 2020

Choose a reason for hiding this comment

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

Isn't there also an Alien type? Or is this going to only have the possible types that are actually used?

Copy link
Copy Markdown
Member Author

@hwillson hwillson Jul 24, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

@designatednerd The schema the tests are using doesn't have an Alien type. You can see it here.

]
}
]
}"
`;

exports[`JSON output should list all unions and their types under a \`unionTypes\` property 1`] = `
"{
\\"operations\\": [
{
\\"filePath\\": \\"GraphQL request\\",
\\"operationName\\": \\"Search\\",
\\"operationType\\": \\"query\\",
\\"rootType\\": \\"Query\\",
\\"variables\\": [],
\\"source\\": \\"query Search {\\\\n search(text: \\\\\\"an\\\\\\") {\\\\n __typename\\\\n ... on Human {\\\\n name\\\\n height\\\\n }\\\\n ... on Droid {\\\\n name\\\\n primaryFunction\\\\n }\\\\n ... on Starship {\\\\n name\\\\n length\\\\n }\\\\n }\\\\n}\\",
\\"fields\\": [
{
\\"responseName\\": \\"search\\",
\\"fieldName\\": \\"search\\",
\\"type\\": \\"[SearchResult]\\",
\\"args\\": [
{
\\"name\\": \\"text\\",
\\"value\\": \\"an\\",
\\"type\\": \\"String\\"
}
],
\\"isConditional\\": false,
\\"isDeprecated\\": false,
\\"fields\\": [
{
\\"responseName\\": \\"__typename\\",
\\"fieldName\\": \\"__typename\\",
\\"type\\": \\"String!\\",
\\"isConditional\\": false,
\\"isDeprecated\\": false
}
],
\\"fragmentSpreads\\": [],
\\"inlineFragments\\": [
{
\\"typeCondition\\": \\"Human\\",
\\"possibleTypes\\": [
\\"Human\\"
],
\\"fields\\": [
{
\\"responseName\\": \\"__typename\\",
\\"fieldName\\": \\"__typename\\",
\\"type\\": \\"String!\\",
\\"isConditional\\": false,
\\"isDeprecated\\": false
},
{
\\"responseName\\": \\"name\\",
\\"fieldName\\": \\"name\\",
\\"type\\": \\"String!\\",
\\"isConditional\\": false,
\\"description\\": \\"What this human calls themselves\\",
\\"isDeprecated\\": false
},
{
\\"responseName\\": \\"height\\",
\\"fieldName\\": \\"height\\",
\\"type\\": \\"Float\\",
\\"isConditional\\": false,
\\"description\\": \\"Height in the preferred unit, default is meters\\",
\\"isDeprecated\\": false
}
],
\\"fragmentSpreads\\": []
},
{
\\"typeCondition\\": \\"Droid\\",
\\"possibleTypes\\": [
\\"Droid\\"
],
\\"fields\\": [
{
\\"responseName\\": \\"__typename\\",
\\"fieldName\\": \\"__typename\\",
\\"type\\": \\"String!\\",
\\"isConditional\\": false,
\\"isDeprecated\\": false
},
{
\\"responseName\\": \\"name\\",
\\"fieldName\\": \\"name\\",
\\"type\\": \\"String!\\",
\\"isConditional\\": false,
\\"description\\": \\"What others call this droid\\",
\\"isDeprecated\\": false
},
{
\\"responseName\\": \\"primaryFunction\\",
\\"fieldName\\": \\"primaryFunction\\",
\\"type\\": \\"String\\",
\\"isConditional\\": false,
\\"description\\": \\"This droid's primary function\\",
\\"isDeprecated\\": false
}
],
\\"fragmentSpreads\\": []
},
{
\\"typeCondition\\": \\"Starship\\",
\\"possibleTypes\\": [
\\"Starship\\"
],
\\"fields\\": [
{
\\"responseName\\": \\"__typename\\",
\\"fieldName\\": \\"__typename\\",
\\"type\\": \\"String!\\",
\\"isConditional\\": false,
\\"isDeprecated\\": false
},
{
\\"responseName\\": \\"name\\",
\\"fieldName\\": \\"name\\",
\\"type\\": \\"String!\\",
\\"isConditional\\": false,
\\"description\\": \\"The name of the starship\\",
\\"isDeprecated\\": false
},
{
\\"responseName\\": \\"length\\",
\\"fieldName\\": \\"length\\",
\\"type\\": \\"Float\\",
\\"isConditional\\": false,
\\"description\\": \\"Length of the starship, along the longest axis\\",
\\"isDeprecated\\": false
}
],
\\"fragmentSpreads\\": []
}
]
}
],
\\"fragmentSpreads\\": [],
\\"inlineFragments\\": [],
\\"fragmentsReferenced\\": [],
\\"sourceWithFragments\\": \\"query Search {\\\\n search(text: \\\\\\"an\\\\\\") {\\\\n __typename\\\\n ... on Human {\\\\n name\\\\n height\\\\n }\\\\n ... on Droid {\\\\n name\\\\n primaryFunction\\\\n }\\\\n ... on Starship {\\\\n name\\\\n length\\\\n }\\\\n }\\\\n}\\",
\\"operationId\\": \\"9887ff0652e14d678a66769b853c41293d4afb1d1338bbbdb9f84e66979605dd\\"
}
],
\\"fragments\\": [],
\\"typesUsed\\": [],
\\"unionTypes\\": [
{
\\"name\\": \\"SearchResult\\",
\\"types\\": [
\\"Human\\",
\\"Droid\\",
\\"Starship\\"
]
}
],
\\"interfaceTypes\\": []
}"
`;
Loading
⚡