Page MenuHomePhabricator
Create Task
Maniphest T291288

Replace Title::newFromIDs and TitleFactory::newFromIDs with PageQueryBuilder
Closed, ResolvedPublic
Actions

Description

Title::newFromIDs does a DB lookup to batch-fetch Title objects given a list of page IDs. It bypasses LinkCache completely, neither benefits from it, nor populates it.

newFromIDs method in both Title and TitleFactory should be deprecated. The replacement is:

MediaWikiServices::getInstance()
  ->getPageStore()
  ->newSelectQueryBuilder()
  ->wherePageIds( $pageIDs )
  ->caller( __METHOD__ )
  ->fetchPageRecords();

Instances

Title::newFromIDs

  • core
  • extensions / Echo
  • extensions / CirrusSearch
  • extensions / FlaggedRevs
  • extensions / GettingStarted
  • extensions / WikibaseMediaInfo

TitleFactory::newFromIDs

  • core
  • extensions / GrowthExperiments
  • extensions / Wikibase

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
Replace deprecated Title::newFromIDsmediawiki/extensions/IndexFunctionmaster+23 -2
Hard deprecate TitleFactory::newFromIDs and Title::newFromIDsmediawiki/coremaster+97 -38
Replace deprecated TitleFactory::newFromIDsmediawiki/extensions/Wikibasemaster+203 -46
Replace deprecated TitleFactory::newFromIDsmediawiki/extensions/GrowthExperimentsmaster+66 -32
Fix return type of PageStore::newSelectQueryBuilder()mediawiki/coremaster+1 -2
Replace deprecated Title::newFromIDsmediawiki/extensions/WikibaseMediaInfomaster+36 -3
Replace deprecated Title::newFromIDsmediawiki/extensions/CirrusSearchmaster+59 -33
Replace deprecated Title::newFromIDsmediawiki/extensions/GettingStartedmaster+33 -3
Replace deprecated Title::newFromIDsmediawiki/extensions/FlaggedRevsmaster+6 -1
Replace deprecated Title::newFromIDsmediawiki/extensions/Echomaster+40 -4
Customize query in gerrit

Related Objects

Event Timeline

• Pchelolo created this task.Sep 17 2021, 6:35 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 17 2021, 6:35 PM
gerritbot added a comment.Oct 1 2021, 7:59 PM

Change 725362 had a related patch set uploaded (by TChin; author: TChin):

[mediawiki/extensions/Echo@master] Replace deprecated Title::newFromIDs

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

gerritbot added a project: Patch-For-Review.Oct 1 2021, 7:59 PM
tchin moved this task from Unsorted pile to Doing on the Platform Team Workboards (MW Expedition) board.Oct 1 2021, 8:04 PM
gerritbot added a comment.Oct 1 2021, 8:10 PM

Change 725365 had a related patch set uploaded (by TChin; author: TChin):

[mediawiki/extensions/CirrusSearch@master] Replace deprecated Title::newFromIDs

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

gerritbot added a comment.Oct 1 2021, 8:12 PM

Change 725366 had a related patch set uploaded (by TChin; author: TChin):

[mediawiki/extensions/GettingStarted@master] Replace deprecated Title::newFromIDs

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

tchin updated the task description. (Show Details)Oct 1 2021, 8:16 PM
gerritbot added a comment.Oct 4 2021, 2:36 PM

Change 725362 merged by jenkins-bot:

[mediawiki/extensions/Echo@master] Replace deprecated Title::newFromIDs

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

ReleaseTaggerBot added a project: MW-1.38-notes (1.38.0-wmf.3; 2021-10-05).Oct 4 2021, 3:00 PM
gerritbot added a comment.Oct 4 2021, 4:08 PM

Change 725969 had a related patch set uploaded (by TChin; author: TChin):

[mediawiki/extensions/FlaggedRevs@master] Replace deprecated Title::newFromIDs

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

gerritbot added a comment.Oct 4 2021, 8:03 PM

Change 725361 had a related patch set uploaded (by TChin; author: TChin):

[mediawiki/extensions/WikibaseMediaInfo@master] Replace deprecated Title::newFromIDs

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

gerritbot added a comment.Oct 5 2021, 2:17 AM

Change 725366 merged by jenkins-bot:

[mediawiki/extensions/GettingStarted@master] Replace deprecated Title::newFromIDs

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

gerritbot added a comment.Oct 5 2021, 2:18 AM

Change 725969 merged by jenkins-bot:

[mediawiki/extensions/FlaggedRevs@master] Replace deprecated Title::newFromIDs

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

ReleaseTaggerBot edited projects, added MW-1.38-notes (1.38.0-wmf.4; 2021-10-12); removed MW-1.38-notes (1.38.0-wmf.3; 2021-10-05).Oct 5 2021, 3:00 AM
tchin changed the task status from Open to In Progress.Oct 6 2021, 5:14 PM
tchin updated the task description. (Show Details)
gerritbot added a comment.Oct 7 2021, 8:29 PM

Change 725365 merged by jenkins-bot:

[mediawiki/extensions/CirrusSearch@master] Replace deprecated Title::newFromIDs

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

gerritbot added a comment.Oct 7 2021, 8:29 PM

Change 725361 merged by jenkins-bot:

[mediawiki/extensions/WikibaseMediaInfo@master] Replace deprecated Title::newFromIDs

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

Maintenance_bot removed a project: Patch-For-Review.Oct 7 2021, 9:10 PM
tchin updated the task description. (Show Details)Oct 13 2021, 3:17 PM
gerritbot added a comment.Oct 13 2021, 5:02 PM

Change 728575 had a related patch set uploaded (by TChin; author: TChin):

[mediawiki/extensions/Wikibase@master] Replace deprecated TitleFactory::newFromIDs

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

gerritbot added a project: Patch-For-Review.Oct 13 2021, 5:02 PM
gerritbot added a comment.Oct 13 2021, 9:06 PM

Change 727364 had a related patch set uploaded (by TChin; author: TChin):

[mediawiki/extensions/GrowthExperiments@master] Replace deprecated TitleFactory::newFromIDs

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

Lucas_Werkmeister_WMDE subscribed.Oct 15 2021, 10:18 AM

It bypasses LinkCache completely, neither benefits from it, nor populates it.

Does the replacement benefit from LinkCache? As far as I can tell, it adds queried objects to the cache (i.e. populates it), but still includes page IDs that are already cached in the query.

Also, is it intentional that PageStore::newSelectQueryBuilder() indicates two different return types?

	 * @return PageSelectQueryBuilder
	 */
	public function newSelectQueryBuilder( $dbOrFlags = self::READ_NORMAL ): SelectQueryBuilder {

To me it seems strange to call wherePageIds() and fetchPageRecords() on an object that’s not actually guaranteed (at runtime) to be anything more than a general SelectQueryBuilder.

• Pchelolo added a comment.Oct 16 2021, 2:13 AM

Does the replacement benefit from LinkCache?

Not yet, but neither does Title::newFromIDs. Eventually we would like to use LinkBatch inside re PageSelectQueryBuilder, but for that we'd want to clean up LinkBach a bit first.

Also, is it intentional that PageStore::newSelectQueryBuilder() indicates two different return types?

No, this is a bug. Should be PageSelectQueryBuilder.

gerritbot added a comment.Oct 18 2021, 9:30 AM

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

[mediawiki/core@master] Fix return type of PageStore::newSelectQueryBuilder()

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

gerritbot added a comment.Oct 18 2021, 1:47 PM

Change 731341 merged by jenkins-bot:

[mediawiki/core@master] Fix return type of PageStore::newSelectQueryBuilder()

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

ReleaseTaggerBot edited projects, added MW-1.38-notes (1.38.0-wmf.5; 2021-10-19); removed MW-1.38-notes (1.38.0-wmf.4; 2021-10-12).Oct 18 2021, 4:00 PM
gerritbot added a comment.Oct 18 2021, 9:15 PM

Change 727364 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] Replace deprecated TitleFactory::newFromIDs

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

gerritbot added a comment.Oct 19 2021, 5:06 PM

Change 728575 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Replace deprecated TitleFactory::newFromIDs

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

tchin updated the task description. (Show Details)Oct 19 2021, 5:12 PM
ReleaseTaggerBot edited projects, added MW-1.38-notes (1.38.0-wmf.6; 2021-10-26); removed MW-1.38-notes (1.38.0-wmf.5; 2021-10-19).Oct 19 2021, 6:00 PM
Michael mentioned this in T293870: Investigate why ChangeHandler no longer translates the user namespace prefix.Oct 20 2021, 10:20 AM
gerritbot added a comment.Nov 16 2021, 4:15 AM

Change 739015 had a related patch set uploaded (by TChin; author: TChin):

[mediawiki/core@master] Hard deprecate TitleFactory::newFromIDs and Title::newFromIDs

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

gerritbot added a comment.Nov 29 2021, 9:28 PM

Change 739015 merged by jenkins-bot:

[mediawiki/core@master] Hard deprecate TitleFactory::newFromIDs and Title::newFromIDs

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

ReleaseTaggerBot edited projects, added MW-1.38-notes (1.38.0-wmf.12; 2021-12-06); removed MW-1.38-notes (1.38.0-wmf.6; 2021-10-26).Nov 29 2021, 10:00 PM
gerritbot added a comment.Dec 9 2021, 12:23 PM

Change 745533 had a related patch set uploaded (by Umherirrender; author: Umherirrender):

[mediawiki/extensions/IndexFunction@master] Replace deprecated Title::newFromIDs

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

Umherirrender subscribed.Dec 9 2021, 9:36 PM

It is a bit confusing that the replacement is PageStore::newSelectQueryBuilder which is marked @unstable

gerritbot added a comment.Dec 17 2021, 3:23 PM

Change 745533 merged by Umherirrender:

[mediawiki/extensions/IndexFunction@master] Replace deprecated Title::newFromIDs

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

tchin closed this task as Resolved.Jan 25 2022, 6:18 PM
tchin updated the task description. (Show Details)
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