Skip to content

[Security][SecurityBundle] Dump role hierarchy as mermaid chart #61034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 6, 2025
Merged

[Security][SecurityBundle] Dump role hierarchy as mermaid chart #61034

merged 1 commit into from
Sep 6, 2025

Conversation

@damienfern
Copy link
Contributor

@damienfern damienfern commented Jul 4, 2025

Q A
Branch? 7.4
Bug fix? no
New feature? yes
Deprecations? no
License MIT

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 :

# config/packages/security.yaml
security:
    # ...

    role_hierarchy:
        ROLE_ADMIN:       ROLE_USER
        ROLE_SUPER_ADMIN: [ROLE_ADMIN, ROLE_ALLOWED_TO_SWITCH]
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_SWITCH
Loading

For 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.

@damienfern damienfern requested a review from chalasr as a code owner July 4, 2025 10:01
@carsonbot carsonbot added this to the 7.4 milestone Jul 4, 2025
@carsonbot carsonbot changed the title [Security] [SecurityBundle] Dump role hierarchy as mermaid chart [Security][SecurityBundle] Dump role hierarchy as mermaid chart Jul 4, 2025
OskarStark
OskarStark reviewed Jul 4, 2025
View reviewed changes
welcoMattic
welcoMattic reviewed Jul 4, 2025
View reviewed changes
OskarStark
OskarStark reviewed Jul 5, 2025
View reviewed changes
@94noni
Copy link
Contributor

94noni commented Jul 6, 2025

Nice one 👍🏻
Question: would it be possible to include this in the profiler like the workflow dump ?
We can even imagine each role box colored depending on the current user roles from this config map

alexandre-daubois
alexandre-daubois requested changes Jul 7, 2025
View reviewed changes
@damienfern damienfern requested a review from OskarStark July 7, 2025 15:35
@damienfern
Copy link
Contributor Author

damienfern commented Jul 7, 2025

Nice one 👍🏻
Question: would it be possible to include this in the profiler like the workflow dump ?

Yes, I had also this in mind for a second PR, once this one gets merged.

We can even imagine each role box colored depending on the current user roles from this config map

Great idea ! I'll keep it in mind :)

stof
stof reviewed Jul 7, 2025
View reviewed changes
@damienfern damienfern force-pushed the feat/dump-role-chart-mermaid branch 3 times, most recently from 702f4a3 to 96d1fda Compare July 18, 2025 16:01
@damienfern damienfern requested review from stof and welcoMattic July 18, 2025 16:06
94noni
94noni approved these changes Aug 20, 2025
View reviewed changes
Copy link
Contributor

@94noni 94noni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice 👍🏻

stof
stof reviewed Aug 20, 2025
View reviewed changes
stof
stof reviewed Aug 20, 2025
View reviewed changes
@damienfern damienfern force-pushed the feat/dump-role-chart-mermaid branch from 66af046 to 9ec7a1a Compare August 22, 2025 06:43
@damienfern damienfern requested a review from stof August 22, 2025 06:56
@damienfern damienfern force-pushed the feat/dump-role-chart-mermaid branch from d3d9f4a to 37982f6 Compare August 25, 2025 15:23
fabpot
fabpot requested changes Sep 4, 2025
View reviewed changes
@damienfern damienfern force-pushed the feat/dump-role-chart-mermaid branch 2 times, most recently from f35574f to 1375f50 Compare September 4, 2025 15:34
@damienfern damienfern requested a review from fabpot September 5, 2025 15:02
@fabpot fabpot force-pushed the feat/dump-role-chart-mermaid branch from 1375f50 to 733fd0d Compare September 6, 2025 11:58
@fabpot
Copy link
Member

fabpot commented Sep 6, 2025

Thank you @damienfern.

@fabpot fabpot merged commit eedf441 into symfony:7.4 Sep 6, 2025
7 of 12 checks passed
@fabpot fabpot mentioned this pull request Sep 6, 2025
Closed
@damienfern damienfern mentioned this pull request Sep 18, 2025
Open
This was referenced Oct 27, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fabpot fabpot fabpot approved these changes

@OskarStark OskarStark OskarStark approved these changes

@alexandre-daubois alexandre-daubois Awaiting requested review from alexandre-daubois

@welcoMattic welcoMattic Awaiting requested review from welcoMattic

@chalasr chalasr Awaiting requested review from chalasr chalasr is a code owner

@stof stof Awaiting requested review from stof

+1 more reviewer

@94noni 94noni 94noni approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Feature Security SecurityBundle Status: Reviewed

Projects

None yet

Milestone

7.4

Development

Successfully merging this pull request may close these issues.

9 participants

@damienfern @94noni @fabpot @stof @welcoMattic @OskarStark @alexandre-daubois @chalasr @carsonbot