4b7ddd3c67
Follow-up ba6490aa1e.
That patch worked around $executeContext iteration errors due to the
lack of recursion support in doUpdates()/handleUpdateQueue(). Errors
were triggered by MediaWiki::schedulePostSendJobs() enqueueing deferred
updates that invoke JobRunner::run(), which, in turn, invoke doUpdates()
for each job via JobRunner:: doExecuteJob(). The doUpdates() method was
changed to operate on the sub-queue for the in-progress DeferrableUpdate.
Further improve the recursion logic:
* Use classes for the scope stack and scope queues.
* Put *all* updates added during a DeferrableUpdate::doUpdate() call into
the subqueue, regardless of "defer until" stage or whether it implements
MergeableUpdate. Now, doUpdate() can run *everything* it enqueued instead
of a non-obvious subset. Note that the TransactionRoundDefiningUpdate
that invokes JobRunner was already a POSTSEND update before ba6490aa1eb;
the only effect of this change is that MergeableUpdate instances from jobs
will once again run in doExecuteJob().
* Make recursive DeferredUpdates::doUpdate() calls error out immediately
unless the DeferrableUpdate responsible is a TransactionRoundAwareUpdate
with the TRX_ROUND_ABSENT flag. This covers the schedulePostSendJobs()
scenario and only prohibits insane call patterns. Failing early avoids
the risk of handleUpdateQueue() dropping all the updates due to the same
DBTransactionError error in DeferredUpdates::attemptUpdate().
* Avoid recursion loop in tryOpportunisticExecute() when JobQueueDB is in
use and a large number of tasks are pending. This happened due to methods
like onTransactionPreCommitOrIdle() being used within JobQueueDB.
Mark DeferredUpdates::doUpdates()/tryOpportunisticExecute() as @internal
and create a Maintenance::shutdown() method to avoid a direct call in the
doMaintenance.php file.
Bug: T249069
Bug: T268840
Change-Id: Ib369f0e74243a48ababdb9cd83b155c9a0f5e741
133 lines
4.3 KiB
PHP
133 lines
4.3 KiB
PHP
<?php
|
|
/**
|
|
* We want to make this whole thing as seamless as possible to the
|
|
* end-user. Unfortunately, we can't do _all_ of the work in the class
|
|
* because A) included files are not in global scope, but in the scope
|
|
* of their caller, and B) MediaWiki has way too many globals. So instead
|
|
* we'll kinda fake it, and do the requires() inline. <3 PHP
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup Maintenance
|
|
*/
|
|
use MediaWiki\MediaWikiServices;
|
|
|
|
if ( !defined( 'RUN_MAINTENANCE_IF_MAIN' ) ) {
|
|
echo "This file must be included after Maintenance.php\n";
|
|
exit( 1 );
|
|
}
|
|
|
|
// Wasn't included from the file scope, halt execution (probably wanted the class)
|
|
// If a class is using CommandLineInc (old school maintenance), they definitely
|
|
// cannot be included and will proceed with execution
|
|
// @phan-suppress-next-line PhanSuspiciousValueComparisonInGlobalScope
|
|
if ( !Maintenance::shouldExecute() && $maintClass != CommandLineInc::class ) {
|
|
return;
|
|
}
|
|
|
|
// @phan-suppress-next-line PhanImpossibleConditionInGlobalScope
|
|
if ( !$maintClass || !class_exists( $maintClass ) ) {
|
|
echo "\$maintClass is not set or is set to a non-existent class.\n";
|
|
exit( 1 );
|
|
}
|
|
|
|
// Define the MediaWiki entrypoint
|
|
define( 'MEDIAWIKI', true );
|
|
|
|
// This environment variable is ensured present by Maintenance.php.
|
|
$IP = getenv( 'MW_INSTALL_PATH' );
|
|
|
|
// Get an object to start us off
|
|
/** @var Maintenance $maintenance */
|
|
$maintenance = new $maintClass();
|
|
|
|
// Basic sanity checks and such
|
|
$maintenance->setup();
|
|
|
|
// We used to call this variable $self, but it was moved
|
|
// to $maintenance->mSelf. Keep that here for b/c
|
|
$self = $maintenance->getName();
|
|
|
|
// Define how settings are loaded (e.g. LocalSettings.php)
|
|
if ( !defined( 'MW_CONFIG_CALLBACK' ) && !defined( 'MW_CONFIG_FILE' ) ) {
|
|
define( 'MW_CONFIG_FILE', $maintenance->loadSettings() );
|
|
}
|
|
|
|
// Custom setup for Maintenance entry point
|
|
if ( !defined( 'MW_SETUP_CALLBACK' ) ) {
|
|
|
|
function wfMaintenanceSetup() {
|
|
global $maintenance, $wgLocalisationCacheConf, $wgCacheDirectory;
|
|
if ( $maintenance->getDbType() === Maintenance::DB_NONE ) {
|
|
if ( $wgLocalisationCacheConf['storeClass'] === false
|
|
&& ( $wgLocalisationCacheConf['store'] == 'db'
|
|
|| ( $wgLocalisationCacheConf['store'] == 'detect' && !$wgCacheDirectory ) )
|
|
) {
|
|
$wgLocalisationCacheConf['storeClass'] = LCStoreNull::class;
|
|
}
|
|
}
|
|
|
|
$maintenance->finalSetup();
|
|
}
|
|
|
|
define( 'MW_SETUP_CALLBACK', 'wfMaintenanceSetup' );
|
|
}
|
|
|
|
require_once "$IP/includes/Setup.php";
|
|
|
|
// Initialize main config instance
|
|
$maintenance->setConfig( MediaWikiServices::getInstance()->getMainConfig() );
|
|
|
|
// Sanity-check required extensions are installed
|
|
$maintenance->checkRequiredExtensions();
|
|
|
|
// A good time when no DBs have writes pending is around lag checks.
|
|
// This avoids having long running scripts just OOM and lose all the updates.
|
|
$maintenance->setAgentAndTriggers();
|
|
|
|
$maintenance->validateParamsAndArgs();
|
|
|
|
// Do the work
|
|
try {
|
|
$success = $maintenance->execute();
|
|
} catch ( Exception $ex ) {
|
|
$success = false;
|
|
$exReportMessage = '';
|
|
while ( $ex ) {
|
|
$cls = get_class( $ex );
|
|
$exReportMessage .= "$cls from line {$ex->getLine()} of {$ex->getFile()}: {$ex->getMessage()}\n";
|
|
$exReportMessage .= $ex->getTraceAsString() . "\n";
|
|
$ex = $ex->getPrevious();
|
|
}
|
|
// Print the exception to stderr if possible, don't mix it in
|
|
// with stdout output.
|
|
if ( defined( 'STDERR' ) ) {
|
|
fwrite( STDERR, $exReportMessage );
|
|
} else {
|
|
echo $exReportMessage;
|
|
}
|
|
}
|
|
|
|
// Potentially debug globals
|
|
$maintenance->globals();
|
|
|
|
$maintenance->shutdown();
|
|
|
|
// Exit with an error status if execute() returned false
|
|
if ( $success === false ) {
|
|
exit( 1 );
|
|
}
|