Problem/Motivation
user_user_role_insert() is a secondary write to config. Basically when you create a role through the API or UI you will always get two actions created. This entangles the role and action configuration entities from an API perspective that is wrong. When you create a role through the API the system should only create a role. At the moment configuration sync only works because we bail if the role is being created as part of a configuration sync. But whether or not it is a config sync seems irrelevant. In fact it feels as though we need different hooks of API and UI based creates.
This is a bug because if an install profile provides both the role and it's related system.action.user_add_role_action.ROLEID the install breaks horribly with the following error:
Drupal\Core\Config\ConfigDuplicateUUIDException: Attempt to save a configuration entity 'user_add_role_action.administrator' with UUID '1b27a4d1-6f94-4c33-9500-a44bd23eeab9' when this entity already exists with UUID 'b69baf55-119d-4066-8d0f-15725863cce1' in Drupal\Core\Config\Entity\ConfigEntityBase->preSave() (line 344 of core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php).
Proposed resolution
- Move the code that creates system.action configuration entities in
user_user_role_insert()to the form that is used to create user roles - Update existing core install profiles and recipes that contain exported user role configuration entities to also include exported system.action configuration entities for those roles since they will no longer be created automatically when the install profile is installed or recipe is applied
Remaining tasks
User interface changes
API changes
Data model changes
| Comment | File | Size | Author |
|---|
Issue fork drupal-2672340
Show commands
Start within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
- 2672340-fix-11.x
changes, plain diff MR !16764
- 2672340-remove-user_user_role_insert
changes, plain diff MR !11992
- 2672340-remove-user_user_role_insert-11.x
changes, plain diff MR !12111
- 2672340-remove-user_user_role_insert-10.4.x
changes, plain diff MR !11995
- 2672340-remove-user_user_role_insert-10.5.x
changes, plain diff MR !12041
- 11.x
compare
- 10.5.x
compare
Comments
Comment #2
alexpottComment #4
marcingy commentedInitial pass, removes the check for sync as we no longer need it. Lets see what tests fail!
Comment #6
marcingy commentedThis should fix some issues, but does seem like we need to re-think the DX to allow for creation programatically in a nice way. Should we introduce a $role->createAction() interface to allow those who wish to do so to create elements programatically but the default would be FALSE.
Comment #8
therealssj commentedSome more fixes.
Till we have something like $role->createAction() as marcingy suggested, i hope this test is a good workaround.
Only adding action for the first role as that is only checked.
Comment #9
therealssj commentedComment #10
alexpottThe change looks good - I'm not sure that we need a $role->createAction() since this will have to access things about the Action entity that the role entity should not know about.
I think we need a CR and I'll discuss with the other committers about whether this is allowable in a minor release.
Comment #16
fancyweb commentedI'm having this exact same issue. It would be nice if this hook was removed.
Comment #17
idebr commentedIn the issue #2980237: Rebuilding routes when node.settings:use_admin_theme changes should be done in a config listener the logic was moved away from the form to make it compatible with changing config through other means such as drush/drupal console, so in a way the proposed resolution here seems a step backwards.
Comment #18
alexpott@idebr this is totally different. That issue is performing an action that HAS to occur when node.settings:use_admin_theme changes.
user_user_role_insert()is doing something that does not have to happen at all. It's a UI niceness but from an API point-of-view just gets in the way.Comment #25
larowlanComment #26
yogeshmpawarUpdated patch with reroll diff.
Comment #33
joegraduateRe-rolled patch from #26 into a MR targeting 11.x.
Comment #35
joegraduateAlso made a second MR targeting 10.4.x
Comment #36
joegraduateCreated a draft change record: https://www.drupal.org/node/3522105
Comment #37
tadean@joegraduate your proposed draft change record looks appropriate to me.
Comment #38
nicxvan commentedIs this eligible for backport to 10.x?
I updated who the CR targets and did a quick review of the 11.x MR
Comment #41
joegraduateCreated MR targeting 10.5.x.
Comment #44
needs-review-queue-bot commentedThe Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".
This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.
Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.
Comment #45
joegraduateSetting back to needs review.
Comment #46
needs-review-queue-bot commentedThe Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".
This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.
Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.
Comment #48
joegraduateHid 10.5.x MR.
Comment #49
needs-review-queue-bot commentedThe Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".
This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.
Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.
Comment #52
joegraduateCreated a new 11.x MR (and hid the original 11.x MR branch). Assuming that the the NR bot only checks the most recently created MR for compatibility with 11.x.
Comment #53
smustgrave commentedCR will need some work as believe we missed 11.2
Left some comments on the MR.
If the test changes were needed to make them pass then wouldn't this change potentially break contrib tests.
Comment #54
joegraduate@smustgrave, yes, I think if contrib module tests involve the creation of user roles, they could be affected by these changes. I think maintainers of profiles and recipes that include custom roles are even more likely to be affected.
Comment #55
smustgrave commentedThen think this needs to go back to NW for backwards compatibility can’t just break things for people immediately
Comment #56
smustgrave commentedThink we will have to trigger some deprecation to warn people
If it’s a major change, I can’t say, may need to be deprecated till 13
Comment #57
joegraduate@smustgrave, I guess I'm not sure how to best go about implementing a deprecation since the current functionality is built into the user module (in a hook_ENTITY_TYPE_insert() implementation that gets triggered any time a user role entity is created) and not part of any API code that would be invoked directly by contrib extensions.
We could add something to trigger a deprecation warning inside the hook implementation but there wouldn't really be anything contrib extension maintainers could do to address the deprecation until functionality contained in the hook implementation is removed or moved elsewhere.
I'm also not sure whether this constitutes a major change or not. @alexpott mentioned in #18 that what user_user_role_insert() currently does isn't strictly needed:
Comment #58
nicxvan commentedI haven't reviewed this since my earlier comment.
Hook implementations are not covered strictly under BC. I know core sometimes still provides it.
I'm not sure either how we would do it in this case.
Comment #59
smustgrave commentedFor some ideas
Comment #60
smustgrave commentedWonder if proposed solution can be cleaned up. It mentions just removing this function but looking at the MR not super clear why all the recipes and profiles had to be updated now.
Comment #61
joegraduateAdded some more detail to the Proposed Resolution section of the Issue Summary.
Comment #62
needs-review-queue-bot commentedThe Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".
This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.
Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.
Comment #64
joegraduateUpdated !MR12111 with latest from main, resolved merged conflicts, and addressed deprecations.
I think this is ready for review again.
Also attaching current diff as updated static patch usable with composer for 11.4.x.
Comment #65
nicxvan commentedI took a pass at updating the CR.
I think this is ready.
Comment #66
quietone commentedI too changed the MR. I wanted to put the part about using the configuration API nearer to the beginning due to its importance.
I updated credit.
Comment #69
catchCommitted/pushed to main and 11.x, thanks!
Comment #71
godotislateI think this is breaking the daily test on 11.x:
https://git.drupalcode.org/project/drupal/-/jobs/11643054
https://git.drupalcode.org/project/drupal/-/jobs/11643055
My guess is that since the actions associated with roles are only created via the form, then roles created via migration do not have the corresponding actions created, which is causing the count discrepancy.
Comment #73
quietone commentedcore/modules/contact/tests/src/Functional/migrate_drupal_ui/d6/Upgrade6Test.php also needs to change
Comment #74
godotislateThanks, @quietone. It was hard to spot that those were two separate tests.
Comment #75
godotislateOpened https://git.drupalcode.org/project/drupal/-/merge_requests/16764 against 11.x with 2 adjustments to test numbers.
Comment #76
quietone commented@godotislate, thanks for finding and fixing this.
Comment #77
godotislateBumping to Critical because Daily 11.x jobs are failing.
Comment #79
xjmCommitted the hotfix to 11.x. Thanks @godotislate and @quietone!
Comment #81
xjmRestoring original priority.