Skip to content
This repository was archived by the owner on Dec 8, 2021. It is now read-only.

Support iterable return types #447

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 11 additions & 13 deletions packages/graphqlgen/src/generators/common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -219,13 +219,12 @@ export const kv = (
return `${key}${isOptional ? '?' : ''}: ${value}`
}

const array = (
innerType: string,
config: { innerUnion?: boolean } = {},
): string => {
return config.innerUnion ? `${innerType}[]` : `Array<${innerType}>`
const array = (innerType: string, innerUnion: boolean): string => {
return innerUnion ? `Array<${innerType}>` : `${innerType}[]`
}

const iterable = (innerType: string) => `Iterable<${innerType}>`

export const union = (types: string[]): string => {
return types.join(' | ')
}
Expand All @@ -242,9 +241,7 @@ export const printFieldLikeType = (
modelMap: ModelMap,
interfacesMap: InterfacesMap,
unionsMap: UnionsMap,
options: FieldPrintOptions = {
isReturn: false,
},
options: FieldPrintOptions = {},
): string => {
if (field.type.isInterface || field.type.isUnion) {
const typesMap = field.type.isInterface ? interfacesMap : unionsMap
Expand All @@ -260,7 +257,7 @@ export const printFieldLikeType = (
}

if (field.type.isArray) {
rendering = array(rendering, { innerUnion: false })
rendering = iterable(rendering)

if (!field.type.isArrayRequired) {
rendering = nullable(rendering)
Expand Down Expand Up @@ -304,8 +301,6 @@ export const printFieldLikeType = (
*/

if (field.type.isArray) {
const innerUnion = field.type.isRequired

// - Not voidable here because a void array member is not possible
// - For arrays default value does not apply to inner value
const valueInnerType = field.type.isRequired ? name : nullable(name)
Expand All @@ -316,9 +311,12 @@ export const printFieldLikeType = (

const isArrayVoidable = isArrayNullable && field.defaultValue === undefined

const arrayType = options.isReturn
? iterable(valueInnerType)
: array(valueInnerType, !field.type.isRequired)
const valueType = isArrayNullable
? nullable(array(valueInnerType, { innerUnion })) // [1]
: array(valueInnerType, { innerUnion })
? nullable(arrayType) // [1]
: arrayType

return options.isReturn
? valueType
Expand Down
47 changes: 28 additions & 19 deletions packages/graphqlgen/tests/flow/__snapshots__/basic.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -324,14 +324,14 @@ export type Query_Custom_array_nullable_Resolver = (
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<Number | null> | null | Promise<Array<Number | null> | null>;
) => Iterable<Number | null> | null | Promise<Iterable<Number | null> | null>;

export type Query_Custom_array_required_Resolver = (
parent: {},
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<Number | null> | Promise<Array<Number | null>>;
) => Iterable<Number | null> | Promise<Iterable<Number | null>>;

export type Query_Custom_with_arg_Resolver = (
parent: {},
Expand Down Expand Up @@ -366,14 +366,14 @@ export type Query_Scalar_array_nullable_Resolver = (
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<boolean | null> | null | Promise<Array<boolean | null> | null>;
) => Iterable<boolean | null> | null | Promise<Iterable<boolean | null> | null>;

export type Query_Scalar_array_required_Resolver = (
parent: {},
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<boolean | null> | Promise<Array<boolean | null>>;
) => Iterable<boolean | null> | Promise<Iterable<boolean | null>>;

export type Query_Scalar_with_arg_Resolver = (
parent: {},
Expand Down Expand Up @@ -416,14 +416,14 @@ export interface Query_Resolvers {
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<Number | null> | null | Promise<Array<Number | null> | null>;
) => Iterable<Number | null> | null | Promise<Iterable<Number | null> | null>;

custom_array_required: (
parent: {},
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<Number | null> | Promise<Array<Number | null>>;
) => Iterable<Number | null> | Promise<Iterable<Number | null>>;

custom_with_arg: (
parent: {},
Expand Down Expand Up @@ -458,14 +458,17 @@ export interface Query_Resolvers {
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<boolean | null> | null | Promise<Array<boolean | null> | null>;
) =>
| Iterable<boolean | null>
| null
| Promise<Iterable<boolean | null> | null>;

scalar_array_required: (
parent: {},
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<boolean | null> | Promise<Array<boolean | null>>;
) => Iterable<boolean | null> | Promise<Iterable<boolean | null>>;

scalar_with_arg: (
parent: {},
Expand Down Expand Up @@ -629,15 +632,15 @@ export type Query_Users_Resolver = (
args: Query_Args_Users,
ctx: Context,
info: GraphQLResolveInfo
) => Array<Student | Professor> | Promise<Array<Student | Professor>>;
) => Iterable<Student | Professor> | Promise<Iterable<Student | Professor>>;

export interface Query_Resolvers {
users: (
parent: {},
args: Query_Args_Users,
ctx: Context,
info: GraphQLResolveInfo
) => Array<Student | Professor> | Promise<Array<Student | Professor>>;
) => Iterable<Student | Professor> | Promise<Iterable<Student | Professor>>;
}

// Types for Student
Expand Down Expand Up @@ -984,14 +987,17 @@ export type Query_Custom_array_nullable_Resolver = (
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<NumberNode | null> | null | Promise<Array<NumberNode | null> | null>;
) =>
| Iterable<NumberNode | null>
| null
| Promise<Iterable<NumberNode | null> | null>;

export type Query_Custom_array_required_Resolver = (
parent: {},
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<NumberNode | null> | Promise<Array<NumberNode | null>>;
) => Iterable<NumberNode | null> | Promise<Iterable<NumberNode | null>>;

export type Query_Custom_with_arg_Resolver = (
parent: {},
Expand Down Expand Up @@ -1026,14 +1032,14 @@ export type Query_Scalar_array_nullable_Resolver = (
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<boolean | null> | null | Promise<Array<boolean | null> | null>;
) => Iterable<boolean | null> | null | Promise<Iterable<boolean | null> | null>;

export type Query_Scalar_array_required_Resolver = (
parent: {},
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<boolean | null> | Promise<Array<boolean | null>>;
) => Iterable<boolean | null> | Promise<Iterable<boolean | null>>;

export type Query_Scalar_with_arg_Resolver = (
parent: {},
Expand Down Expand Up @@ -1077,16 +1083,16 @@ export interface Query_Resolvers {
ctx: Context,
info: GraphQLResolveInfo
) =>
| Array<NumberNode | null>
| Iterable<NumberNode | null>
| null
| Promise<Array<NumberNode | null> | null>;
| Promise<Iterable<NumberNode | null> | null>;

custom_array_required: (
parent: {},
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<NumberNode | null> | Promise<Array<NumberNode | null>>;
) => Iterable<NumberNode | null> | Promise<Iterable<NumberNode | null>>;

custom_with_arg: (
parent: {},
Expand Down Expand Up @@ -1121,14 +1127,17 @@ export interface Query_Resolvers {
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<boolean | null> | null | Promise<Array<boolean | null> | null>;
) =>
| Iterable<boolean | null>
| null
| Promise<Iterable<boolean | null> | null>;

scalar_array_required: (
parent: {},
args: {},
ctx: Context,
info: GraphQLResolveInfo
) => Array<boolean | null> | Promise<Array<boolean | null>>;
) => Iterable<boolean | null> | Promise<Iterable<boolean | null>>;

scalar_with_arg: (
parent: {},
Expand Down
Loading