v7

[yaacovCR]

Breaking Changes:

Schema Generation and Decoration API (@graphql-tools/schema)

• 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.

Schema Delegation (delegateToSchema & @graphql-tools/delegate)

• 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-executabel) 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.

Remote Schemas & Wrapping (wrapSchema, makeRemoteExecutableSchema, and @graphql-tools/wrap)

• 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.

Schema Stitching (stitchSchemas & @graphql-tools/stitch)

• 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.

Mocking (addMocksToSchema and @graphql-tools/mock)

• 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.

Other Utilities (@graphql-tools/utils)

• 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.
• Unused fieldNodes utility functions have been removed.
• Unused typeContainsSelectionSet function has been removed, and typesContainSelectionSet has been moved to the stitch package.
• Unnecessary Operation type has been removed in favor of OperationTypeNode from upstream graphql-js.
• As above, applySchemaTransforms/applyRequestTransforms/applyResultTransforms have been removed from the utils package, as they are implemented elsewhere or no longer necessary.

[theguild-bot]

The latest changes of this PR are available as alpha in npm (based on the declared changesets):

@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]
@graphql-tools/[email protected]

[gmac]

Another proposal I'd offer here is to make mergeTypes: true (and friends) implicit in the presence of any merge subschema config when stitching schemas. At this point, the feature is feeling non-experimental enough that the extra setting feels a little odd... maybe I'm glossing over some nuanced use cases though. Just a thought.

[yaacovCR]

#1994 (comment)

[changeset-bot]

🦋 Changeset detected

Latest commit: 09822d8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 24 packages

Name	Type
@graphql-tools/batch-execute	Major
@graphql-tools/delegate	Major
@graphql-tools/mock	Major
@graphql-tools/schema	Major
@graphql-tools/stitch	Major
@graphql-tools/utils	Major
@graphql-tools/wrap	Major
@graphql-tools/links	Patch
@graphql-tools/merge	Patch
graphql-tools	Patch
@graphql-tools/batch-delegate	Patch
@graphql-tools/url-loader	Patch
@graphql-tools/graphql-tag-pluck	Patch
@graphql-tools/load	Patch
@graphql-tools/relay-operation-optimizer	Patch
@graphql-tools/resolvers-composition	Patch
@graphql-tools/apollo-engine-loader	Patch
@graphql-tools/code-file-loader	Patch
@graphql-tools/git-loader	Patch
@graphql-tools/github-loader	Patch
@graphql-tools/graphql-file-loader	Patch
@graphql-tools/json-file-loader	Patch
@graphql-tools/module-loader	Patch
@graphql-tools/prisma-loader	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[yaacovCR]

@ardatan @dotansimha

What do we envision the changeset for v7 to look like? major version bump for everything or just the changed packages?

[dotansimha]

Just the changed packages :) and those who are heavily effected by those changes.

[alfaproject]

@yaacovCR how do I try out this version?

[dotansimha]

@yaacovCR can you please rebase to latest master? i think this will fix canary release

[yaacovCR]

#1935 (comment)

[gmac]

Wahoo!! Congrats!

[alfaproject]

I don't get it tho. Now you have dependencies that got a minor update (6.2.5) depending on modules that got a major update (7.0.0). My node modules are a mess...