Change the default field resolver

[spawnia]

What problem does this feature proposal attempt to solve?

Community feedback has shown that the default resolver from webonyx/graphql-php may not be optimally suited for a Laravel application and there is potential for improvement.

• Model accessors are called twice
• snake_case vs. camelCase
  • Standardized way to organize custom field resolver #2188 (comment)
  • allow to set default schema case styles (Camel, Pascal, Snake, and Kebab Case) in lighthouse config without overuse @rename #1561
• Type based on Laravel model ignores regular php properties #2687

Because the default resolver is called very often, we have to consider performance.

Which possible solutions should be considered?

Given Eloquent models are probably the most common returned data type, we could optimize for them.

Changing the default resolver is documented here, but could perhaps be simplified through the config.

[olivernybroe]

I think this could be a great idea and something that would improve performance greatly.

I have however tried to also submit a pr to Laravel with the issue itself as webonyx/graphql is prob. not the only package relying on ArrayAccess being implemented correctly. laravel/framework#45976

[pyrou]

I am using for while now the following "DefaultResolver":

<?php

namespace App\GraphQL\Resolvers;

use ArrayAccess;
use Closure;
use GraphQL\Type\Definition\ResolveInfo;
use Illuminate\Support\Str;
use Nuwave\Lighthouse\Support\Contracts\GraphQLContext;

class DefaultResolver
{
    public function __invoke(mixed $parent, $args, GraphQLContext $context, ResolveInfo $resolveInfo): mixed
    {
        $fieldName = $resolveInfo->fieldName;
        $snakeFieldName = Str::snake($fieldName);
        
        $value = $this->getFieldValue($parent, $fieldName);
        
        if ($value === null && $snakeFieldName !== $fieldName) {
            // Give a chance to resolve field using the snake case
            $value = $this->getFieldValue($parent, $snakeFieldName);
        }

        return $value instanceof Closure ? $value($parent, $args, $context, $resolveInfo) : $value;
    }

    protected function getFieldValue(mixed $parent, string $fieldName): mixed
    {
        if (is_array($parent) || $parent instanceof ArrayAccess) {
            return $parent[$fieldName] ?? null;
        }
        if (is_object($parent) && isset($parent->{$fieldName})) {
            return $parent->{$fieldName};
        }

        return null;
    }
}

It is plugged into lighthouse with Executor::setDefaultFieldResolver($defaultResolver);

It mainly address the @rename overuse.

If this get you some idea for a new default resolver on Lighthouse 6 😉

[spawnia]

I have created #2693 as a potential solution to this issue and the issues mentioned within. If you are watching this space, please take a look and provide feedback there.