Deprecate WebRequest::getRequestId()
Open, LowPublic
Actions

Assigned To

None

Authored By

	pmiazga
	Sep 13 2023, 8:58 AM

Description

In T320559 we introduced a new MediaWiki/Http/Telemetry class which took the responsibility of handling Telemetry data - including the X-Request-Id handling.
WebRequest::getRequestId and WebRequest::overrideRequestId() became deprecated in 1.41 and should be removed in future releases.

Definition of done:

WebRequest::getRequestId() is not used
WebRequest::overrideRequestId() is not used
Methods are removed from the WebRequest class
update docs/Injection.md document on how to inject the X-Request-Id header.

Details

	Subject	Repo	Branch	Lines +/-
	WebRequest: Remove 'deprecated' mark from unstable Telemetry pointer	mediawiki/core	master	+0 -2

Customize query in gerrit

Related Objects

Mentioned Here: T320559: Trace header propagation for MediaWiki

Event Timeline

pmiazga created this task.Sep 13 2023, 8:58 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 13 2023, 8:58 AM

pmiazga triaged this task as Low priority.Sep 13 2023, 8:58 AM

The majority uses of reqId in MediaWiki are not strictly Telmetry related (i.e. no headers or other HTTP subcalls). I wouldn't mind keeping WebRequest::getRequestId()` in its current form as widely used stable API and having it internally use Telemetry indeed as today.

Either way, I suggest we at least wait with that until the Telemetry singleton has stabilized a bit. For example, if we can make it a simple class that requires no configuration or MW integration, then we can move callers to that instead of having to a second round of deprecations and replacements. In particular, the human side of feeling a shift in the ecosystem I'd like to reduce given how much of a bad rap MW already has as constantly breaking-change everything (which is interesting, since the same code also as a bad rap for not changing much, which is polar opposite).

larissagaulia added a project: MW-1.42-release.Sep 18 2023, 1:29 PM

larissagaulia moved this task from Inbox, needs triage to Backlog: non-prioritized on the MediaWiki-Platform-Team board.

Jdforrester-WMF moved this task from Blocker to Deprecate or remove on the MW-1.42-release board.Jan 3 2024, 5:52 PM

Osps7 awarded a token.Jan 5 2024, 10:21 AM

It seems that WebRequest::getRequestId() has been deprecated in the latest version of the MediaWiki core repository, based on what I observed in the code.

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

[mediawiki/core@master] WebRequest: Remove 'deprecated' mark from unstable Telemetry pointer

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

gerritbot added a project: Patch-For-Review.Feb 7 2024, 5:40 PM

Change 998485 merged by jenkins-bot:

[mediawiki/core@master] WebRequest: Remove 'deprecated' mark from unstable Telemetry pointer

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

Maintenance_bot removed a project: Patch-For-Review.Feb 7 2024, 6:31 PM

ReleaseTaggerBot added a project: MW-1.42-notes (1.42.0-wmf.18; 2024-02-13).Feb 7 2024, 10:01 PM