feat(laravel): add middleware granularity

[jonerickson]

Q	A
Branch?	4.0
Tickets
License	MIT
Doc PR	TBD

Problem

This PR aims to give more granularity when setting middleware for different features/routes this package provides. The most notable is the ability to enable the GraphQL IDE independent of the actual endpoint. Second, a developer can set middleware explicitly for the GraphQL routes.

Story

An application may want to expose the GraphQL IDE for consumer use. This endpoint may want to use the web and auth middleware for session authentication which typically is not wanted/needed for the API endpoints where a dev would probably opt for some kind of JWT/API/OAuth implementation.

Or, a dev may want to allow GraphQL requests, but does not want the IDE to be exposed in production.

Adding these settings allows more flexibility on how these features can be used.

Changes

1. Add ability to disable GraphQL IDE graphhiql independent of the graphql POST endpoint.
2. Set middleware individually on the GraphQL graphql endpoint and GraphQL IDE graphiql endpoint.
3. Remove unused api-platform.defaults.middleware config setting? I could not find any reference to this config setting and it clashes/confusing with the global middleware set in api-platform.routes.middleware.
4. Moved and renamed api-platform.defaults.route_prefix setting to api-platform.routes.prefix. Backwards compatibility is provided. This aims to move all routes related config under a common config key versus spread out in the config file.

[jonerickson]

@soyuka I still dont understand what is going on with the routing. It is behaving very strangely. First of all, getRoutePrefix() is returning null. Which then causes L38 of rtrim() to fail. Second, the middleware() calls continue to fail as getMiddleware() on L43 is returning null as well which causes the middleware() call to return an array. How in the world have you gotten your tests to pass? I feel like I haven't changed anything that would cause this strange behavior.

I am not quite up-to-speed on the intricacies of API platform and how all the operations work, but something strange is happening with the routing. This may be linked to #6969. You should be able to call prefix() just fine and have the route correctly prefixed. You should not have to do what you did and compose the URI from scratch in #6978

[soyuka]

First of all, getRoutePrefix() is returning null. Which then causes L38 of rtrim() to fail.

My bad on this I'm missing a test, weird that phpstan didn't trigger on this being nullable, my guess is that we ignore the routes/api.php file now.

Second, the middleware() calls continue to fail as getMiddleware() on L43 is returning null as well which causes the middleware() call to return an array. How in the world have you gotten your tests to pass? I feel like I haven't changed anything that would cause this strange behavior.

Yes but it's expected that getMiddleware can return null, this is why you should run:

if ($m = $operation->getMiddleware()) {
    $route = $route->middleware($m);
}

I am not quite up-to-speed on the intricacies of API platform and how all the operations work, but something strange is happening with the routing.

Nothing has an impact on routing except the lines you changed at #6969

[jonerickson]

@soyuka Okay, based on #6980 it appears to be all good now. I changed the domain config to default to '' as when null, it causes the Uri parsing to fail. Thanks for the help!

[soyuka]

Thanks @jonerickson !