pekkah / tanka-graphql

GraphQL server and execution libraries

Tanka GraphQL library

• Execute queries, mutations and subscriptions
• Validation
• Source Generator based source code generation (Schema types from classes)
• New and improved parser for executable and type system documents
• Delegates as resolvers and subscriptions (also middleware)
• New middleware based execution pipelines (since v3)
• New server and executor implementations (since v3)
• Apollo Federation subgraph support (since v3)
• graphql-ws compatible web socket server (compatible with latest Apollo Client) (since v3)

Documentation and packages

• Documentation

Both beta and release packages are available from NuGet and NPM

Samples

See Samples in the repository. See Tanka Chat for a more complete example.

Install

dotnet package add Tanka.GraphQL
dotnet package add Tanka.GraphQL.Server

Run benchmarks

src\GraphQL.benchmarks> dotnet run --configuration release --framework net8.0

tanka-graphql's Issues

Real-world sample application

https://github.com/pekkah/tanka-graphql-samples

Introspection round 2

Simplify introspection by removing the intermediate "__types"

Input for mutation type can only bind data in the last field

I'm not sure if it is a bug or not, but when I created the input type with multiple fields like

input CreateProductInput {
  name: String!
  price: Float!
  imageUrl: String
  desc: String
}

with mutation type

type Mutation {
  createProduct(message: CreateProductInput!): Product!
}

schema {
  query: Query
  mutation: Mutation
}

on the server side, I have created CoolStoreResolvers class

public class CoolStoreResolvers : ResolverMap
{
    public CoolStoreResolvers(ICoolStoreResolverService resolverService)
    {
        
        this["Mutation"] = new FieldResolverMap
        {
            {"createProduct",  resolverService.CreateProductAsync}
        };
    }
}

and CoolStoreResolverService as

public class CoolStoreResolverService : ICoolStoreResolverService
{
    public async Task<IResolveResult> CreateProductAsync(ResolverContext context)
    {
        var input = context.GetArgument<CreateProductRequest>("message");
		
		// do something		

        return await Task.FromResult(As(product));
    }
}

I tested with graphiql with the test data like

mutation createProduct($message: CreateProductInput!) {
  createProduct(message: $message) {
    name
	price
	desc
  }
}

Input variables as below

{
  "message": {
    "name": "product 1",
    "price": 100,
    "desc": "this is product 1"
  }
}

In the code above, I always got only desc field binding data with the string this is product 1, and the rest of fields such as name, price and imageUrl were null.

I have seen the samples folder from this project only have one field for input type as

input InputMessage {
    content: String!
}

Is it because this library could not bind multiple field data for input type?

I used

<PackageReference Include="tanka.graphql" Version="0.3.1" />
<PackageReference Include="tanka.graphql.server" Version="0.3.1" />

Subscription example in docs is faulty

Adding delete but receiving insert

Args and PossibleTypes as connections

Review extensions

Move directives away from Meta

Global resolver middleware

Investigate replacing data flow blocks with channels

Implement missing validator

• 5.8.3 All Variable Uses Defined

docs: update type system - descriptions

https://pekkah.github.io/tanka-graphql/beta/3-type-system/03-descriptions.html

Update to match builder methods

UnionType should only accept Object types as possible types

Support apollo link ws

For compatibility with existing GraphQL services this would be required to integrate with them

Schema immutability

Review schema initialization

Currently initializing schema requires several async phases. This leads extra complications when used with IoC services which do not support async registrations.

Directive args

Default values

Builder: validate owner and to types are known

Complexity analyzers

Links:
https://github.com/pa-bru/graphql-cost-analysis
https://blog.apollographql.com/securing-your-graphql-api-from-malicious-queries-16130a324a6b
https://sangria-graphql.org/learn/#protection-against-malicious-queries

Directives round 2

Should be only on these locations in type system:

 public static IEnumerable<DirectiveLocation> TypeSystemLocations = new[]
        {
            DirectiveLocation.SCHEMA,
            DirectiveLocation.SCALAR,
            DirectiveLocation.OBJECT,
            DirectiveLocation.FIELD_DEFINITION,
            DirectiveLocation.ARGUMENT_DEFINITION,
            DirectiveLocation.INTERFACE,
            DirectiveLocation.UNION,
            DirectiveLocation.ENUM,
            DirectiveLocation.ENUM_VALUE,
            DirectiveLocation.INPUT_OBJECT,
            DirectiveLocation.INPUT_FIELD_DEFINITION
        };

Apollo Federation

https://www.apollographql.com/docs/apollo-server/federation/federation-spec/#federation-schema-specification

Schema type validations

Type validation sections from the spec

Review validation

• It's slow. Based on benchmarks it takes most of the execution time with simple schema.

Use new JSON parser

Use the new json parser coming with .NET Core 3

Create executable schema from model classes

public class SchemaRoot
{
    public Task<Query> GetQuery()...
}

public class Query 
{
    public Task<User> GetUser(int id)...
}

var schema = await SchemaGenerator.FromModelAsync(new SchemaRoot());

GetArgument<T> failing for value types (int, string, etc)

Optional List on input breaks instrospection in GraphQL client

In v0.10.0,

Currently, the schema below breaks introspection in GraphQL Clients
(Tested with GraphQL Playground, Altair GraphQL Client)

Example Schema

input InputItem {
  name: String
  foo: [String]
}

type Mutation {
  createItem(input: InputItem!): ID
}

This is due to defaultValue being assigned as System.Object[]

Benchmarks

Tools:

• https://github.com/hasura/graphql-bench

Question about using message broker

Hi @pekkah. I really appreciate this project because it helps me a lot for the idea to make GraphQL.NET works with SignalR. I'm refactoring to try this project, but could you please help to explain a bit about how it works if we use some of the message brokers out there such as RabbitMQ or Kafka? I think I will interfere with BroadcastBlock, right? And how it can subscribe after we publish an event from other publishers?

Relay connections

Include location in errors

Review resolvers and chaining

Add current graph path to context

[server] Allow setting Map function for resolving values in stream

Instead of calling Executor.SubscribeAsync split the pipeline into two parts and use the lower level functions
https://github.com/pekkah/fugu-graphql/blob/552d0aa6ac86cdea1aa1bdaad0e53ed473a6ec6c/src/graphql/execution/Subscription.cs#L97

https://github.com/pekkah/fugu-graphql/blob/552d0aa6ac86cdea1aa1bdaad0e53ed473a6ec6c/src/graphql/execution/Subscription.cs#L62

Allow overriding the default functions trough options.

Review error handling

Query vs. field errors

[server] Error response

Currently validation errors won't get reported properly to apollo link

Error handling

Path is calculated wrong

In the trace the path is wrong this would indicate that the path calculation is not working as it should

Authentication/authorization question

Hi @pekkah. How about authentication/authorization if we use this library. I have seen that we have X-Requested-With with the value authorization at

tanka-graphql/samples/graphql.samples.chat.web/Startup.cs

Line 47 in 14fd8d2

policy.WithHeaders("X-Requested-With", "authorization");

. Is it what we do with the key authentication from the client side. With GraphQL.NET, there is https://github.com/graphql-dotnet/authorization for doing authn/authz for the system. My question is how can we do it in this lib or is it planning to do in next phase?

Documentation

Add Convenience Middleware for GraphiQL, Playground and Voyager

Similar to the graphql-dotnet/server offering

// use graphiQL middleware at default url /graphiql
app.UseGraphiQLServer(new GraphiQLOptions());

// use graphql-playground middleware at default url /ui/playground
app.UseGraphQLPlayground(new GraphQLPlaygroundOptions());
    
// use voyager middleware at default url /ui/voyager
app.UseGraphQLVoyager(new GraphQLVoyagerOptions());

If this is reasonable, I'd be willing to take a stab at making a PR for this.

Fix https://pekkah.github.io/tanka-graphql/beta/1-execution/01-resolvers.html

Resolver middlewares were moved so the documentation is outdated

Apollo trace

https://github.com/apollographql/apollo-tracing/blob/master/README.md

Logging

parser: Add support for markdown descriptions

https://facebook.github.io/graphql/June2018/#sec-Descriptions

Dependabot couldn't find a package.json for this project

Dependabot couldn't find a package.json for this project.

Dependabot requires a package.json to evaluate your project's current JavaScript dependencies. It had expected to find one at the path: /samples/graphql.samples.chat.ui/package.json.

If this isn't a JavaScript project, or if it is a library, you may wish to disable updates for it from within Dependabot.

You can mention @dependabot in the comments below to contact the Dependabot team.

Executable schema from introspection result

Differences From graphql-dotnet/server

@pekkah Just saw your comment on graphql-dotnet/server#193. What are the main reasons for forking the code and starting again? I see the addition of Signal-R as being super valuable because it has a backplane already implemented, there is an open issue in graphql-dotnet/server to implement that. It also seems to be schema first which I think is the direction that people are going.

Also, what is the quality of this project, alpha, beta?

Use ValueTask for resolvers and subscribers

Bug with rule R5421RequiredArguments

System.InvalidCastException: Unable to cast object of type 'GraphQLParser.AST.GraphQLVariable' to type 'System.IConvertible'.
at System.Convert.ToInt64(Object value, IFormatProvider provider)
at tanka.graphql.type.converters.LongConverter.ParseValue(Object input) in D:\a\1\s\src\graphql\type\converters\LongConverter.cs:line 20
at tanka.graphql.validation.ExecutionRules.g__ValidateArguments|8_1(IEnumerable1 keyValuePairs, List1 graphQLArguments, IRuleVisitorContext ruleVisitorContext) in D:\a\1\s\src\graphql\validation\ExecutionRules.cs:line 347
at tanka.graphql.validation.RulesWalker.BeginVisitFieldSelection(GraphQLFieldSelection selection) in D:\a\1\s\src\graphql\validation\RulesWalker.cs:line 135