Page MenuHomePhabricator
Create Task
Maniphest T391444

Create HookRunner classes and interfaces for Wikibase Repo and use them
Closed, ResolvedPublic
Actions

Description

On the basis of the Wikibase Hooks ADR in T391438 and in support of T338452, create HookRunner classes and interfaces for the Wikibase Repo code, and use them throughout the Wikibase codebase

This includes:

  • core hooks
  • MobileFrontend hooks
  • Vector hook
  • Own hooks

MediaWikiEditFilterHook will be handled separately in T391963

Acceptance Criteria

  • Use of Wikibase Hooks within Wikibase Repo code (except for MediaWikiEditFilterHook) are conformant with the Wikibase Hooks ADR

Details

SubjectRepoBranchLines +/-
Fix abortability of two repo hooksmediawiki/extensions/Wikibasemaster+3 -2
Update WikibaseRepoEntityNamespacesHook docsmediawiki/extensions/Wikibasemaster+2 -2
Clean up hooks documentationmediawiki/extensions/Wikibasemaster+24 -34
Use WikibaseRepoHookRunner service for default settingsmediawiki/extensions/Wikibasemaster+2 -3
Use HookRunner pattern for WikibaseRepoEntityNamespaces hookmediawiki/extensions/Wikibasemaster+39 -8
Migrate WikibaseContentLanguages hookmediawiki/extensions/Wikibasemaster+85 -10
Migrate WikibaseRepoEntitySearchHelperCallbacks hookmediawiki/extensions/Wikibasemaster+52 -16
Migrate WikibaseRepoEntityTypes hookmediawiki/extensions/Wikibasemaster+66 -32
Migrate WikibaseRepoDataTypes hookmediawiki/extensions/Wikibasemaster+52 -17
Migrate WikibaseContentModelMapping hookmediawiki/extensions/Wikibasemaster+57 -15
Add configureHookRunner() to ServiceWiringTestCasemediawiki/extensions/Wikibasemaster+44 -2
Add strict types to EntityParserOutputGeneratorFactorymediawiki/extensions/Wikibasemaster+20 -65
Migrate WikibaseRepoOnParserOutputUpdaterConstruction hookmediawiki/extensions/Wikibasemaster+64 -24
Migrate GetEntityContentModelForTitle hookmediawiki/extensions/Wikibasemaster+55 -28
Migrate GetEntityByLinkedTitleLookup hookmediawiki/extensions/Wikibasemaster+49 -31
Migrate WikibaseTextForSearchIndex hookmediawiki/extensions/Wikibasemaster+46 -17
Migrate WikibaseChangeNotification hookmediawiki/extensions/Wikibasemaster+58 -42
Add WikibaseRepoHookRunner to service containermediawiki/extensions/Wikibasemaster+76 -8
Show related patches Customize query in gerrit

Related Objects
Search...

Event Timeline

ArthurTaylor created this task.Apr 9 2025, 9:46 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptApr 9 2025, 9:46 AM
ArthurTaylor updated the task description. (Show Details)Apr 9 2025, 9:49 AM
ArthurTaylor added parent tasks: T338452: Update Wikibase to use the new HookContainer/HookRunner system, T381172: [EPIC] Update all WMDE Wikibase topics to use the new HookContainer/HookRunner system.
Maintenance_bot added a project: Wikidata.Apr 9 2025, 10:30 AM
karapayneWMDE moved this task from Incoming to The Backlog on the Wikidata-Omega board.Apr 9 2025, 10:51 AM
Lucas_Werkmeister_WMDE claimed this task.Apr 10 2025, 2:15 PM
Lucas_Werkmeister_WMDE edited projects, added Wikidata-Omega (The Board); removed Wikidata-Omega.
Lucas_Werkmeister_WMDE moved this task from new to the board to In Development on the Wikidata-Omega (The Board) board.
Lucas_Werkmeister_WMDE added a project: MediaWiki-extensions-Wikibase-Repo.
gerritbot added a comment.Apr 10 2025, 2:43 PM

Change #1135745 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Add HookRunner to repo

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

gerritbot added a project: Patch-For-Review.Apr 10 2025, 2:43 PM
gerritbot added a comment.Apr 10 2025, 3:44 PM

Change #1135757 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Add WikibaseRepoHookRunner to service container

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

gerritbot added a comment.Apr 10 2025, 3:44 PM

Change #1135758 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] WIP: Use HookRunner for WikibaseTextForSearchIndex

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

gerritbot added a comment.Apr 11 2025, 9:08 AM

Change #1135904 had a related patch set uploaded (by Arthur taylor; author: Arthur taylor):

[mediawiki/extensions/Wikibase@master] Use HookRunner for WikibaseClientSiteLinksForItem

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

gerritbot added a comment.Apr 11 2025, 10:42 AM

Change #1135927 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Migrate WikibaseChangeNotification hook

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

gerritbot added a comment.Apr 11 2025, 11:26 AM

Change #1135934 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Migrate WikibaseRepoOnParserOutputUpdaterConstruction hook

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

Lucas_Werkmeister_WMDE mentioned this in T391693: Clean up extra $slot argument of EditFilterMergedContent hook.Apr 11 2025, 3:33 PM
gerritbot added a comment.Apr 11 2025, 3:35 PM

Change #1135985 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Migrate GetEntityByLinkedTitleLookup hook

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

gerritbot added a comment.Apr 11 2025, 3:35 PM

Change #1135986 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Migrate MediaWikiEditFilterHookRunner

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

Lucas_Werkmeister_WMDE removed Lucas_Werkmeister_WMDE as the assignee of this task.Apr 11 2025, 4:39 PM
Lucas_Werkmeister_WMDE moved this task from In Development to Ready for Peer Review on the Wikidata-Omega (The Board) board.
Lucas_Werkmeister_WMDE subscribed.

This isn’t done yet (I checked all the references to HookContainer in repo/includes/, but that misses several hooks that are run directly in the service wiring – docs/topics/hooks-php.md can also serve as an additional list of hooks), but what’s there already should mostly be okay to start reviewing (except for the MediaWikiEditFilterHookRunner change, where CI isn’t green yet).

ArthurTaylor claimed this task.Apr 14 2025, 7:35 AM
ArthurTaylor moved this task from Ready for Peer Review to In Peer Review on the Wikidata-Omega (The Board) board.
gerritbot added a comment.Apr 14 2025, 8:00 AM

Change #1135757 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Add WikibaseRepoHookRunner to service container

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

gerritbot added a comment.Apr 14 2025, 8:05 AM

Change #1135758 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Migrate WikibaseTextForSearchIndex hook

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

gerritbot added a comment.Apr 14 2025, 8:05 AM

Change #1135927 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Migrate WikibaseChangeNotification hook

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

ReleaseTaggerBot added a project: MW-1.44-notes (1.44.0-wmf.25; 2025-04-15).Apr 14 2025, 9:00 AM
gerritbot added a comment.Apr 14 2025, 9:10 AM

Change #1136332 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Add strict types to EntityParserOutputGeneratorFactory

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

gerritbot added a comment.Apr 14 2025, 9:54 AM

Change #1135985 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Migrate GetEntityByLinkedTitleLookup hook

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

gerritbot added a comment.Apr 14 2025, 11:54 AM

Change #1135745 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Migrate GetEntityContentModelForTitle hook

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

ArthurTaylor reassigned this task from ArthurTaylor to Lucas_Werkmeister_WMDE.Apr 14 2025, 11:59 AM
ArthurTaylor moved this task from In Peer Review to In Development on the Wikidata-Omega (The Board) board.
gerritbot added a comment.Apr 14 2025, 12:24 PM

Change #1135934 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Migrate WikibaseRepoOnParserOutputUpdaterConstruction hook

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

gerritbot added a comment.Apr 14 2025, 12:25 PM

Change #1136332 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Add strict types to EntityParserOutputGeneratorFactory

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

gerritbot added a comment.Apr 14 2025, 4:13 PM

Change #1136410 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Add configureHookRunner() to ServiceWiringTestCase

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

gerritbot added a comment.Apr 14 2025, 4:13 PM

Change #1136411 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Migrate WikibaseContentModelMapping hook

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

gerritbot added a comment.Apr 14 2025, 4:37 PM

Change #1136415 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Migrate WikibaseRepoDataTypes hook

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

Lucas_Werkmeister_WMDE removed Lucas_Werkmeister_WMDE as the assignee of this task.Apr 14 2025, 4:38 PM
Lucas_Werkmeister_WMDE moved this task from In Development to Ready for Peer Review on the Wikidata-Omega (The Board) board.

Still not done but ready for another round of reviews.

ArthurTaylor claimed this task.Apr 15 2025, 7:11 AM
ArthurTaylor moved this task from Ready for Peer Review to In Peer Review on the Wikidata-Omega (The Board) board.
gerritbot added a comment.Apr 15 2025, 7:39 AM

Change #1136410 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Add configureHookRunner() to ServiceWiringTestCase

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

gerritbot added a comment.Apr 15 2025, 7:42 AM

Change #1136411 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Migrate WikibaseContentModelMapping hook

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

ReleaseTaggerBot edited projects, added MW-1.44-notes (1.44.0-wmf.27; 2025-04-29); removed MW-1.44-notes (1.44.0-wmf.25; 2025-04-15).Apr 15 2025, 8:00 AM
gerritbot added a comment.Apr 15 2025, 9:26 AM

Change #1136415 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Migrate WikibaseRepoDataTypes hook

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

gerritbot added a comment.Apr 15 2025, 9:27 AM

Change #1136667 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Migrate WikibaseRepoEntityTypes hook

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

gerritbot added a comment.Apr 15 2025, 10:52 AM

Change #1136667 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Migrate WikibaseRepoEntityTypes hook

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

gerritbot added a comment.Apr 15 2025, 11:24 AM

Change #1136686 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Migrate WikibaseRepoEntitySearchHelperCallbacks hook

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

gerritbot added a comment.Apr 15 2025, 12:23 PM

Change #1136686 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Migrate WikibaseRepoEntitySearchHelperCallbacks hook

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

ArthurTaylor updated the task description. (Show Details)Apr 15 2025, 12:51 PM
gerritbot added a comment.Apr 15 2025, 1:52 PM

Change #1136729 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Migrate WikibaseContentLanguages hook

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

Lucas_Werkmeister_WMDE added a comment.Apr 15 2025, 4:35 PM

Still missing:

  • WikibaseContentLanguages (see patch above)
  • WikibaseRepoEntityNamespaces (called in Wikibase.default.php)

And that should be it as far as hooks-php.md goes, at least. We’ll probably want to check the code again before declaring this task done. (This Huma query might be useful, though it’s apparently based on an outdated MediaWiki version.)

gerritbot added a comment.Apr 16 2025, 8:03 AM

Change #1136729 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Migrate WikibaseContentLanguages hook

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

gerritbot added a comment.Apr 17 2025, 9:24 AM

Change #1137217 had a related patch set uploaded (by Arthur taylor; author: Arthur taylor):

[mediawiki/extensions/Wikibase@master] Use HookRunner pattern for WikibaseRepoEntityNamespaces hook

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

gerritbot added a comment.Apr 17 2025, 11:35 AM

Change #1137264 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Use WikibaseRepoHookRunner service for default settings

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

gerritbot added a comment.Apr 17 2025, 11:35 AM

Change #1137265 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Update WikibaseRepoEntityNamespacesHook docs

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

gerritbot added a comment.Apr 17 2025, 11:57 AM

Change #1137217 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Use HookRunner pattern for WikibaseRepoEntityNamespaces hook

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

gerritbot added a comment.Apr 17 2025, 12:18 PM

Change #1137274 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Clean up hooks documentation

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

Lucas_Werkmeister_WMDE added a comment.Apr 17 2025, 12:21 PM
In T391444#10744635, @Lucas_Werkmeister_WMDE wrote:

And that should be it as far as hooks-php.md goes, at least. We’ll probably want to check the code again before declaring this task done.

Well, depends I guess. We now have hook interfaces for all of our own hooks, and use the hook runner to run them. We don’t yet use hook handler classes for all the hooks we implement – I still see plenty of static method references in "Hooks" in extension-repo.json. (Almost all of them in RepoHooks, except for ViewEntityAction::onBeforeDisplayNoArticleText.) Is that part of this task?

Lucas_Werkmeister_WMDE updated the task description. (Show Details)Apr 17 2025, 4:28 PM
gerritbot added a comment.Apr 17 2025, 5:12 PM

Change #1137327 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] Fix abortability of two repo hooks

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

ArthurTaylor added a comment.EditedApr 22 2025, 6:45 AM

Well, depends I guess. We now have hook interfaces for all of our own hooks, and use the hook runner to run them. We don’t yet use hook handler classes for all the hooks we implement – I still see plenty of static method references in "Hooks" in extension-repo.json. (Almost all of them in RepoHooks, except for ViewEntityAction::onBeforeDisplayNoArticleText.) Is that part of this task?

Insofar as they're hooks for which interfaces exist, I would say it is part of the larger Epic. I would draw the line at creating interfaces in other extensions or in core for us to implement. The same issue exists in extension-client.json - my preference would be to have two new tickets for the remaining tidy-up - this task is already long and full of patches.

ArthurTaylor mentioned this in T391442: Create HookRunner classes and interfaces for Wikibase Client and use them.Apr 22 2025, 6:50 AM
gerritbot added a comment.Apr 22 2025, 7:01 AM

Change #1137264 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Use WikibaseRepoHookRunner service for default settings

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

gerritbot added a comment.Apr 22 2025, 7:01 AM

Change #1137265 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Update WikibaseRepoEntityNamespacesHook docs

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

gerritbot added a comment.Apr 22 2025, 7:07 AM

Change #1137274 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Clean up hooks documentation

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

ArthurTaylor mentioned this in T392413: Migrate static hook handlers in WikibaseRepo to use HookRunner pattern.Apr 22 2025, 7:30 AM

Filed the follow-up as T392413

ArthurTaylor updated the task description. (Show Details)Apr 22 2025, 7:33 AM
ArthurTaylor removed ArthurTaylor as the assignee of this task.Apr 22 2025, 7:36 AM
ArthurTaylor moved this task from In Peer Review to Ready for Tech Verification on the Wikidata-Omega (The Board) board.
ArthurTaylor updated the task description. (Show Details)
gerritbot added a comment.Apr 22 2025, 12:16 PM

Change #1137327 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Fix abortability of two repo hooks

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

Lucas_Werkmeister_WMDE added a comment.Apr 22 2025, 1:24 PM
In T391444#10758341, @ArthurTaylor wrote:

I would draw the line at creating interfaces in other extensions or in core for us to implement.

We shouldn’t need to create any interfaces, we can just migrate to non-static hook handler classes regardless of whether the corresponding interfaces already exist or not.

karapayneWMDE closed this task as Resolved.May 15 2025, 2:07 PM
karapayneWMDE claimed this task.
karapayneWMDE moved this task from Ready for Tech Verification to Done - Moving a task here will move it to the completed tasks workboard, resolve the ticket, and assign it to whomever made the move on the Wikidata-Omega (The Board) board.
karapayneWMDE edited projects, added Wikidata-Omega (Completed Tasks); removed Wikidata-Omega (The Board).
karapayneWMDE mentioned this in T381172: [EPIC] Update all WMDE Wikibase topics to use the new HookContainer/HookRunner system.May 15 2025, 2:15 PM
karapayneWMDE moved this task from Newly completed tasks to 2025 Q2 on the Wikidata-Omega (Completed Tasks) board.May 15 2025, 2:21 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 · Credits