wiki.techinc.nl/includes/deferred/DeferredUpdatesScopeStack.php
Aaron Schulz 4b7ddd3c67 deferred: make DeferredUpdates::doUpdates() recursion more uniform
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
2021-01-14 15:37:58 -08:00

78 lines
2.3 KiB
PHP

<?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
*/
/**
* DeferredUpdates helper class for tracking DeferrableUpdate::doUpdate() nesting levels
* caused by nested calls to DeferredUpdates::doUpdates()
*
* @internal For use by DeferredUpdates only
* @since 1.36
*/
class DeferredUpdatesScopeStack {
/** @var DeferredUpdatesScope[] Stack of root scope and any recursive scopes */
private $stack;
public function __construct() {
$this->stack = [ DeferredUpdatesScope::newRootScope() ];
}
/**
* @return DeferredUpdatesScope The innermost scope
*/
public function current() {
return $this->stack[count( $this->stack ) - 1];
}
/**
* Make a new child scope, push it onto the stack, and return it
*
* @param int $activeStage The in-progress stage; one of DeferredUpdates::STAGES
* @param DeferrableUpdate $update The deferred update that owns this scope
* @return DeferredUpdatesScope Scope for the case of an in-progress deferred update
*/
public function descend( $activeStage, DeferrableUpdate $update ) {
$scope = DeferredUpdatesScope::newChildScope( $activeStage, $update, $this->current() );
$this->stack[count( $this->stack )] = $scope;
return $scope;
}
/**
* Pop the innermost scope from the stack
*
* @return DeferredUpdatesScope
*/
public function ascend() {
if ( count( $this->stack ) <= 1 ) {
throw new LogicException( "Cannot pop root stack scope; something is out of sync" );
}
return array_pop( $this->stack );
}
/**
* Get the depth of the scope stack below the root scope
*
* @return int
*/
public function getRecursiveDepth() {
return count( $this->stack ) - 1;
}
}