Skip to content

Allow circular references #68

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
tibawatanabe merged 2 commits into from
May 19, 2018
Merged

Allow circular references #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ba63a4
Allow self-referencing circular types
VojtaStanek Dec 31, 2017
6ace1fb
Allow thunk in return types
VojtaStanek Dec 31, 2017
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
25 changes: 22 additions & 3 deletions src/specs/object.type-factory.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ describe('objectTypeFactory', function () {
@D.ObjectType()
class Obj { @D.Field() title: string; }
const GQLType: any = objectTypeFactory(Obj);
assert(GQLType._typeConfig.name === 'Obj');
assert(GQLType._typeConfig.fields.title.type instanceof graphql.GraphQLScalarType);
assert(GQLType.name === 'Obj');
assert(GQLType.getFields().title.type instanceof graphql.GraphQLScalarType);
});

it('returns GraphQLInputObjectType with a class annotated by @InputObjectType', function () {
Expand All @@ -62,11 +62,30 @@ describe('objectTypeFactory', function () {
@D.InputObjectType()
class Obj { @D.Field() title: string; @D.Field({ type: undefined }) nested: {}; }
try {
const GQLType: any = objectTypeFactory(Obj, true);
const GQLType = objectTypeFactory(Obj, true);
GQLType.getFields();
assert.fail();
} catch (e) {
const err = e as SchemaFactoryError;
assert(err.type === SchemaFactoryErrorType.NO_FIELD);
}
});

it('returns GraphQLObjectType if includes circular references', function () {
@D.ObjectType()
class Obj { @D.Field() circle: Obj; }
const GQLType = objectTypeFactory(Obj);
assert(GQLType.name === 'Obj');
assert((GQLType.getFields().circle.type as graphql.GraphQLObjectType).getFields().circle.type instanceof graphql.GraphQLObjectType);
});

it('allows thunk circular dependecies', function () {
@D.ObjectType()
class A { @D.Field({type: () => B}) circle: any; } // tslint:disable-line:no-use-before-declare
@D.ObjectType()
class B { @D.Field({type: () => A}) circle: any; }
const GQLType = objectTypeFactory(A);
assert(GQLType.name === 'A');
assert((GQLType.getFields().circle.type as graphql.GraphQLObjectType).getFields().circle.type instanceof graphql.GraphQLObjectType);
});
});
6 changes: 5 additions & 1 deletion src/type-factory/field.type-factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,11 @@ function convertType(typeFn: Function, metadata: FieldMetadata | ArgumentMetadat
returnType = objectTypeFactory(typeFn, isInput);
}
} else {
returnType = metadata.type;
try {
returnType = typeof metadata.type === 'function' ? metadata.type() : metadata.type;
} catch (e) {
returnType = metadata.type;
}

if (returnType && returnType.prototype && getMetadataArgsStorage().filterUnionTypeByClass(returnType).length > 0) {
returnType = unionTypeFactory(returnType, isInput);
Expand Down
2 changes: 1 addition & 1 deletion src/type-factory/object.type-factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export function objectTypeFactory(target: Function, isInput: boolean = false): g
SchemaFactoryErrorType.NO_FIELD);
}

const fields = fieldMetadataList.reduce((map, fieldMetadata) => {
const fields = () => fieldMetadataList.reduce((map, fieldMetadata) => {
Copy link
Copy Markdown

@felipesabino felipesabino Jan 5, 2018

Choose a reason for hiding this comment

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

🤔 clever 👏

I will leave this SO answer here for future reference on why this works https://stackoverflow.com/a/39290345/429521

let field = fieldTypeFactory(fieldMetadata.target, fieldMetadata.field, isInput);
if (!field) {
throw new SchemaFactoryError(`@ObjectType()'s ${fieldMetadata.field.name} is annotated by @Field() but no type could be inferred`,
Expand Down
⚡