Page MenuHomePhabricator

Update name in EventLogging Extension and WikimediaEvents Extension
Closed, ResolvedPublic3 Estimated Story Points

Description

EventLogging Extension
[N/A] Update EventSubmitter references << superseded by T367034: TestKitchen Extension: Merge PHP MetricsPlatform client library
[N/A] Update Metrics-Platform lib references

[N/A] Test functionality after updates

WikimediaEvents Extension

Event Timeline

cjming set the point value for this task to 3.

Regarding EventLogging Extension:

  • I would say we should wait until TestKitchen extension is fully ready and working in production before starting to update EventLogging
  • metrics-platform client libraries will be moved to TestKitchen extension so, regarding that point, we will only have to remove JS + PHP client libraries from the extension. But we only can do that once we have updated all the instruments/experiments to use the new TestKitchen extension. In the meantime client libraries will have to live in EventLogging and TestKitchen extensions at the same time

Regarding WikimediaEvents Extension:

  • I would say we should wait until TestKitchen extension is fully ready and working in production before starting to update anything in WikimediaEvents (that would include also having the JS+PHP client libraries embedded already in the extension)
  • At least our own instruments/experiments (PageVisitInstrument, impactTest, . . . ) and some experiments from other teams like loggedOutPageVisitare using the configuration by default when sending events (base schema + stream). Just updating MetricsPlatform references to use TestKitchen would mean using the new base schemas + streams (2.0) because the extension and client libraries will be updated to use them. We probably will have to update these instruments/experiments to use explicitly those specific schemas or streams when being updated (I assume we don't want to update old/current instruments to use new schemas + streams)
  • Keeping in mind the above, maybe we should break down this per instrument/experiment and consider all of them separately before addressing any update/refactoring. All instruments/experiments should be refactored to use the new TestKitchen extension but, at the same time, they should keep using current base schemas + streams (<= 1.5.0). Some of them use specific configuration explicitly but others don't, as mentioned above

Change #1225249 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[mediawiki/extensions/EventLogging@master] Update references in comments to Test Kitchen

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

Regarding EventLogging Extension:

  • metrics-platform client libraries will be moved to TestKitchen extension so, regarding that point, we will only have to remove JS + PHP client libraries from the extension. But we only can do that once we have updated all the instruments/experiments to use the new TestKitchen extension. In the meantime client libraries will have to live in EventLogging and TestKitchen extensions at the same time

If you remove the libraries from the EventLogging extension, then all pre-MP and pre-TK-but-still-using-MP-features instruments will break. We also want to avoid introducing a dependency on TestKitchen

One way forward would be to:

  1. Merge the client libraries into both the EventLogging and TestKitchen extensions, which avoids introducing a dependency on TestKitchen in EventLogging
  2. Strip back the client library in EventLogging to the bare minimum
  3. Migrate instruments using TK features to TK as quickly as possible (we could swarm on this)
  4. Remove all TK related functionality from the EventLogging extension
  5. (Future) migrate pre-MP instruments to TK piecemeal if necessary

Change #1226678 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[mediawiki/extensions/WikimediaEvents@master] Add references to Test Kitchen

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

Added some WIP patches for EL + WME but agree with @Sfaci that we should wait until TK extension is on all prod wikis -- moving this to blocked in the meantime

I like @phuedx's plan to move forward - let's do that - presumably we need separate tickets to cover all those steps - maybe we have some of them already? I'll dig into this tomorrow and spin up missing tickets if needed.

Change #1229276 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[mediawiki/extensions/WikimediaEvents@master] Remove mintReaderPageVisit instrumentation

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

Change #1229276 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Remove mintReaderPageVisit instrumentation

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

Change #1226678 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Add references to Test Kitchen

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

Change #1233563 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[mediawiki/extensions/WikimediaEvents@master] Move impact test to testKitchen namespace

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

Change #1233565 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[mediawiki/extensions/WikimediaEvents@master] Move readinglistAB test to testKitchen namespace

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

Change #1233787 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[mediawiki/extensions/WikimediaEvents@wmf/1.46.0-wmf.12] Add references to Test Kitchen

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

Change #1233787 abandoned by Clare Ming:

[mediawiki/extensions/WikimediaEvents@wmf/1.46.0-wmf.12] Add references to Test Kitchen

Reason:

retrying another way

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

Change #1233563 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Move impact test to testKitchen namespace

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

Change #1233565 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Move readinglistAB test to testKitchen namespace

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

Sfaci updated the task description. (Show Details)

Change #1238074 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[operations/mediawiki-config@master] Update reference to Metrics Platform to Test Kitchen for hcaptcha experiment.

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

Change #1238074 abandoned by Clare Ming:

[operations/mediawiki-config@master] Update reference to Metrics Platform to Test Kitchen for hcaptcha experiment.

Reason:

superceded by https://gerrit.wikimedia.org/r/c/operations/mediawiki-config/+/1238072

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

Change #1238074 restored by Clare Ming:

[operations/mediawiki-config@master] Update reference to Metrics Platform to Test Kitchen for hcaptcha experiment.

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

Change #1238074 abandoned by Clare Ming:

[operations/mediawiki-config@master] Update reference to Metrics Platform to Test Kitchen for hcaptcha experiment and fix comment typo.

Reason:

taken care of in https://gerrit.wikimedia.org/r/c/operations/mediawiki-config/+/1238072

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

cjming updated the task description. (Show Details)

Change #1239221 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[mediawiki/extensions/WikimediaEvents@master] Update xLab to testKitchen in clientError

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

Change #1239223 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[mediawiki/extensions/WikimediaEvents@master] Update xLab to testKitchen in mobileSectionSwitch

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

Change #1239224 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[mediawiki/extensions/WikimediaEvents@master] Update xLab to testKitchen in hcaptcha

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

Change #1239226 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[mediawiki/extensions/WikimediaEvents@master] Update references to xLab with Test Kitchen

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

Change #1239228 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[mediawiki/extensions/WikimediaEvents@master] Update reference to xLab to testKitchen

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

Change #1239231 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[mediawiki/extensions/WikimediaEvents@master] Remove xLab module, update references to TK

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

Change #1239221 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Update xLab to testKitchen in clientError

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

Change #1239231 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Remove xLab module, update references to TK

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

Change #1239228 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Update reference to xLab to testKitchen

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

Change #1239226 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Update references to xLab with Test Kitchen in sessionLengthMixin

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

Change #1239223 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Update xLab to testKitchen in mobileSectionSwitch

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

@cjming: I've been bold and moved this to To Deploy having merged all of your patches to WikimediaEvents. Please feel free to move this back to In Progress / Needs Review if I've missed something.

Change #1239224 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Update xLab to testKitchen in hcaptcha

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

Change #1239367 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[mediawiki/extensions/WikimediaEvents@master] Update phan config to use TK instead of MP

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

As for the EL ACs in the ticket -- in discussing with @Sfaci, it seems as far as the renaming effort goes, there's nothing more to do there -- all the EventLogging changes will be taken care of with the migrating the libraries into the Test Kitchen SDKs. Please correct me if I'm wrong

Copying my comment from @cjming's last patch:

I think we should make WikimediaEvents explicitly depend on Test Kitchen now. The SDK is in good shape and we're starting to ramp up migrating older instrumentation to it. Also, it would mean that folks don't have to use optional services / mw.loader.using( 'ext.testKitchen' ) everywhere 🎉

Change #1239367 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Update phan config to use TK instead of MP

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