Migrating from v3.x to v4.x
See issues and pull requests done in v4.
New Features
Improved Performance
GraphQL.NET 4.0 has been highly optimized, typically executing queries at least 50% faster while also providing a 75% memory reduction. Small queries have been measured to run twice as fast as they previously ran. A cached query executor is also provided, which can reduce execution time another 20% once the query has been parsed (disabled by default). Variable parsing is also improved to run about 50% faster, and schema build time is now about 20x faster than previously and requires 1/25th the amount of memory.
See the Document Caching guide to enable document caching.
To facilitate the performance changes, many changes were made to the API that may affect you if you have built custom execution strategies, scalars, parser, or similar core components. Please see the complete list of breaking changes below.
Input Object Custom Deserializers (aka resolver)
You can now add code to InputObjectGraphType descendants to build an object from the collected argument
fields. The new ParseDictionary method is called when variables are being parsed or GetArgument is called,
depending on if the argument is stored within variables or as a literal. The method is passed a dictionary
containing the input object's fields and deserialized values.
By default, for InputObjectGraphType<TSourceType> implementations, the dictionary is passed to
ObjectExtensions.ToObject in order to convert the dictionary to an object of TSourceType.
You can override the method to have it return an instance of any appropriate type.
Below is a sample which sets a default value for an unsupplied field (this could be done with a default value set on the field, of course) and converts the name to uppercase:
public class HumanInputType : InputObjectGraphType
{
public HumanInputType()
{
Name = "HumanInput";
Field<NonNullGraphType<StringGraphType>>("name");
Field<StringGraphType>("homePlanet");
}
public override object ParseDictionary(IDictionary<string, object> value)
{
return new Human
{
Name = ((string)value["name"]).ToUpper(),
HomePlanet = value.TryGetValue("homePlanet", out var homePlanet) ? (string)homePlanet : "Unknown",
Id = null,
};
}
}Note that pursuant to GraphQL specifications, if a field is optional, not supplied, and has no default, it will not be in the dictionary.
For untyped InputObjectGraphType classes, like shown above, the default behavior of ParseDictionary
will be to return the dictionary. GetArgument<T> will still attempt to convert a dictionary to the
requested type via ObjectExtensions.ToObject as it did before.
Scalar null value handling
Custom scalars can now handle serialization or deserialization of null values. This can be useful if
you have a need to coerce certain internal values to null, such as serializing empty strings to null.
It can also be used to control deserialization of external null values, such as deserializing null to
the value zero.
GraphQL nullability semantics are enforced on the external AST representation of the data. For instance,
if a custom scalar converted empty strings to null during serialization, an error would occur if a field
resolver tried to return an empty string for a non-null field.
See the Custom Scalars documentation page which describes this in detail.
Experimental Features / Applied Directives
In v4 we added ability to apply directives to the schema elements and expose user-defined meta-information via introspection. This was one of the most requested features not only in GraphQL.NET, but in the entire GraphQL ecosystem as a whole. See the Directives documentation page which describes the new features in detail.
Microsoft-specific Dependency Injection Extensions
If you are using the Microsoft.Extensions.DependencyInjection package, extension methods are provided within
the GraphQL.MicrosoftDI NuGet package for creating a service
provider scope during a field resolver's execution. This is useful when accessing a scoped service with a parallel
execution strategy, as typically scoped services are not multi-threaded compatible. The library also provides a
builder to assist constructing a field resolver that relies on scoped services. Below is a sample of a field resolver
that relies on a scoped service and can run concurrently with other field resolvers:
public class MyGraphType : ObjectGraphType<Category>
{
public MyGraphType()
{
Field("Name", context => context.Source.Name);
Field<ListGraphType<ProductGraphType>>().Name("Products")
.Resolve()
.WithScope()
.WithService<MyDbContext>()
.ResolveAsync((context, db) => db.Products.Where(x => x.CategoryId == context.Source.Id).ToListAsync());
}
}See Dependency Injection for more details.
Ability to Sort Introspection Results
Introspection results are now sorted based on a configured 'comparer' for a schema. You can configure the comparer
by setting ISchema.Comparer to an implementation of ISchemaComparer. By default, introspection results are
returned in the order they were defined.
See Default Sort Order of Introspection Query Results below for a sample of how this can be used to return introspection results that are sorted alphabetically.
Array Pooling
When returning lists of information from field resolvers, you can choose to rent an array from IResolveFieldContext.ArrayPool,
populating it with your results and returning the array. The array will be released after the execution completes. This has
limited uses, since the rented array is not guaranteed to be exactly the requested length, so the array would need to be
wrapped in order to only return the correct number of entries, triggering a memory allocation (albeit a smaller one):
resolve: context =>
{
var ints = context.ArrayPool.Rent<int>(1000); // ints.Length >= 1000
for (int i=0; i<1000; ++i)
ints[i] = i;
return ints.Constrained(1000); // extension method to return an array or array-like object of a given length
});It is not recommended to use this feature for interim calculations, as it is better to work directly with System.Buffers.ArrayPool<T>.
Global Switches
GraphQL.GlobalSwitches is a new static class with properties that affect the schema build process:
EnableReadDefaultValueFromAttributesenables or disables setting default values for 'defaultValue' fromDefaultValueAttribute. Enabled by default.EnableReadDeprecationReasonFromAttributesenables or disables setting default values for 'deprecationReason' fromObsoleteAttribute. Enabled by default.EnableReadDescriptionFromAttributesenables or disables setting default values for 'description' fromDescriptionAttribute. Enabled by default.EnableReadDescriptionFromXmlDocumentationenables or disables setting default values for 'description' from XML documentation. Disabled by default.NameValidationconfigures the validator used when setting theNameproperty on types, arguments, etc. Can be used to disable validation when the configuredINameConverterfixes up invalid names. SeeISchema.NameConverter.
It is recommended to configure these options once when your application starts, such as within your void Main() method, a static
constructor of your schema, or a similar location.
Authorization Extension Methods
Historically, there are two repositories in graphql-dotnet org that provide APIs for configuring authorization requirements.
| Name | Package | Description |
|---|---|---|
| server | GraphQL.Server.Authorization.AspNetCore | Integration of GraphQL.NET validation subsystem into ASP.NET Core |
| authorization | GraphQL.Authorization | A toolset for authorizing access to graph types for GraphQL.NET |
Authorization itself is not a specific part of the GraphQL.NET repository, so it was quite natural to keep this functionality
in separate repositories. However, this resulted in some code duplication between repositories. In addition, there was constant
confusion about which of the two projects to use. In v4, we began the process of converging the two projects to a common denominator.
Extension methods (see AuthorizationExtensions) to configure authorization requirements for GraphQL elements (types, fields, schema)
were moved to GraphQL.NET repository. These methods will be removed from their respective projects after v4 release.
GraphQL.NET will not receive new dependencies, since all methods just read or write meta information. Calling code changes not required.
New parsing methods for scalars
2 new methods for ScalarGraphType have been added in v4:
public bool CanParseLiteral/CanParseValue
These methods checks for input coercion possibility. They can be overridden for custom scalars to validate input values without directly getting those values, i.e. without boxing.
Ability to get parent resolve context of any level
New property IResolveFieldContext.Parent provides access to the parent context (up to the root).
This may be needed to get the parameters of parent nodes.
Other Features
- New method
FieldConfig.ArgumentFor - New property
ISchema.ValueConverters - New method
IParentExecutionNode.ApplyToChildren ExecutionStrategyexposes a number ofprotected virtualmethods that can be used to alter the execution of a document without rewriting the entire class. For instance, overridingShouldIncludeNodeprovides the ability to control the set of fields that the strategy executes; overridingProcessNodeUnhandledExceptionprovides a way to customize exception handling, and so on.- With the addition of
ExecutionContext.ExecutionStrategyandIExecutionStrategy.GetSubFields, the execution strategy now controls the fields that are returned when requested fromIResolveFieldContext.SubFields. - Schema validation upon initialization and better support for schema traversal via
ISchemaNodeVisitor
Breaking Changes
Scalar Deserialization Type Enforcement
Scalars do not coerce values if passed an incompatible type during deserialization from a variable. Previously, values would pass
through the ValueConverter while being deserialized. Now the ValueConverter is ignored for deserialization of built-in scalars.
Calling GetArgument<T> within the field resolver will still call the ValueConverter to coerce the input data to the correct type,
but if the document is unable to deserialize successfully, the field resolver will not run.
Here are some of the situations that you may run into with version 4:
StringGraphTypedoes not serialize integers to strings- Numeric scalars such as
IntGraphTypedo not deserialize strings to their numeric type - Integer numeric scalars such as
IntGraphTypedo not coerce floating-point values to their numeric type BooleanGraphTypedoes not deserialize/serialize strings or integers (e.g. "true", "false", 0, 1, etc)EnumGraphTypeis stricter, requiring internal values for serialization, and external values for deserializationIdGraphType(which allows any basic type) does not coerce variable values to trimmed strings during deserializationIdGraphTypedoes not trim serialized values (but does convert them to strings)DateTimeGraphTypeserializes values to strings instead of letting the JSON serializer do so
If you have a schema-first schema, you may run into an issue with enumeration types, since the SchemaBuilder uses the name of each
enumeration value as its value also. In other words, you must return a string corresponding to the enumeration value (e.g, "Cat" or
"Dog") rather than a matching C# enumeration value (e.g. Animal.Cat or Animal.Dog). You can configure the SchemaBuilder to
match the defined enumeration values to a C# enumeration type in this manner demonstrated below. Then when used as an input type,
the values will be parsed into the matching C# enumeration values, and when used as an output type, you must return the C# enumeration
value (e.g. Animal.Cat) or its underlying value (typically an int). Below are a few examples of how this is configured:
var schema = Schema.For(definitions, c =>
{
// example 1: define the "Animal" schema enumeration type to use the C# type Animal
c.Types.Include<Animal>();
// example 2: define the "AnimalType" schema enumeration type to use the C# type Animal
c.Types.Include<Animal>("AnimalType");
// example 3: define the "Animal" schema enumeration type to use the C# type Animal
c.Types.For("Animal").Type = typeof(Animal);
});For situations where it is necessary to revert scalars to previous behavior, you can override the built-in scalar by following the instructions within the Custom Scalars documentation page.
Below is a sample replacement for the BooleanGraphType which will restore the previous behavior exactly
as it was in version 3.x.
public class MyBooleanGraphType : BooleanGraphType
{
public MyBooleanGraphType()
{
Name = "Boolean";
}
public override object ParseValue(object value) => value switch
{
null => null,
_ => ValueConverter.ConvertTo(value, typeof(bool)) ?? ThrowValueConversionException(value)
};
public override bool CanParseValue(object value)
{
try
{
_ = ParseValue(value);
return true;
}
catch
{
return false;
}
}
}
// Code-first: add the following line of code to your schema's constructor
RegisterType(new MyBooleanGraphType());
// Schema-first: add the following line of code after your schema is built, before it is initialized
schema.RegisterType(new MyBooleanGraphType());Custom Scalar Cleanup
All of the code necessary for a proper custom scalar implementation has been moved from the ValueConverter and IAstNodeConverter
directly into the scalar itself. Some changes will be necessary for custom scalars as follows:
IAstNodeConverter has been completely removed along with the properties relating to it on the Schema. Code that had been configured
for a custom scalar may need to be moved into the new ToAST virtual member of the custom scalar. ValueNode implementations are not
recommended; the ToAST member should return one of the base value node types present in the library, such as StringValue or IntValue.
If the Serialize method returns a basic .NET type (such as int or string), the default ToAST implementation should suffice.
Code within ValueConverter registrations should be moved directly into the ParseLiteral and/or ParseValue methods. Having a
ValueConverter registration should no longer be necessary for custom scalars.
ParseLiteral and ParseValue must handle null values (NullValue for ParseLiteral and null for ParseValue). Typically
this involves returning null for each of these cases.
ParseLiteral, ParseValue and Serialize must throw an exception if the value cannot be parsed. Previously, returning null would
indicate a conversion failure. ThrowLiteralConversionError, ThrowValueConversionError and ThrowSerializationError convenience
methods are provided for this purpose but any exception is valid to throw.
Serialize's default behavior still calls ParseValue. With the other changes, it should be verified if this is still valid
for the custom scalar.
If ToAST is overridden, it must process a value of null (typically by returning a new instance of NullValue) and throw an
exception if there are serialization errors. The ThrowASTConversionError convenience method is provided for this purpose but
any exception is valid to throw.
You may wish to add implementations for the new CanParseValue, CanParseLiteral and IsValidDefault methods. This is not necessary
as the default implementations will call ParseValue, ParseLiteral and ToAST respectively, returning true unless the method
throws an exception. Adding a custom implementation of CanParseLiteral can improve performance if ParseLiteral causes memory allocation / boxing.
CanParseValue is not used by the framework at this time, and ToAST is only called during schema initialization and schema printing.
Schema Configuration Options Moved
NameConverter, SchemaFilter and FieldMiddleware have been removed from ExecutionOptions and are now properties on Schema.
These properties can be set in the constructor of the Schema instance, or within your DI composition root, or at any time before
any query is executed. Once a query has been executed, changes to these fields is not allowed, and adding middleware via the field middleware
builder has no effect.
Middleware Builders
- The signature of
IFieldMiddlewareBuilder.Usehas been changed to remove the schema from delegate. Since the schema is now known, there is no need for it to be passed to the middleware builder. - The middleware
Use<T>extension method has been removed. Please use theUsemethod with a middleware instance instead.
See Field Middleware for more information.
Dependency Injection / GetRequiredService
GraphQL.Utilities.ServiceProviderExtensions has been made internal. This affects usages of its extension method GetRequiredService.
Instead, reference the Microsoft.Extensions.DependencyInjection.Abstractions NuGet package and use the extension method from the
Microsoft.Extensions.DependencyInjection.ServiceProviderServiceExtensions class.
Default Sort Order of Introspection Query Results
By default fields returned by introspection query are no longer sorted by their names. LegacyV3SchemaComparer can be used to switch to the old behavior.
/// <summary>
/// Default schema comparer for GraphQL.NET v3.x.x.
/// By default only fields are ordered by their names within enclosing type.
/// </summary>
public sealed class LegacyV3SchemaComparer : DefaultSchemaComparer
{
private static readonly FieldByNameComparer _instance = new FieldByNameComparer();
private sealed class FieldByNameComparer : IComparer<IFieldType>
{
public int Compare(IFieldType x, IFieldType y) => x.Name.CompareTo(y.Name);
}
/// <inheritdoc/>
public override IComparer<IFieldType> FieldComparer(IGraphType parent) => _instance;
}
schema.Comparer = new LegacyV3SchemaComparer();IResolveFieldContext Re-use
The IResolveFieldContext instance passed to field resolvers is re-used at the completion of the resolver. Be sure not to
use this instance once the resolver finishes executing. To preserve a copy of the context, call .Copy() on the context
to create a copy that is not re-used. Note that it is safe to use the field context within asynchronous field resolvers and
data loaders. Once the asynchronous field resolver or data loader returns its final result, the context will be cleared and may be re-used.
Also, any calls to the configured UnhandledExceptionDelegate will receive a field context copy that will not be re-used,
so it is safe to preserve these instances without calling .Copy().
In version 4.7 and newer, the context will not be re-used if the result of the resolver is an IEnumerable, making it safe
to return LINQ enumerables that are based on the context source.
Subscriptions Moved to Separate Project
The implementation for subscriptions, contained within SubscriptionExecutionStrategy, has been moved into the
GraphQL.SystemReactive NuGet package. The default document executer
will now throw a NotSupportedException when attempting to execute a subscription. Please import the NuGet package and use the
SubscriptionDocumentExecuter instead. If you have a custom document executer, you can override SelectExecutionStrategy in
order to select the SubscriptionExecutionStrategy instance for subscriptions.
protected override IExecutionStrategy SelectExecutionStrategy(ExecutionContext context)
{
return context.Operation.OperationType switch
{
OperationType.Subscription => SubscriptionExecutionStrategy.Instance,
_ => base.SelectExecutionStrategy(context)
};
}DataLoader Moved to Separate Project
The implementation for data loaders, contained within the GraphQL.DataLoader namespace, has been moved into the
GraphQL.DataLoader NuGet package. Please import the NuGet
package if you use data loaders. No code changes are necessary.
ExecutionOptions.EnableMetrics is disabled by default
To enable metrics, please set the option to true before executing the query.
var result = await schema.ExecuteAsync(options =>
{
options.Query = "{ hero { id name } }";
options.EnableMetrics = true;
});GraphQL Member Descriptions
To improve performance, by default GraphQL.NET 4.0 does not pull descriptions for types/fields/etc from XML comments as it did in 3.x. To re-enable that functionality, see Global Switches above.
Changes to IResolveFieldContext.Arguments
IResolveFieldContext.Arguments now returns an IDictionary<string, ArgumentValue> instead of IDictionary<string, object> so that it
can be determined if the value returned is a default value or if it is a specified literal or variable.
IResolveFieldContext.HasArgument now returns false when GetArgument returns a field default value. Note that if a variable is specified,
and the variable resolves to its default value, then HasArgument returns true (since the field argument has successfully resolved to a variable
specified by the query).
Metadata is Not Thread Safe
IProvideMetadata.Metadata is now a Dictionary<string, object> instead of ConcurrentDictionary<string, object>, and is not thread safe anymore.
If you need to write metadata during execution of field resolvers, lock on the graph type before accessing the dictionary. Do not lock on the
Metadata property because there can be concurrency issues accessing the field.
lock (field)
{
int value;
if (field.Metadata.TryGetValue("counter", out var valueObject)) value = (int)valueObject;
field.Metadata["counter"] = value + 1;
}Ability to map CLR types to GraphTypes
Strictly speaking, this feature was available before via GraphTypeTypeRegistry, but it had a significant
drawbacks, since the mapping was static and did not allow registering the same CLR type both as input and output.
In v4 GraphTypeTypeRegistry was completely removed and the ISchema.RegisterTypeMapping(Type, Type)
method was added instead (also there are several extension methods).
Consider the following example:
public class Money
{
public decimal Amount { get; set; }
public string Currency { get; set; }
}
public class Account
{
public Money Saldo { get; set; }
}
public class MoneyType : ObjectGraphType<Money>
{
public MoneyType()
{
Field(x => x.Amount);
Field(x => x.Currency);
}
}
public class AccountType : ObjectGraphType<Account>
{
public MoneyType()
{
Field(x => x.Saldo);
}
}On the Field(x => x.Saldo) line when parsing an expression GraphQL.NET should somehow infer
that the Money CLR type corresponds to the MoneyType GraphType. In fact, this cannot be done
without specifying additional information from the caller. GraphQL.NET can only infer some primitive
CLR types (int, string, DateTime, Guid, etc.) that match built-in scalars.
Type registration is used for the hint:
GraphTypeTypeRegistry.Register<Money, MoneyType>(); // static method before v4
schema.RegisterTypeMapping<Money, MoneyType>(); // instance method on `ISchema` after v4Note that since v4 it's possible to register both input and output GraphType for the same CLR type. In this case, GraphQL.NET will choose the desired GraphType depending on the context.
public class Money
{
public decimal Amount { get; set; }
public string Currency { get; set; }
}
public class MoneyType : ObjectGraphType<Money>
{
public MoneyType()
{
Field(x => x.Amount);
Field(x => x.Currency);
}
}
public class MoneyInputType : InputObjectGraphType<Money>
{
public MoneyInputType()
{
Field(x => x.Amount).Description("Total amount").DefaultValue(100m);
Field(x => x.Currency).DefaultValue("USD");
}
}
schema.RegisterTypeMapping<Money, MoneyType>();
schema.RegisterTypeMapping<Money, MoneyInputType>();An alternative way to define the mapping is to use the new properties in the GraphQLMetadata attribute.
Consider the following example:
[GraphQLMetadata(InputType = typeof(FilterInputGraphType))]
public class Filter
{
public string Key { get; set; }
public int Value { get; set; }
}
public class ContainerRequest
{
public IList<Filter> Filters { get; set; }
public int ClientId { get; set; }
public int AppId { get; set; }
}
public class FilterInputGraphType : InputObjectGraphType<Filter>
{
public FilterInputGraphType()
{
Name = "FilterInput";
Field(x => x.Key);
Field(x => x.Value);
}
}
public class MyInputType : InputObjectGraphType<ContainerRequest>
{
public MyInputType()
{
Name = "Input";
Field(x => x.Filters); // when building this field, its type is implicitly inferred to list of FilterInputGraphType
Field(x => x.ClientId);
Field(x => x.AppId, nullable: true);
}
}In this case, a call to the registration method is not required, since the schema will use information from the provided attribute.
Keep in mind that you can register type mappings even for built-in/primitive types if you want to change their behavior:
schema.RegisterTypeMapping<int, MyIntGraphType>();
schema.RegisterTypeMapping<string, MySpecialFormattedStringGraphType>();If you have dynamic code that relies on a call to GraphTypeTypeRegistry.Get<T> then you will need to instead utilize
a graph type of GraphQLClrOutputTypeReference<T> or GraphQLClrInputTypeReference<T> where T is the CLR type.
The type reference will be replaced with the proper graph type during schema initialization.
Classes for automatic GraphType registration by default use all properties of the CLR type
In v4 AutoRegisteringObjectGraphType<TSourceType> and AutoRegisteringInputObjectGraphType<TSourceType>
classes by default use all properties from the provided TSourceType to generate GraphType's fields (previously they
may skip unmatched properties). If no matching is found for some of the properties, then an exception will be thrown
during schema initialization.
You have multiple options to fix this.
- Add all necessary type mappings with
ISchema.RegisterTypeMappingmethod. - Or pass the unwanted properties into the
excludedPropertiesparameter of the constructor if you create a type vianewoperator.
myField.ResolvedType = new AutoRegisteringObjectGraphType<SomeClassWithManyProperties>(x => x.Address, x => x.SecretCode);- Alternatively, you can inherit from these classes and override the
GetRegisteredPropertiesmethod.
public class MyAutoType : AutoRegisteringObjectGraphType<SomeClassWithManyProperties>
{
protected override IEnumerable<PropertyInfo> GetRegisteredProperties() => typeof(SomeClassWithManyProperties)
.GetProperties(BindingFlags.Public | BindingFlags.Instance).Where(p => Attribute.IsDefined(p, typeof(ForExportAttribute)));
}- Or even compose 2 and 3 approaches.
public class MyAutoType : AutoRegisteringObjectGraphType<SomeClassWithManyProperties>
{
public MyAutoType() : base(x => x.Address, x => x.SecretCode) { }
}IResolveFieldContext.FieldName and IResolveFieldContext.ReturnType
These properties have been removed. Use IResolveFieldContext.FieldAst.Name and
IResolveFieldContext.FieldDefinition.ResolvedType instead.
GraphQLMetadataAttribute.Type -> GraphQLMetadataAttribute.ResolverType
This property was renamed. If you have explicitly set this property in an attribute or used it
directly anywhere, then just change its name. If you did not explicitly set this property, the
default continues to be ResolverType.Resolver.
No more static predefined directives
DirectiveGraphType.Deprecated, DirectiveGraphType.Include and DirectiveGraphType.Skip static properties were moved
into corresponding virtual properties within SchemaDirectives class. This is done in order to be able to independently change
the directives implementation without mutual influence on the schemas using them.
API Cleanup
GraphQL.Instrumentation.StatsReportand its associated classes have been removed. Please copy the source code into your project if you require these classes.LightweightCache.Firstmethod has been removed.IGraphType.CollectTypesmethod has been removed.TypeExtensions.Asmethod has been removedExecutionHelper.SubFieldsForandExecutionHelper.DoesFragmentConditionMatchmethods have been removed.ExecutionHelper.GetVariableValuehas been removed, and the signature forExecutionHelper.CoerceValuehas changed.- All methods inside
ExecutionHelperexceptCoerceValueandGetArgumentValueshave been moved into protected methods withinExecutionStrategy. Method signatures may have changed a very little. RootExecutionNode's constructor requires the root field's selection set, butnullcan be provided if this value is not needed by the execution strategy.UnhandledExceptionContext.Contextis now of typeIExecutionContext, returning a read-only view of the execution context.NodeExtensions,AstNodeExtensionsclasses have been removed.CoreToVanillaConverterclass becamestaticand most of its members have been removed.GraphQL.Language.AST.Field.MergeSelectionSetmethod has been removed.CoreToVanillaConverter.Convertmethod now requires only oneGraphQLDocumentargument.GraphTypesLookuphas been renamed toSchemaTypeswith a significant decrease in public APIsGraphTypesLookup.Createhas been removed; use theSchemaTypesconstructor instead.TypeCollectionContextclass is now internal, also all methods with this parameter inGraphTypesLookup(nowSchemaTypes) are private.GraphTypesLookup.ApplyTypeReferencesis now private.IHaveDefaultValue.Typehas been moved toIProvideResolvedType.TypeErrorLocationstruct becamereadonly.DebugNodeVisitorclass has been removed.- Most methods and classes within
OverlappingFieldsCanBeMergedare now private. EnumerableExtensions.Applyfor dictionaries has been removed.ISubscriptionExecuterhas been removed.EnterLeaveListenerhas been removed and the signatures ofINodeVisitor.EnterandINodeVisitor.Leavehave changed.NodeVisitorsclass has been added in its place.TypeInfo.GetAncestors()has been changed toTypeInfo.GetAncestor(int index)- Various methods within
StringUtilshave been removed; please use extension methods withinStringExtensionsinstead. ISchema.FindDirective,ISchema.RegisterDirective,ISchema.RegisterDirectivesmethods were moved intoSchemaDirectivesclassISchema.FindTypemethod was moved intoSchemaTypes[string typeName]indexer- Some of the
ISchemaNodeVisitormethods have been changes to better support schema traversal SourceLocation,NameNodeandBasicVisitorhave been changed to areadonly struct.ObjectExtensions.GetInterfacehas been removed along with two overloads ofGetPropertyValue.void INode.Visit<TState>(System.Action<INode, TState> action, TState state)method has been added.- Various
IEnumerable<T>properties on schema and graph types have been changed to custom collections:SchemaDirectives,SchemaTypes,TypeFields,PossibleTypes,InterfacesandResolvedInterfaces INode.IsEqualToand related methods have been removed.ApolloTracing.ConvertTimeis now private andResolverTrace.Pathdoes not initialize an empty list when created.SchemaBuilder.RegisterTypeandSchemaBuilder.RegisterTypesmethods have been removed, useISchema.RegisterTypeon the builded schema instead.SchemaBuilder.DirectivesandSchemaBuilder.RegisterDirectiveVisitorhave been removed, useISchema.RegisterVisitoron the builded schema instead.SchemaPrinter.IsBuiltInScalar,SchemaPrinter.IsSpecDirective,SchemaPrinter.IsIntrospectionType,SchemaPrinter.IsDefinedTypemethods have been removed from public APISchemaPrinterOptions.CustomScalarsproperty has been removedValidationContext.Print(INode node)andValidationContext.Print(IGraphType type)methods have been removedDirectives.HasDuplicatesproperty has been removedKnownDirectivesvalidation rule has been renamed toKnownDirectivesInAllowedLocationsand now also generates5.7.2validation error numberAstPrintersupporting classes have been removed; the static methodAstPrinter.Print(INode node)is the only exposed member.Language.AST.Fieldswas replaced withDictionary<string, Field>IResolveFieldContext.Fragmentswas removed; useIResolveFieldContext.Document.FragmentsinsteadExecutionContext.Fragmentswas removed; useExecutionContext.Document.FragmentsinsteadAbstractGraphTypeExtensions.GetTypeOfwas removed; useAbstractGraphTypeExtensions.GetObjectTypeinsteadTypeConfig.FieldFor(string, IServiceProvider)andTypeConfig.SubscriptionFieldFor(string, IServiceProvider)methods were merged into singleTypeConfig.FieldFor(string)method and just return the required configuration without its initialization
Other Breaking Changes (including but not limited to)
- GraphQL.NET now uses GraphQL-Parser v7 with new memory model taking advantage of
System.MemoryAPIs. - When used, Apollo tracing will now convert the starting timestamp to UTC so that
StartTimeandEndTimeare properly serialized as UTC values. Connection<TNode, TEdge>.TotalCounthas been changed from anintto anint?. This allows for returningnullindicating that the total count is unknown.InputObjectGraphType.ParseDictionaryhas been added so that customized deserialization behavior can be specified for input objects (aka input resolvers). IfInputObjectGraphType<T>is used, andGetArgument<T>is called with the same type, no behavior changes will occur by default. IfInputObjectGraphType<T>is used, butGetArgument<T>is called with a different type, coercion may fail. OverrideParseDictionaryto force resolving the input object to the correct type. See Input Object Custom Deserializers above.ExecutionResult.Dataformat breaking changes. BothGraphQL.NewtonsoftJsonandGraphQL.SystemTextJsonserializers received the necessary changes to produce the same JSON as before. However, consumers usingExecutionResultinstances directly most likely will not work correctly. Call((ExecutionNode)result.Data).ToValue()to return the data in the same format as 3.x (as a dictionary).- Most
ExecutionStrategymethods are nowprotected ObjectExecutionNode.SubFieldsproperty type was changed fromDictionary<string, ExecutionNode>toExecutionNode[]ExecutionNode.IsResultSethas been removedExecutionNode.Sourceis read-only; additional derived classes have been added for subscriptionsNameValidator.ValidateNameaccepts an enum instead of a string for its second argumentNameValidator.ValidateNameOnSchemaInitializehas been made internal andValidationOnSchemaInitializehas been removedExecutionNode.PropagateNullmust be called beforeExecutionNode.ToValue; see reference implementationIDocumentValidator.ValidateAsyncdoes not takeoriginalQueryparameter; useDocument.OriginalQueryinsteadIDocumentValidator.ValidateAsyncnow returns(IValidationResult validationResult, Variables variables)tuple instead of singleIValidationResultbeforeGraphQLExtensions.IsValidLiteralValuenow returnsstringinstead ofstring[]and is a member ofValidationContext.