GraphQL type sources - Githubissues

prisma-labs / graphql-framework-experiment

Code-First Type-Safe GraphQL Framework

https://nexusjs.org

MIT License

673 stars 66 forks source link

GraphQL type sources #1056

Open jasonkuhrt opened 4 years ago

jasonkuhrt commented 4 years ago

Perceived Problem

We want to give users feedback about empty graphql schema
plugins can contribute graphql schema types
when we dogfood (for example scalar builtins) we also, in core, contribute
contributions from core, or plugins, remove the feedback we want our users to see (we use a hack right now to avoid the core contribs removing the feedback)

Ideas / Proposed Solution(s)

A way for graphql schema type contributions to be tracked
This would allow giving diagnostic feedback/overview about the composition of a schema, useful maybe if user has many different plugins contributing

a private api, not visible to public

schema.private.source('name').<schema type builder api>

the public schema api would essentially come from an internal call like this:
```
schema.private.source('app')
```
plugins would be given a type builder api like so:
```
schema.private.source(pluginName)
```

then we can upgrade our internal index like so:

schema.private.state.types.all: NexusType[]
schema.private.state.types.from: { app: NexusType[], [name:string]: NexusType:[] }

Finally a type's source name could also be kept in its meta property

Weakky commented 4 years ago

Love the proposal! ✅