Share
Embed
DIY GraphQL Codegen
Yosuke Kurami
August 28, 2020
Transcript
43 slides
-
Client Side Code Generation - ͳͥGraphQLͰCodeGen͕ඞཁͳͷ͔ - ClientͷϦΫΤετ(query)ͷܗʹԠͯ͡Response͕ܾఆ͞ΕΔͷ͕ GraphQLͷಛ -
ಛʹ੩తܕݴޠͷ߹ʮͲͷΑ͏ͳσʔλ͕ฦͬͯ͘Δ͔ʯ͕ඞཁ ʹͳΔ -
Client Side Code Generation export default () => { const
{ data } = useQuery< GitHubQuery, GitHubQueryVariables >(query, { variables: { first: 100 } }); if (!data) return null; return ( <ul> {data.viewer?.repositories?.nodes?.map(repo => ( <li key={repo?.id}> <span>{repo?.description}</span> </li> ))} </ul> ); }; const repositoryFragment = gql` fragment RepositoryFragment on Repository { description } `; const query = gql` ${repositoryFragment} query GitHubQuery($first: Int!) { viewer { repositories(first: $first) { nodes { id ...RepositoryFragment } } } } `; -
Client Side Code Generation - ͜͏͍͏ܕใ͕͋Εɺલϖʔδͷ data ΛܕνΣοΫͰ͖Δ export type
RepositoryFragment = { description: string | null; }; export type GitHubQuery = { viewer: { repositories: { nodes: (({ id: string; } & RepositoryFragment) | null)[] | null; }; }; }; export type GitHubQueryVariables = { first: number; }; -
Client Side Code Generation - queryʹଘࡏ͠ͳ͍ϑΟʔϧυʹରͯ͠ɺίʔυ͔ΒͷΞΫηεΛېࢭͰ ͖ΔͨΊɺCodeGenʮUnder FetchingΛࢭ͢ΔΈʯͱߟ͑Δ͜ ͱͰ͖Δ -
※ Under Fetching: ຊདྷClientʹඞཁͳϑΟʔϧυΛqueryʹॻ͖Εͯ͠·͏͜ͱɻ ػೳཁ্݅ͷෆඋʹͳΔɻ ରͱͳΔͷ Over FetchingɻෆཁͳϑΟʔϧυ͕queryʹࡌ͍ͬͯΔঢ়ଶɻੑೳྼ ԽΛҾ͖ى͜͢ɻඇػೳཁ݅ͷෆඋͱͳΔɻ -
ts-graphql-plugin - https://github.com/Quramy/ts-graphql-plugin - ͕ࣗ࡞͍ͯ͠ΔπʔϧɻTypeScriptͰͷClient։ൃʹಛԽ͍ͯ͠Δ - CodeGenҎ֎ʹҎԼͷػೳ: - GarphQL queryʹର͢ΔLanguage
Service(ิΤϥʔνΣοΫ) - Ϗϧυ࣌ʹqueryΛparse͢ΔͨΊͷwebpack plugin - etc… -
ͳͥCodeGenΛࣗ࡞ͨ͠ͷ͔ - ͿͬͪΌ͚Δͱʮ࡞Γ͔͔ͨͬͨΒʯͱ͍͏ͷ͕ຊԻ - ͱͱApollo ToolingΛར༻͍͕ͯͨ͠ɺόʔδϣϯΞοϓʹରͯ͠ಈ ࡞͕ෆ҆ఆʹײ͍ͯͨ͡ - Apollo Toolingʹdependencies͕ଟ͗͢Δ
- ts-graphql-plugin 3 dependenciesͷΈʢ͔͠༁2ͭgraphql ͱtypescriptʣɻΊͬͪΌinstall ͍ܰ -
ͳͥCodeGenΛࣗ࡞ͨ͠ͷ͔ - ͷ߹ɺClientͱͯ͠TypeScriptͷΈ͕͋Εॆ - ൚༻తͳCodeGenΛ࡞Ζ͏ͱ͢Δͱɺಈ࡞ݴޠΛநԽ͢ΔͨΊʹ Template Engineʢ࣮ࡍɺgraphql-codegen Template Literal String
ϕʔεͷpluginػߏʹͳͬͯͨϋζʣʹཔͬͯ͠·͍͕ͪ - ʮTypeScriptͷίʔυΛੜ͢Δ͜ͱʯΛతʹ͢ΔͱɺTypeScript ASTͷAPIͰ݁͢Δɻ ಛʹGraphQLͷΑ͏ͳ࠶ؼߏจΛѻ͏্ͰɺAST APIΛ৮ͬͨํ͕γ ϯϓϧʹ࡞ΕΔ -
GraphQL visitor - queryͷղੳʹඞཁͳπʔϧNPMͷ graphql ʹ ͯ͢API͕ἧ͍ͬͯΔ - parser, visitor,
unperser(generator), etc… - visitorͷAPIESLintBabel pluginͱಉ༷ͷܗ ࣜʢNode kindʹcallback͕Ԡ͢ΔλΠϓʣ - ֤callbackʹ͞ΕΔnodenodeใΛอ ͍࣋ͯ͠ͳ͍ (non-recursive, serializableʣ import { parse, visit, DocumentNode } from 'graphql'; const inputString = ` query MyQuery { viewer { id name } } `; const documentNode = parse(inputString); visit(documentNode, { // GraphQL ASTͷNodeछผ OperationDefinition: { enter: node => { // enter visitor͕nodeʹೖͬͨͱ͖ͷॲཧ if (node.operation === 'query') { console.log(node.name?.value); } }, leave: node => { // leavevisitor͕nodeΛग़Δͱ͖ͷॲཧ }, }, }); -
query MyQuery { viewer { id: userId name } }
export type MyQuery = { viewer: { userId: string; name: string; }; }; αϯϓϧͱͯ͠ɺ͜ͷRVFSZUZQFੜʹ͍ͭͯੜنଇΛߟ͑ͯΈΔ -
query MyQuery { viewer { id: userId name } }
OperationDefinition export type MyQuery = { viewer: { userId: string; name: string; }; }; TypeAliasDeclaration OperationDefinitionTypeAliasDeclarationʹରԠ -
query MyQuery { viewer { id: userId name } }
OperationDefinition SelectionSet export type MyQuery = { viewer: { userId: string; name: string; }; }; TypeAliasDeclaration TypeLiteral SelectionSetTypeLiteralʹରԠ -
query MyQuery { viewer { id: userId name } }
OperationDefinition SelectionSet Field export type MyQuery = { viewer: { userId: string; name: string; }; }; TypeAliasDeclaration TypeLiteral PropertySignature FieldPropertySignatureʹରԠ -
query MyQuery { viewer { id: userId name } }
OperationDefinition SelectionSet Field SelectionSet export type MyQuery = { viewer: { userId: string; name: string; }; }; TypeAliasDeclaration TypeLiteral TypeLiteral PropertySignature SelectionSetTypeLiteralʹରԠʢ͖ͬ͞ͱҰॹʂʣ -
query MyQuery { viewer { id: userId name } }
OperationDefinition SelectionSet Field Field SelectionSet export type MyQuery = { viewer: { userId: string; name: string; }; }; TypeAliasDeclaration TypeLiteral TypeLiteral PropertySignature PropertySignature FieldPropertySignatureʹରԠʢ͖ͬ͞ͱҰॹʂʣ -
query MyQuery { viewer { id: userId name } }
OperationDefinition SelectionSet Field Field Field SelectionSet export type MyQuery = { viewer: { userId: string; name: string; }; }; TypeAliasDeclaration TypeLiteral TypeLiteral PropertySignature PropertySignature PropertySignature OperationDefiniton -> TypeAliasDeclaration SelectionSet -> TypeLiteral Field -> PropertySignature ͨͬͨͭʢొ͍ͯͨ͠"45ͷछྨʣͷنଇ͚ͩͰΓཱͭ -
visitதʹඞཁͱͳΔσʔλ - ʮੜنଇΛຬͨͨ͢Ίʹɺvisitor͔Βࢀর͖͢σʔλԿ͔ʯΛߟ ͑Δ - ࠓճͷྫͩͱɺԼهͳͲΛݕ౼͢Δ - visitor͕ண͍ͯ͠ΔGraphQLͷSchema Object Type
- visitor͕ண͍ͯ͠ΔFieldͷܕͱͳΔ͖TypeScript AST - visitor͕ண͍ͯ͠ΔSelectionSetʹؚ·ΕΔmemberͷܕ -
Schema Info Stack (GraphQL Object type) Type Literal Members Stack
(TypeScript AST) undefined Current Field Type (TypeScript AST) FNQUZ FNQUZ ண͍ͯ͠ΔGraphQLͷ Schema Object Type ண͍ͯ͠ΔFieldͷܕͱͳ Δ͖TypeScript AST ண͍ͯ͠ΔSelectionSetʹ ؚ·ΕΔmemberͷܕ -
Enter OperationDefinition Schema Info Stackʹ2VFSZ.VUBUJPO4VCTDSJQUJPOͷ4DIFNBใΛੵΉ Leave OperationDefinition Schema
Info StackΛQPQ͢Δ Current Field Type ͔ΒTypeAliasDeclarationΛੜ͢Δ Enter SelectionSet Type Literal Members StackʹۭྻΛੵΉ Leave SelectionSet Type Literal MembersΛQPQ͢Δ QPQͨ͠NFNCFSใ͔ΒLiteralTypeOPEFΛੜͯ͠ɺCurrent Field Type ʹηοτ͢Δ Enter Field 4DIFNB*OGP4UBDLʹͦͷpFMEʹରԠ͢Δ4DIFNB0CKFDUͷใΛੵΉ ϑΟʔϧυ͕4DBMBUZQFͷ߹ Current Field Typeʹ4DBMBʹରԠ͢Δܕͷ"45 Ληοτ͢Δ Leave Field 4DIFNB*OGP4UBDLΛQPQ͢Δ $VSSFOU'JFME5ZQFΛܕͱͯ࣋ͭ͠Α͏ʹQSPQFSUZ4JHOBUVSFOPEFΛੜ͠ɺ -JUFSBM.FNCFST4UBDLͷUBJMཁૉʹՃ ϧʔϧΛॻ͖ग़͢ͱ্هͷΑ͏ʹͳΔ͕ɺ۩ମతʹWJTJUPSͷಈ͖Λݟͨํ͕ཧղ͍͢͠ -
Schema Info Stack (GraphQL Object type) Type Literal Members Stack
(TypeScript AST) undefined enter OperationDefinition enter SelectionSet enter Field enter SelectionSet enter Field leave Field enter Field leave Field leave SelectionSet leave Field leave SelectionSet leave OperationDefinition Current Field Type (TypeScript AST) query MyQuery { viewer { id: userId name } } FNQUZ FNQUZ ண͍ͯ͠ΔGraphQLͷ Schema Object Type ண͍ͯ͠ΔFieldͷܕͱͳ Δ͖TypeScript AST ண͍ͯ͠ΔSelectionSetʹ ؚ·ΕΔmemberͷܕ -
type Query, name = MyQuery Schema Info Stack (GraphQL Object
type) Type Literal Members Stack (TypeScript AST) undefined QVTI enter OperationDefinition enter SelectionSet enter Field enter SelectionSet enter Field leave Field enter Field leave Field leave SelectionSet leave Field leave SelectionSet leave OperationDefinition Current Field Type (TypeScript AST) query MyQuery { viewer { id: userId name } } OperationDefinition FNQUZ -
type Query, name = MyQuery Schema Info Stack (GraphQL Object
type) Type Literal Members Stack (TypeScript AST) [] undefined enter OperationDefinition enter SelectionSet enter Field enter SelectionSet enter Field leave Field enter Field leave Field leave SelectionSet leave Field leave SelectionSet leave OperationDefinition Current Field Type (TypeScript AST) query MyQuery { viewer { id: userId name } } SelectionSet QVTI -
type Query, name = MyQuery Schema Info Stack (GraphQL Object
type) Type Literal Members Stack (TypeScript AST) [] type Viewer!, name = viewer undefined QVTI enter OperationDefinition enter SelectionSet enter Field enter SelectionSet enter Field leave Field enter Field leave Field leave SelectionSet leave Field leave SelectionSet leave OperationDefinition Current Field Type (TypeScript AST) query MyQuery { viewer { id: userId name } } Field -
type Query, name = MyQuery Schema Info Stack (GraphQL Object
type) Type Literal Members Stack (TypeScript AST) [] type Viewer!, name = viewer [] undefined enter OperationDefinition enter SelectionSet enter Field enter SelectionSet enter Field leave Field enter Field leave Field leave SelectionSet leave Field leave SelectionSet leave OperationDefinition Current Field Type (TypeScript AST) query MyQuery { viewer { id: userId name } } SelectionSet QVTI -
type Query, name = MyQuery Schema Info Stack (GraphQL Object
type) Type Literal Members Stack (TypeScript AST) [] type Viewer!, name = viewer [] string type ID!, name = userId QVTI enter OperationDefinition enter SelectionSet enter Field enter SelectionSet enter Field leave Field enter Field leave Field leave SelectionSet leave Field leave SelectionSet leave OperationDefinition Current Field Type (TypeScript AST) query MyQuery { viewer { id: userId name } } Field -
type Query, name = MyQuery Schema Info Stack (GraphQL Object
type) Type Literal Members Stack (TypeScript AST) [] type Viewer!, name = viewer [userId: string;] string type ID!, name = userId QPQ enter OperationDefinition enter SelectionSet enter Field enter SelectionSet enter Field leave Field enter Field leave Field leave SelectionSet leave Field leave SelectionSet leave OperationDefinition Current Field Type (TypeScript AST) query MyQuery { viewer { id: userId name } } Field -
type Query, name = MyQuery Schema Info Stack (GraphQL Object
type) Type Literal Members Stack (TypeScript AST) [] type Viewer!, name = viewer [userId: string;] string type String!, name = name QVTI enter OperationDefinition enter SelectionSet enter Field enter SelectionSet enter Field leave Field enter Field leave Field leave SelectionSet leave Field leave SelectionSet leave OperationDefinition Current Field Type (TypeScript AST) query MyQuery { viewer { id: userId name } } Field -
type Query, name = MyQuery Schema Info Stack (GraphQL Object
type) Type Literal Members Stack (TypeScript AST) [] type Viewer!, name = viewer [userId: string; name: string;] string type String!, name = name QPQ enter OperationDefinition enter SelectionSet enter Field enter SelectionSet enter Field leave Field enter Field leave Field leave SelectionSet leave Field leave SelectionSet leave OperationDefinition Current Field Type (TypeScript AST) query MyQuery { viewer { id: userId name } } Field -
type Query, name = MyQuery Schema Info Stack (GraphQL Object
type) Type Literal Members Stack (TypeScript AST) [] type Viewer!, name = viewer [userId: string; name: string;] { userId: string; name: string; } enter OperationDefinition enter SelectionSet enter Field enter SelectionSet enter Field leave Field enter Field leave Field leave SelectionSet leave Field leave SelectionSet leave OperationDefinition Current Field Type (TypeScript AST) query MyQuery { viewer { id: userId name } } SelectionSet QPQ -
type Query, name = MyQuery Schema Info Stack (GraphQL Object
type) Type Literal Members Stack (TypeScript AST) [viwer: {…}] type Viewer!, name = viewer { userId: string; name: string; } QPQ enter OperationDefinition enter SelectionSet enter Field enter SelectionSet enter Field leave Field enter Field leave Field leave SelectionSet leave Field leave SelectionSet leave OperationDefinition Current Field Type (TypeScript AST) query MyQuery { viewer { id: userId name } } Field -
type Query, name = MyQuery Schema Info Stack (GraphQL Object
type) Type Literal Members Stack (TypeScript AST) [viwer: {…}] { viewer: { userId: string; name: string; }; } enter OperationDefinition enter SelectionSet enter Field enter SelectionSet enter Field leave Field enter Field leave Field leave SelectionSet leave Field leave SelectionSet leave OperationDefinition Current Field Type (TypeScript AST) query MyQuery { viewer { id: userId name } } SelectionSet QPQ -
type Query, name = MyQuery Schema Info Stack (GraphQL Object
type) Type Literal Members Stack (TypeScript AST) { viewer: { userId: string; name: string; }; } QPQ enter OperationDefinition enter SelectionSet enter Field enter SelectionSet enter Field leave Field enter Field leave Field leave SelectionSet leave Field leave SelectionSet leave OperationDefinition Current Field Type (TypeScript AST) $VSSFOU'JFME5ZQFͱ4DIFNB*OGP4UBDLͷઌ಄͔ΒUZQFΛPVUQVUͰ͖Δ query MyQuery { viewer { id: userId name } } OperationDefinition FNQUZ -
AST to ASTͷޣຯ - ͘͝؆୯ͳྫͰղઆ͕ͨ͠ɺts-graphql-pluginͰ͍ͬͯΔͷղઆ͠ ͨύλʔϯͱҰॹ - ୯७ͳϧʔϧͳΈ߹ΘͤͰෳࡶͳܕ͕ੜͰ͖Δͷຊʹ໘ന͍ - e.g.
Current Field Type͔ΒType Literal MembersΛੜ͢Δࡍʹͪΐͬͱͨ͠ॲཧΛՃ ͢Δɻ Current Field TypeʹͲΜͳܕ͕ೖ͍ͬͯͯΓཱͭ - ts.SyntaxKind.NullKeyword ΛՃ͑ͯ ts.createUnionTypeNode ΛऔΕɺ Optionalͳܕͷදݱʹ - ts.createArrayTypeNode Ͱϥοϓ͢Εɺྻܕͷදݱʹ -
Summary - GraphQL AST͔ΒTypeScriptͷASTΛੜ͢ΔྲྀΕΛղઆ - ʮ͘͝؆୯ͳϧʔϧͷΈ߹ΘͤͰෳࡶͳίʔυΛੜ͢Δʯͱ͍͏ҙ ຯͰɺίϯύΠϥͷ࣮ͱࣅ͍ͯΔͱ͜Ζ͕͋Δ - GraphQLͷASTඇৗʹγϯϓϧͳͷͰɺࣗͷཉ͍͠ίʔυʹ߹Θ ͤͯCodeGenΛखΈ͢Δͱָ͍͠
- Apollo Linkapollo-client෦తʹGraphQL ͷvisitorΛར༻͢Δͨ ΊɺࣝͷԠ༻ޮ͘