Issue on 'Variable "$agent_id" of required type "String!" was not provided.'. ask for help. thanks.

[smartbox-jiandonghan]

my frontend use vue 3 + "@apollo/client": "^3.7.11", "@vue/apollo-composable": "^4.0.0-beta.4",
the query code is:

useQuery(gql`
      query Agents($id: String!) {
        agent (agent_id: $id) {
          agent_id,
          agent_name......

and backend: rebing/graphql-laravel

the AgentQuery code:

<?php
namespace App\GraphQL\Queries;

use Closure;
use App\Models\Agent;
use GraphQL;
use GraphQL\Type\Definition\Type;
//use Rebing\GraphQL\Support\Facades\GraphQL;
use GraphQL\Type\Definition\ResolveInfo;
use Rebing\GraphQL\Support\SelectFields;
use Rebing\GraphQL\Support\Query;

use Illuminate\Support\Facades\Log;

class AgentQuery extends Query
{
    protected $attributes = [
        "name" => "agent",
    ];

    public function type(): Type
    {
        //return GraphQL::type("Agent");
        return Type::listOf(GraphQL::type("Agent"));
    }
    
    public function args(): array
    {
        return [
            "agent_id" => [
                "name" => "agent_id",
                "type" => Type::string(),
                "rules" => ["required"],
            ],
        ];
    }
    
    //public function resolve($root, $args)
    //{
    //    return Agent::findOrFail($args["agent_id"]);
    //}

    public function resolve($root, array $args, $context, ResolveInfo $info, Closure $getSelectFields)
    {
        Log::info($args['agent_id']);
        $agentid = intval($args['agent_id']);
        Log::info($agentid);
        
        $fields = $getSelectFields();
        $select = $fields->getSelect();
        $with = $fields->getRelations();
        

        if (isset($args['agent_id'])) {
            return Agent::where('agent_id', $agentid)->get();
        }
        else {
            return Agent::where('agent_id', $agentid)->get();
        } 
        


        /*
        if (isset($args['agent_id'])) {
            return Agent::where('agent_id', $args['agent_id'])->get();
        }
        return Agent::all();
        */
    }
}

the query can be executed in Graphiql, but when being exceuted in frontend, I got the error.

Does any one can help? Thank a lot!

[mfn]

$id: String!

This means you expect a non-null string on the "GraphQL type system level, i.e. instead of Type::string() you need to type it as Type::nonNull(Type::string()).

I see that you added the 'rules' definition, but that is the "Laravel validation", which happens after the GraphQL type system has been satisfied.

In other words: likely a Type::nonNull(Type::string()) with a required rule isn't useful, because by definition of the GraphQL type system, it has to be present anyway. Aka you probably can remove it.

[smartbox-jiandonghan]

Thank you very much Markus.
I optimized the query code according to your suggestion. now the frondend code is like this:
Frondend:

const { result, loading, error } = useQuery(gql`
  query Agents($agent_id: String!) {
    agent (agent_id: $agent_id) {
      agent_id,
      agent_name,
      contact,
      address,
      city,
      province,
      postal_code,
      area_code,
      phone,
      fax,
      tax_id,
      email,
      gst_percent,
      account_number,
      pst_qst_flag,
      pst_qst_percent,
      status,
      bank_account_num,
      user_access,
      password,
      commission_percent,
      transit_number,
      fi_number,
      fax_area_code,
      cellular_area_code,
      cellular,
      pymnt_freq,
      pymnt_freq_date,
      date_created,
      last_billing_date,
      prepaid,
      percent_gst,
      qst_id,
      tax_included,
      real_address,
      ind_author,
      del_transaction,
      master_with_sub_account
    }
  }
`, () => ({ variables: { agent_Id: agent_id.value } }))

return {
  result,
  loading,
  error
}

the backend querycode:

<?php
namespace App\GraphQL\Queries;

use Closure;
use App\Models\Agent;
use GraphQL\Type\Definition\Type;
use Rebing\GraphQL\Support\Facades\GraphQL;
use Rebing\GraphQL\Support\Query;
use Illuminate\Support\Facades\Log;

class AgentQuery extends Query
{
    protected $attributes = [
        "name" => "agent",
    ];

    public function type(): Type
    {
        return Type::listOf(GraphQL::type("Agent"));
    }
    
    public function args(): array
    {
        return [
            "agent_id" => [
                "name" => "agent_id",
                "type" => Type::nonNull(Type::string()),
            ],
        ];
    }
    
    public function resolve($root, array $args)
    {
        log::info($args['agent_id']);

        if (isset($args['agent_id'])) {
            return Agent::where('agent_id', intval($args['agent_id']))->get();
        }
        else {
            return Agent::All();
        } 
    }
}

then I test it and get the same error(graphiql is ok but the frontend code get the "Variable "$agent_id" of required type "String!" was not provided." error).

it seemed, the string type was not declared in the "\vendor\webonyx\graphql-php\src\Executor\Values.php" file? not sure of it.

Thank you and have a nice day!

Any one others will be greatly appreciated for your kindly help.

[smartbox-jiandonghan]

the error message from laravel.log

[2023-04-20 13:27:38] local.INFO: 224  
[2023-04-20 13:28:03] local.ERROR: Variable "$agent_id" of required type "String!" was not provided. {"exception":"[object] (GraphQL\\Error\\Error(code: 0): Variable \"$agent_id\" of required type \"String!\" was not provided. at C:\\project\\newpin_laravel\\vendor\\webonyx\\graphql-php\\src\\Executor\\Values.php:93)
[stacktrace]
#0 C:\\project\\newpin_laravel\\vendor\\webonyx\\graphql-php\\src\\Executor\\ReferenceExecutor.php(179): GraphQL\\Executor\\Values::getVariableValues(Object(GraphQL\\Type\\Schema), Object(GraphQL\\Language\\AST\\NodeList), Array)
#1 C:\\project\\newpin_laravel\\vendor\\webonyx\\graphql-php\\src\\Executor\\ReferenceExecutor.php(91): GraphQL\\Executor\\ReferenceExecutor::buildExecutionContext(Object(GraphQL\\Type\\Schema), Object(GraphQL\\Language\\AST\\DocumentNode), NULL, NULL, Array, 'Agents', Array, Object(GraphQL\\Executor\\Promise\\Adapter\\SyncPromiseAdapter))
#2 C:\\project\\newpin_laravel\\vendor\\webonyx\\graphql-php\\src\\Executor\\Executor.php(153): GraphQL\\Executor\\ReferenceExecutor::create(Object(GraphQL\\Executor\\Promise\\Adapter\\SyncPromiseAdapter), Object(GraphQL\\Type\\Schema), Object(GraphQL\\Language\\AST\\DocumentNode), NULL, NULL, Array, 'Agents', Array)
#3 C:\\project\\newpin_laravel\\vendor\\webonyx\\graphql-php\\src\\GraphQL.php(162): GraphQL\\Executor\\Executor::promiseToExecute(Object(GraphQL\\Executor\\Promise\\Adapter\\SyncPromiseAdapter), Object(GraphQL\\Type\\Schema), Object(GraphQL\\Language\\AST\\DocumentNode), NULL, NULL, Array, 'Agents', NULL)
#4 C:\\project\\newpin_laravel\\vendor\\webonyx\\graphql-php\\src\\GraphQL.php(94): GraphQL\\GraphQL::promiseToExecute(Object(GraphQL\\Executor\\Promise\\Adapter\\SyncPromiseAdapter), Object(GraphQL\\Type\\Schema), Object(GraphQL\\Language\\AST\\DocumentNode), NULL, NULL, Array, 'Agents', NULL, NULL)
#5 C:\\project\\newpin_laravel\\vendor\\rebing\\graphql-laravel\\src\\Support\\ExecutionMiddleware\\GraphqlExecutionMiddleware.php(32): GraphQL\\GraphQL::executeQuery(Object(GraphQL\\Type\\Schema), Object(GraphQL\\Language\\AST\\DocumentNode), NULL, NULL, Array, 'Agents', NULL)
#6 C:\\project\\newpin_laravel\\vendor\\rebing\\graphql-laravel\\src\\Support\\ExecutionMiddleware\\AbstractExecutionMiddleware.php(34): Rebing\\GraphQL\\Support\\ExecutionMiddleware\\GraphqlExecutionMiddleware->handle('default', Object(GraphQL\\Type\\Schema), Object(Rebing\\GraphQL\\Support\\OperationParams), NULL, NULL, Object(Closure))
#7 C:\\project\\newpin_laravel\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php(167): Rebing\\GraphQL\\Support\\ExecutionMiddleware\\AbstractExecutionMiddleware->resolve(Array, Object(Closure))
#8 C:\\project\\newpin_laravel\\vendor\\rebing\\graphql-laravel\\src\\Support\\ExecutionMiddleware\\AbstractExecutionMiddleware.php(33): Illuminate\\Pipeline\\Pipeline->Illuminate\\Pipeline\\{closure}(Array)
#9 C:\\project\\newpin_laravel\\vendor\\rebing\\graphql-laravel\\src\\Support\\ExecutionMiddleware\\AddAuthUserContextValueMiddleware.php(28): Rebing\\GraphQL\\Support\\ExecutionMiddleware\\AbstractExecutionMiddleware->Rebing\\GraphQL\\Support\\ExecutionMiddleware\\{closure}('default', Object(GraphQL\\Type\\Schema), Object(Rebing\\GraphQL\\Support\\OperationParams), NULL, NULL)
#10 C:\\project\\newpin_laravel\\vendor\\rebing\\graphql-laravel\\src\\Support\\ExecutionMiddleware\\AbstractExecutionMiddleware.php(34): Rebing\\GraphQL\\Support\\ExecutionMiddleware\\AddAuthUserContextValueMiddleware->handle('default', Object(GraphQL\\Type\\Schema), Object(Rebing\\GraphQL\\Support\\OperationParams), NULL, NULL, Object(Closure))
#11 C:\\project\\newpin_laravel\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php(167): Rebing\\GraphQL\\Support\\ExecutionMiddleware\\AbstractExecutionMiddleware->resolve(Array, Object(Closure))
#12 C:\\project\\newpin_laravel\\vendor\\rebing\\graphql-laravel\\src\\Support\\ExecutionMiddleware\\AbstractExecutionMiddleware.php(33): Illuminate\\Pipeline\\Pipeline->Illuminate\\Pipeline\\{closure}(Array)
#13 C:\\project\\newpin_laravel\\vendor\\rebing\\graphql-laravel\\src\\Support\\ExecutionMiddleware\\AutomaticPersistedQueriesMiddleware.php(42): Rebing\\GraphQL\\Support\\ExecutionMiddleware\\AbstractExecutionMiddleware->Rebing\\GraphQL\\Support\\ExecutionMiddleware\\{closure}('default', Object(GraphQL\\Type\\Schema), Object(Rebing\\GraphQL\\Support\\OperationParams), NULL, NULL)
#14 C:\\project\\newpin_laravel\\vendor\\rebing\\graphql-laravel\\src\\Support\\ExecutionMiddleware\\AbstractExecutionMiddleware.php(34): Rebing\\GraphQL\\Support\\ExecutionMiddleware\\AutomaticPersistedQueriesMiddleware->handle('default', Object(GraphQL\\Type\\Schema), Object(Rebing\\GraphQL\\Support\\OperationParams), NULL, NULL, Object(Closure))
#15 C:\\project\\newpin_laravel\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php(167): Rebing\\GraphQL\\Support\\ExecutionMiddleware\\AbstractExecutionMiddleware->resolve(Array, Object(Closure))
#16 C:\\project\\newpin_laravel\\vendor\\rebing\\graphql-laravel\\src\\Support\\ExecutionMiddleware\\AbstractExecutionMiddleware.php(33): Illuminate\\Pipeline\\Pipeline->Illuminate\\Pipeline\\{closure}(Array)
#17 C:\\project\\newpin_laravel\\vendor\\rebing\\graphql-laravel\\src\\Support\\ExecutionMiddleware\\ValidateOperationParamsMiddleware.php(39): Rebing\\GraphQL\\Support\\ExecutionMiddleware\\AbstractExecutionMiddleware->Rebing\\GraphQL\\Support\\ExecutionMiddleware\\{closure}('default', Object(GraphQL\\Type\\Schema), Object(Rebing\\GraphQL\\Support\\OperationParams), NULL, NULL)
#18 C:\\project\\newpin_laravel\\vendor\\rebing\\graphql-laravel\\src\\Support\\ExecutionMiddleware\\AbstractExecutionMiddleware.php(34): Rebing\\GraphQL\\Support\\ExecutionMiddleware\\ValidateOperationParamsMiddleware->handle('default', Object(GraphQL\\Type\\Schema), Object(Rebing\\GraphQL\\Support\\OperationParams), NULL, NULL, Object(Closure))
#19 C:\\project\
"} 

[smartbox-jiandonghan]

it seemed, the string type was not declared in the "\vendor\webonyx\graphql-php\src\Executor\Values.php" file? not sure of it.

[mfn]

Can you please edit all your messages and add proper codeblock formatting first? I hope you can see they're barely readable currently 😅 I did it for the first one, but don't want to do it for all of them, thanks.

[smartbox-jiandonghan]

yes, I should. thank you Markus.

[smartbox-jiandonghan]

The backend AgentQuery,php

<?php
namespace App\GraphQL\Queries;

use Closure;
use App\Models\Agent;
use GraphQL\Type\Definition\Type;
use Rebing\GraphQL\Support\Facades\GraphQL;
use Rebing\GraphQL\Support\Query;
use Illuminate\Support\Facades\Log;

class AgentQuery extends Query
{
    protected $attributes = [
        "name" => "agent",
    ];

    public function type(): Type
    {
        return Type::listOf(GraphQL::type("Agent"));
    }
    
    public function args(): array
    {
        return [
            "agent_id" => [
                "name" => "agent_id",
                "type" => Type::nonNull(Type::string()),
            ],
        ];
    }
    
    public function resolve($root, array $args)
    {
        log::info($args['agent_id']);

        if (isset($args['agent_id'])) {
            return Agent::where('agent_id', intval($args['agent_id']))->get();
        }
        else {
            return Agent::All();
        } 
    }
}

[smartbox-jiandonghan]

For the agent_id's type definition in Frondend. in the beginning, I tried it with the ID!. then in the backend AgentQuery, the accordingly args type was Type::int(). it also had the similar error when frontend was executed: Variable "$agent_id" of required type "Int" was not provided.
So I am trying String instead. but got the similar errors.

Greatly appreciate any helps!

[mfn]

Variable "$agent_id" of required type "Int" was not provided.

When I check your other comment #1025 (reply in thread) it says

() => ({ variables: { agent_Id: agent_id.value } }))

That's an uppercase I there, but it should be lowercase: agent_id. See if this is the cause.

---

A couple of more advises (and I guess the README should be cleaned up, too):

• you don't need the name inside, you can leave it out

              "agent_id" => [
                  "name" => "agent_id", // <-- you can remove this
                  "type" => Type::nonNull(Type::string()),

• return Type::listOf(GraphQL::type("Agent"));
  What I consider one of the "billion dollar mistakes" of GraphQL is, that everything is nullable by default. That means if you define a type like the above:
  • the return type can be an array (=listOf) or null
  • the elements within ("Agent" in this case) can also be null
    That is, ideally you always make types non-nullable everywhere unless you know they can be null:
    return Type::nonNull(Type::listOf(Type::nonNull(GraphQL::type("Agent"))));
• return Agent::where('agent_id', intval($args['agent_id']))->get();
  If you can make the type work with Type::int(), you can remove the intval => the type will be correct / coerced.

HTH!

[smartbox-jiandonghan]

Good morning Markus. I update the uppercase I then test it. the error still there, so sad!
But your advises really help me to learn the GraphQL better. thank you very much and have a nice day!