A set of utils for faster development of GraphQL tools
A fully open-source MIT-licensed GraphQL API gateway that can act as a GraphQL federation Gateway or a Proxy Gateway for any GraphQL services.
It can be run as a standalone binary, a Docker Image, or as a JavaScript package (e.g. within Node.js, Bun, Deno, Google Cloud Functions, Azure Functions or Cloudflare Workers)
#1140 f634b53 Thanks @enisdenjo! - Use delegated response iterable next iterations for accurate cache key construction in external value loaders
#1134 dca6529 Thanks @ardatan! - Small improvements on usage of promise helpers
Updated dependencies []:
graphql-hive0512be3]:#532 4e33933 Thanks @EmrysMyrddin! - dependencies updates:
@whatwg-node/promise-helpers@^1.3.0 ↗︎ (from ^1.2.5, in dependencies)Updated dependencies [4e33933]:
#862 278618a Thanks @ardatan! - dependencies updates:
@whatwg-node/promise-helpers@^1.2.5 ↗︎ (from ^1.0.0, in dependencies)Updated dependencies [278618a]:
#726 6334b2e Thanks @ardatan! - dependencies updates:
@whatwg-node/promise-helpers@^1.0.0 ↗︎ (to dependencies)#742 2a54e85 Thanks @kathrynkodama! - Remove the index from the batched error;
In case of batched delegation (for example multiple book entitites fetched from different places from a field), remove the index from the error message, as it is not relevant in this case.
Updated dependencies [6334b2e, 2a54e85]:
2318393]:#620 d72209a Thanks @renovate! - dependencies updates:
@graphql-tools/utils@^10.8.1 ↗︎ (from ^10.7.0, in dependencies)Updated dependencies [d72209a]:
9144222]:18682e6]:#396 da65b2d Thanks @ardatan! - Memoize the key arguments correctly;
With the following schema and resolvers, userById should batch all the requests to usersByIds;
{
typeDefs: /* GraphQL */ `
type User {
id: ID!
email: String!
}
type Query {
userById(id: ID!): User
usersByIds(ids: [ID!]): [User]
}
`,
resolvers: {
Query: {
usersByIds: (_root, args) => {
return args.ids.map((id: string) => users.find((user) => user.id === id));
},
userById: (root, args, context, info) => {
return batchDelegateToSchema({
schema: userSubschema,
fieldName: 'usersByIds',
key: args.id,
rootValue: root,
context,
info,
})
},
},
},
}
This query should batch all the requests to usersByIds:
{
userById(id: "1") {
id
email
}
userById(id: "2") {
id
email
}
}
The delegation request should be;
{
usersByIds(ids: ["1", "2"]) {
id
email
}
}
#382 21e1f05 Thanks @ardatan! - Memoize the batched delegation loader by respecting the arguments correctly
#373 e606975 Thanks @ardatan! - dependencies updates:
@graphql-tools/utils@^10.7.0 ↗︎ (from ^10.6.2, in dependencies)Updated dependencies [e606975]:
23b8987]:#291 34d1224 Thanks @ardatan! - dependencies updates:
tslib@^2.8.1 ↗︎ (from ^2.4.0, in dependencies)Updated dependencies [34d1224]:
#264 6f56083 Thanks @renovate! - dependencies updates:
dataloader@2.2.3 ↗︎ (from 2.2.2, in dependencies)#268 7df2215 Thanks @ardatan! - dependencies updates:
dataloader@^2.2.3 ↗︎ (from 2.2.3, in dependencies)#269 cdca511 Thanks @ardatan! - dependencies updates:
@graphql-tools/utils@^10.6.2 ↗︎ (from ^10.6.0, in dependencies)Updated dependencies [7df2215, cdca511]:
9ce705c]:7ca0ff3]:2e0add3]:#164 310613d Thanks @ardatan! - dependencies updates:
@graphql-tools/utils@^10.6.0 ↗︎ (from ^10.5.6, in dependencies)#185 f0b6921 Thanks @ardatan! - dependencies updates:
value-or-promise@^1.0.12 ↗︎ (from dependencies)#188 f71366d Thanks @ardatan! - dependencies updates:
value-or-promise@^1.0.12 ↗︎ (from dependencies)Updated dependencies [310613d]:
f32cb2a]:73c621d]:342e044]:e9906eb]:da1de08]:f470f49]:180f3f0]:8effad4]:8a16b01]:4cdb462]:7e2938d]:cf2ce5e]:#6194
7368829
Thanks @ardatan! - Handle interface objects in a different way
Updated dependencies
[7368829,
e10c13a,
e10c13a,
dfccfbf,
0134f7f]:
83c0af0
Thanks @enisdenjo! - dependencies updates:@graphql-tools/delegate@^10.0.3 ↗︎
(from ^10.0.1, in dependencies)@graphql-tools/utils@^10.0.13 ↗︎
(from ^10.0.0, in dependencies)83c0af0,
83c0af0]:8fba6cc1,
944a68e8,
944a68e8]:Updated dependencies
[8e80b689]:
#5205
a33097f7
Thanks @ardatan! - dependencies updates:
value-or-promise@^1.0.12 ↗︎ (to
dependencies)2f342e43
Thanks @ardatan! - Do not use promises if not async
Updated dependencies
[2f342e43]:
1c95368a
Thanks @ardatan! - Use ranged versions for dependencies
Updated dependencies []:
f26392a6]:1913bf91
Thanks @PatrykWalach! - Pass keys to lazyOptionsFn492220cb]:30bd4d0c
Thanks @renovate! - dependencies updates:dataloader@2.2.2 ↗︎
(from 2.2.1, in dependencies)30bd4d0c]:b09ea282
Thanks @renovate! - dependencies updates:dataloader@2.2.1 ↗︎
(from 2.1.0, in dependencies)b09ea282,
b5c8f640]:a94217e9,
62d074be]:772b948a]:a4d36fcc,
e3ec35ed]:13177794]:904fe770,
904fe770]:13c24883,
b5e6459f]:7411a5e7]:c0639dd0]:d83b1960]:80836fa7,
8f6d3efc,
80836fa7,
80836fa7,
80836fa7]:f7daf777]:df5848b8,
df5848b8,
df5848b8,
df5848b8]:0402894d]:614a5622
Thanks @ardatan! - Smarter caching for batch delegation by using the
selectionSet input00c4a1a4]:43c736bd]:71cb4fae,
403ed450]:4fe3d9c0]:#4640
27bdc237
Thanks @ardatan! - dependencies updates:
@graphql-tools/delegate@9.0.3 ↗︎
(was 9.0.2, in dependencies)0555a972]:29ee7542]:2609d71f]:#4624
e3167edc
Thanks @n1ru4l! - Fix CommonJS TypeScript resolution with
moduleResolution node16 or nodenext
Updated dependencies
[e3167edc,
d8dc67aa]:
5482c99a: Support graphql-executor
batchDelegateToSchema currently assumes that the source fieldNodes are unique for each request, but this may not be the case when using executors such as graphql-executor. graphql-executor uses memoization to deliver the identical source fieldNodes object across requests, so functions operating on these fieldNodes can be memoized. This change ensures that batches are unique to requests, as long as the context object differs, using the same strategy that stitching makes use of with batch execution (getBatchingExecutor).
dae6dc7b: refactor: ExecutionParams type replaced by Request type
rootValue property is now a part of the Request type.
When delegating with delegateToSchema, rootValue can be set multiple ways:
When using wrapSchema/stitchSchemas, a subschemaConfig can specify the createProxyingResolver function which can pass whatever rootValue it wants to delegateToSchema as above.
161963ac: fix(batch-delegate): only batch together delegations to the same root field
see #2638.
a9254491: - Resolver validation options should now be set to error, warn or ignore rather
than true or false. In previous versions, some of the validators caused errors to be thrown,
while some issued warnings. This changes brings consistency to validator behavior.
The allowResolversNotInSchema has been renamed to requireResolversToMatchSchema, to
harmonize the naming convention of all the validators. The default setting of
requireResolversToMatchSchema is error, matching the previous behavior.
The delegateToSchema return value has matured and been formalized as an ExternalObject, in
which all errors are integrated into the GraphQL response, preserving their initial path. Those
advanced users accessing the result directly will note the change in error handling. This also
allows for the deprecation of unnecessary helper functions including slicedError, getErrors,
getErrorsByPathSegment functions. Only external errors with missing or invalid paths must
still be preserved by annotating the remote object with special properties. The new
getUnpathedErrors function is therefore necessary for retrieving only these errors. Note also
the new annotateExternalObject and mergeExternalObjects functions, as well as the renaming
of handleResult to resolveExternalValue.
Transform types and the applySchemaTransforms are now relocated to the delegate package;
applyRequestTransforms/applyResultTransforms functions have been deprecated, however, as
this functionality has been replaced since v6 by the Transformer abstraction.
The transformRequest/transformResult methods are now provided additional delegationContext
and transformationContext arguments -- these were introduced in v6, but previously optional.
The transformSchema method may wish to create additional delegating resolvers and so it is now
provided the subschemaConfig and final (non-executable) transformedSchema parameters. As in
v6, the transformSchema is kicked off once to produce the non-executable version, and then, if
a wrapping schema is being generated, proxying resolvers are created with access to the
(non-executable) initial result. In v7, the individual transformSchema methods also get access
to the result of the first run, if necessary, they can create additional wrapping schema
proxying resolvers.
applySchemaTransforms parameters have been updated to match and support the transformSchema
parameters above.
wrapSchema and generateProxyingResolvers now only take a single options argument with named
properties of type SubschemaConfig. The previously possible shorthand version with first
argument consisting of a GraphQLSchema and second argument representing the transforms should
be reworked as a SubschemaConfig object.
Similarly, the ICreateProxyingResolverOptions interface that provides the options for the
createProxyingResolver property of SubschemaConfig options has been adjusted. The schema
property previously could be set to a GraphQLSchema or a SubschemaConfig object. This
property has been removed in favor of a subschemaConfig property that will always be a
SubschemaConfig object. The transforms property has been removed; transforms should be
included within the SubschemaConfig object.`
The format of the wrapping schema has solidified. All non-root fields are expected to use
identical resolvers, either defaultMergedResolver or a custom equivalent, with root fields
doing the hard work of proxying. Support for custom merged resolvers throught
createMergedResolver has been deprecated, as custom merging resolvers conflicts when using
stitching's type merging, where resolvers are expected to be identical across subschemas.
The WrapFields transform's wrappingResolver option has been removed, as this complicates
multiple wrapping layers, as well as planned functionality to wrap subscription root fields in
potentially multiple layers, as the wrapping resolvers may be different in different layers.
Modifying resolvers can still be performed by use of an additional transform such as
TransformRootFields or TransformObjectFields.
The ExtendSchema transform has been removed, as it is conceptually simpler just to use
stitchSchemas with one subschema.
The ReplaceFieldsWithFragment, AddFragmentsByField, AddSelectionSetsByField, and
AddMergedTypeSelectionSets transforms has been removed, as they are superseded by the
AddSelectionSets and VisitSelectionSets transforms. The AddSelectionSets purposely takes
parsed SDL rather than strings, to nudge end users to parse these strings at build time (when
possible), rather than at runtime. Parsing of selection set strings can be performed using the
parseSelectionSet function from @graphql-tools/utils.
stitchSchemas's mergeTypes option is now true by default! This causes the onTypeConflict
option to be ignored by default. To use onTypeConflict to select a specific type instead of
simply merging, simply set mergeTypes to false.
schemas argument has been deprecated, use subschemas, typeDefs, or types, depending on
what you are stitching.
When using batch delegation in type merging, the argsFromKeys function is now set only via the
argsFromKeys property. Previously, if argsFromKeys was absent, it could be read from args.
Support for fragment hints has been removed in favor of selection set hints.
stitchSchemas now processes all GraphQLSchema and SubschemaConfig subschema input into new
Subschema objects, handling schema config directives such aso@computed as well as generating
the final transformed schema, stored as the transformedSchema property, if transforms are
used. Signatures of the onTypeConflict, fieldConfigMerger, and inputFieldConfigMerger have
been updated to include metadata related to the original and transformed subschemas. Note the
property name change for onTypeConflict from schema to subschema.
Mocks returning objects with fields set as functions are now operating according to upstream
graphql-js convention, i.e. these functions take three arguments, args, context, and info
with parent available as this rather than as the first argument.
filterSchema's fieldFilter will now filter all fields across Object, Interface, and Input
types. For the previous Object-only behavior, switch to the objectFieldFilter option.
fieldNodes utility functions have been removed.typeContainsSelectionSet function has been removed, and typesContainSelectionSet has
been moved to the stitch package.Operation type has been removed in favor of OperationTypeNode from upstream
graphql-js.applySchemaTransforms/applyRequestTransforms/applyResultTransforms have been
removed from the utils package, as they are implemented elsewhere or no longer necessary.96a7555d: Fix release
Last PATCH release actually transitively updated graphql-tools and @graphql-tools/delegate to use latest MAJOR version of dependencies.