Removed deprecated "legacy" serialization type from RESTBagOStuff
Closed, ResolvedPublic2 Estimated Story Points
Actions

Description

T233963: Add serialization options to RESTBagOStuff added a serialization type parameter to RESTBagOStuff with possible values:

legacy
PHP
JSON

The purpose of the "legacy" serialization type was to give any RESTBagOStuff users the opportunity to migrate to one of the other types. This was done in an abundance of caution, as there were no known users, but it is possible that third party private wikis were using RESTBagOStuff.

The "legacy" type was marked as deprecated in 1.34, with a comment that it would be removed in 1.35.

After the 1.34 release, remove the "legacy" serialization type, so that it will not be present in 1.35.

Details

	Subject	Repo	Branch	Lines +/-
	Remove deprecated "legacy" serialization type from RESTBagOStuff	mediawiki/core	master	+20 -34

Customize query in gerrit

Related Objects

Mentioned In: T233537: Document and communicate potentially breaking session storage serialization change
Mentioned Here: T233963: Add serialization options to RESTBagOStuff

Event Timeline

BPirkle created this task.Oct 7 2019, 4:57 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 7 2019, 4:57 AM

Marking this as "Stalled" because it cannot be done until after the 1.34 release.

Krinkle moved this task from Blocker to To deprecate or remove on the MW-1.35-release board.Oct 11 2019, 10:44 PM

WDoranWMF edited projects, added Platform Engineering; removed Platform Team Workboards (Green).Feb 20 2020, 8:41 PM

Anomie moved this task from Inbox to Triage Meeting Inbox on the Platform Engineering board.Feb 21 2020, 2:49 PM

In T234779#5550614, @BPirkle wrote:

Marking this as "Stalled" because it cannot be done until after the 1.34 release.

1.34 was released, no longer stalled

@BPirkle What's the status here? Is it just code removal, or is WMF production still using "legacy"?

• nnikkhoui removed a project: Platform Engineering.Mar 31 2020, 8:27 PM

WMF Production is explicitly specifying the "PHP" serialization type in $wgObjectCaches['kask-session'] (with an hmac key stored in $wmgSessionStoreHMACKey). The "legacy" type can be removed.

Unless I'm missing something, these are the things that need to be done:

change block comment at https://gerrit.wikimedia.org/g/mediawiki/core/+/35eea56a957d84f6f7dc9c106af85ac0ccd7f194/includes/libs/objectcache/RESTBagOStuff.php#78 to not mention "legacy", to remove the deprecation notice, and to list only "PHP" and "JSON" as allowed values.
change block comment at https://gerrit.wikimedia.org/g/mediawiki/core/+/35eea56a957d84f6f7dc9c106af85ac0ccd7f194/includes/libs/objectcache/RESTBagOStuff.php#87 to not mention "legacy"
change default at https://gerrit.wikimedia.org/g/mediawiki/core/+/35eea56a957d84f6f7dc9c106af85ac0ccd7f194/includes/libs/objectcache/RESTBagOStuff.php#125 to be whatever we prefer. We'd said in T233963: Add serialization options to RESTBagOStuff that we'd default to PHP. But as production is explicitly specifying the serialization type, I don't have strong feelings about which default we choose.
change function decodeBody at https://gerrit.wikimedia.org/g/mediawiki/core/+/35eea56a957d84f6f7dc9c106af85ac0ccd7f194/includes/libs/objectcache/RESTBagOStuff.php#232 to remove mentions of legacy.
ditto for function encodeBody at https://gerrit.wikimedia.org/g/mediawiki/core/+/35eea56a957d84f6f7dc9c106af85ac0ccd7f194/includes/libs/objectcache/RESTBagOStuff.php#272
modify the two data provider functions in RESTBagOStuffTest to not test the "legacy" serialization type.

This needs a code base project tag so someone can find this task when searching, hence adding MediaWiki-libs-BagOStuff

Krinkle moved this task from General to libs/objectcache on the MediaWiki-libs-BagOStuff board.Apr 14 2020, 11:16 PM

Krinkle moved this task from Untriaged to 2020 | MW 1.35 on the Technical-Debt (Deprecation process) board.Apr 21 2020, 3:53 PM

Change 612362 had a related patch set uploaded (by BPirkle; owner: BPirkle):
[mediawiki/core@master] Remove deprecated "legacy" serialization type from RESTBagOStuff

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

gerritbot added a project: Patch-For-Review.Jul 13 2020, 3:15 PM

Change 612362 merged by jenkins-bot:
[mediawiki/core@master] Remove deprecated "legacy" serialization type from RESTBagOStuff

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

ReleaseTaggerBot added a project: MW-1.35-notes (1.35.0-wmf.41; 2020-07-14).Jul 13 2020, 8:00 PM

Maintenance_bot removed a project: Patch-For-Review.Jul 13 2020, 8:11 PM

BPirkle closed this task as Resolved.Jul 13 2020, 8:18 PM

BPirkle mentioned this in T233537: Document and communicate potentially breaking session storage serialization change.Jul 14 2020, 1:48 PM

Aklapper removed a subscriber: Anomie.Oct 16 2020, 5:43 PM