Page MenuHomePhabricator
Create Task
Maniphest T252907

Reduce public variables and methods in EditPage
Open, MediumPublic
Actions

Description

Currently, there is a large number of public methods and variables that shouldn't be used outside of the class (eg when the entire EditPage object is passed in a hook). These should be deprecated for public access and made private

methods to make private*
EditPage::extractSectionTitle (used in EditPageTest)
EditPage::getSummaryInputWidget
EditPage::noSuchSectionPage
EditPage::initialiseForm
EditPage::setPreloadedContent (entirely unused)

*Only used in EditPage unless noted otherwise

Variables to make private
EditPage::$hookError
EditPage::$deletedSinceEdit
EditPage::$lastDelete
EditPage::$mTokenOkExceptSuffix
EditPage::$mTriedSave
EditPage::$incompleteForm
EditPage::$tooBig
EditPage::$missingComment
EditPage::$missingSummary
EditPage::$allowBlankSummary
EditPage::$autoSumm
EditPage::$hasPresetSummary
EditPage::$recreate
EditPage::$noSummary
EditPage::$parentRevId
EditPage::$editintro
EditPage::$markAsBot
EditPage::$mPreloadContent (public method setPreloadedContent exists, as does protected getPreloadedContent)

Details

Other Assignee
Krinkle
SubjectRepoBranchLines +/-
Remove public access to internal EditPage variablesmediawiki/coremaster+21 -20
EditPage: Remove various deprecated properties and methodsmediawiki/coremaster+15 -23
EditPage: make most methods privatemediawiki/coreREL1_38+111 -143
EditPage: make most methods privatemediawiki/coremaster+113 -143
Emit deprecation warnings for internal EditPage fieldsmediawiki/coremaster+59 -96
Add RELEASE-NOTES for removals of EditPage public methodsmediawiki/coremaster+7 -0
Reduce public methods of EditPagemediawiki/coremaster+9 -17
Make EditPage::$hookError privatemediawiki/coremaster+2 -1
Customize query in gerrit

Related Objects
Search...

Event Timeline

DannyS712 created this task.May 15 2020, 6:45 PM
DannyS712 updated the task description. (Show Details)
DannyS712 updated the task description. (Show Details)May 15 2020, 6:59 PM
DannyS712 updated the task description. (Show Details)May 16 2020, 12:34 AM
gerritbot added a comment.May 16 2020, 12:34 AM

Change 596791 had a related patch set uploaded (by DannyS712; owner: DannyS712):
[mediawiki/core@master] Make EditPage::$hookError private

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

gerritbot added a project: Patch-For-Review.May 16 2020, 12:34 AM
DannyS712 moved this task from Unsorted to In progress on the User-DannyS712 board.May 16 2020, 12:35 AM
DannyS712 added a project: Platform Team Workboards (External Code Reviews).
DannyS712 added a parent task: T11968: Reduce use of global and public variables.May 26 2020, 6:13 AM
gerritbot added a comment.May 27 2020, 6:48 PM

Change 596791 merged by jenkins-bot:
[mediawiki/core@master] Make EditPage::$hookError private

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

ReleaseTaggerBot added a project: MW-1.35-notes (1.35.0-wmf.35; 2020-06-02).May 27 2020, 7:00 PM
Maintenance_bot removed a project: Patch-For-Review.May 27 2020, 7:10 PM
CCicalese_WMF moved this task from External Code Review Needed to External Code Review Completed on the Platform Team Workboards (External Code Reviews) board.Aug 11 2020, 8:39 PM
DannyS712 updated the task description. (Show Details)Sep 13 2020, 11:38 PM
DannyS712 updated the task description. (Show Details)Nov 10 2020, 11:28 PM
gerritbot added a comment.Nov 10 2020, 11:36 PM

Change 640490 had a related patch set uploaded (by DannyS712; owner: DannyS712):
[mediawiki/core@master] Reduce public methods of EditPage

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

gerritbot added a project: Patch-For-Review.Nov 10 2020, 11:36 PM
DannyS712 moved this task from External Code Review Completed to External Code Review Needed on the Platform Team Workboards (External Code Reviews) board.Nov 10 2020, 11:41 PM
DannyS712 updated the task description. (Show Details)
gerritbot added a comment.Nov 18 2020, 3:58 AM

Change 640490 merged by jenkins-bot:
[mediawiki/core@master] Reduce public methods of EditPage

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

ReleaseTaggerBot added a project: MW-1.36-notes (1.36.0-wmf.20; 2020-12-01).Nov 18 2020, 4:00 AM
Maintenance_bot removed a project: Patch-For-Review.Nov 18 2020, 4:10 AM
gerritbot added a comment.Nov 18 2020, 3:45 PM

Change 641504 had a related patch set uploaded (by DannyS712; owner: DannyS712):
[mediawiki/core@master] Add RELEASE-NOTES for removals of EditPage public methods

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

gerritbot added a project: Patch-For-Review.Nov 18 2020, 3:45 PM
gerritbot added a comment.Nov 18 2020, 4:10 PM

Change 641504 merged by jenkins-bot:
[mediawiki/core@master] Add RELEASE-NOTES for removals of EditPage public methods

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

Maintenance_bot removed a project: Patch-For-Review.Nov 18 2020, 4:10 PM
BPirkle subscribed.Nov 19 2020, 2:08 PM

I see several patches merged. Is this completed?

DannyS712 added a comment.Nov 19 2020, 6:36 PM

The variables need to be made private still

gerritbot added a comment.Nov 22 2020, 1:21 AM

Change 642440 had a related patch set uploaded (by DannyS712; owner: DannyS712):
[mediawiki/core@master] Make @internal EditPage variables private

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

gerritbot added a project: Patch-For-Review.Nov 22 2020, 1:21 AM
gerritbot added a comment.Dec 9 2020, 8:19 PM

Change 647298 had a related patch set uploaded (by DannyS712; owner: DannyS712):
[mediawiki/core@master] Emit deprecation warnings for internal EditPage fields

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

gerritbot added a comment.Dec 9 2020, 9:59 PM

Change 647298 merged by jenkins-bot:
[mediawiki/core@master] Emit deprecation warnings for internal EditPage fields

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

ReleaseTaggerBot edited projects, added MW-1.36-notes (1.36.0-wmf.22; 2020-12-15); removed MW-1.36-notes (1.36.0-wmf.20; 2020-12-01).Dec 9 2020, 10:00 PM
edwardspec mentioned this in T283977: PageForms + MW 1.36: "Cannot access non-public property EditPage::$hookError".May 29 2021, 7:58 PM
gerritbot added a comment.Feb 12 2022, 12:42 PM

Change 761914 had a related patch set uploaded (by Daimona Eaytoy; author: Daimona Eaytoy):

[mediawiki/core@master] EditPage: make most methods private

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

gerritbot added a comment.Feb 18 2022, 4:39 PM

Change 642440 merged by jenkins-bot:

[mediawiki/core@master] Remove public access to internal EditPage variables

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

ReleaseTaggerBot added a project: MW-1.38-notes (1.38.0-wmf.23; 2022-02-21).Feb 18 2022, 5:00 PM
gerritbot added a comment.Mar 26 2022, 5:13 PM

Change 761914 merged by jenkins-bot:

[mediawiki/core@master] EditPage: make most methods private

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

gerritbot added a comment.Mar 26 2022, 5:15 PM

Change 773856 had a related patch set uploaded (by Krinkle; author: Daimona Eaytoy):

[mediawiki/core@REL1_38] EditPage: make most methods private

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

gerritbot added a comment.Mar 26 2022, 5:45 PM

Change 773856 merged by jenkins-bot:

[mediawiki/core@REL1_38] EditPage: make most methods private

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

ReleaseTaggerBot edited projects, added MW-1.38-notes, MW-1.39-notes (1.39.0-wmf.5; 2022-03-28); removed MW-1.38-notes (1.38.0-wmf.23; 2022-02-21).Mar 26 2022, 6:00 PM
DannyS712 added a subscriber: Daimona.Mar 26 2022, 7:29 PM

Additional things that can be made private (or removed) (deployed uses refers to things outside of core):

EditPage::$editFormTextAfterWarn - NO deployed uses, can remove entirely
EditPage::$editFormTextBottom - NO deployed uses, can remove entirely

EditPage::setHeaders() - I *think* there are no deployed uses, but given how many other methods by this name exist I'm not positive
EditPage::showEditForm() - NO deployed uses
EditPage::showDiff() - NO deployed uses
EditPage::getPreviewText() - NO deployed uses
EditPage::getEditButtons() - NO deployed uses
EditPage::spamPageWithContent() - NO deployed uses


Also,
EditPage::getCheckboxesWidget() - can be made protected (overridden by ProofreadPage)

@Daimona care to continue working on this?

Daimona added a comment.Mar 27 2022, 10:39 AM

Those with no deployed uses but that do have 3rd party uses should go through the deprecation process. We can backport the deprecation to 1.38 and remove them on master though :)

gerritbot added a comment.Mar 27 2022, 10:58 AM

Change 773996 had a related patch set uploaded (by Daimona Eaytoy; author: Daimona Eaytoy):

[mediawiki/core@master] Remove some deprecated stuff from EditPage

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

Krinkle assigned this task to Daimona.Mar 27 2022, 12:03 PM
Krinkle triaged this task as Medium priority.
Krinkle updated Other Assignee, added: Krinkle.
Krinkle edited projects, added Performance-Team (Radar); removed MW-1.39-notes (1.39.0-wmf.5; 2022-03-28), MW-1.36-notes (1.36.0-wmf.22; 2020-12-15), Patch-For-Review, MW-1.35-notes (1.35.0-wmf.35; 2020-06-02), Platform Team Workboards (External Code Reviews).
Krinkle edited projects, added Technical-Debt (Deprecation process); removed Technical-Debt.Apr 5 2022, 2:39 PM
Krinkle moved this task from Untriaged to 2022 | MW 1.38 / 1.39 on the Technical-Debt (Deprecation process) board.
Krinkle added a subtask: T305028: PHP Deprecated: Use of EditPage::$textbox2 was deprecated in MediaWiki 1.38. [Called from TwoColConflict\Hooks\TwoColConflictHooks::onEditPageBeforeConflictDiff].Apr 5 2022, 3:02 PM
thiemowmde mentioned this in T305028: PHP Deprecated: Use of EditPage::$textbox2 was deprecated in MediaWiki 1.38. [Called from TwoColConflict\Hooks\TwoColConflictHooks::onEditPageBeforeConflictDiff].Apr 8 2022, 5:18 PM
Krinkle closed subtask T305028: PHP Deprecated: Use of EditPage::$textbox2 was deprecated in MediaWiki 1.38. [Called from TwoColConflict\Hooks\TwoColConflictHooks::onEditPageBeforeConflictDiff] as Resolved.Apr 9 2022, 5:20 PM
dancy reopened subtask T305028: PHP Deprecated: Use of EditPage::$textbox2 was deprecated in MediaWiki 1.38. [Called from TwoColConflict\Hooks\TwoColConflictHooks::onEditPageBeforeConflictDiff] as Open.Apr 11 2022, 3:04 PM
Krinkle moved this task from Limbo to Watching on the Performance-Team (Radar) board.Apr 11 2022, 7:15 PM
Umherirrender mentioned this in T316577: Find replacement for EditPage::$textbox2 and deprecate the public access.Aug 29 2022, 6:35 PM
Umherirrender added a subtask: T316577: Find replacement for EditPage::$textbox2 and deprecate the public access.
Umherirrender closed subtask T316577: Find replacement for EditPage::$textbox2 and deprecate the public access as Resolved.Aug 29 2022, 6:39 PM
Umherirrender closed subtask T305028: PHP Deprecated: Use of EditPage::$textbox2 was deprecated in MediaWiki 1.38. [Called from TwoColConflict\Hooks\TwoColConflictHooks::onEditPageBeforeConflictDiff] as Resolved.Aug 29 2022, 6:41 PM
Daimona removed Daimona as the assignee of this task.Jun 17 2023, 4:02 PM
Krinkle removed a project: Performance-Team (Radar).Aug 18 2023, 8:13 PM
gerritbot added a comment.Sep 12 2023, 12:18 AM

Change 773996 merged by jenkins-bot:

[mediawiki/core@master] EditPage: Remove various deprecated properties and methods

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

ReleaseTaggerBot added a project: MW-1.41-notes (1.41.0-wmf.26; 2023-09-12).Sep 12 2023, 1: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