[Security][SecurityBundle] Dump role hierarchy as mermaid chart #61034
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
OskarStark
reviewed
Jul 4, 2025
OskarStark
reviewed
Jul 4, 2025
src/Symfony/Bundle/SecurityBundle/Command/SecurityRoleHierarchyDumpCommand.php
Outdated
Show resolved
Hide resolved
OskarStark
reviewed
Jul 4, 2025
src/Symfony/Bundle/SecurityBundle/Command/SecurityRoleHierarchyDumpCommand.php
Outdated
Show resolved
Hide resolved
src/Symfony/Bundle/SecurityBundle/Tests/Command/SecurityRoleHierarchyDumpCommandTest.php
Outdated
Show resolved
Hide resolved
welcoMattic
reviewed
Jul 4, 2025
| ]; | ||
|
|
||
| public function __construct( | ||
| private readonly string $direction = self::DIRECTION_TOP_TO_BOTTOM, |
There was a problem hiding this comment.
Moving $direction argument to dump method would allow to dump multiple times the same role hierarchy in different directions without the need to instanciate multiple dumpers. WDYT?
OskarStark
reviewed
Jul 5, 2025
| 7.4 | ||
| --- | ||
|
|
||
| * Added `MermaidDumper` to dump Role Hierarchy graphs in the Mermaid.js flowchart format |
There was a problem hiding this comment.
Suggested change
| * Added `MermaidDumper` to dump Role Hierarchy graphs in the Mermaid.js flowchart format | |
| * Add `MermaidDumper` to dump Role Hierarchy graphs in the Mermaid.js flowchart format |
|
Nice one 👍🏻 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
From a developer POV, Roles and the SecurityBundle are so convenient, specially role hierarchy in the config. But as a web app grows, the number of roles also grows and with role inheritance, it can be painful to clearly see which role implies another which implies another which implies another (and its possible consequences).
I'm proposing a new command in the security bundle to generate a Mermaid flowchart, easing the understanding of the roles and its hierarchy. An example of the graph generated from the role hierarchy in the doc :
graph TB ROLE_ADMIN ROLE_USER ROLE_SUPER_ADMIN ROLE_ALLOWED_TO_SWITCH ROLE_ADMIN --> ROLE_USER ROLE_SUPER_ADMIN --> ROLE_ADMIN ROLE_SUPER_ADMIN --> ROLE_ALLOWED_TO_SWITCHFor now, only the mermaid format is suggested (the only format I know) but as the worfklow dump command, we could implement graphviz and plantuml format later.