rename "cli" directory to "maintenance"
Open, Needs TriagePublic
Actions

Assigned To

None

Authored By

	Novem_Linguae
	Jul 1 2025, 1:13 AM

Description

What

rename cli/ directory to maintenance/, leaving in place a redirect file so that the cron job still works (gerrit)
(after July 17, after the above patch rides the train) update modules/profile/manifests/mediawiki/maintenance/purge_securepoll.pp cron job in puppet repo: https://codesearch.wmcloud.org/puppet/?q=SecurePoll%2Fcli%2F&files=&excludeFiles=&repos=
(weeks or months from now, to allow 3rd party wikis time to notice and fix the deprecation) remove the redirect file, and remove cli/* exception from .phpcs.xml
https://wikitech.wikimedia.org/wiki/SecurePoll
- replace "cli/" with "maintenance/"
- fix renamed file names: delete -> deletePoll, dump -> dumpElection, import -> importElectionConfiguration, tally -> tallyElection, populateEditCount -> prefix it with that particular election's acronym, e.g. bv2024PopulateEditCount
https://www.mediawiki.org/wiki/Extension:SecurePoll
- replace "cli/" with "maintenance/"
- fix renamed file names
"handbook of running global elections" at https://docs.google.com/document/d/1uyaJk5ZA1RWH-iuUFKTZbnG_wwKM-Hw4q8_jQ84N8cA/edit?tab=t.0#heading=h.i7q0oqet2m2n (I don't have access so someone else would need to do it)
- replace "cli/" with "maintenance/"
- fix renamed file names

Why

so commands such as docker compose exec mediawiki php maintenance/run.php SecurePoll:migrateTallies work correctly and don't give the following error: Script 'SecurePoll:migrateTallies' not found (tried path '/var/www/html/w/extensions/SecurePoll/maintenance/migrateTallies.php' and class 'MediaWiki\Extension\SecurePoll\Maintenance\migrateTallies').

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	rename "cli" folder to "maintenance"	mediawiki/extensions/SecurePoll	master	+16 -12
	recreate cli/purgePrivateVoteData.php	mediawiki/extensions/SecurePoll	master	+37 -1

Customize query in gerrit

Related Objects

Mentioned In: T387701: Allow multiple tallies to be associated with a poll

Event Timeline

Novem_Linguae created this task.Jul 1 2025, 1:13 AM

Restricted Application added a project: Trust and Safety Product Team. · View Herald TranscriptJul 1 2025, 1:13 AM

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

Novem_Linguae mentioned this in T387701: Allow multiple tallies to be associated with a poll.Jul 1 2025, 1:19 AM

Novem_Linguae updated the task description. (Show Details)Jul 1 2025, 1:21 AM

Dreamy_Jazz awarded a token.Jul 1 2025, 6:16 AM

Might I suggest leaving the cli folder with deprecated aliases.

That would be useful because I think the purging script is run on a schedule using the current name. Therefore, we need to avoid moving without deprecation of the old name.

If you need an example, I'd suggest looking at AbuseFilter where I recently renamed a script leaving a deprecated alias (the script which purges private data from abuse_filter_log.

A_smart_kitten updated the task description. (Show Details)Jul 1 2025, 8:29 AM

In T398268#10961886, @Dreamy_Jazz wrote:

Might I suggest leaving the cli folder with deprecated aliases.

That would be useful because I think the purging script is run on a schedule using the current name. Therefore, we need to avoid moving without deprecation of the old name.

If you need an example, I'd suggest looking at AbuseFilter where I recently renamed a script leaving a deprecated alias (the script which purges private data from abuse_filter_log.

Can't we just patch the cron job to point at maintenance/*? Looks like a one line patch: https://gerrit.wikimedia.org/g/operations/puppet/+/a1bd6b74947e6bc13cc85c52bc6e23a5a3ed5e3f/modules/profile/manifests/mediawiki/maintenance/purge_securepoll.pp#7

That doesn't work if some wikis are on the new version and some use the old version, then you need to have both names working.

Plus third party wikis which have similar scripts.

Seems a bit complicated, but OK. I imagine this is the example one you're talking about in the AbuseFilter repo:

https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/extensions/AbuseFilter/+/refs/heads/master/maintenance/PurgeOldLogIPData.php

Think it'd be OK to only make one alias for the one cron job purgePrivateVoteData.php, and just move the rest without aliases?

If we're doing this, I suggest also renaming the few files whose names don't match the class names (delete.php -> deletePoll.php, dump.php -> dumpElection.php, import -> importElectionConfiguration.php, tally -> tallyElection.php). Doing it together with directory rename avoids having to update all references twice.

Change #1166017 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/SecurePoll@master] rename "cli" folder to "maintenance"

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

gerritbot added a project: Patch-For-Review.Jul 2 2025, 11:20 PM

Novem_Linguae updated the task description. (Show Details)Jul 2 2025, 11:49 PM

Change #1166952 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/SecurePoll@master] recreate cli/purgePrivateVoteData.php

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

Change #1166017 merged by jenkins-bot:

[mediawiki/extensions/SecurePoll@master] rename "cli" folder to "maintenance"

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

Change #1166952 merged by jenkins-bot: