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

Issue fork drupal-2672340

Command icon 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:

Comments

alexpott created an issue. See original summary.

alexpott’s picture

Issue summary: View changes

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.0-beta1 was released on March 2, 2016, which means new developments and disruptive changes should now be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

marcingy’s picture

Status: Active » Needs review
StatusFileSize
new3.47 KB

Initial pass, removes the check for sync as we no longer need it. Lets see what tests fail!

Status: Needs review » Needs work

The last submitted patch, 4: issue-2672340.patch, failed testing.

marcingy’s picture

Status: Needs work » Needs review
StatusFileSize
new5.91 KB

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

Status: Needs review » Needs work

The last submitted patch, 6: issue-2672340.patch, failed testing.

therealssj’s picture

StatusFileSize
new8.69 KB
new2.78 KB

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

therealssj’s picture

Status: Needs work » Needs review
alexpott’s picture

Issue tags: +Needs change record

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

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.0-beta1 was released on August 3, 2016, which means new developments and disruptive changes should now be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

fancyweb’s picture

I'm having this exact same issue. It would be nice if this hook was removed.

idebr’s picture

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

alexpott’s picture

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

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

larowlan’s picture

yogeshmpawar’s picture

Issue tags: -Needs reroll
StatusFileSize
new9.06 KB
new14.78 KB

Updated patch with reroll diff.

Status: Needs review » Needs work

The last submitted patch, 26: 2672340-26.patch, failed testing. View results

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

joegraduate made their first commit to this issue’s fork.

joegraduate’s picture

Status: Needs work » Needs review

Re-rolled patch from #26 into a MR targeting 11.x.

joegraduate’s picture

Also made a second MR targeting 10.4.x

joegraduate’s picture

Issue tags: -Needs change record

Created a draft change record: https://www.drupal.org/node/3522105

tadean’s picture

@joegraduate your proposed draft change record looks appropriate to me.

nicxvan’s picture

Is this eligible for backport to 10.x?

I updated who the CR targets and did a quick review of the 11.x MR

joegraduate changed the visibility of the branch 2672340-remove-user_user_role_insert-10.4.x to hidden.

joegraduate’s picture

Created MR targeting 10.5.x.

joegraduate changed the visibility of the branch 10.5.x to hidden.

joegraduate changed the visibility of the branch 11.x to hidden.

needs-review-queue-bot’s picture

Status: Needs review » Needs work
StatusFileSize
new91 bytes

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

joegraduate’s picture

Status: Needs work » Needs review

Setting back to needs review.

needs-review-queue-bot’s picture

Status: Needs review » Needs work
StatusFileSize
new91 bytes

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

joegraduate changed the visibility of the branch 2672340-remove-user_user_role_insert-10.5.x to hidden.

joegraduate’s picture

Status: Needs work » Needs review

Hid 10.5.x MR.

needs-review-queue-bot’s picture

Status: Needs review » Needs work
StatusFileSize
new91 bytes

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

joegraduate changed the visibility of the branch 2672340-remove-user_user_role_insert to hidden.

joegraduate’s picture

Status: Needs work » Needs review

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

smustgrave’s picture

Status: Needs review » Needs work

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

joegraduate’s picture

Status: Needs work » Needs review
  • Addressed @smustgrave's MR comments
  • Added the actions as exported config yml files to config/install in the standard and demo_umami install profiles
  • Added the actions as exported config yml files in the administrator_role and content_editor_role recipes

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

smustgrave’s picture

Then think this needs to go back to NW for backwards compatibility can’t just break things for people immediately

smustgrave’s picture

Status: Needs review » Needs work

Think 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

joegraduate’s picture

@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:

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.

nicxvan’s picture

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

smustgrave’s picture

Status: Needs work » Needs review

For some ideas

smustgrave’s picture

Status: Needs review » Needs work

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

joegraduate’s picture

Issue summary: View changes
Status: Needs work » Needs review

Added some more detail to the Proposed Resolution section of the Issue Summary.

needs-review-queue-bot’s picture

Status: Needs review » Needs work
StatusFileSize
new91 bytes

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

Version: 11.x-dev » main

Drupal core is now using the main branch as the primary development branch. New developments and disruptive changes should now be targeted to the main branch.

Read more in the announcement.

joegraduate’s picture

Status: Needs work » Needs review
StatusFileSize
new19.17 KB

Updated !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.

nicxvan’s picture

Status: Needs review » Reviewed & tested by the community

I took a pass at updating the CR.

I think this is ready.

quietone’s picture

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

  • catch committed 0e0ab608 on main
    fix: #2672340 user_user_role_insert should not exist
    
    By: alexpott
    By:...

  • catch committed c9e3af7c on 11.x
    fix: #2672340 user_user_role_insert should not exist
    
    By: alexpott
    By:...
catch’s picture

Version: main » 11.x-dev
Status: Reviewed & tested by the community » Fixed

Committed/pushed to main and 11.x, thanks!

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

godotislate’s picture

Status: Fixed » Needs work

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

quietone’s picture

core/modules/contact/tests/src/Functional/migrate_drupal_ui/d6/Upgrade6Test.php also needs to change

godotislate’s picture

Thanks, @quietone. It was hard to spot that those were two separate tests.

godotislate’s picture

Status: Needs work » Needs review

Opened https://git.drupalcode.org/project/drupal/-/merge_requests/16764 against 11.x with 2 adjustments to test numbers.

quietone’s picture

Status: Needs review » Reviewed & tested by the community

@godotislate, thanks for finding and fixing this.

godotislate’s picture

Priority: Normal » Critical

Bumping to Critical because Daily 11.x jobs are failing.

  • xjm committed be0f7c72 on 11.x
    fix: #2672340 Test regression hotfix
    
    By: quietone
    By: godotislate
    
xjm’s picture

Status: Reviewed & tested by the community » Fixed

Committed the hotfix to 11.x. Thanks @godotislate and @quietone!

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

xjm’s picture

Priority: Critical » Normal

Restoring original priority.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.