Page MenuHomePhabricator
Create Task
Maniphest T348084

Language team: Review stable code (hooks, mw object, undocumented) and mark (un)stable interfaces before 1.42.0
Open, In Progress, HighPublic2 Estimated Story Points
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 +/-
ext.translationstats.graphbuilder: Update method as internalmediawiki/extensions/Translatemaster+1 -1
ext.translate.workflowselector.js: Mark methods as private or internalmediawiki/extensions/Translatemaster+18 -1
jquery.ajaxdispatcher: Mark method as internalmediawiki/extensions/Translatemaster+1 -0
ext.translate.editor.js: Tweaks to method level commentsmediawiki/extensions/Translatemaster+9 -5
ext.translate.special.translate.js: Mark methods as private or internalmediawiki/extensions/Translatemaster+15 -0
ext.translate.proofread.js: Mark methods as privatemediawiki/extensions/Translatemaster+20 -1
ext.translate.pagetranslation.uls.js: Mark methods as internalmediawiki/extensions/Translatemaster+9 -8
ext.translate.groupselector.js: Mark methods as private and internalmediawiki/extensions/Translatemaster+43 -2
ext.translate.pagemode.js: Mark methods as privatemediawiki/extensions/Translatemaster+13 -1
ext.translate.base.js: Update methods as internalmediawiki/extensions/Translatemaster+11 -11
ext.translate.editor.helpers: Mark methods as internalmediawiki/extensions/Translatemaster+18 -0
ext.translate.editor.js: Mark methods as private or internalmediawiki/extensions/Translatemaster+69 -2
ext.translate.messagetable.js: Mark methods as private or internalmediawiki/extensions/Translatemaster+18 -0
ext.translate.translationstats.graphbuiler: Mark methods as internalmediawiki/extensions/Translatemaster+4 -2
ext.translate.special.pagemigration.js: Mark methods as internalmediawiki/extensions/Translatemaster+5 -0
ext.translate.parsers.js: Mark method as internalmediawiki/extensions/Translatemaster+1 -0
mw.translate.recentgroups.js: Mark method as internalmediawiki/extensions/Translatemaster+1 -1
mw.translate.storage.js: Mark methods as privatemediawiki/extensions/Translatemaster+1 -0
MessageRenameDialog: Mark constructor as privatemediawiki/extensions/Translatemaster+1 -0
ext.translate.base.js: Mark methods and properties as @privatemediawiki/extensions/Translatemaster+26 -4
Show related patches Customize query in gerrit

Related Objects
Search...

Event Timeline

Jdlrobson created this task.Oct 4 2023, 12:09 AM
Jdlrobson renamed this task from Language team: Review code on mw object and mark (un)stable interfaces before 1.42.0 to Language team: Review code on mw object and mark (un)stable interfaces before 1.41.0.Oct 4 2023, 12:12 AM
Jdlrobson edited projects, added MW-1.41-release; removed MW-1.42-release.
Jdlrobson updated the task description. (Show Details)
Jdlrobson renamed this task from Language team: Review code on mw object and mark (un)stable interfaces before 1.41.0 to Language team: Review stable code (hooks, mw object, undocumented) and mark (un)stable interfaces before 1.42.0.Oct 4 2023, 4:46 PM
• Nikerabbit moved this task from Backlog to maintenance and operational issues on the MediaWiki-extensions-Translate board.Oct 10 2023, 11:35 AM
• Nikerabbit triaged this task as Medium priority.Nov 6 2023, 11:52 AM
• Nikerabbit moved this task from Needs Triage to Epic and Trackers on the ContentTranslation board.
Reedy added a project: MW-1.42-release.Dec 21 2023, 4:59 PM
Reedy moved this task from Blocker to Not a blocker on the MW-1.41-release board.
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?

• Nikerabbit subscribed.Apr 8 2024, 7:37 PM

It wont.

Jdlrobson added a comment.Apr 15 2024, 2:23 PM

Hey @Nikerabbit 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 language team I think the implications of this is that Translate, ULS, ContentTranslation now have 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). I've included the list of methods/hooks that can now be considered stable below.

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 it isn't this should be prioritized asap and backported to the deployment branch.

  • mw.translate
  • mw.uls
  • mw.ime

*mw.webfonts

  • mw.cx

Hooks:

  • mw.uls.interface.language.change
  • mw.uls.compactlinks.initialized
  • mw.uls.login.click
  • mw.uls.interface.morelanguages
  • mw.uls.webfonts.enable
  • mw.uls.webfonts.disable
  • mw.uls.font.change
  • mw.uls.ime.disable
  • mw.uls.ime.change
  • mw.uls.ime.morelanguages
  • mw.uls.ime.change
  • mw.uls.language.revert
  • mw.uls.settings.open
  • mw.uls.settings.cancel
  • mw.uls.settings.apply
  • mw.uls.compact_language_links.open
  • mw.uls.interface.language.change
  • mw.cx.dashboard.ready'
  • mw.cx.error
  • mw.cx.translation.conflict
  • mw.cx.warning
  • mw.cx.success
  • mw.cx.cta.accept
  • mw.cx.suggestion.action
  • mw.cx.translation.deleted
  • mw.cx.betafeature.enabled
  • mw.cx.cta.shown
  • mw.cx.cta.reject
  • mw.cx.translation.published
  • mw.cx.translation.publish.error
  • mw.cx.translation.saved
  • mw.cx.translation.save-failed
  • mw.cx.translation.continued
  • mw.cx.draft.restore-failed
  • mw.cx.translation.abusefilter
  • mw.cx.error.anonuser
  • mw.cx.draft.restored
  • mw.translate.editor.afterEditorShown
  • mw.translate.editor.beforeSubmit
  • mw.translate.editor.afterSubmit
  • mw.translate.editor.afterEditorShown
  • mw.translate.messagetable.formatMessageBeforeTable
  • mw.translate.translationView.stateChange
  • mw.translate.editor.showTranslationHelpers
• Nikerabbit raised the priority of this task from Medium to High.Apr 16 2024, 6:13 AM
• Nikerabbit added projects: Language-Team (Language-2024-April-June), Unplanned-Sprint-Work, Localization Infrastructure FY2023-24.

We are planning to mark the values on the global mw object as internal and leave the hooks to be public.

• Nikerabbit moved this task from Quarter Backlog to Priority: Localization infrastructure on the Language-Team (Language-2024-April-June) board.Apr 16 2024, 6:14 AM
• Nikerabbit set the point value for this task to 2.Apr 16 2024, 6:58 AM
Jdlrobson added a comment.Apr 25 2024, 8:48 PM

Thanks! On the long term you may also want to move the code off the global and into require statements, but no need to do this as part of this ticket - the intention of this ticket is only to make sure the stability of these APIs is well documented in jsdoc blocks. Let me know if you have any more questions!

gerritbot added a comment.Apr 29 2024, 7:50 AM

Change #1025273 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.base.js: Mark methods as @private

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

gerritbot added a project: Patch-For-Review.Apr 29 2024, 7:50 AM
gerritbot added a comment.Apr 29 2024, 7:57 AM

Change #1025274 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] MessageRenameDialog: Mark constructor as private

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

abi_ changed the task status from Open to In Progress.May 2 2024, 4:10 AM
abi_ claimed this task.
abi_ moved this task from Priority: Localization infrastructure to In Progress on the Language-Team (Language-2024-April-June) board.
• Nikerabbit moved this task from Backlog to Support (LM) on the Localization Infrastructure FY2023-24 board.May 7 2024, 11:14 AM
gerritbot added a comment.May 15 2024, 10:51 AM

Change #1025273 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translate.base.js: Mark methods and properties as @private

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

gerritbot added a comment.May 15 2024, 10:53 AM

Change #1025274 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] MessageRenameDialog: Mark constructor as private

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

ReleaseTaggerBot added a project: MW-1.43-notes (1.43.0-wmf.6; 2024-05-21).May 15 2024, 11:00 AM
Maintenance_bot removed a project: Patch-For-Review.May 15 2024, 11:30 AM
gerritbot added a comment.May 27 2024, 10:02 AM

Change #1036203 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] mw.translate.TranslationApiStorage: Mark as private

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

gerritbot added a project: Patch-For-Review.May 27 2024, 10:02 AM

Change #1036204 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] mw.translate.recentGroups: Mark as @private

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

gerritbot added a comment.May 27 2024, 10:02 AM

Change #1036205 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.parsers.js: Mark method as private

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

gerritbot added a comment.May 27 2024, 10:02 AM

Change #1036226 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.special.pagemigration: Mark methods as private

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

gerritbot added a comment.May 27 2024, 10:02 AM

Change #1036227 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.messagetable: Mark method as private

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

gerritbot added a comment.May 27 2024, 10:11 AM

Change #1036229 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.translationstats.graphbuiler: Mark method as private

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

gerritbot added a comment.May 28 2024, 7:58 AM

Change #1036203 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] mw.translate.storage.js: Mark methods as private

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

gerritbot added a comment.May 28 2024, 9:33 AM

Change #1036587 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.editor.helpers: Mark methods as internal

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

ReleaseTaggerBot edited projects, added MW-1.43-notes (1.43.0-wmf.8; 2024-06-04); removed MW-1.43-notes (1.43.0-wmf.6; 2024-05-21).May 28 2024, 1:01 PM
gerritbot added a comment.Jun 10 2024, 12:22 PM

Change #1041084 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.editor.js: Mark methods as private or internal

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

gerritbot added a comment.Jun 11 2024, 5:14 AM

Change #1036204 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] mw.translate.recentgroups.js: Mark method as internal

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

gerritbot added a comment.Jun 11 2024, 5:14 AM

Change #1036205 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translate.parsers.js: Mark method as internal

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

gerritbot added a comment.Jun 11 2024, 5:19 AM

Change #1036226 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translate.special.pagemigration.js: Mark methods as internal

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

ReleaseTaggerBot edited projects, added MW-1.43-notes (1.43.0-wmf.10; 2024-06-18); removed MW-1.43-notes (1.43.0-wmf.8; 2024-06-04).Jun 11 2024, 6:00 AM
gerritbot added a comment.Jun 11 2024, 6:35 AM

Change #1041397 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.groupselector.js: Mark methods as private and internal

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

gerritbot added a comment.Jun 11 2024, 6:35 AM

Change #1041398 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.pagemode.js: Mark methods as private

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

gerritbot added a comment.Jun 12 2024, 12:42 PM

Change #1036227 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translate.messagetable.js: Mark methods as private or internal

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

gerritbot added a comment.Jun 12 2024, 12:42 PM

Change #1036229 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translate.translationstats.graphbuiler: Mark methods as internal

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

gerritbot added a comment.Jun 13 2024, 4:14 PM

Change #1043143 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.pagetranslation.uls.js: Mark methods as internal

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

gerritbot added a comment.Jun 13 2024, 4:14 PM

Change #1043144 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.proofread.js: Mark methods as private

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

gerritbot added a comment.Jun 13 2024, 4:14 PM

Change #1043145 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.special.translate.js: Mark methods as private or internal

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

gerritbot added a comment.Jun 19 2024, 10:38 AM

Change #1036587 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translate.editor.helpers: Mark methods as internal

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

gerritbot added a comment.Jun 19 2024, 10:38 AM

Change #1041084 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translate.editor.js: Mark methods as private or internal

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

gerritbot added a comment.Jun 19 2024, 11:02 AM

Change #1047479 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.workflowselector.js: Mark methods as private or internal

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

ReleaseTaggerBot edited projects, added MW-1.43-notes (1.43.0-wmf.11; 2024-06-25); removed MW-1.43-notes (1.43.0-wmf.10; 2024-06-18).Jun 19 2024, 12:00 PM
gerritbot added a comment.Jun 19 2024, 1:47 PM

Change #1047476 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.editor.js: Tweaks to method level comments

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

gerritbot added a comment.Mon, Jun 24, 10:31 AM

Change #1049119 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] jquery.ajaxdispatcher: Mark method as internal

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

gerritbot added a comment.Mon, Jun 24, 10:31 AM

Change #1049120 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translationstats.graphbuilder: Update method as internal

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

gerritbot added a comment.Mon, Jun 24, 10:31 AM

Change #1049121 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] ext.translate.base.js: Update methods as internal

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

gerritbot added a comment.Mon, Jun 24, 1:08 PM

Change #1041397 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translate.groupselector.js: Mark methods as private and internal

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

gerritbot added a comment.Mon, Jun 24, 1:08 PM

Change #1041398 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translate.pagemode.js: Mark methods as private

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

gerritbot added a comment.Wed, Jun 26, 3:55 AM

Change #1043143 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translate.pagetranslation.uls.js: Mark methods as internal

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

gerritbot added a comment.Wed, Jun 26, 3:55 AM

Change #1043144 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translate.proofread.js: Mark methods as private

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

ReleaseTaggerBot edited projects, added MW-1.43-notes (1.43.0-wmf.12; 2024-07-02); removed MW-1.43-notes (1.43.0-wmf.11; 2024-06-25).Wed, Jun 26, 4:00 AM
gerritbot added a comment.Thu, Jun 27, 4:32 AM

Change #1043145 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translate.special.translate.js: Mark methods as private or internal

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

• Nikerabbit set Final Story Points to 4.Thu, Jun 27, 7:43 AM
• Nikerabbit edited projects, added LPL Essential (LPL Essential 2024 Jul-Sep); removed Language-Team (Language-2024-April-June).
• Nikerabbit moved this task from Sprint Backlog to In Progress on the LPL Essential (LPL Essential 2024 Jul-Sep) board.
gerritbot added a comment.Tue, Jul 9, 7:12 AM

Change #1047476 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translate.editor.js: Tweaks to method level comments

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

gerritbot added a comment.Tue, Jul 9, 7:12 AM

Change #1047479 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translate.workflowselector.js: Mark methods as private or internal

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

gerritbot added a comment.Tue, Jul 9, 7:12 AM

Change #1049119 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] jquery.ajaxdispatcher: Mark method as internal

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

gerritbot added a comment.Tue, Jul 9, 7:12 AM

Change #1049120 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] ext.translationstats.graphbuilder: Update method as internal

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

ReleaseTaggerBot edited projects, added MW-1.43-notes (1.43.0-wmf.14; 2024-07-16); removed MW-1.43-notes (1.43.0-wmf.12; 2024-07-02).Tue, Jul 9, 8:00 AM
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