Skip to content

Variable validation broken when variables are used inside an input object value #3276

Closed

Description

@kaqqao

Setup

I'll use the following simple schema to illustrate the issue:

type Query {
  items(pagination: Pagination = {limit: 10, offset: 0}): [String]
}

input Pagination {
  limit: Int
  offset: Int
}

While variables are commonly used as the whole argument value:

query Items($pagination: Pagination) {
  items(pagination: $pagination) { #variable is the entire input object (Pagination)
    ...
  }
}

they can also be used as the values of fields inside an input object:

query Items($limit: Int) {
  items(pagination: {limit: $limit, offset: 0}) { #variable is only a part of the input
    ...
  }
}

I've scoured the spec for a confirmation on whether this is indeed legal usage of variables and, while this situation is never directly addressed either way, the section on Input Coercion lists the following examples which seem to indicate this is legitimate usage:

input ExampleInputObject {
  a: String
  b: Int!
}
Literal Value Variables Coerced Value
{ a: $var, b: 123 } { var: null } { a: null, b: 123 }
{ b: $var } { var: 123 } { b: 123 }

The bug

When a variable is used inside an input object which has a default value (like in my Pagination example), graphql-java's variable type validation freaks out, because it compares the type of the variable (Int) against the default value of the entire argument (Pagination) here:

//Notice the getValidationContext().getArgument()
Optional<InputValueWithState> schemaDefault = Optional.ofNullable(getValidationContext().getArgument()).map(v -> v.getArgumentDefaultValue());
...  
//expectedType is Int
schemaDefaultValue = ValuesResolver.valueToLiteral(schemaDefault.get(), expectedType, getValidationContext().getGraphQLContext(), getValidationContext().getI18n().getLocale());

To Reproduce

Here's a self-contained example:

GraphQLSchema schema = GraphQLSchema.newSchema()
                .query(GraphQLObjectType.newObject()
                        .name("Query")
                        .field(items -> items
                                .name("items")
                                .type(GraphQLList.list(Scalars.GraphQLString))
                                .argument(pagination -> pagination
                                        .name("pagination")
                                        //skipped adding the default limit/offset values as it doesn't change anything
                                        .defaultValueProgrammatic(new HashMap<>())
                                        .type(GraphQLInputObjectType.newInputObject()
                                                .name("Pagination")
                                                .field(limit -> limit
                                                        .name("limit")
                                                        .type(Scalars.GraphQLInt))
                                                .field(offset -> offset
                                                        .name("offset")
                                                        .type(Scalars.GraphQLInt))
                                                .build())))
                        .build())
                .codeRegistry(GraphQLCodeRegistry.newCodeRegistry()
                        .dataFetcher(FieldCoordinates.coordinates("Query", "items"), (DataFetcher<?>) env -> Collections.singletonList("test"))
                        .build())
                .build();

        GraphQL gql = GraphQLRuntime.newGraphQL(schema).build();

        Map<String, Object> vars = new HashMap<>();
        vars.put("limit", 5);
        vars.put("offset", 0);

        ExecutionInput in = ExecutionInput.newExecutionInput()
                .query("query Items( $limit: Int, $offset: Int) {\n" +
                        "  items(\n" +
                        "    pagination: {limit: $limit, offset: $offset} \n" +
                        "  )\n" +
                        "}")
                .variables(vars)
                .build();
        ExecutionResult result = gql.execute(in);

Leads to:

graphql.AssertException: Expected a value that can be converted to type 'Int' but it was a 'HashMap'

Activity

  1. bbakerman commented on Aug 1, 2023

    @bbakerman
    Member

    I've scoured the spec for a confirmation on whether this is indeed legal usage of variables
    It certainly is legal

    We will look into this bug - thanks for reporting

  2. bbakerman commented on Aug 1, 2023

    @bbakerman
    Member

    Hmmm I just had enough time to create a reproduction PR

    Interestingly the SDL based test cases works as expected - while your programmatic reproduction does indeed assert

    They are obviously not quite the same. I havent had time yet to work out the bug (is it a test case input bug or is it a true code bug?) but we have a reproduction PR to look into this.

    Thanks once again for reporting

    #3278

  3. bbakerman commented on Aug 1, 2023

    @bbakerman
    Member

    OK fixed. The problem was as reported and only happened on programmatic defaults

    schemaDefaultValue = ValuesResolver.valueToLiteral(schemaDefault.get(), expectedType, getValidationContext().getGraphQLContext(), getValidationContext().getI18n().getLocale());
    

    the type that should have been passed in was the argument type and not the variable reference type.

    Thanks for reporting. We will look to get a bug fix release out for this

  4. kaqqao commented on Aug 2, 2023

    @kaqqao
    ContributorAuthor

    I commented on the PR, but noting here too in case you're not monitoring that discussion any more: the problem seems to be deeper, I managed to break the validation further (regardless whether SDL or programmatic). Please see the details here.

  5. dondonz commented on Oct 14, 2023

    @dondonz
    Member

    Fixed by #3278

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions