v0.0.12
Patch Changes
-
d93aa9a: Add graphql-js v14 support
-
832b8af: Introduce the
ExecutorSchema
interfacegraphql-executor
"upgrades"GraphQLSchema
objects created withgraphql-js
v14 and v15 to agraphql-js
v16-compatibile version by providing utility functions that analyze the schema and provide all the necessary metadata. This change introduces the theExecutorSchema
interface so that clients can explicitly perform this schema preparation step.The included (memoized)
toExectorSchema
utility function generates anExecutorSchema
from aGraphQLSchema
object and is called implicitly if only aGraphQLSchema
is passed to the executor. Using the newexecutorSchema
option, however, a pre-specifiedExecutorSchema
instance can be used. In this case, theGraphQLSchema
passed via theschema
option is never used bygraphql-executor
and only required so that it can be passed through to resolvers via theinfo
argument.The
ExecutorSchema
is also passed to resolvers within anexecutorSchema
property added to theinfo
argument (using TypeScript interface merging). This property is populated both when theExecutorSchema
is provided explicitly and when it is generated from theGraphQLSchema
.BREAKING CHANGE:
The
Executor
class is now instantiated with an configuration object containing aschema
of typeGraphQLSchema
and an optionalexecutorSchema
of typeExecutorSchema
. Previously, the executor was instantiated without any parameters.NOTE:
When the executor is instantiated with both a
schema
and anexecutorSchema
:graphql-executor
does not validate theschema
orexecutorSchema
.graphql-executor
does not check whether theexecutorSchema
matches theschema
.graphql-executor
does not utilize theschema
in any way except to pass its value to resolvers as a property of theinfo
argument.
-
ac0430a: remove createSourceEventStream function export
BREAKING CHANGE: access to createSourceEventStream is still possible in advanced cases, but now only via an explicitly created instance of the internal Executor class.
-
d06133c: Skip schema validation prior to first use.
Schemas can (and should!) still be validated when and where appropriate using the dedicated graphql-js validateSchema method.
graphql-js validates previously unvalidated schemas prior to the first execution. The validation step is skipped by graphql-js if and only if the schema was created with the
assumeValid
option, which essentially triggers a faux validation run that produces no errors.graphql-executor now simply does not automatically validate schemas, preferring to require servers to explicitly validate schemas when and where appropriate, just as document validation is a distinct, explicit step.
-
ecc3758: Allow cross-realm execution
This is made possible by avoiding instanceof checks within the executor proper.
New predicates are introduced that rely on Symbol.toStringTag (or error names) to identify objects from other realms.
Field/type resolvers and isTypeOf functions that are passed GraphQL type system entities and use native graphql-js predicates will still encounter cross-realm errors.
Cross-realm execution can be avoided by end-users by simply calling the original isSchema predicate from graphql-js.