Add @schema decorator to mark namespaces as GraphQL schemas
#1
Conversation
|
Note to reviewers: the first commit is just some |
packages/graphql/src/lib/schema.ts
Outdated
| // This will set the namespace for all the decorators | ||
| export const namespace = "TypeSpec.GraphQL"; |
There was a problem hiding this comment.
| // This will set the namespace for all the decorators | |
| export const namespace = "TypeSpec.GraphQL"; |
This should not be needed when using export const $decorators.
There was a problem hiding this comment.
Turns out we do need this. When we import schema.js into schema.tsp, the definition must be namespaced in order to match the TypeSpec declaration.
So we have two different paths for namespacing:
export const $decoratorsintsp-index.jssets the namespace explicitly for all decorators when used by external codeexport const namespace =inschema.jssets the namespace when the$schemadecorator is imported directly.
Since these are two independent import paths, they should not conflict.
steverice
force-pushed
the
schema-decorator
branch
4 times, most recently
from
bb18a3a
to
c0fff8a
Compare
packages/graphql/package.json
Outdated
| @@ -1,10 +1,26 @@ | |||
| { | |||
| "name": "@typespec/graphql", | |||
| "version": "0.1.0", | |||
| "author": "Microsoft Corporation", | |||
There was a problem hiding this comment.
As I mentioned, these package.json updates have been proposed upstream on their own. So I am hoping to get MSFT's input on what should and shouldn't be in package.json as I think it's ultimately up to them.
Until that, I am mostly just copying things over from other packages (primarily openapi3).
| // Change this to whatever makes sense for the actual GraphQL emitter, probably a GraphQLSchemaRecord | ||
| return [content, diagnostics]; | ||
| const schema = content | ||
| ? buildSchema(content, { |
There was a problem hiding this comment.
I wonder if we can run the emitter in test mode to just return the GraphQL AST directly without deserializing the content into the AST using buildSchema
There was a problem hiding this comment.
Indeed, I wanted to do this, but the structure of the test host and runner built into @typespec/compiler doesn't really allow for this. So after looking into it for a while I gave up.
This approach matches what is done with the OpenAPI tests — the file is emitted, and then loaded and JSON parsed into the OpenAPI object for tests to use.
There was a problem hiding this comment.
Gotcha! Can we add this as a comment here and maybe Brian Terlson can chime in?
steverice
force-pushed
the
schema-decorator
branch
from
c0fff8a
to
4581ffb
Compare
| // Change this to whatever makes sense for the actual GraphQL emitter, probably a GraphQLSchemaRecord | ||
| return [content, diagnostics]; | ||
| const schema = content | ||
| ? buildSchema(content, { |
There was a problem hiding this comment.
Gotcha! Can we add this as a comment here and maybe Brian Terlson can chime in?
steverice
force-pushed
the
schema-decorator
branch
2 times, most recently
from
9b12057
to
f87595e
Compare
Using the `TypeSpec.GraphQL.@schema` decorator on a namespace indicates that the decorated namespace represents a GraphQL schema that should be generated by the GraphQL emitter. Because this allows for multiple schemas to be specified in a TypeSpec source, our test host is reworked to provide a `GraphQLTestResult` corresponding to each schema produced. This commit does not actually implement any emitter functionality, but populates a state map that will be used by the emitter in the future.
steverice
force-pushed
the
schema-decorator
branch
from
f87595e
to
5ef2ace
Compare
Using the
TypeSpec.GraphQL.@schemadecorator on a namespace indicates that the decorated namespace represents a GraphQL schema that should be generated by the GraphQL emitter.Because this allows for multiple schemas to be specified in a TypeSpec source, our test host is reworked to provide a
GraphQLSchemaRecordcorresponding to each schema produced.This commit does not actually implement any emitter functionality, but populates a state map that will be used by the emitter in the future.