Relax PaginationType getPaginationFields typehint

[jasonvarga]

Summary

When upgrading a project from 8.0 to 9.0, I began to see errors around pagination:

TypeError: Rebing\GraphQL\Support\PaginationType::getPaginationFields(): Argument #1 ($underlyingType) must be of type GraphQL\Type\Definition\ObjectType, GraphQL\Type\Definition\InterfaceType given, called in /path/to/rebing/graphql-laravel/src/Support/PaginationType.php on line 22

We have queries where the type is a paginator with interfaces:

class EntriesQuery extends Query
{
    public function type(): Type
    {
        return GraphQL::paginate(GraphQL::type('EntryInterface'));
    }
}

This has worked fine until v9 (specifically #1033) since the typehint of PaginationType::getPaginationFields() was changed to ObjectType.

This PR changes the typehint from an ObjectType definition to the parent Type definition, which covers both ObjectType and InterfaceType.

I'm not sure if there's a specific reason ObjectType was used, but this fixes our issue and all of this package's tests continue to pass.

Also, I'm sorry but I don't understand what's up with the phpstan stuff. 😊

---

Type of change:

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Misc. change (internal, infrastructure, maintenance, etc.)

Checklist:

• Existing tests have been adapted and/or new tests have been added
• Add a CHANGELOG.md entry
• Update the README.md
• Code style has been fixed via composer fix-style

[mfn]

I think the change is ok!

Also relaxing should not be a breaking change, so we would not need to do a major version bump, WDYT?

Can you please add a dedicated test, i.e. one which covers what you needed it for (support for interface type)?

(I can take care of the phpstan once all is done here)

[jasonvarga]

Also relaxing should not be a breaking change, so we would not need to do a major version bump, WDYT?

Nah I don't think it needs to be breaking.

Can you please add a dedicated test, i.e. one which covers what you needed it for (support for interface type)?

Can do 👍 Thanks!

[jasonvarga]

I've added/modified tests where the existing pagination test was.

There's an assertion on the generated sql that doesn't currently pass because of an unrelated issue, so I've left it in there but commented out: 392c17d (#1132)

The sql should be select "posts"."id" but is currently select * - I believe this is the same or similar issue as #683.

I think it's out of scope of this PR to fix it.

Anyway, the tests in this class would fail without the typehint change in getPaginationFields.

[mfn]

Solid work, thank you!

Will roll a release right after merge.

[jasonvarga]

Thank you!