Page MenuHomePhabricator
Create Task
Maniphest T348078

Proofread Page: Review stable code (hooks, mw object, undocumented) and mark (un)stable interfaces before 1.42.0
Closed, ResolvedPublic
Actions

Description

The stable interface policy was introduced in September 2023 during the 1.41 MediaWiki release. As a result of the introduction of this policy I am asking teams to take the opportunity to review their existing stable APIs and take appropriate action to limit unsupported APIs where necessary and possible.

TODO

  • Please read the guidelines around what constitutes stable code
  • Please remove any functions on the mw object that you do not wish to consider stable. Note "Code that was never part of a public MediaWiki release, and never consumed according to Codesearch and Global Search MAY be changed (including marked explicitly as @private) or removed without deprecation, since the code has never become part of the stable interface or used."
  • Please add @private or @internal documentation tags to hook events that you wish to limit usage of.

Details

SubjectRepoBranchLines +/-
mw.proofreadpage.viewer should log deprecation warningsmediawiki/extensions/ProofreadPageREL1_42+3 -0
Mark APIs as internal and not stablemediawiki/extensions/ProofreadPageREL1_42+6 -0
mw.proofreadpage.viewer should log deprecation warningsmediawiki/extensions/ProofreadPagemaster+3 -0
Mark APIs as internal and not stablemediawiki/extensions/ProofreadPagemaster+6 -0
Remove internal APIs from global namespace after OOUI infusionmediawiki/extensions/ProofreadPagemaster+5 -1
Remove internal APIs from global namespace after OOUI infusionmediawiki/extensions/ProofreadPageREL1_42+5 -1
Customize query in gerrit

Related Objects
Search...

Event Timeline

Jdlrobson created this task.Oct 4 2023, 12:09 AM
Jdlrobson updated the task description. (Show Details)Oct 4 2023, 12:11 AM
Jdlrobson renamed this task from Proofread Page: Review code on mw object and mark (un)stable interfaces before 1.42.0 to Proofread Page: Review stable code (hooks, mw object, undocumented) and mark (un)stable interfaces before 1.42.0.Oct 4 2023, 4:45 PM
Jdforrester-WMF moved this task from Blocker to Deprecate or remove on the MW-1.42-release board.Jan 3 2024, 5:51 PM
Jdforrester-WMF subscribed.Apr 8 2024, 2:13 PM

FYI, the 1.42 branch point is in a matter of hours; it doesn't appear that this will be done by then?

Jdlrobson added a comment.EditedApr 16 2024, 5:02 PM

The stable policy grace period is now closed, so any code from now on that has not been marked as @internal or @private should be considered stable per the frontend stable policy.

For ProofReadPage the following APIs (and all public methods associated with these objects) can now be considered stable for use in extensions and gadgets (and are subject to the deprecation policy)

  • mw.ext.proofreadPage
  • mw.proofreadpage

Hooks:

If this is not acceptable please comment in the next 7 days so we have a record of the intent to change this, otherwise we can decline this ticket.
(If you need to fix these APIs to not be stable, please make sure to backport any applicable patches to 1.42 branch).

Soda subscribed.Apr 16 2024, 5:23 PM

@Jdlrobson What/where is mw.ext.proofreadPage being created ?

Soda added a comment.Apr 16 2024, 5:41 PM

Similarly proofreadpage-openseadragon-no-image-found is not a API that is provided by ProofreadPage. I'm super confused where these are showing up.

Jdlrobson added a comment.Apr 16 2024, 5:43 PM

@Soda my mistake - I got this list from doing a quick grep of code. Looks like mw.ext.proofreadPage is in a Lua template. Updated my message!

Soda added a comment.EditedApr 16 2024, 7:08 PM

Taking a look at the rest:

  • ext.proofreadpage.osd-no-image-found should be fine to have around. That code path does get exercised (Thumbor is notoriously unstable for Wikisource).
  • ext.proofreadpage.page-selection-register-filter is part of a beta feature, but is mostly staT344928ble, no issues there
  • ext.proofreadpage.osd-controller-available is very stable no issues there

Regarding mw.proofreadpage:

  • mw.proofreadpage.PagelistInputWidget most of this is supposed to be internal and probably needs to be removed unless somebody legitimately uses this (I do not know if anyone does)
  • mw.proofreadpage.viewer is deprecated and has been for a while, however it cannot be removed since Inductive's tool still uses it (AFAIK)
  • mw.proofreadpage.openseadragon is stable and has been for a while
  • mw.proofreadpage.PageQualityInputWidget is internal and probably should not be exposed. (I'm pretty sure nobody uses this since it was introduced fairly recently in T344928)
Soda added a comment.Apr 16 2024, 10:13 PM

Unrelated to this, there is a bunch of scripts on wikisource that use $( '.prp-page-image img' ).attr( 'src' ) which would probably go against the stable interface policy :( These should probably be asked to change over to the mw.proofreadpage.openseadragon API.

Jdlrobson added a comment.Apr 16 2024, 10:17 PM

@Soda let me know if you need any help reviewing or documenting these APIs and preparing backports. Happy to help!

Soda added a comment.EditedApr 16 2024, 11:00 PM

Based on a search of scripts, mw.proofreadpage.PagelistInputWidget does not appear to be used.

gerritbot added a comment.Apr 17 2024, 12:43 PM

Change #1020816 had a related patch set uploaded (by Sohom Datta; author: Sohom Datta):

[mediawiki/extensions/ProofreadPage@master] Remove internal APIs from global namespace after OOUI infusion

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

gerritbot added a project: Patch-For-Review.Apr 17 2024, 12:43 PM
gerritbot added a comment.Apr 17 2024, 1:59 PM

Change #1020734 had a related patch set uploaded (by Sohom Datta; author: Sohom Datta):

[mediawiki/extensions/ProofreadPage@REL1_42] Remove internal APIs from global namespace after OOUI infusion

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

Soda added a comment.Apr 17 2024, 2:11 PM

@Jdlrobson Could you take a look at the patch if the cherry pick/backport was setup correctly ?

gerritbot added a comment.Apr 17 2024, 2:30 PM

Change #1020848 had a related patch set uploaded (by Jdlrobson; author: Jdlrobson):

[mediawiki/extensions/ProofreadPage@master] Mark APIs as internal and not stable

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

gerritbot added a comment.Apr 17 2024, 3:08 PM

Change #1020734 abandoned by Sohom Datta:

[mediawiki/extensions/ProofreadPage@REL1_42] Remove internal APIs from global namespace after OOUI infusion

Reason:

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

gerritbot added a comment.Apr 17 2024, 3:08 PM

Change #1020816 abandoned by Sohom Datta:

[mediawiki/extensions/ProofreadPage@master] Remove internal APIs from global namespace after OOUI infusion

Reason:

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

gerritbot added a comment.Apr 17 2024, 3:13 PM

Change #1020735 had a related patch set uploaded (by Jdlrobson; author: Jdlrobson):

[mediawiki/extensions/ProofreadPage@REL1_42] Mark APIs as internal and not stable

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

gerritbot added a comment.Apr 17 2024, 3:28 PM

Change #1020848 merged by jenkins-bot:

[mediawiki/extensions/ProofreadPage@master] Mark APIs as internal and not stable

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

gerritbot added a comment.Apr 17 2024, 3:40 PM

Change #1020855 had a related patch set uploaded (by Jdlrobson; author: Jdlrobson):

[mediawiki/extensions/ProofreadPage@master] mw.proofreadpage.viewer should log deprecation warnings

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

ReleaseTaggerBot added a project: MW-1.43-notes (1.43.0-wmf.2; 2024-04-23).Apr 17 2024, 4:00 PM
gerritbot added a comment.Apr 17 2024, 4:37 PM

Change #1020855 merged by jenkins-bot:

[mediawiki/extensions/ProofreadPage@master] mw.proofreadpage.viewer should log deprecation warnings

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

gerritbot added a comment.Apr 17 2024, 8:01 PM

Change #1020741 had a related patch set uploaded (by Jdlrobson; author: Jdlrobson):

[mediawiki/extensions/ProofreadPage@REL1_42] mw.proofreadpage.viewer should log deprecation warnings

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

gerritbot added a comment.Apr 25 2024, 2:30 PM

Change #1020735 merged by jenkins-bot:

[mediawiki/extensions/ProofreadPage@REL1_42] Mark APIs as internal and not stable

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

gerritbot added a comment.Apr 25 2024, 2:33 PM

Change #1020741 merged by jenkins-bot:

[mediawiki/extensions/ProofreadPage@REL1_42] mw.proofreadpage.viewer should log deprecation warnings

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

Jdlrobson closed this task as Resolved.Apr 25 2024, 5:05 PM
Jdlrobson claimed this task.
Maintenance_bot removed a project: Patch-For-Review.Apr 26 2024, 6:18 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits