Skip to content

feat: update graphql type informer to handle circular dependencies be… #1571

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
hendrik-depauw-lemon wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: update graphql type informer to handle circular dependencies be… #1571

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
71 changes: 52 additions & 19 deletions packages/framework-core/src/services/graphql/graphql-type-informer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ import {
GraphQLType,
GraphQLUnionType,
} from 'graphql'
import { defineFieldMap } from 'graphql/type/definition'

import { GraphQLJSON } from 'graphql-scalars'
import { ClassMetadata, ClassType, PropertyMetadata, TypeMetadata } from '@boostercloud/metadata-booster'
import { DateScalar, isExternalType, nonExcludedFields } from './common'
Expand Down Expand Up @@ -153,20 +155,37 @@ export class GraphQLTypeInformer {
inputType: boolean,
excludeProps?: Array<string>
): GraphQLType {
const typeName = classMetadata.name + (inputType ? 'Input' : '')

// Create a placeholder to store type before defining fields (for circular refs)
if (!this.graphQLTypes[typeName]) {
this.graphQLTypes[typeName] = inputType
? new GraphQLInputObjectType({ name: typeName, fields: {} })
: new GraphQLObjectType({ name: typeName, fields: {} })
}

const finalFields: Array<PropertyMetadata> = nonExcludedFields(classMetadata.fields, excludeProps)

if (inputType) {
return new GraphQLInputObjectType({
name: classMetadata.name + 'Input',
fields: finalFields?.reduce((obj, prop) => {
this.logger.debug(`Get or create GraphQL input type for property ${prop.name}`)
return {
...obj,
[prop.name]: { type: this.getOrCreateGraphQLType(prop.typeInfo, inputType) },
}
}, {}),
Object.assign(this.graphQLTypes[typeName], {
_fields: () =>
defineFieldMap({
Copy link
Copy Markdown
Collaborator

@MarcAstr0 MarcAstr0 Apr 22, 2025

Choose a reason for hiding this comment

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

@hendrik-depauw-lemon, it appears that defineFieldMap is no longer accessible in graphql: ^16.6.0, the version used, causing the project not to build. It seems you can work around this by doing the following instead:

const inputObjectType = this.graphQLTypes[typeName] as GraphQLInputObjectType
Object.assign(inputObjectType, {
  _fields: () => {
    return finalFields.reduce((obj, prop) => {
      this.logger.debug(`Get or create GraphQL input type for property ${prop.name}`)
      return {
        ...obj,
        [prop.name]: { type: this.getOrCreateGraphQLType(prop.typeInfo, inputType) },
      }
    }, {})
  },
})

name: typeName,
fields: () =>
finalFields.reduce((obj, prop) => {
this.logger.debug(`Get or create GraphQL input type for property ${prop.name}`)
return {
...obj,
[prop.name]: { type: this.getOrCreateGraphQLType(prop.typeInfo, inputType) },
}
}, {}),
}),
})
} else {
this.createOutputObjectType(classMetadata, excludeProps)
}
return this.createOutputObjectType(classMetadata, excludeProps)

return this.graphQLTypes[typeName]
}

private getOrCreateObjectTypeForUnion(classMetadata: ClassMetadata, excludeProps?: Array<string>): GraphQLType {
Expand All @@ -178,16 +197,30 @@ export class GraphQLTypeInformer {
}

private createOutputObjectType(classMetadata: ClassMetadata, excludeProps?: Array<string>): GraphQLObjectType {
const typeName = classMetadata.name

// Placeholder for circular references
if (!this.graphQLTypes[typeName]) {
this.graphQLTypes[typeName] = new GraphQLObjectType({ name: typeName, fields: {} })
}

const finalFields: Array<PropertyMetadata> = nonExcludedFields(classMetadata.fields, excludeProps)
return new GraphQLObjectType({
name: classMetadata.name,
fields: finalFields?.reduce((obj, prop) => {
this.logger.debug(`Get or create GraphQL output type for property ${prop.name}`)
return {
...obj,
[prop.name]: { type: this.getOrCreateGraphQLType(prop.typeInfo, false) },
}
}, {}),

Object.assign(this.graphQLTypes[typeName], {
_fields: () =>
defineFieldMap({
Copy link
Copy Markdown
Collaborator

@MarcAstr0 MarcAstr0 Apr 22, 2025

Choose a reason for hiding this comment

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

@hendrik-depauw-lemon, it's the same thing here regarding the usage of defineFieldMap.

name: typeName,
fields: () =>
finalFields.reduce((obj, prop) => {
this.logger.debug(`Get or create GraphQL output type for property ${prop.name}`)
return {
...obj,
[prop.name]: { type: this.getOrCreateGraphQLType(prop.typeInfo, false) },
}
}, {}),
}),
})

return this.graphQLTypes[typeName] as GraphQLObjectType
}
}
Loading