Page MenuHomePhabricator
Create Task
Maniphest T247862

Stable Interface Policy annotations
Closed, ResolvedPublic
Actions

Description

https://www.mediawiki.org/wiki/Core_Platform_Team/Initiative/Stability_annotations
https://www.mediawiki.org/wiki/Stable_interface_policy#Stability_Annotations

Done Criteria
Based on usage by Production Extensions

  • replace @private with @internal (currently, both are used synonymously) (patch)
  • replace or remove @protected as appropriate (patch)
  • Manually compile a list of classes designed to be "newable" (value objects) (list). Apply tags (patch).
  • Mark exceptions as newable (patch)
  • Manually compile a list of interfaces designed to be implemented by extensions (list). Apply tags (patch)
  • Manually compile a list of classes designed to serve as extensions points (base classes) (list). Apply tags (patch)
  • For each class, identify methods that are intended to be overwritten.

Details

SubjectRepoBranchLines +/-
Mark token methods in query apis as internalmediawiki/coremaster+13 -0
rdbms: Mark the Database class as stable for subclassingmediawiki/coremaster+269 -1
HTML Classes stability annotationsmediawiki/coremaster+378 -2
Update stability annotations to follow new stable interface policymediawiki/coremaster+31 -24
Mark potential abstract classes stable for subclassingmediawiki/coremaster+30 -1
Mark special page base classes as stable for subclassingmediawiki/coremaster+151 -0
Mark exceptions as newable and stable for subclassingmediawiki/coremaster+119 -0
Mark remaining eligible classes as stable for subclassingmediawiki/coremaster+110 -1
Mark file backend base classes as stable for subclassingmediawiki/coremaster+31 -0
Annotate extensible classes.mediawiki/coremaster+312 -3
Mark skin base classes as stable for subclassing.mediawiki/coremaster+12 -0
Mark Content and ContentHandler base classes as extensiblemediawiki/coremaster+118 -1
Mark File base classes as extensible.mediawiki/coremaster+155 -1
Mark exceptions as @newablemediawiki/coremaster+139 -3
Mark media handling based classes as stable for subclassingmediawiki/coremaster+146 -0
Mark search base classes as stable for subclassingmediawiki/coremaster+31 -3
Mark methods in authentication base classes as stable for overriding.mediawiki/coremaster+253 -0
Mark pager base classes as stable for subclassing.mediawiki/coremaster+84 -0
Mark action base classes as extensiblemediawiki/coremaster+30 -0
Mark additional classes as newable for now.mediawiki/coremaster+70 -4
Mark API base classes as extensiblemediawiki/coremaster+47 -0
Stability annotations for interfaces.mediawiki/coremaster+58 -0
resourceloader: Mark ResourceLoaderModule as stable for subclassingmediawiki/coremaster+24 -0
Annotate newable classesmediawiki/coremaster+130 -5
[EditPage] Mark public fields not used outside of core as internalmediawiki/coremaster+82 -21
OutputPage: Use @unstable instead of @internal for addHtmlClasses()mediawiki/coremaster+1 -2
DNM: Document some classes as not newable.mediawiki/coremaster+13 -1
Replace @protected tagmediawiki/coremaster+36 -34
Use @internal instead of @private per policymediawiki/coremaster+72 -72
Show related patches Customize query in gerrit

Related Objects
Search...

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 17 2020, 4:02 PM
Izno subscribed.Mar 18 2020, 1:04 AM
daniel updated the task description. (Show Details)Jun 23 2020, 3:39 PM
WDoranWMF assigned this task to daniel.Jun 23 2020, 6:20 PM
WDoranWMF edited projects, added Platform Team Workboards (Green); removed Platform Team Workboards (Initiatives).
WDoranWMF updated the task description. (Show Details)
WDoranWMF added a parent task: T256154: Rollout of Stability Annotation Policy in 1.35.Jun 23 2020, 6:25 PM
daniel updated the task description. (Show Details)Jun 26 2020, 12:15 PM
gerritbot added a comment.Jun 26 2020, 12:16 PM

Change 608033 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Use @internal instead of @private per policy

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

gerritbot added a project: Patch-For-Review.Jun 26 2020, 12:16 PM
daniel updated the task description. (Show Details)Jun 26 2020, 12:33 PM
gerritbot added a comment.Jun 26 2020, 12:35 PM

Change 608035 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Replace @protected tag

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

daniel removed a project: Patch-For-Review.Jun 26 2020, 12:35 PM
daniel updated the task description. (Show Details)
daniel updated the task description. (Show Details)
gerritbot added a comment.Jun 26 2020, 12:57 PM

Change 579253 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Annotate newable classes

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

gerritbot added a project: Patch-For-Review.Jun 26 2020, 12:57 PM
daniel updated the task description. (Show Details)Jun 26 2020, 12:59 PM
gerritbot added a comment.Jun 26 2020, 1:07 PM

Change 608040 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Document some classes as not newable.

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

daniel updated the task description. (Show Details)Jun 26 2020, 2:09 PM
gerritbot added a comment.Jun 26 2020, 2:25 PM

Change 608054 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Stability annotations for interfaces.

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

daniel updated the task description. (Show Details)Jun 26 2020, 2:52 PM
daniel updated the task description. (Show Details)Jun 26 2020, 3:37 PM
gerritbot added a comment.Jun 26 2020, 3:38 PM

Change 579252 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] [WIP] Annotate extensible classes.

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

daniel updated the task description. (Show Details)Jun 26 2020, 3:51 PM
gerritbot added a comment.Jun 26 2020, 5:12 PM

Change 608033 merged by jenkins-bot:
[mediawiki/core@master] Use @internal instead of @private per policy

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

gerritbot added a comment.Jun 26 2020, 5:17 PM

Change 608035 merged by jenkins-bot:
[mediawiki/core@master] Replace @protected tag

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

ReleaseTaggerBot added a project: MW-1.35-notes (1.35.0-wmf.39; 2020-06-30).Jun 26 2020, 6:00 PM
daniel updated the task description. (Show Details)Jun 29 2020, 9:37 AM
daniel updated the task description. (Show Details)
daniel updated the task description. (Show Details)Jun 29 2020, 12:15 PM
gerritbot added a comment.Jun 29 2020, 12:15 PM

Change 608303 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark exceptions as @newable

https://gerrit.wikimedia.org/r/c/mediawiki/core/ /608303

daniel updated the task description. (Show Details)Jun 29 2020, 12:16 PM
daniel added subscribers: Nikki, DannyS712, • Pchelolo.
gerritbot added a comment.Jun 30 2020, 10:17 AM

Change 608581 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark more classes as newable, per the Stable Interface Policy.

https://gerrit.wikimedia.org/r/c/mediawiki/core/ /608581

gerritbot added a comment.Jun 30 2020, 12:44 PM

Change 608608 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark API base classes as extensible

https://gerrit.wikimedia.org/r/c/mediawiki/core/ /608608

gerritbot added a comment.Jun 30 2020, 2:46 PM

Change 608638 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark pager base classes as stable for subclassing.

https://gerrit.wikimedia.org/r/c/mediawiki/core/ /608638

gerritbot added a comment.Jun 30 2020, 4:54 PM

Change 608689 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark Content and ContentHandler base classes as extensible

https://gerrit.wikimedia.org/r/c/mediawiki/core/ /608689

gerritbot added a comment.Jun 30 2020, 5:15 PM

Change 608694 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark action base classes as extensible

https://gerrit.wikimedia.org/r/c/mediawiki/core/ /608694

gerritbot added a comment.Jul 1 2020, 6:48 PM

Change 608927 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark methods in authentication base classes as stable for overriding.

https://gerrit.wikimedia.org/r/c/mediawiki/core/ /608927

gerritbot added a comment.Jul 1 2020, 7:16 PM

Change 608939 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark media handling based classes as stable for subclassing

https://gerrit.wikimedia.org/r/c/mediawiki/core/ /608939

gerritbot added a comment.Jul 2 2020, 1:04 AM

Change 608981 had a related patch set uploaded (by Krinkle; owner: Krinkle):
[mediawiki/core@master] OutputPage: Use @unstable instead of @internal for addHtmlClasses()

https://gerrit.wikimedia.org/r/c/mediawiki/core/ /608981

gerritbot added a comment.Jul 3 2020, 11:51 AM

Change 609413 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark skin base classes as stable for subclassing.

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

gerritbot added a comment.Jul 3 2020, 12:05 PM

Change 609414 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark search base classes as stable for subclassing

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

gerritbot added a comment.Jul 3 2020, 12:32 PM

Change 609418 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark ResourceLoader Module as stable for subclassing

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

gerritbot added a comment.Jul 3 2020, 2:51 PM

Change 609438 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark database base classes as stable for subclassing

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

gerritbot added a comment.Jul 6 2020, 9:20 AM

Change 609628 had a related patch set uploaded (by DannyS712; owner: DannyS712):
[mediawiki/core@master] [EditPage] Mark public fields not used outside of core as internal

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

gerritbot added a comment.Jul 6 2020, 2:07 PM

Change 609632 had a related patch set uploaded (by DannyS712; owner: DannyS712):
[mediawiki/core@master] Mark token methods in query apis as internal

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

gerritbot added a comment.Jul 6 2020, 6:07 PM

Change 608981 merged by jenkins-bot:
[mediawiki/core@master] OutputPage: Use @unstable instead of @internal for addHtmlClasses()

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

gerritbot added a comment.Jul 6 2020, 6:09 PM

Change 609628 merged by jenkins-bot:
[mediawiki/core@master] [EditPage] Mark public fields not used outside of core as internal

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

ReleaseTaggerBot edited projects, added MW-1.35-notes (1.35.0-wmf.40; 2020-07-07); removed MW-1.35-notes (1.35.0-wmf.39; 2020-06-30).Jul 6 2020, 7:00 PM
gerritbot added a comment.Jul 7 2020, 6:46 PM

Change 579253 merged by jenkins-bot:
[mediawiki/core@master] Annotate newable classes

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

gerritbot added a comment.Jul 7 2020, 6:49 PM

Change 609418 merged by jenkins-bot:
[mediawiki/core@master] resourceloader: Mark ResourceLoaderModule as stable for subclassing

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

ReleaseTaggerBot edited projects, added MW-1.35-notes (1.35.0-wmf.41; 2020-07-14); removed MW-1.35-notes (1.35.0-wmf.40; 2020-07-07).Jul 7 2020, 7:00 PM
gerritbot added a comment.Jul 7 2020, 10:23 PM

Change 608054 merged by jenkins-bot:
[mediawiki/core@master] Stability annotations for interfaces.

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

gerritbot added a comment.Jul 8 2020, 3:03 PM

Change 608608 merged by jenkins-bot:
[mediawiki/core@master] Mark API base classes as extensible

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

gerritbot added a comment.Jul 8 2020, 4:42 PM

Change 608581 merged by jenkins-bot:
[mediawiki/core@master] Mark additional classes as newable for now.

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

gerritbot added a comment.Jul 8 2020, 4:44 PM

Change 608694 merged by jenkins-bot:
[mediawiki/core@master] Mark action base classes as extensible

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

gerritbot added a comment.Jul 8 2020, 5:31 PM

Change 608638 merged by jenkins-bot:
[mediawiki/core@master] Mark pager base classes as stable for subclassing.

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

gerritbot added a comment.Jul 8 2020, 6:16 PM

Change 608927 merged by jenkins-bot:
[mediawiki/core@master] Mark methods in authentication base classes as stable for overriding.

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

gerritbot added a comment.Jul 8 2020, 6:18 PM

Change 608303 merged by jenkins-bot:
[mediawiki/core@master] Mark exceptions as @newable

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

gerritbot added a comment.Jul 8 2020, 11:04 PM

Change 609414 merged by jenkins-bot:
[mediawiki/core@master] Mark search base classes as stable for subclassing

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

gerritbot added a comment.Jul 9 2020, 8:35 AM

Change 608939 merged by jenkins-bot:
[mediawiki/core@master] Mark media handling based classes as stable for subclassing

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

gerritbot added a comment.Jul 9 2020, 9:05 AM

Change 610717 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark File base classes as extensible.

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

gerritbot added a comment.Jul 9 2020, 4:32 PM

Change 608689 merged by jenkins-bot:
[mediawiki/core@master] Mark Content and ContentHandler base classes as extensible

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

gerritbot added a comment.Jul 9 2020, 4:32 PM

Change 610717 merged by jenkins-bot:
[mediawiki/core@master] Mark File base classes as extensible.

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

gerritbot added a comment.Jul 9 2020, 4:35 PM

Change 609413 merged by jenkins-bot:
[mediawiki/core@master] Mark skin base classes as stable for subclassing.

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

gerritbot added a comment.Jul 9 2020, 5:25 PM

Change 579252 merged by jenkins-bot:
[mediawiki/core@master] Annotate extensible classes.

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

gerritbot added a comment.Jul 9 2020, 9:57 PM

Change 609415 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark file backend base classes as stable for subclassing

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

gerritbot added a comment.Jul 9 2020, 10:45 PM

Change 608660 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark special page base classes as stable for subclassing

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

gerritbot added a comment.Jul 10 2020, 12:12 PM

Change 611294 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark exceptions as newable and stable for subclassing

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

gerritbot added a comment.Jul 10 2020, 1:00 PM

Change 611307 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Mark remaining eligible classes as stable for subclassing

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

gerritbot added a comment.Jul 10 2020, 1:52 PM

Change 609415 merged by jenkins-bot:
[mediawiki/core@master] Mark file backend base classes as stable for subclassing

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

daniel updated the task description. (Show Details)Jul 10 2020, 1:56 PM
gerritbot added a comment.Jul 10 2020, 1:59 PM

Change 611307 merged by jenkins-bot:
[mediawiki/core@master] Mark remaining eligible classes as stable for subclassing

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

gerritbot added a comment.Jul 10 2020, 2:14 PM

Change 608660 merged by jenkins-bot:
[mediawiki/core@master] Mark special page base classes as stable for subclassing

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

gerritbot added a comment.Jul 10 2020, 2:23 PM

Change 611294 merged by jenkins-bot:
[mediawiki/core@master] Mark exceptions as newable and stable for subclassing

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

gerritbot added a comment.Jul 10 2020, 4:16 PM

Change 611371 had a related patch set uploaded (by Nikki Nikkhoui; owner: Nikki Nikkhoui):
[mediawiki/core@master] Mark potential abstract classes stable for subclassing

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

gerritbot added a comment.Jul 10 2020, 7:24 PM

Change 611413 had a related patch set uploaded (by Nikki Nikkhoui; owner: Nikki Nikkhoui):
[mediawiki/core@master] HTML Classes stability annotations

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

daniel mentioned this in T257789: Update stability annotations to conform to new policy.Jul 13 2020, 8:51 AM
gerritbot added a comment.Jul 13 2020, 9:23 AM

Change 612164 had a related patch set uploaded (by Daniel Kinzler; owner: Daniel Kinzler):
[mediawiki/core@master] Update stability annotatiosn for new stable interface policy

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

gerritbot added a comment.Jul 13 2020, 9:48 AM

Change 611371 merged by jenkins-bot:
[mediawiki/core@master] Mark potential abstract classes stable for subclassing

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

gerritbot added a comment.Jul 13 2020, 10:05 AM

Change 612164 merged by jenkins-bot:
[mediawiki/core@master] Update stability annotations to follow new stable interface policy

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

gerritbot added a comment.Jul 13 2020, 4:14 PM

Change 611413 merged by jenkins-bot:
[mediawiki/core@master] HTML Classes stability annotations

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

gerritbot added a comment.Jul 13 2020, 8:02 PM

Change 609438 merged by jenkins-bot:
[mediawiki/core@master] rdbms: Mark the Database class as stable for subclassing

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

daniel closed this task as Resolved.Jul 13 2020, 8:06 PM
daniel updated the task description. (Show Details)
daniel moved this task from Backlog to Done on the Platform Team Workboards (Green) board.
daniel mentioned this in T257897: Write blog post about the Stable Interface Policy and stability annotations.Jul 14 2020, 8:12 AM
Naike mentioned this in T262342: Stability Annotations.Sep 8 2020, 10:11 PM
gerritbot added a comment.Sep 9 2020, 11:22 PM

Change 609632 abandoned by DannyS712:
[mediawiki/core@master] Mark token methods in query apis as internal

Reason:
since the hooks were removed, users can now be injected

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

daniel mentioned this in T275749: Survey tool to see which extension uses which hooks.Feb 25 2021, 9:46 AM
TBurmeister closed subtask T256152: Prepare Tech Blog Post covering new Stability Annotation release as Declined.Jan 23 2023, 6:00 PM
Aklapper merged a task: T262342: Stability Annotations.Oct 9 2023, 6:02 PM
Aklapper added a subscriber: Naike.
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