Page MenuHomePhabricator

Update instrumentation to use stable API to Check Wikimedia Media Viewer Extension Status
Open, Stalled, LowPublic

Description

Background

The current method for checking the status of the Media Viewer extension is fragile and inefficient. Updating the instrumentation to use a stable API will streamline the process and enhance reliability, ensuring that the Wikimedia Media Viewer Extension status is easily accessible.

User story

As a developer, I want to use a stable API to check the status of the Media Viewer extension, so that I can reliably access this information without relying on fragile conditions.

Requirements

  • Develop a public API that allows efficient checking of the Media Viewer extension status.
  • Ensure the API can be used seamlessly in JavaScript with the mw.mv API.
  • Integrate the new API into the WikimediaEvents extension.

Design

No mockups are required as this is a backend development task.

Acceptance criteria

  • A public API is developed and allows checking the Media Viewer extension status efficiently.
  • The API is successfully integrated into the WikimediaEvents extension.
  • Documentation is updated to reflect the new API usage.

Communication criteria - does this need an announcement or discussion?

An internal announcement should be made to inform the web team about the new API integration.

Rollback plan

  • If the new API introduces issues, revert to the previous method of checking the Media Viewer extension status.
  • Communicate any rollbacks to Web team Slack ASAP with an explanation of the issues encountered.

This task was created by Version 1.0.0 of the Web team task template using phabulous

Event Timeline

Change 998535 had a related patch set uploaded (by Simon04; author: Simon04):

[mediawiki/extensions/MultimediaViewer@master] Public API to Check Wikimedia Media Viewer Extension Status

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

Change 998535 merged by jenkins-bot:

[mediawiki/extensions/MultimediaViewer@master] Public API to Check Wikimedia Media Viewer Extension Status

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

Jdlrobson renamed this task from Public API to Check Wikimedia Media Viewer Extension Status to Update instrumentation to use stable API to Check Wikimedia Media Viewer Extension Status.Feb 15 2024, 9:19 PM
Jdlrobson updated the task description. (Show Details)

Change 1005612 had a related patch set uploaded (by Kimberly Sarabia; author: Kimberly Sarabia):

[mediawiki/extensions/WikimediaEvents@master] [WIP] Adds new Media Viewer API setting

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

Jdlrobson changed the task status from Open to Stalled.May 24 2024, 5:27 PM
Jdlrobson assigned this task to KSarabia-WMF.

Hi @KSarabia-WMF could you please update this ticket to the new task template and take another pass at https://gerrit.wikimedia.org/r/c/mediawiki/extensions/WikimediaEvents/+/1005612 please? Thanks in advance!

I also wouldn't recommend changing the instrumentation now that we are actively using it. Should this be declined with that in mind? or stalled until the project is completed?