Page MenuHomePhabricator
Create Task
Maniphest T253078

Create ActionFactory, add dependency injection to actions
Open, LowPublic
Actions

Description

The different action classes, retrieved from Action::factory, should instead be constructed from a dedicated factory service that has an object factory and provides each action the services it needs.

Actions used by services (I may have missed some):

ContentLanguage (HistoryAction, InfoAction, RevertAction)
HookContainer (FormAction, EditAction, HistoryAction, InfoAction, RawAction, ViewAction, WatchAction)
IContentHandlerFactory (RollbackAction)
ILoadBalancer (HistoryAction, InfoAction, both via wfGetDB)
LanguageNameUtils (InfoAction)
LinkBatchFactory (HistoryAction, InfoAction)
LinkRenderer (CreditsAction, HistoryAction, InfoAction, MarkpatrolledAction)
MagicWordFactory (InfoAction)
MainWANObjectCache (InfoAction)
NamespaceInfo (InfoAction)
PageProps (InfoAction, via PageProps::getInstance)
Parser (RawAction)
PermissionManager (HistoryAction, InfoAction, McrUndoAction, RawAction, WatchAction)
RepoGroup (InfoAction, RevertAction)
RevisionLookup (InfoAction, McrUndoAction, RawAction)
RevisionRenderer (McrUndoAction)
RevisionStore (HistoryAction, McrUndoAction)
SpecialPageFactory (SpecialPageAction)
UserFactory (CreditsAction, InfoAction, RawAction, all via User::newFromName)
UserOptionsLookup (RollbackAction, via User::getOption)
WatchedItemStore (InfoAction, WatchAction)
WatchlistNotificationManager (HistoryAction)
WikiPageFactory (WatchAction)

Don't exist yet, but:
RestrictionStore (InfoAction, RawAction)

SpecialPageFactory::getPage can be used as a model for the desired ActionFactory::getAction

Details

Show related patches Customize query in gerrit

Related Objects
Search...

Event Timeline

DannyS712 created this task.May 18 2020, 11:09 PM
Restricted Application added a project: User-DannyS712. · View Herald TranscriptMay 18 2020, 11:09 PM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
DannyS712 moved this task from Unsorted to Later on the User-DannyS712 board.May 18 2020, 11:09 PM
DannyS712 updated the task description. (Show Details)May 20 2020, 8:36 PM
DannyS712 added a project: Platform Engineering.
CCicalese_WMF moved this task from Inbox to Triage Meeting Inbox on the Platform Engineering board.May 21 2020, 11:56 AM
• eprodromou triaged this task as Low priority.May 26 2020, 8:33 PM
• eprodromou added a project: Platform Team Workboards (Clinic Duty Team).
• eprodromou removed a project: Platform Team Workboards (Clinic Duty Team).
• eprodromou moved this task from Triage Meeting Inbox to Tech Planning Review on the Platform Engineering board.
Umherirrender mentioned this in T265944: Make class WatchAction a real action class and move helper function to own service.Oct 19 2020, 7:49 PM
DannyS712 added a subscriber: • eprodromou.EditedOct 21 2020, 3:03 PM

@eprodromou is it okay to move forward with this using ObjectFactory specs for DI? This has been in "Tech Planning Review" since May

DannyS712 mentioned this in T268386: Create #mediawiki-actions component.Nov 21 2020, 7:30 PM
DannyS712 updated the task description. (Show Details)Nov 22 2020, 4:50 AM
In T253078#6568524, @DannyS712 wrote:

@eprodromou is it okay to move forward with this using ObjectFactory specs for DI? This has been in "Tech Planning Review" since May

{{ping}}

daniel added a subscriber: daniel.Feb 3 2021, 7:51 PM
In T253078#6568524, @DannyS712 wrote:

@eprodromou is it okay to move forward with this using ObjectFactory specs for DI? This has been in "Tech Planning Review" since May

Yes :)

I wouldn't consider this high priority, but moving from a static factory methods to a factory service object is the right thing. It can use ObjectFactory just like we do it for SpecialPages and API modules.

daniel moved this task from Tech Planning Review to Tracking/Watching on the Platform Engineering board.Feb 3 2021, 7:52 PM
Lucas_Werkmeister_WMDE added a subscriber: Lucas_Werkmeister_WMDE.Feb 26 2021, 11:42 AM
gerritbot added a comment.Mar 21 2021, 10:34 PM

Change 673795 had a related patch set uploaded (by DannyS712; owner: DannyS712):
[mediawiki/core@master] Add an ActionFactory and start converting to DI

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

gerritbot added a project: Patch-For-Review.Mar 21 2021, 10:34 PM
DannyS712 moved this task from Later to Awaiting review and deployment on the User-DannyS712 board.Mar 21 2021, 10:42 PM
DannyS712 added a project: Platform Team Workboards (External Code Reviews).
gerritbot added a comment.Jul 29 2021, 1:45 AM

Change 708626 had a related patch set uploaded (by DannyS712; author: DannyS712):

[mediawiki/core@master] Inject services into WatchAction and UnwatchAction

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

gerritbot added a comment.Jul 29 2021, 1:56 AM

Change 673795 merged by jenkins-bot:

[mediawiki/core@master] Add an ActionFactory and start converting to DI

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

ReleaseTaggerBot added a project: MW-1.37-notes (1.37.0-wmf.17; 2021-08-02).Jul 29 2021, 2:00 AM
gerritbot added a comment.Jul 29 2021, 2:29 AM

Change 708627 had a related patch set uploaded (by DannyS712; author: DannyS712):

[mediawiki/core@master] Inject services into a bunch more actions

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

Lucas_Werkmeister_WMDE added a comment.Jul 29 2021, 10:47 AM

For services that still need a factory method in the ObjectFactory spec, is there a suggested/recommended method name? In Wikibase we’ve usually used factory(), but of course that doesn’t work for actions, because they already inherit Action::factory().

(We used to call these methods newFromGlobalState(), but that became confusing/misleading when we started injecting dependencies into those methods.)

DannyS712 added a comment.Jul 29 2021, 4:11 PM
In T253078#7245857, @Lucas_Werkmeister_WMDE wrote:

For services that still need a factory method in the ObjectFactory spec, is there a suggested/recommended method name? In Wikibase we’ve usually used factory(), but of course that doesn’t work for actions, because they already inherit Action::factory().

(We used to call these methods newFromGlobalState(), but that became confusing/misleading when we started injecting dependencies into those methods.)

Hmm, maybe createNew or something? Not sure - I don't think there is an official recommended name, thats just my suggestion

gerritbot added a comment.Jul 31 2021, 3:02 AM

Change 709192 had a related patch set uploaded (by DannyS712; author: DannyS712):

[mediawiki/core@master] Clean up SpecialPageAction name handling

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

gerritbot added a comment.Aug 2 2021, 12:25 AM

Change 708626 merged by jenkins-bot:

[mediawiki/core@master] Inject services into WatchAction and UnwatchAction

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

gerritbot added a comment.Aug 2 2021, 12:57 AM

Change 708627 merged by jenkins-bot:

[mediawiki/core@master] Inject services into a bunch more actions

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

gerritbot added a comment.Aug 2 2021, 1:16 AM

Change 709192 merged by jenkins-bot:

[mediawiki/core@master] SpecialPageAction: inject action name and SpecialPageFactory

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

gerritbot added a comment.Aug 2 2021, 1:17 AM

Change 709203 had a related patch set uploaded (by DannyS712; author: DannyS712):

[mediawiki/core@master] Inject services into InfoAction

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

gerritbot added a comment.Aug 2 2021, 1:48 AM

Change 709204 had a related patch set uploaded (by DannyS712; author: DannyS712):

[mediawiki/core@master] Inject services into Mcr(Undo|Restore)Action

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

gerritbot added a comment.Aug 2 2021, 1:56 AM

Change 709205 had a related patch set uploaded (by DannyS712; author: DannyS712):

[mediawiki/core@master] Mark Action::getHookContainer() as @internal

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

gerritbot added a comment.Aug 2 2021, 1:59 AM

Change 709266 had a related patch set uploaded (by DannyS712; author: DannyS712):

[mediawiki/core@master] RELEASE-NOTES: document changes to $wgActions

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

gerritbot added a comment.Aug 2 2021, 2:55 AM

Change 709267 had a related patch set uploaded (by DannyS712; author: DannyS712):

[mediawiki/extensions/DiscussionTools@master] Injected SubscriptionStore into UnsubscribeAction

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

gerritbot added a comment.Aug 2 2021, 3:16 PM

Change 709266 merged by jenkins-bot:

[mediawiki/core@master] RELEASE-NOTES: document changes to $wgActions

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

gerritbot added a comment.Aug 2 2021, 3:25 PM

Change 709205 merged by jenkins-bot:

[mediawiki/core@master] Mark Action::getHookContainer() as @internal

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

gerritbot added a comment.Aug 4 2021, 6:02 PM

Change 710086 had a related patch set uploaded (by DannyS712; author: DannyS712):

[mediawiki/core@master] RELEASE-NOTES: fix typo (where -> were)

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

gerritbot added a comment.Aug 4 2021, 6:46 PM

Change 710086 merged by jenkins-bot:

[mediawiki/core@master] RELEASE-NOTES: fix typo (where -> were)

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

ReleaseTaggerBot edited projects, added MW-1.37-notes (1.37.0-wmf.18; 2021-08-09); removed MW-1.37-notes (1.37.0-wmf.17; 2021-08-02).Aug 4 2021, 7:00 PM
gerritbot added a comment.Aug 4 2021, 10:44 PM

Change 709203 merged by jenkins-bot:

[mediawiki/core@master] Inject services into InfoAction

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

gerritbot added a comment.Aug 4 2021, 10:45 PM

Change 709204 merged by jenkins-bot:

[mediawiki/core@master] Inject services into Mcr(Undo|Restore)Action

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

gerritbot added a comment.Aug 6 2021, 12:49 AM

Change 710409 had a related patch set uploaded (by Zabe; author: Zabe):

[mediawiki/core@master] McrUndoAction: inject ReadOnlyMode

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

gerritbot added a comment.Aug 6 2021, 1:48 AM

Change 710409 merged by jenkins-bot:

[mediawiki/core@master] McrUndoAction: inject ReadOnlyMode

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

Zabe added a subscriber: Zabe.Aug 6 2021, 2:47 PM
gerritbot added a comment.Aug 6 2021, 9:39 PM

Change 710559 had a related patch set uploaded (by DannyS712; author: DannyS712):

[mediawiki/core@master] Action::addHelpLink() - don't call getActionName()

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

gerritbot added a comment.Aug 6 2021, 10:00 PM

Change 710560 had a related patch set uploaded (by DannyS712; author: DannyS712):

[mediawiki/core@master] Inject HookContainer into RawAction

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

gerritbot added a comment.Aug 9 2021, 10:44 PM

Change 709267 merged by jenkins-bot:

[mediawiki/extensions/DiscussionTools@master] Injected SubscriptionStore into UnsubscribeAction

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

gerritbot added a comment.Aug 13 2021, 11:34 AM

Change 712934 had a related patch set uploaded (by Zabe; author: Zabe):

[mediawiki/core@master] CreditsAction: inject UserFactory

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

gerritbot added a comment.Aug 13 2021, 3:58 PM

Change 712934 merged by jenkins-bot:

[mediawiki/core@master] CreditsAction: inject UserFactory

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

ReleaseTaggerBot edited projects, added MW-1.37-notes (1.37.0-wmf.19; 2021-08-16); removed MW-1.37-notes (1.37.0-wmf.18; 2021-08-09).Aug 13 2021, 4:00 PM
gerritbot added a comment.Aug 13 2021, 8:49 PM

Change 710560 merged by jenkins-bot:

[mediawiki/core@master] Inject HookContainer into RawAction

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

gerritbot added a comment.Aug 13 2021, 9:48 PM

Change 710559 merged by jenkins-bot:

[mediawiki/core@master] Action::addHelpLink() - don't call getActionName()

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

Krinkle mentioned this in T289190: ActionFactory: Error: Class 'New-topicAction' not found.Aug 18 2021, 6:53 PM
gerritbot added a comment.Aug 19 2021, 10:59 AM

Change 713525 had a related patch set uploaded (by DannyS712; author: DannyS712):

[mediawiki/core@master] ActionFactory: restore missing check for non-existent classes

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

gerritbot added a comment.Aug 19 2021, 2:42 PM

Change 713525 merged by jenkins-bot:

[mediawiki/core@master] ActionFactory: restore missing check for non-existent classes

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

Content licensed under Creative Commons Attribution-ShareAlike 3.0 (CC-BY-SA) unless otherwise noted; code licensed under GNU General Public License (GPL) or 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