Page MenuHomePhabricator
Create Task
Maniphest T278459

Replace Title parameters with PageIdentity (straight forward cases)
Open, HighPublic
Actions

Description

As a first step of moving the code base away from Title, towards PageIdentity, we need to make methods that currently expect a Title instance accept a PageIdentity instance instead. This is generally safe, since every Title is a PageIdentity, so callers do not need to change. Ideally, the implementation of the method will work directly on the PageIdentity, but converting back to a Title is acceptable (via an injected TitleFactory, or the static cast method on Title). See the strategy outlined on Platform_Engineering_Team/Expedition for details.

NOTE: Methods that are stable to override (explicitly or implicitly because they are abstract on a class that is stable to extend) cannot be changed in this way!

The idea is that we can convert more code to not use Title when we have more interfaces that do not require Title. So the strategy is to work from the public interfaces inward.

Straight forwards cases (presumably - always check for pitfalls):

Known hard cases that need further investigation (please link tickets where appropriate):

  • Parser, ParserOutput, ParserOptions, PPFrame and friends
  • Remaining parts of RevisionStore
  • Content, ContentHandler (stable to override)
  • PrefixSearch (stable to override)
  • SearchResult and subclasses
  • ...

Details

SubjectRepoBranchLines +/-
Use FlaggableWikiPage::newInstance everywheremediawiki/extensions/FlaggedRevsmaster+43 -56
Remove singleton behavior from FlaggableWikiPage::getTitleInstancemediawiki/extensions/FlaggedRevsmaster+5 -8
Refactor remaining methods to accept PageIdentitymediawiki/extensions/FlaggedRevsmaster+41 -35
LogPager: replace Title in method signaturesmediawiki/coremaster+36 -27
Deprecate the FlaggableWikiPage constructormediawiki/extensions/FlaggedRevsmaster+22 -5
resourceloader: Remove Title from public interfacesmediawiki/coremaster+36 -30
ImportReporter: replace Title in method signaturesmediawiki/coremaster+35 -31
ApiPageSet: replace Title in method signaturesmediawiki/coremaster+256 -32
Deferred updates: remove Title from method signatures.mediawiki/coremaster+94 -69
HTMLForm: accept PageReference instead of Title.mediawiki/coremaster+29 -19
LinkBatch: replace Title with PageReference in method signaturesmediawiki/coremaster+88 -15
RecentChange: replace Title in method signaturesmediawiki/coremaster+250 -109
FileRepo: replace Title in method signaturesmediawiki/coremaster+35 -19
RepoGroup: replace Title in method signaturesmediawiki/coremaster+62 -6
Remove Title from method signatures in Usermediawiki/coremaster+135 -51
Remove Title from public interface of OutputPagemediawiki/coremaster+144 -53
Don't set RecentChange::mTitle in testsmediawiki/extensions/Wikibasemaster+6 -3
HTMLFileCache: replace Title in method signaturesmediawiki/coremaster+98 -8
WikiExporter: replace Title in method signaturesmediawiki/coremaster+15 -8
Show related patches Customize query in gerrit

Related Objects
Search...

Event Timeline

daniel created this task.Mar 25 2021, 5:28 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 25 2021, 5:28 PM
daniel moved this task from Unsorted pile to PageStore pile on the Platform Team Workboards (MW Expedition) board.Apr 8 2021, 4:45 PM
gerritbot added a comment.Apr 8 2021, 7:12 PM

Change 678013 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] Remove Title from public interface of OutputPage

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

gerritbot added a project: Patch-For-Review.Apr 8 2021, 7:12 PM
gerritbot added a comment.Apr 8 2021, 8:09 PM

Change 678045 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] WIP: Remove Title from method signatures in User

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

gerritbot added a comment.Apr 9 2021, 1:40 PM

Change 678252 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] HTMLFileCache: replace Title in method signatures

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

gerritbot added a comment.Apr 9 2021, 1:40 PM

Change 678253 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] WikiExporter: replace Title in method signatures

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

gerritbot added a comment.Apr 9 2021, 3:19 PM

Change 678267 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] RepoGroup: replace Title in method signatures

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

gerritbot added a comment.Apr 9 2021, 3:43 PM

Change 678274 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] FileRepo: replace Title in method signatures

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

gerritbot added a comment.Apr 9 2021, 5:07 PM

Change 678279 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] RecentChange: replace Title in method signatures

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

daniel triaged this task as High priority.Apr 9 2021, 5:33 PM
daniel updated the task description. (Show Details)
daniel moved this task from PageStore pile to Doing on the Platform Team Workboards (MW Expedition) board.
gerritbot added a comment.Apr 14 2021, 3:57 PM

Change 678253 merged by jenkins-bot:

[mediawiki/core@master] WikiExporter: replace Title in method signatures

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

ReleaseTaggerBot added a project: MW-1.37-notes (1.37.0-wmf.3; 2021-04-27).Apr 14 2021, 4:00 PM
gerritbot added a comment.Apr 14 2021, 5:50 PM

Change 679407 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/extensions/Wikibase@master] Don't set RecentChange::mTitle in tests

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

gerritbot added a comment.Apr 14 2021, 9:26 PM

Change 678252 merged by jenkins-bot:

[mediawiki/core@master] HTMLFileCache: replace Title in method signatures

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

gerritbot added a comment.Apr 15 2021, 8:04 AM

Change 679407 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Don't set RecentChange::mTitle in tests

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

gerritbot added a comment.Apr 16 2021, 5:49 PM

Change 678013 merged by jenkins-bot:

[mediawiki/core@master] Remove Title from public interface of OutputPage

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

gerritbot added a comment.Apr 19 2021, 2:52 AM

Change 678045 merged by jenkins-bot:

[mediawiki/core@master] Remove Title from method signatures in User

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

gerritbot added a comment.Apr 19 2021, 6:11 PM

Change 678267 merged by jenkins-bot:

[mediawiki/core@master] RepoGroup: replace Title in method signatures

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

gerritbot added a comment.Apr 19 2021, 6:11 PM

Change 678274 merged by jenkins-bot:

[mediawiki/core@master] FileRepo: replace Title in method signatures

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

gerritbot added a comment.Apr 23 2021, 3:16 PM

Change 682144 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] LinkBatch: replace Title with PageReference in method signatures

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

gerritbot added a comment.Apr 26 2021, 10:24 PM

Change 678279 merged by jenkins-bot:

[mediawiki/core@master] RecentChange: replace Title in method signatures

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

gerritbot added a comment.Apr 27 2021, 11:12 PM

Change 682144 merged by jenkins-bot:

[mediawiki/core@master] LinkBatch: replace Title with PageReference in method signatures

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

ReleaseTaggerBot edited projects, added MW-1.37-notes (1.37.0-wmf.4; 2021-05-04); removed MW-1.37-notes (1.37.0-wmf.3; 2021-04-27).Apr 28 2021, 12:00 AM
gerritbot added a comment.Apr 30 2021, 2:42 PM

Change 683904 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] ApiPageSet: replace Title in method signatures

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

gerritbot added a comment.Apr 30 2021, 3:23 PM

Change 683915 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] ImportReporter: replace Title in method signatures

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

daniel updated the task description. (Show Details)May 4 2021, 5:44 PM
Krinkle added a project: MediaWiki-Page-derived-data.May 7 2021, 3:32 AM
gerritbot added a comment.May 7 2021, 3:13 PM

Change 686626 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] LogPager: replace Title in method signatures

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

gerritbot added a comment.May 7 2021, 9:38 PM

Change 686776 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] HTMLForm: accept PageReference instead of Title.

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

gerritbot added a comment.May 7 2021, 10:20 PM

Change 686785 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] Deferred updates: remove Title from method signatures.

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

daniel updated the task description. (Show Details)May 8 2021, 1:35 PM
daniel updated the task description. (Show Details)
gerritbot added a comment.May 8 2021, 1:37 PM

Change 685580 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] ResourceLoader: remove Title from public interface

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

gerritbot added a comment.May 10 2021, 1:49 PM

Change 686776 merged by jenkins-bot:

[mediawiki/core@master] HTMLForm: accept PageReference instead of Title.

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

gerritbot added a comment.May 10 2021, 1:54 PM

Change 686626 merged by jenkins-bot:

[mediawiki/core@master] LogPager: replace Title in method signatures

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

ReleaseTaggerBot edited projects, added MW-1.37-notes (1.37.0-wmf.5; 2021-05-11); removed MW-1.37-notes (1.37.0-wmf.4; 2021-05-04).May 10 2021, 2:00 PM
gerritbot added a comment.May 12 2021, 3:51 AM

Change 686785 merged by jenkins-bot:

[mediawiki/core@master] Deferred updates: remove Title from method signatures.

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

ReleaseTaggerBot edited projects, added MW-1.37-notes (1.37.0-wmf.6; 2021-05-18); removed MW-1.37-notes (1.37.0-wmf.5; 2021-05-11).May 12 2021, 4:00 AM
gerritbot added a comment.May 12 2021, 10:51 PM

Change 683904 merged by jenkins-bot:

[mediawiki/core@master] ApiPageSet: replace Title in method signatures

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

gerritbot added a comment.May 13 2021, 3:11 PM

Change 683915 merged by jenkins-bot:

[mediawiki/core@master] ImportReporter: replace Title in method signatures

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

gerritbot added a comment.May 13 2021, 3:41 PM

Change 685580 merged by jenkins-bot:

[mediawiki/core@master] resourceloader: Remove Title from public interfaces

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

Krinkle mentioned this in T282834: LogEventsList.php: PHP Notice: Undefined variable: pageName.May 14 2021, 2:20 AM
Krinkle subscribed.May 18 2021, 9:27 PM
Change by Daniel Kinzler:

[mediawiki/core@master] RevisionDeleter: Use PageIdentity instead of Title

https://gerrit.wikimedia.org/r/c/mediawiki/core/+/685570

Krinkle mentioned this in T283098: PHP Notice: Undefined property: ChangeTagsRevisionList::$page.May 18 2021, 9:30 PM
Krinkle added a parent task: T208776: RFC: Introduce PageIdentity to be used instead of WikiPage.May 18 2021, 9:33 PM
gerritbot added a comment.Mar 31 2022, 10:02 PM

Change 775891 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/FlaggedRevs@master] Introduce newInstance taking base PageIdentity

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

gerritbot added a comment.Mar 31 2022, 10:02 PM

Change 775981 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/FlaggedRevs@master] Use FlaggableWikiPage::newInstance everywhere

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

gerritbot added a comment.Mar 31 2022, 10:02 PM

Change 775982 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/FlaggedRevs@master] Refactor remaining methods to accept PageIdentity

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

gerritbot added a comment.Apr 1 2022, 9:35 AM

Change 776165 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/FlaggedRevs@master] Deprecate the FlaggableWikiPage constructor

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

gerritbot added a comment.Apr 1 2022, 9:50 AM

Change 776165 merged by jenkins-bot:

[mediawiki/extensions/FlaggedRevs@master] Deprecate the FlaggableWikiPage constructor

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

ReleaseTaggerBot added a project: MW-1.39-notes (1.39.0-wmf.6; 2022-04-04).Apr 1 2022, 10:00 AM
daniel moved this task from Doing to PageStore pile on the Platform Team Workboards (MW Expedition) board.May 24 2022, 8:13 AM
Pppery edited projects, added Patch-Needs-Improvement, FlaggedRevs; removed Patch-For-Review.Oct 10 2023, 5:29 AM
Krinkle removed a parent task: T208776: RFC: Introduce PageIdentity to be used instead of WikiPage.Dec 11 2023, 12:11 AM
Krinkle added a subtask: T208776: RFC: Introduce PageIdentity to be used instead of WikiPage.

Inverting dependency since the RFC doesn't depend on a migation. RFC T208776 is already closed, and this follow-up otherwise shows as indirectly unresolved subtask of T302623: FY2022-2023: Improve Backend Pageview Timing.

Jdforrester-WMF mentioned this in T376615: Migrate MediaWiki away from heavy classes to lighter-weight, smaller ones.Oct 7 2024, 12:57 PM
daniel mentioned this in T380536: RevisionRecord::getPage() should return an immutable ProperPageIdentity.Mon, Nov 25, 9:29 AM
daniel updated the task description. (Show Details)Mon, Nov 25, 9:38 AM
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