nuwave / lighthouse

A framework for serving GraphQL from Laravel
https://lighthouse-php.com
MIT License
3.37k stars 438 forks source link

CanDirective args Argument value is of type 'ArrayValue', expected a scalar #2263

Open Stevemoretz opened 1 year ago

Stevemoretz commented 1 year ago

I use the GraphQL plugin for intellij suggested by the official docs, but it gives me an error when adding an array to args of @can

Screen Shot 1401-10-07 at 19 10 32

The message is:

'createProperty' uses an illegal value for the argument 'args' on directive 'can'. Argument value is of type 'ArrayValue', expected a scalar

Describe the bug

type Mutation {
    createProperty(input: PropertyCreationInput @spread): Property @can(ability: "wp:role", args: [1,2], model: "App\\Models\\User")
}

So the args with [1,2] is the problem.

This is the defined type at schema-directives.graphql which comes from /vendor/nuwave/lighthouse/src/Auth/CanDirective.php

"""
Any constant literal value: https://graphql.github.io/graphql-spec/draft/#sec-Input-Values
"""
scalar CanArgs

Shouldn't that be something like instead?

scalar CanArgs @scalar(class: "a class here")

Expected behavior/Solution

Steps to reproduce

  1. You can just use the example from the docs and add the args to it:
    type Mutation {
    createBlogPost(input: PostInput!): BlogPost
    @can(ability: "create", model: "App\\Post", args: [1,2])
    }
  2. You can now see createBlogPost is underlined and red in intellij with this error: 'createBlogPost' uses an illegal value for the argument 'args' on directive 'can'. Argument value is of type 'ArrayValue', expected a scalar

Output/Logs

Click to expand ``` # Add in log output/error messages here ```

**Lighthouse Version : v5.67.0**
spawnia commented 1 year ago

I believe there is nothing we can do to fix this. The GraphQL specification distinguishes between scalars and lists, see https://spec.graphql.org/draft/#sel-FAFdFABAB6EugR

Field and directive arguments accept input values of various literal primitives; input values can be scalars, enumeration values, lists, or input objects.

Since input types can not be polymorphic, I believe it is impossible to express that the type of args can be any input value.

In your specific case, the plugin would probably be fine when defining the directive as args: [CanArgs] - but that would then break use cases where any other value such as args: "foo" is passed.

Stevemoretz commented 1 year ago

I believe there is nothing we can do to fix this. The GraphQL specification distinguishes between scalars and lists, see https://spec.graphql.org/draft/#sel-FAFdFABAB6EugR

Field and directive arguments accept input values of various literal primitives; input values can be scalars, enumeration values, lists, or input objects.

Since input types can not be polymorphic, I believe it is impossible to express that the type of args can be any input value.

In your specific case, the plugin would probably be fine when defining the directive as args: [CanArgs] - but that would then break use cases where any other value such as args: "foo" is passed.

Thanks for responding can't we use Unions though?

Update: input values can't be unioned I guess that's impossible then....