[10.x] Allow route:list to expand middleware groups in 'VeryVerbose' mode

[NickSdot]

Together with @timacdonald I've been exploring the idea of expanding the middleware groups when using route:list. We both feel that being able to see the actual middleware being used instead of group names like 'web' adds value to the command. This PR proposes this as optional functionality.

Benefits

Developers see what really is applied, instead of group names. No more jumping to e.g. the Kernel, to see what is in the group. Most importantly, the middleware are listed in the order defined by $middlewarePriority.

When merged

route:list (no change)

route:list -v (no change)

route:list -vv (expands middleware groups)

The group name web is no longer listed. Instead, the actual middleware from that group are listed. The same behaviour applies when using the --json flag.

Consideration

The -vv flag until now has not been used in the command. If someone were to use it in an automated way for whatever reason, this change could be considered a BC break.

However, I wanted to get the maintainer's opinion on this first.
If you consider it a BC break, there are two options:

A) Target Laravel 11
B) Add a new flag --expand-groups / -e.

Input welcome.

[NickSdot]

Also prepared a docs addition, but will wait with the PR until we have a result here.

laravel/docs@10.x...NickSdot:laravel-docs:10.x#diff-1970690c078dba0956a24f726ce3ec51a6e04396faaf18f595f2cef0d2056aec

[taylorotwell]

Do you know if they are sorted properly into the actual order they will be executed in? For example the SortMiddleware class will rearrange your middleware to make sure certain things run before others.

[NickSdot]

Do you know if they are sorted properly into the actual order they will be executed in? For example the SortMiddleware class will rearrange your middleware to make sure certain things run before others.

Yes, @taylorotwell, they are. I just added this to the 'Benefits' section of the description 2 minutes before you commented:

Most importantly, the middleware are listed in the order defined by $middlewarePriority.

Command calls Router::gatherRouteMiddleware() -> Router::resolveMiddleware() -> Router::sortMiddleware()

See:

framework/src/Illuminate/Foundation/Console/RouteListCommand.php

Line 199 in 1cae837

return collect($this->router->gatherRouteMiddleware($route))->map(function ($middleware) {

and

framework/src/Illuminate/Routing/Router.php

Line 809 in 1cae837

public function gatherRouteMiddleware(Route $route)

Edit:

Example

[NickSdot]

Do you know if they are sorted properly into the actual order they will be executed in? For example the SortMiddleware class will rearrange your middleware to make sure certain things run before others.

Added test testMiddlewareGroupsExpandCorrectlySortedIfVeryVerbose() for this.

[taylorotwell]

Thanks 👍

[timacdonald]

Lovely addition, @NickSdot. Thanks for making this happen!

[NickSdot]

Thanks for ping-ponging the idea with me @timacdonald 🙏