Add namespace to BagOStuff library (ObjectCache, MemcachedClient, Redis)
Open, LowPublic
Actions

Assigned To

Authored By

	pmiazga
	Dec 15 2023, 2:49 PM

Description

The BagOStuff and other classes that extend it are defined in the global namespace, stored in includes/libs/objectcache folder.
When working on T353458, I tried to move some of the BagOStuff classes and discovered that some things in objectcache/utils folder already belong to Wikimedia/LightweightObjectStore namespace.

Let's decide on the namespace and what to do with existing namespaced classes.

Definition of done

Agree on the namespace name Wikimedia/ObjectCache to match folder structure, or Wikimedia/LightweightObjectStore to match the namespace of some classes.
Migrate classes into new namespace, add aliases for backwards-compatibility
Migrate MediaWiki core to use the new class names
decide on what to do with items in Wikimedia/LightweightObjectStore namespace - move to Wikimedia/{NEW_NAME}/Utils namespace, or move files to lib root directory

Details

Related Changes in Gerrit:

Subject	Repo	Branch	Lines +/-
objectcache: Remove internal StorageAwareness, now unused	mediawiki/core	master	+76 -109
Replace ExpirationAwareness with BagOStuff	mediawiki/extensions/CentralAuth	master	+9 -12
Storage,MessageCache: Reference TTL constants from BagOStuff	mediawiki/core	master	+9 -8
Un-implement ExpirationAwareness	mediawiki/extensions/GrowthExperiments	master	+10 -14
Remove use of BagOStuff TTL constants from unrelated code	mediawiki/core	master	+20 -21
objectcache: Tag SerializedValueContainer as `@internal`	mediawiki/core	master	+3 -7
objectcache: Move RedisConn files out of utils/ to match class	mediawiki/core	master	+4 -4
objectcache: Move internal StorageAwareness to ObjectCache namespace	mediawiki/core	master	+47 -50
objectcache: Move RedisConnRef.php to /libs/objectcache/	mediawiki/core	master	+15 -18

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Open		None	T146257 Create objectcache/BagOStuff library
		Open		Krinkle	T353529 Add namespace to BagOStuff library (ObjectCache, MemcachedClient, Redis)

Event Timeline

pmiazga created this task.Dec 15 2023, 2:49 PM

Restricted Application added a project: MediaWiki-Platform-Team. · View Herald TranscriptDec 15 2023, 2:49 PM

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

@Krinkle do you have any thoughts on this? Do you know where the Wikimedia/LightweightObjectStore comes from?

• larissagaulia moved this task from Inbox, needs triage to Not planned (Patches welcome!) on the MediaWiki-Platform-Team board.Dec 18 2023, 4:04 PM

LightweightObjectStore was introduced as a draft namespace for internal BagOStuff-related classes. It became obvious that adding things like "ExpirationAwareness" as a global unnamespaced class would be far too generic, so we picked a namespace.

However, I don't think it's a brandable library name, and too verbose for my taste if we're going to publish it properly. I'd recommend going with Wikimedia\BagOStuff instead. The ones already there may be obsolete or things we can rename with a class_alias.

It has very little use in practice, and for the most part, it seems more appropiate for these references to use $cache::TTL_ or BagOStuff::TTL_ instead, following the principal of locality in terms of getting constants from the thing you link with, instead of from some shared internal trait.

https://codesearch.wmcloud.org/deployed/?q=%28ExpirationAwareness%7CStorageAwareness%29%3A%3A&files=php%24&excludeFiles=test&repos=

Change #1083488 had a related patch set uploaded (by Krinkle; author: Krinkle):

[mediawiki/core@master] objectcache: Move RedisConnRef.php to /libs/objectcache/

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

gerritbot added a project: Patch-For-Review.Oct 28 2024, 3:30 AM

Krinkle renamed this task from Add namespace to ObjectCache (BagOStuff and friends) library to Add namespace to BagOStuff library (ObjectCache, MemcachedClient, Redis).Oct 28 2024, 3:31 AM

Krinkle triaged this task as Low priority.

Krinkle updated the task description. (Show Details)

Task description:

decide on what to do with items in Wikimedia/LightweightObjectStore namespace

The /lib/objectcache/utils/ directory contains these two differently-namespaced classes:

StorageAwareness (@internal since https://gerrit.wikimedia.org/r/c/mediawiki/core/+/1072923)
ExpirationAwareness

Change #1083488 merged by jenkins-bot:

[mediawiki/core@master] objectcache: Move RedisConnRef.php to /libs/objectcache/

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

Maintenance_bot removed a project: Patch-For-Review.Oct 29 2024, 12:31 PM

ReleaseTaggerBot added a project: MW-1.44-notes (1.44.0-wmf.2; 2024-11-05).Oct 29 2024, 1:00 PM

Change #1106562 had a related patch set uploaded (by Krinkle; author: Krinkle):

[mediawiki/core@master] objectcache: Move internal StorageAwareness to ObjectCache namespace

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

gerritbot added a project: Patch-For-Review.Dec 24 2024, 4:54 PM

Krinkle added a parent task: T146257: Create objectcache/BagOStuff library.Dec 24 2024, 5:02 PM

Change #1106563 had a related patch set uploaded (by Krinkle; author: Krinkle):

[mediawiki/core@master] objectcache: Tag SerializedValueContainer as `@internal`

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

Change #1106564 had a related patch set uploaded (by Krinkle; author: Krinkle):

[mediawiki/core@master] objectcache: Move RedisConn files out of utils/ to match class

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

Krinkle claimed this task.Dec 24 2024, 5:03 PM

Krinkle added a project: Developer Productivity.

Change #1106562 merged by jenkins-bot:

[mediawiki/core@master] objectcache: Move internal StorageAwareness to ObjectCache namespace

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

Change #1106563 merged by jenkins-bot:

[mediawiki/core@master] objectcache: Tag SerializedValueContainer as `@internal`

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

Change #1106564 merged by jenkins-bot:

[mediawiki/core@master] objectcache: Move RedisConn files out of utils/ to match class

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

Maintenance_bot removed a project: Patch-For-Review.Jan 9 2025, 1:30 PM

ReleaseTaggerBot edited projects, added MW-1.44-notes (1.44.0-wmf.12; 2025-01-14); removed MW-1.44-notes (1.44.0-wmf.2; 2024-11-05).Jan 9 2025, 2:00 PM

Change #1110876 had a related patch set uploaded (by Krinkle; author: Krinkle):

[mediawiki/core@master] Remove use of BagOStuff TTL constants from unrelated code

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

Change #1110877 had a related patch set uploaded (by Krinkle; author: Krinkle):

[mediawiki/core@master] Storage,MessageCache: Reference TTL constants from BagOStuff

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

Change #1110879 had a related patch set uploaded (by Krinkle; author: Krinkle):

[mediawiki/extensions/GrowthExperiments@master] Un-implement ExpirationAwareness

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

Change #1110879 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] Un-implement ExpirationAwareness

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

ReleaseTaggerBot edited projects, added MW-1.44-notes (1.44.0-wmf.13; 2025-01-21); removed MW-1.44-notes (1.44.0-wmf.12; 2025-01-14).Jan 14 2025, 11:00 AM

Change #1110876 merged by jenkins-bot:

[mediawiki/core@master] Remove use of BagOStuff TTL constants from unrelated code

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

Change #1110877 merged by jenkins-bot:

[mediawiki/core@master] Storage,MessageCache: Reference TTL constants from BagOStuff

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

ReleaseTaggerBot edited projects, added MW-1.44-notes (1.44.0-wmf.14; 2025-01-28); removed MW-1.44-notes (1.44.0-wmf.13; 2025-01-21).Jan 21 2025, 7:00 AM

Maintenance_bot removed a project: Patch-For-Review.Jan 21 2025, 7:31 AM

JTweed-WMF edited projects, added MediaWiki-Platform-Team (Roadmap); removed MediaWiki-Platform-Team.Jan 22 2025, 3:45 PM

JTweed-WMF moved this task from Now => Move to Inbox to Parking Lot on the MediaWiki-Platform-Team (Roadmap) board.

Change #1126155 had a related patch set uploaded (by Krinkle; author: Krinkle):

[mediawiki/core@master] objectcache: Remove internal StorageAwareness, now unused

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

gerritbot added a project: Patch-For-Review.Mar 10 2025, 9:35 PM

Change #1072920 had a related patch set uploaded (by Krinkle; author: Krinkle):

[mediawiki/extensions/CentralAuth@master] Replace ExpirationAwareness with BagOStuff

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

Change #1072920 merged by jenkins-bot:

[mediawiki/extensions/CentralAuth@master] Replace ExpirationAwareness with BagOStuff

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

ReleaseTaggerBot edited projects, added MW-1.44-notes (1.44.0-wmf.21; 2025-03-18); removed MW-1.44-notes (1.44.0-wmf.14; 2025-01-28).Mar 16 2025, 2:00 PM

Change #1126155 merged by jenkins-bot:

[mediawiki/core@master] objectcache: Remove internal StorageAwareness, now unused

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

Maintenance_bot removed a project: Patch-For-Review.Mar 27 2025, 1:31 PM

Note LightweightObjectStore was mostly going to be used in https://gerrit.wikimedia.org/r/c/mediawiki/core/+/524663/27 . Any such interfaces can just use the ObjectCache namespace.

OWresch-WMF moved this task from Roadmap to Not planned / Patches welcome on the MediaWiki-Platform-Team board.Tue, Jan 20, 11:18 AM

OWresch-WMF edited projects, added MediaWiki-Platform-Team; removed MediaWiki-Platform-Team (Roadmap).

For better or for worse, it looks like there are still a number of extensions that currently reference (the now-@internal) ExpirationAwareness directly (https://codesearch.wmcloud.org/things/?q=ExpirationAwareness currently returns 39 files from 25 repositories).

Add namespace to BagOStuff library (ObjectCache, MemcachedClient, Redis)Open, LowPublicActions