Maniphest T284955

Remove LinkCache::addGoodLinkObj()
Closed, ResolvedPublic
Actions

Description

LinkCache::addGoodLinkObj() has many optional arguments, but omitting them actually means corrupting the cache. Production code should never call this method, it should use addGoodLinkObjFromRow instead.

addGoodLinkObj() is kind of handy to have for tests. We should introduce a separate method, addGoodLinkObjForTest(), that can only be used of MW_PHPUNIT_TEST is set.

addGoodLinkObj() is used in six extensions, see https://codesearch.wmcloud.org/extensions/?q=-%3EaddGoodLinkObj%5C(&i=nope&files=&excludeFiles=&repos=

Deployed:

Other:

Favorites (beta)

Details

	Subject	Repo	Branch	Lines +/-
	Hard deprecate LinkCache::addGoodLinkObj	mediawiki/core	master	+5 -2
	LinkCache: soft deprecate addGoodLinkObj()	mediawiki/core	master	+100 -70

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Resolved		Vlad.shapik	T284955 Remove LinkCache::addGoodLinkObj()
		Resolved		Vlad.shapik	T288533 extensions/CirrusSearch - replace LinkCache::addGoodLinkObj() with LinkCacheTestTrait::addGoodLinkObject
		Resolved		Vlad.shapik	T288537 extensions/Babel - replace LinkCache::addGoodLinkObj() with LinkCacheTestTrait::addGoodLinkObject
		Resolved		Vlad.shapik	T290490 extensions/Flow - replace LinkCache::addGoodLinkObj() with LinkCacheTestTrait::addGoodLinkObject
		Resolved		Vlad.shapik	T290495 extensions/GeoData - replace LinkCache::addGoodLinkObj() with LinkCacheTestTrait::addGoodLinkObject
		Resolved		Vlad.shapik	T290496 extensions/Wikibase - replace LinkCache::addGoodLinkObj() with LinkCacheTestTrait::addGoodLinkObject
		Open		None	T290499 extensions/Favorites - replace LinkCache::addGoodLinkObj() with LinkCacheTestTrait::addGoodLinkObject

Event Timeline

daniel created this task.Jun 14 2021, 7:59 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJun 14 2021, 7:59 PM

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

[mediawiki/core@master] LinkCache: hard deprecate addGoodLinkObj()

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

gerritbot added a project: Patch-For-Review.Jun 14 2021, 7:59 PM

DannyS712 added a project: Technical-Debt (Deprecation process).Jun 15 2021, 7:00 AM

daniel updated the task description. (Show Details)Jun 22 2021, 3:43 PM

daniel updated the task description. (Show Details)Jun 22 2021, 7:27 PM

• Pchelolo moved this task from Unsorted pile to Waiting for Review on the Platform Team Workboards (MW Expedition) board.Jul 19 2021, 10:18 PM

Vlad.shapik claimed this task.Aug 10 2021, 3:39 PM

Vlad.shapik triaged this task as Medium priority.Aug 10 2021, 3:44 PM

Vlad.shapik moved this task from Waiting for Review to Doing on the Platform Team Workboards (MW Expedition) board.Aug 19 2021, 12:42 PM

Vlad.shapik updated the task description. (Show Details)Sep 8 2021, 12:59 PM

Vlad.shapik updated the task description. (Show Details)

Vlad.shapik updated the task description. (Show Details)Sep 8 2021, 1:09 PM

Change 699071 merged by jenkins-bot:

[mediawiki/core@master] LinkCache: soft deprecate addGoodLinkObj()

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

ReleaseTaggerBot added a project: MW-1.37-notes (1.37.0-wmf.23; 2021-09-13).Sep 10 2021, 6:00 PM

Maintenance_bot removed a project: Patch-For-Review.Sep 10 2021, 6:11 PM

kostajh closed subtask T290490: extensions/Flow - replace LinkCache::addGoodLinkObj() with LinkCacheTestTrait::addGoodLinkObject as Resolved.Sep 13 2021, 10:01 AM

Vlad.shapik updated the task description. (Show Details)Sep 13 2021, 1:42 PM

Vlad.shapik updated the task description. (Show Details)Sep 13 2021, 2:25 PM

Vlad.shapik updated the task description. (Show Details)Sep 17 2021, 2:54 PM

I believe a patch to hard-deprecate this method can be submitted now, and we're done.

Change 734657 had a related patch set uploaded (by Vlad.shapik; author: Vlad.shapik):

[mediawiki/core@master] Hard deprecate LinkCache::addGoodLinkObj

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

gerritbot added a project: Patch-For-Review.Oct 26 2021, 3:21 PM

In T284955#7380532, @Pchelolo wrote:

I believe a patch to hard-deprecate this method can be submitted now, and we're done.

The patch has already landed -> https://gerrit.wikimedia.org/r/c/mediawiki/core/+/734657

Vlad.shapik moved this task from Doing to Waiting for Review on the Platform Team Workboards (MW Expedition) board.Oct 26 2021, 3:25 PM

Vlad.shapik moved this task from Waiting for Review to On the train on the Platform Team Workboards (MW Expedition) board.Oct 26 2021, 3:44 PM

• Pchelolo closed this task as Resolved.Oct 26 2021, 3:46 PM

Change 734657 merged by jenkins-bot:

[mediawiki/core@master] Hard deprecate LinkCache::addGoodLinkObj

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

ReleaseTaggerBot added a project: MW-1.38-notes (1.38.0-wmf.7; 2021-11-02).Oct 26 2021, 4:00 PM

Maintenance_bot removed a project: Patch-For-Review.Oct 26 2021, 4:12 PM

Pppery closed subtask T290499: extensions/Favorites - replace LinkCache::addGoodLinkObj() with LinkCacheTestTrait::addGoodLinkObject as Declined.Oct 10 2023, 5:35 AM

Pppery reopened subtask T290499: extensions/Favorites - replace LinkCache::addGoodLinkObj() with LinkCacheTestTrait::addGoodLinkObject as Open.Oct 27 2023, 2:31 PM