robojones / gqltest Goto Github PK

Problem

The draft syntax which aims to use the @expect directive for all comparable types. This requires the usage of a union type which is not supported by the current graphql syntax.

@expect(v: "hello")
@expect(v: 5)

This syntax would need v to have a union type which contains String and Int.

There are two alternatives to work around the usage of a union type:

Solution 1: Define the expect directive with an optional parameter for each type

directive @expect(string: String, int: Int, float: Float, boolean: Boolean, id: ID)

This approach allows the user to use the directive like this:

@expect(string: "hello")

The problem is that the directive definition would allow the user to specify multiple values:

@expect(string: "hello", int: 15)

Another problem is that when using variables these could use optional types which is not intended.

Solution 2: Define separate directives for all the types

@expectString(equal: "hello")
@expectInt(equal: 15)

This syntax is less good looking but allows for easier verification. The problem here is that the user could use multiple different @expect* directives on the same field.

If a test file contains a query:

query testUserName @test {
  user {
    name @expect(v: "Frank")
  }
}

The only thing that is actually sent to the API is query everything else is omitted.