Page MenuHomePhabricator
Create Task
Maniphest T234921

Factor group membership management out of User class
Closed, ResolvedPublic
Actions

Description

To reduce coupling, functionality related to user group management should be factored out of the User class. Some of the relevant code is already encapsulated in the UserGroupMembership class. UserGroupMembership however should be replaced by (or become) a pure value object.

Proposed design: introduce a UserGroupManager service that offers the following methods:

  • getExpliciteGroups( UserIdentity )
  • getAutomaticGroups( UserIdentity )
  • getEffectiveGroups( UserIdentity )
  • getFormerGroups( UserIdentity )
  • addToGroup( UserIdentity, $group )
  • removeFromGroup( UserIdentity, $group )
  • getGroupLink( $group, UserIdentity|null )

Details

SubjectRepoBranchLines +/-
Use UserGroupManager instead of deprecated User methodsmediawiki/coremaster+30 -10
Remove hard deprecate Autopromote methodsmediawiki/coremaster+0 -0
Remove all hard-deprecated methods of UserGroupMembershipmediawiki/coremaster+10 -158
Hard-deprecate UserGroupMembership methods replaced by managermediawiki/coremaster+26 -8
Use UserGroupManagerFactory with correct domain to fetch groupsmediawiki/extensions/CheckUserwmf/1.35.0-wmf.36+35 -14
Use UserGroupManagerFactory with correct domain to fetch groupsmediawiki/extensions/CheckUsermaster+35 -14
UserGroupManager: add tests for coverage gapsmediawiki/coremaster+82 -9
Create UserGroupManagermediawiki/coremaster+1 K -579
Adds missing tests for User class related to group management, covers:mediawiki/coremaster+180 -0
Tests: Don't reuse the same username for users with different groups.mediawiki/extensions/Wikibasemaster+5 -15
Customize query in gerrit

Related Objects
Search...

StatusSubtypeAssignedTask
 Resolved• PcheloloT234921 Factor group membership management out of User class
 Resolved• PcheloloT252621 Move Autopromotion logic to UserGroupManager service
 Resolved• PcheloloT254537 UserGroupManager/PermissionManager cyclic dependency
 ResolvedPeter.ovchynT271593 Replace specific PermissionManager calls with GroupPermissionsLookup calls in all deployed extensions
 ResolvedPeter.ovchynT271596 Migrate relevant User method usages to GroupPermissionsLookup and hard-deprecate User methods.
 Resolved• PcheloloT254282 Reuse cached values for higher queryFlags in UserGroupManager if possible
 ResolvedUrbanecmT254822 CentralAuth's group membership is not reliable
 Resolved• PcheloloT254838 Move User::changeableGroups and User::changeableByGroup to UserGroupManager
 Resolved• PcheloloT273510 Convert AuthManager to Authority
 Resolved• PcheloloT273511 Convert CentralAuthUtilityService to Authority instead of PermissionManager
 Resolved• PcheloloT254912 CheckUser is using UserGroupMembership::getGroupMemberships for foreign wikis
 ResolvedUmherirrenderT275148 Prepare User group methods for hard deprecation
 ResolvedVlad.shapikT281704 extensions/Wikibase - Use UserGroupManager instead of User group methods
 DuplicateNoneT281816 extensions/Wikibase - Use UserGroupManager instead of User group methods
 InvalidNoneT281818 extensions/Translate - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281819 extensions/CheckUser - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281820 extensions/SecurePoll - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281821 extensions/UserMerge - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281822 extensions/WikibaseMediaInfo - Use UserGroupManager instead of User group methods
 ResolvedZabeT281823 operations/mediawiki-config - Use UserGroupManager instead of User group methods
 ResolvedDaimonaT281824 extensions/AbuseFilter - Use UserGroupManager instead of User group methods
 InvalidVlad.shapikT281825 extensions/EventBus - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281831 extensions/LdapAuthentication - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281834 extensions/OAuth - Use UserGroupManager instead of User group methods
 ResolvedjeenaT281835 extensions/Flow - Use UserGroupManager instead of User group methods
 InvalidNoneT281836 extensions/BetaFeatures - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281837 extensions/CentralAuth - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281838 extensions/GlobalCssJs - Use UserGroupManager instead of User group methods
 InvalidNoneT281839 extensions/CentralNotice - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281841 extensions/LDAPGroups - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281842 extensions/WikiLexicalData - Use UserGroupManager instead of User group methods
 DuplicateNoneT281843 extensions/BlueSpiceFoundation - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281844 extensions/SimpleSAMLphp - Use UserGroupManager instead of User group methods
 ResolvedNoneT281845 extension/AbsenteeLandlord - Use UserGroupManager instead of User group methods
 InvalidNoneT281846 extensions/UserGroups - Use UserGroupManager instead of User group methods
 InvalidVlad.shapikT281847 extensions/UserGroups - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281848 extensions/AccessControl - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281849 extensions/ApprovedRevs - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281850 extensions/BatchUserRights - Use UserGroupManager instead of User group methods
 ResolvedZabeT281851 BlueSpice related extensions - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281855 extensions/ConfirmAccount - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281856 extensions/Farmer - Use UserGroupManager instead of User group methods
 InvalidNoneT281857 extensions/ImportUsers - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281858 extensions/LinkFilter - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281859 extensions/RevisionCommentSupplement - Use UserGroupManager instead of User group methods
 ResolvedashleyT281861 extensions/SocialProfile - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281862 extensions/WikiToLDAP - Use UserGroupManager instead of User group methods
 ResolvedNoneT281863 mediawiki/vagrant - Use UserGroupManager instead of User group methods
 ResolvedUniversal_OmegaT281864 skins/Cosmos - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281865 extensions/Auth_remoteuser - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281867 extensions/GlobalNotice - Use UserGroupManager instead of User group methods
 InvalidNoneT281868 extensions/GroupsSidebar - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281869 extensions/GroupWhitelist - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281870 extensions/HAWelcome - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281871 extensions/Lockdown - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281872 extensions/LockDownEnglishPages - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281873 extensions/PageForms - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281875 extensions/PrivateDomains - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281877 extensions/Quantcast - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281878 extensions/RightFunctions - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281880 extensions/SemanticACL - Use UserGroupManager instead of User group methods
 InvalidNoneT281882 extensions/SemanticPageSeries - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281883 extensions/ShoutWikiAds - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281884 extensions/ShoutWikiAPI - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281885 extensions/StaffPowers - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281886 extensions/UserFunctions - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281887 extensions/WikiForum - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281888 extensions/WSOAuth - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281889 extensions/DisableAccount - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281890 extensions/InviteSignup - Use UserGroupManager instead of User group methods
 ResolvedVlad.shapikT281891 extensions/Shibboleth - Use UserGroupManager instead of User group methods
 ResolvedNoneT255309 Remove UserRightsProxy and replace its usages with UserGroupManager (remove in 1.42)
 ResolvedUmherirrenderT337590 Assert correct wiki for the user identity in UserGroupManager for cross-wiki group changes/reading

Event Timeline

daniel created this task.Oct 8 2019, 1:01 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 8 2019, 1:01 PM
gerritbot added a comment.Oct 24 2019, 3:15 AM

Change 545690 had a related patch set uploaded (by Ppchelko; owner: Ppchelko):
[mediawiki/core@master] WIP: Create UserGroupManager

https://gerrit.wikimedia.org/r/545690

gerritbot added a project: Patch-For-Review.Oct 24 2019, 3:15 AM
DannyS712 added a project: MediaWiki-User-management.Oct 26 2019, 9:57 PM
DannyS712 subscribed.
DannyS712 moved this task from Backlog to User rights on the MediaWiki-User-management board.Oct 26 2019, 9:59 PM
gerritbot added a comment.Oct 29 2019, 8:24 PM

Change 547029 had a related patch set uploaded (by Ppchelko; owner: Ppchelko):
[mediawiki/extensions/Wikibase@master] Tests: Don't reuse the same username for users with different groups.

https://gerrit.wikimedia.org/r/547029

gerritbot added a comment.Oct 30 2019, 12:02 PM

Change 547029 merged by jenkins-bot:
[mediawiki/extensions/Wikibase@master] Tests: Don't reuse the same username for users with different groups.

https://gerrit.wikimedia.org/r/547029

ReleaseTaggerBot added a project: MW-1.35-notes (1.35.0-wmf.5; 2019-11-05).Oct 30 2019, 1:00 PM
tosfos assigned this task to Vedmaka.Nov 1 2019, 6:19 PM
tosfos subscribed.
gerritbot added a comment.Nov 23 2019, 10:24 AM

Change 552625 had a related patch set uploaded (by Vedmaka Wakalaka; owner: Vedmaka Wakalaka):
[mediawiki/core@master] Adds missing tests for User class related to group management, covers:

https://gerrit.wikimedia.org/r/552625

gerritbot added a comment.Nov 25 2019, 1:29 PM

Change 552625 merged by jenkins-bot:
[mediawiki/core@master] Adds missing tests for User class related to group management, covers:

https://gerrit.wikimedia.org/r/552625

ReleaseTaggerBot edited projects, added MW-1.35-notes (1.35.0-wmf.8; 2019-11-26); removed MW-1.35-notes (1.35.0-wmf.5; 2019-11-05).Nov 25 2019, 2:00 PM
Reedy mentioned this in T239212: UserGroupMembershipTest::testGetLink failing on travis.Nov 26 2019, 10:16 AM
DannyS712 mentioned this in T224423: Factor user group management out of the User object.Nov 28 2019, 7:29 AM
Vedmaka mentioned this in T239516: Add Vedmaka to Gerrit Trusted-Contributors group.Nov 30 2019, 6:07 PM
CCicalese_WMF added a project: Platform Team Workboards (Clinic Duty Team).Dec 16 2019, 6:07 PM
CCicalese_WMF moved this task from Inbox to External Code Review Needed on the Platform Team Workboards (Clinic Duty Team) board.
daniel triaged this task as Medium priority.Apr 8 2020, 11:28 AM
gerritbot added a comment.Apr 11 2020, 5:31 AM

Change 588071 had a related patch set uploaded (by Ppchelko; owner: Ppchelko):
[mediawiki/core@master] Use UserGroupManager instead of deprecated User methods

https://gerrit.wikimedia.org/r/588071

daniel moved this task from External Code Review Needed to Backlog on the Platform Team Workboards (Clinic Duty Team) board.Apr 16 2020, 12:49 PM
WDoranWMF removed Vedmaka as the assignee of this task.May 20 2020, 8:53 PM
WDoranWMF added a subscriber: Vedmaka.
CCicalese_WMF moved this task from Backlog to Ready (WIP:5) on the Platform Team Workboards (Clinic Duty Team) board.May 21 2020, 1:50 PM
• Clarakosi claimed this task.May 21 2020, 2:36 PM
CCicalese_WMF moved this task from Ready (WIP:5) to Later on the Platform Team Workboards (Clinic Duty Team) board.May 21 2020, 3:15 PM
• Clarakosi reassigned this task from • Clarakosi to • Pchelolo.May 27 2020, 3:14 PM
• Clarakosi moved this task from Later to Waiting for Review on the Platform Team Workboards (Clinic Duty Team) board.
• Clarakosi subscribed.
• Pchelolo added a subtask: T252621: Move Autopromotion logic to UserGroupManager service.Jun 2 2020, 5:12 PM
• eprodromou changed the status of subtask T252621: Move Autopromotion logic to UserGroupManager service from Open to Stalled.Jun 2 2020, 8:30 PM
gerritbot added a comment.Jun 4 2020, 3:31 PM

Change 545690 merged by jenkins-bot:
[mediawiki/core@master] Create UserGroupManager

https://gerrit.wikimedia.org/r/545690

DannyS712 removed a project: Patch-For-Review.Jun 4 2020, 3:40 PM
Naike changed the status of subtask T254282: Reuse cached values for higher queryFlags in UserGroupManager if possible from Open to Stalled.Jun 5 2020, 1:30 PM
gerritbot added a comment.Jun 5 2020, 2:19 PM

Change 602695 had a related patch set uploaded (by Ppchelko; owner: Ppchelko):
[mediawiki/core@master] UserGroupManager: add tests for coverage gaps

https://gerrit.wikimedia.org/r/602695

gerritbot added a project: Patch-For-Review.Jun 5 2020, 2:19 PM
DannyS712 mentioned this in T233385: Expand phpunit tests for User.php.Jun 6 2020, 4:51 AM
gerritbot added a comment.Jun 7 2020, 5:31 AM

Change 602695 merged by jenkins-bot:
[mediawiki/core@master] UserGroupManager: add tests for coverage gaps

https://gerrit.wikimedia.org/r/602695

ReleaseTaggerBot edited projects, added MW-1.35-notes (1.35.0-wmf.36; 2020-06-09); removed MW-1.35-notes (1.35.0-wmf.8; 2019-11-26).Jun 7 2020, 6:00 AM
Naike changed the status of subtask T254282: Reuse cached values for higher queryFlags in UserGroupManager if possible from Stalled to Open.Jun 8 2020, 1:58 PM
DannyS712 added a subtask: T254822: CentralAuth's group membership is not reliable.Jun 8 2020, 9:29 PM
• Pchelolo moved this task from Waiting for Review to Waiting for deployment on the Platform Team Workboards (Clinic Duty Team) board.Jun 8 2020, 9:37 PM
gerritbot added a comment.Jun 9 2020, 3:14 PM

Change 604047 had a related patch set uploaded (by Ppchelko; owner: Ppchelko):
[mediawiki/extensions/CheckUser@master] Use UserGroupManagerFactory with correct domain to fetch groups

https://gerrit.wikimedia.org/r/604047

gerritbot added a comment.Jun 9 2020, 4:46 PM

Change 604047 merged by jenkins-bot:
[mediawiki/extensions/CheckUser@master] Use UserGroupManagerFactory with correct domain to fetch groups

https://gerrit.wikimedia.org/r/604047

ReleaseTaggerBot edited projects, added MW-1.35-notes (1.35.0-wmf.37; 2020-06-16); removed MW-1.35-notes (1.35.0-wmf.36; 2020-06-09).Jun 9 2020, 5:00 PM
Urbanecm closed subtask T254822: CentralAuth's group membership is not reliable as Resolved.Jun 9 2020, 5:20 PM
Agusbou2015 subscribed.Jun 9 2020, 5:21 PM
• Pchelolo closed subtask T254912: CheckUser is using UserGroupMembership::getGroupMemberships for foreign wikis as Resolved.Jun 9 2020, 5:44 PM
Jdforrester-WMF reopened subtask T254912: CheckUser is using UserGroupMembership::getGroupMemberships for foreign wikis as Open.Jun 9 2020, 5:48 PM
gerritbot added a comment.Jun 9 2020, 5:51 PM

Change 604096 had a related patch set uploaded (by Jforrester; owner: Ppchelko):
[mediawiki/extensions/CheckUser@wmf/1.35.0-wmf.36] Use UserGroupManagerFactory with correct domain to fetch groups

https://gerrit.wikimedia.org/r/604096

gerritbot added a comment.Jun 9 2020, 6:07 PM

Change 604096 merged by jenkins-bot:
[mediawiki/extensions/CheckUser@wmf/1.35.0-wmf.36] Use UserGroupManagerFactory with correct domain to fetch groups

https://gerrit.wikimedia.org/r/604096

Stashbot added a comment.Jun 9 2020, 6:13 PM

Mentioned in SAL (#wikimedia-operations) [2020-06-09T18:13:06Z] <jforrester@deploy1001> Synchronized php-1.35.0-wmf.36/extensions/CheckUser/: T234921 T254912 Use UserGroupManagerFactory with correct domain to fetch groups (duration: 02m 26s)

Stashbot mentioned this in T254912: CheckUser is using UserGroupMembership::getGroupMemberships for foreign wikis.Jun 9 2020, 6:13 PM
Jdforrester-WMF closed subtask T254912: CheckUser is using UserGroupMembership::getGroupMemberships for foreign wikis as Resolved.Jun 9 2020, 6:15 PM
DannyS712 changed the status of subtask T252621: Move Autopromotion logic to UserGroupManager service from Stalled to Open.Jun 11 2020, 3:41 AM
• Pchelolo closed subtask T254282: Reuse cached values for higher queryFlags in UserGroupManager if possible as Resolved.Jun 11 2020, 9:45 PM
• Pchelolo closed subtask T252621: Move Autopromotion logic to UserGroupManager service as Resolved.Jun 12 2020, 7:39 PM
gerritbot added a comment.Jun 12 2020, 9:37 PM

Change 605323 had a related patch set uploaded (by Ppchelko; owner: Ppchelko):
[mediawiki/core@master] Hard-deprecate UserGroupMembership methods replaced by manager

https://gerrit.wikimedia.org/r/605323

DannyS712 mentioned this in T255330: [Regression] user rights log entries no longer include expiry.Jun 13 2020, 2:49 AM
gerritbot added a comment.Jun 24 2020, 6:35 PM

Change 605323 merged by jenkins-bot:
[mediawiki/core@master] Hard-deprecate UserGroupMembership methods replaced by manager

https://gerrit.wikimedia.org/r/605323

ReleaseTaggerBot edited projects, added MW-1.35-notes (1.35.0-wmf.39; 2020-06-30); removed MW-1.35-notes (1.35.0-wmf.37; 2020-06-16).Jun 24 2020, 7:00 PM
• Pchelolo moved this task from Waiting for deployment to Ready (WIP:5) on the Platform Team Workboards (Clinic Duty Team) board.Jun 25 2020, 3:19 AM
gerritbot added a comment.Oct 3 2020, 3:16 PM

Change 631927 had a related patch set uploaded (by Ppchelko; owner: Ppchelko):
[mediawiki/core@master] Remove all hard-deprecated methods of UserGroupMembership

https://gerrit.wikimedia.org/r/631927

gerritbot added a comment.Oct 5 2020, 6:44 PM

Change 631927 merged by jenkins-bot:
[mediawiki/core@master] Remove all hard-deprecated methods of UserGroupMembership

https://gerrit.wikimedia.org/r/631927

ReleaseTaggerBot added a project: MW-1.36-notes (1.36.0-wmf.12; 2020-10-05; NEVER DEPLOYED).Oct 5 2020, 7:00 PM
gerritbot added a comment.Oct 5 2020, 11:20 PM

Change 632334 had a related patch set uploaded (by DannyS712; owner: DannyS712):
[mediawiki/core@master] Remove hard deprecate Autopromote methods

https://gerrit.wikimedia.org/r/632334

gerritbot added a comment.Oct 5 2020, 11:22 PM

Change 632334 abandoned by DannyS712:
[mediawiki/core@master] Remove hard deprecate Autopromote methods

Reason:
only hard deprecated since 1.36

https://gerrit.wikimedia.org/r/632334

Daimona mentioned this in T265298: Provide a public method for logging user rights changes.Oct 12 2020, 6:10 PM
• Pchelolo edited projects, added Platform Team Workboards (MW Expedition); removed Platform Team Workboards (Clinic Duty Team).Mar 16 2021, 1:45 PM
gerritbot added a comment.Jun 9 2021, 2:57 PM

Change 588071 abandoned by Ppchelko:

[mediawiki/core@master] Use UserGroupManager instead of deprecated User methods

Reason:

https://gerrit.wikimedia.org/r/588071

• Pchelolo closed subtask T254838: Move User::changeableGroups and User::changeableByGroup to UserGroupManager as Resolved.Jun 17 2021, 9:17 PM
• Pchelolo moved this task from Unsorted pile to Blocked on the Platform Team Workboards (MW Expedition) board.Jul 27 2021, 2:21 PM
Zabe removed a project: Patch-For-Review.Aug 14 2021, 12:29 PM
daniel closed this task as Resolved.Jun 29 2022, 10:57 AM
Umherirrender changed the status of subtask T255309: Remove UserRightsProxy and replace its usages with UserGroupManager (remove in 1.42) from Open to Stalled.Aug 29 2023, 7:34 PM
Jdforrester-WMF closed subtask T275148: Prepare User group methods for hard deprecation as Resolved.Aug 31 2023, 1:44 PM
Umherirrender changed the status of subtask T255309: Remove UserRightsProxy and replace its usages with UserGroupManager (remove in 1.42) from Stalled to Open.Oct 13 2023, 3:47 PM
Umherirrender closed subtask T255309: Remove UserRightsProxy and replace its usages with UserGroupManager (remove in 1.42) as Resolved.Oct 20 2023, 4:45 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL