Deploy the latest version of the PHP Metrics Platform client library
Closed, ResolvedPublic5 Estimated Story Points
Actions

Assigned To

Authored By

	phuedx
	Nov 15 2023, 9:51 AM

Description

Epic: T350495: [EPIC] Deploy latest version of Metrics Platform client libraries

Background

In T346287, T346288, and T346286, we updated the JS, Java, and PHP client libraries to produce core interaction events. Before they can be used by us and, eventually, by third-parties, they must be deployed.

AC

The latest version of the PHP client library is integrated into EventLogging
- https://gerrit.wikimedia.org/r/976940
The latest version of the PHP client library is merged into mediawiki/vendor
- https://gerrit.wikimedia.org/r/976942
The above are all tested end to end
Deployment processes are documented on Wikitech
- https://wikitech.wikimedia.org/wiki/Metrics_Platform/How_To/Deploy_a_New_Version#PHP

Details

Subject	Repo	Branch	Lines +/-
Use wikimedia/metrics-platform 3.1.0	mediawiki/extensions/EventLogging	master	+3 -8
Update wikimedia/metrics-platform to 3.1.0	mediawiki/vendor	master	+169 -38
tests: Update EventLoggingTest::testDispatch()	mediawiki/extensions/EventLogging	master	+1 -1

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Resolved	None	T346146 At least one client library is refactored
Resolved	VirginiaPoundstone	T346285 [Epic] Create Metrics Platform API for Submitting Core Interaction Events
Resolved	phuedx	T350495 [EPIC] Deploy latest version of Metrics Platform client libraries
Resolved	phuedx	T351294 Deploy the latest version of the PHP Metrics Platform client library

Event Timeline

phuedx created this task.Nov 15 2023, 9:51 AM

phuedx moved this task from Sprint Backlog to In Process on the Experimentation Lab (Data Products (Sprint 03)) board.Nov 15 2023, 1:27 PM

phuedx moved this task from Data Products (Sprint 03) to Data Products Sprint 04 on the Experimentation Lab board.Nov 15 2023, 2:22 PM

phuedx edited projects, added Experimentation Lab (Data Products Sprint 04); removed Experimentation Lab (Data Products (Sprint 03)).

phuedx moved this task from Sprint Backlog to In Process on the Experimentation Lab (Data Products Sprint 04) board.

phuedx moved this task from Backlog to Client improvements on the Metrics Platform board.Nov 15 2023, 4:50 PM

phuedx set the point value for this task to 5.Nov 16 2023, 1:45 PM

Sfaci removed Sfaci as the assignee of this task.Nov 20 2023, 4:38 PM

Sfaci moved this task from In Process to Sprint Backlog on the Experimentation Lab (Data Products Sprint 04) board.

phuedx moved this task from Sprint Backlog to In Process on the Experimentation Lab (Data Products Sprint 04) board.Nov 20 2023, 5:08 PM

phuedx claimed this task.Nov 20 2023, 5:14 PM

VirginiaPoundstone triaged this task as High priority.Nov 22 2023, 5:20 PM

cjming mentioned this in T349417: Document process for event submission/validation via Metrics Platform core interactions.Nov 23 2023, 2:26 AM

Change 976940 had a related patch set uploaded (by Phuedx; author: Phuedx):

[mediawiki/extensions/EventLogging@master] Use wikimedia/metrics-platform 3.0.0

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

gerritbot added a project: Patch-For-Review.Nov 23 2023, 10:18 AM

Change 976942 had a related patch set uploaded (by Phuedx; author: Phuedx):

[mediawiki/vendor@master] Update wikimedia/metrics-platform to 3.0.0

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

phuedx updated the task description. (Show Details)Nov 23 2023, 10:41 AM

phuedx updated the task description. (Show Details)Nov 23 2023, 10:57 AM

phuedx opened https://gitlab.wikimedia.org/repos/data-engineering/metrics-platform/-/merge_requests/19

[PHP] Reinstate MetricsClient::SCHEMA constant

phuedx merged https://gitlab.wikimedia.org/repos/data-engineering/metrics-platform/-/merge_requests/19

[PHP] Reinstate MetricsClient::SCHEMA constant

Change 977064 had a related patch set uploaded (by Phuedx; author: Phuedx):

[mediawiki/extensions/EventLogging@master] tests: Update EventLoggingTest::testDispatch()

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

phuedx moved this task from In Process to Code Review / Tech Input on the Experimentation Lab (Data Products Sprint 04) board.Nov 23 2023, 2:05 PM

This was… interesting…

Firstly, the ideal scenario is:

Update composer.json in EventLogging
Submit patch
Update composer.json in mediawiki/vendor

$composer self-update 2.6.4
composer update --no-dev

Submit patch
$$$

Now, there are a couple of minor issues that required a change to the EventLogging:

EventLoggingTest::testDispatch() and ::testDispatchAddsContextAttributes() both use the MetricsClient::SCHEMA constant. That constant was removed in 049ea5725c6e
Those same test cases make assertions about the output of MetricsClient::dispatch(), which has changed between 2.0.0 and 3.0.0

Unfortunately, there's a curious circular dependency between the build environments of EventLogging and mediawiki/vendor that complicates fixing these issues cleanly. One of the build pipelines for EventLogging pulls down dependencies from mediawiki/vendor and one of the the pipelines for mediawiki/vendor runs the tests in EventLogging. Updating one breaks a pipeline in the other. The solution is to first update the EventLogging tests in an isolated patch, then update mediawiki/vendor, then update EventLogging, i.e. see https://gerrit.wikimedia.org/r/c/mediawiki/vendor/+/976942 and its dependency.

phuedx updated the task description. (Show Details)Nov 27 2023, 9:50 AM

Change 977064 merged by jenkins-bot:

[mediawiki/extensions/EventLogging@master] tests: Update EventLoggingTest::testDispatch()

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

ReleaseTaggerBot added a project: MW-1.42-notes (1.42.0-wmf.9; 2023-12-12).Nov 28 2023, 4:00 AM

Change 976942 merged by jenkins-bot:

[mediawiki/vendor@master] Update wikimedia/metrics-platform to 3.1.0

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

Change 976940 merged by jenkins-bot:

[mediawiki/extensions/EventLogging@master] Use wikimedia/metrics-platform 3.1.0

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

Maintenance_bot removed a project: Patch-For-Review.Dec 1 2023, 12:10 AM