[FrameworkBundle] Add `--method` option to `debug:router` command #59909

santysisi · 2025-03-04T18:28:33Z

Q	A
Branch?	7.3
Bug fix?	no
New feature?	yes
Deprecations?	no
Issues	Feature #59906
License	MIT

Description

I have added a new InputOption named method to the debug:router command. This option allows developers to filter the displayed routes by HTTP method (GET, POST, PUT, DELETE, etc.) when running the command. This improvement makes it easier and more efficient to debug routes, especially in large applications. It also aligns the debug:router command with the router:match command, which already includes a similar option for filtering by HTTP method.

Changes Made

Added the --method option to the debug:router command.
Routes can now be filtered based on the HTTP method used (GET, POST, PUT, DELETE, etc.).
This enhances debugging capabilities and streamlines the process of working with specific route methods.

Example

Before adding the new InputOption:
php bin/console debug:router

After adding the new InputOption:
php bin/console debug:router --method=GET

Before adding the new InputOption with the name argument
php bin/console debug:router app_foo

After adding the method InputOption with the name argument:
php bin/console debug:router app_foo --method=DELETE

carsonbot · 2025-03-04T18:28:39Z

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

Always add tests
Keep backward compatibility (see https://symfony.com/bc).
Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
Features and deprecations must be submitted against the 7.3 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/ObjectsProvider.php

src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php

src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php

src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php

src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/ObjectsProvider.php

santysisi · 2025-03-11T01:51:20Z

Hi 😃, I hope you're doing well!
I wanted to check if any further changes are needed in the PR, or if it's good to go for merging 🎉🎉🎉
Thanks a lot in advance, and I look forward to your response!

mtarld

Almost good to me 😉

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php

src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php

chalasr

Congrats on your great first PR to Symfony.

santysisi · 2025-03-12T21:31:55Z

Congrats on your great first PR to Symfony.

Thank you very much, I'm very excited 😄

OskarStark · 2025-03-13T08:00:16Z

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php

+            if (
+                $route->getMethods()
+                && !\in_array($method, $route->getMethods(), true)
+            ) {


Symfony usually prefers one liners to ease merging

OskarStark · 2025-03-13T08:00:22Z

src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php

+            if (
+                false !== stripos($routeName, $name)
+                && (null === $method || !$route->getMethods() || \in_array($method, $route->getMethods(), true))
+            ) {


Symfony usually prefers one liners to ease merging

…method

nicolas-grekas · 2025-03-13T14:16:28Z

Thank you @santysisi.

carsonbot added Status: Needs Review Feature FrameworkBundle labels Mar 4, 2025

carsonbot added this to the 7.3 milestone Mar 4, 2025

OskarStark changed the title ~~[FrameworkBundle] Add new InputOption 'method' to debug:router command~~ [FrameworkBundle] Add --method option to debug:router command Mar 5, 2025

OskarStark reviewed Mar 5, 2025

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md Outdated Show resolved Hide resolved

OskarStark reviewed Mar 5, 2025

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/ObjectsProvider.php Show resolved Hide resolved

alexandre-daubois reviewed Mar 5, 2025

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php Outdated Show resolved Hide resolved

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php Outdated Show resolved Hide resolved

mtarld reviewed Mar 5, 2025

View reviewed changes

santysisi force-pushed the feature_add-http-method-filter-to-debug-router branch from 2c1095c to e2d90fa Compare March 5, 2025 14:27

santysisi requested review from OskarStark, alexandre-daubois and mtarld March 5, 2025 14:41

mtarld reviewed Mar 6, 2025

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php Outdated Show resolved Hide resolved

src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/ObjectsProvider.php Show resolved Hide resolved

santysisi force-pushed the feature_add-http-method-filter-to-debug-router branch from e2d90fa to ca61a87 Compare March 6, 2025 21:53

santysisi requested a review from mtarld March 6, 2025 22:03

mtarld reviewed Mar 11, 2025

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php Outdated Show resolved Hide resolved

src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php Outdated Show resolved Hide resolved

santysisi force-pushed the feature_add-http-method-filter-to-debug-router branch from ca61a87 to 3d9c69d Compare March 11, 2025 13:38

mtarld approved these changes Mar 12, 2025

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Mar 12, 2025

chalasr approved these changes Mar 12, 2025

View reviewed changes

OskarStark reviewed Mar 13, 2025

View reviewed changes

OskarStark approved these changes Mar 13, 2025

View reviewed changes

Add 'method' option to debug:router command to filter routes by HTTP …

6a98d49

…method

nicolas-grekas force-pushed the feature_add-http-method-filter-to-debug-router branch from 3d9c69d to 6a98d49 Compare March 13, 2025 14:16

nicolas-grekas merged commit 6c0058a into symfony:7.3 Mar 13, 2025
11 checks passed

nicolas-grekas mentioned this pull request Mar 13, 2025

[FrameworkBundle] Add --method option to debug:router command symfony/symfony-docs#20762

Closed

fabpot mentioned this pull request May 2, 2025

Release v7.3.0-BETA1 #60327

Merged

Uh oh!

[FrameworkBundle] Add --method option to debug:router command #59909

[FrameworkBundle] Add --method option to debug:router command #59909

Uh oh!

Conversation

santysisi commented Mar 4, 2025

Description

Changes Made

Example

Uh oh!

carsonbot commented Mar 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

santysisi commented Mar 11, 2025

Uh oh!

mtarld left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

chalasr left a comment

Choose a reason for hiding this comment

Uh oh!

santysisi commented Mar 12, 2025

Uh oh!

OskarStark Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

OskarStark Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas commented Mar 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

[FrameworkBundle] Add `--method` option to `debug:router` command #59909

[FrameworkBundle] Add `--method` option to `debug:router` command #59909