Trax .NET
View as MarkdownEdit on GitHub

Reference

IGraphQLClientValidator

Package Trax.Api.GraphQL.ClientNamespace Trax.Api.GraphQL.ClientSource IGraphQLClientValidator.cs, GraphQLClientValidatorExtensions.cs

Checks an outbound query against the client's schema before it is sent. Registered per client by AddTraxGraphQLClient; the executor and assembly validation both call it. The static class GraphQLClientValidatorExtensions adds ValidateAssembliesAsync.

Signatures

public interface IGraphQLClientValidator
{
    Task<OperationType> ValidateAsync(string query, CancellationToken cancellationToken = default);
}
 
public static class GraphQLClientValidatorExtensions
{
    public static Task ValidateAssembliesAsync(
        this IGraphQLClientValidator validator,
        IEnumerable<Assembly> assemblies,
        CancellationToken cancellationToken = default);
 
    public static Task ValidateAssembliesAsync(
        this IGraphQLClientValidator validator,
        IEnumerable<Assembly> assemblies,
        Func<Type, bool>? typeFilter,
        CancellationToken cancellationToken = default);
}

OperationType here is GraphQLParser.AST.OperationType.

Members

MemberDescription
ValidateAsync(query, cancellationToken)Validates query and returns its operation type (Query, Mutation or Subscription)
ValidateAssembliesAsync(assemblies, cancellationToken)Validates every concrete, closed IGenericGraphQLClientRequest type in assemblies, whatever its [GraphQLClient] mark
ValidateAssembliesAsync(assemblies, typeFilter, cancellationToken)The same, for the types typeFilter accepts (all of them when null)

Behavior

  • ValidateAsync throws ArgumentNullException for a null query, and GraphQLValidationException when the document holds no operation or more than one, when the schema has no root type for the operation (a subscription, by default), or when schema validation fails.
  • A query that passes is cached by its text, up to 1,024 queries per validator. Past that a query is still validated, but not remembered.
  • The schema is loaded on the first validation through the client's ISchemaProvider; a load failure throws GraphQLSchemaIntrospectionException.
  • ValidateAssembliesAsync creates each type without running a constructor, stops at the first failure, and does not fail when it finds no type. The ownership rule (unmarked types for the unkeyed client, marked types for their key) is applied by ValidateGraphQLClientAssembliesAsync, not here.

Example

public class QueryCheck(IGraphQLClientValidator validator)
{
    public Task CheckReportingQueries(CancellationToken ct) =>
        validator.ValidateAssembliesAsync(
            [typeof(QueryCheck).Assembly],
            type => type.Namespace?.EndsWith(".Reporting") == true,
            ct
        );
}

See also