includes/deferred/DeferredUpdates.php

   1 <?php
   2 /**
   3  * Interface and manager for deferred updates.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22 use MediaWiki\MediaWikiServices;
  23
  24 /**
  25  * Class for managing the deferred updates
  26  *
  27  * In web request mode, deferred updates can be run at the end of the request, either before or
  28  * after the HTTP response has been sent. In either case, they run after the DB commit step. If
  29  * an update runs after the response is sent, it will not block clients. If sent before, it will
  30  * run synchronously. These two modes are defined via PRESEND and POSTSEND constants, the latter
  31  * being the default for addUpdate() and addCallableUpdate().
  32  *
  33  * Updates that work through this system will be more likely to complete by the time the client
  34  * makes their next request after this one than with the JobQueue system.
  35  *
  36  * In CLI mode, updates run immediately if no DB writes are pending. Otherwise, they run when:
  37  *   - a) Any waitForReplication() call if no writes are pending on any DB
  38  *   - b) A commit happens on Maintenance::getDB( DB_MASTER ) if no writes are pending on any DB
  39  *   - c) EnqueueableDataUpdate tasks may enqueue on commit of Maintenance::getDB( DB_MASTER )
  40  *   - d) At the completion of Maintenance::execute()
  41  *
  42  * When updates are deferred, they go into one two FIFO "top-queues" (one for pre-send and one
  43  * for post-send). Updates enqueued *during* doUpdate() of a "top" update go into the "sub-queue"
  44  * for that update. After that method finishes, the sub-queue is run until drained. This continues
  45  * for each top-queue job until the entire top queue is drained. This happens for the pre-send
  46  * top-queue, and later on, the post-send top-queue, in execute().
  47  *
  48  * @since 1.19
  49  */
  50 class DeferredUpdates {
  51         /** @var DeferrableUpdate[] Updates to be deferred until before request end */
  52         private static $preSendUpdates = [];
  53         /** @var DeferrableUpdate[] Updates to be deferred until after request end */
  54         private static $postSendUpdates = [];
  55
  56         const ALL = 0; // all updates; in web requests, use only after flushing the output buffer
  57         const PRESEND = 1; // for updates that should run before flushing output buffer
  58         const POSTSEND = 2; // for updates that should run after flushing output buffer
  59
  60         const BIG_QUEUE_SIZE = 100;
  61
  62         /** @var array|null Information about the current execute() call or null if not running */
  63         private static $executeContext;
  64
  65         /**
  66          * Add an update to the deferred list to be run later by execute()
  67          *
  68          * In CLI mode, callback magic will also be used to run updates when safe
  69          *
  70          * @param DeferrableUpdate $update Some object that implements doUpdate()
  71          * @param integer $stage DeferredUpdates constant (PRESEND or POSTSEND) (since 1.27)
  72          */
  73         public static function addUpdate( DeferrableUpdate $update, $stage = self::POSTSEND ) {
  74                 global $wgCommandLineMode;
  75
  76                 // This is a sub-DeferredUpdate, run it right after its parent update
  77                 if ( self::$executeContext && self::$executeContext['stage'] >= $stage ) {
  78                         self::$executeContext['subqueue'][] = $update;
  79                         return;
  80                 }
  81
  82                 if ( $stage === self::PRESEND ) {
  83                         self::push( self::$preSendUpdates, $update );
  84                 } else {
  85                         self::push( self::$postSendUpdates, $update );
  86                 }
  87
  88                 // Try to run the updates now if in CLI mode and no transaction is active.
  89                 // This covers scripts that don't/barely use the DB but make updates to other stores.
  90                 if ( $wgCommandLineMode ) {
  91                         self::tryOpportunisticExecute( 'run' );
  92                 }
  93         }
  94
  95         /**
  96          * Add a callable update. In a lot of cases, we just need a callback/closure,
  97          * defining a new DeferrableUpdate object is not necessary
  98          *
  99          * @see MWCallableUpdate::__construct()
 100          *
 101          * @param callable $callable
 102          * @param integer $stage DeferredUpdates constant (PRESEND or POSTSEND) (since 1.27)
 103          * @param IDatabase|null $dbw Abort if this DB is rolled back [optional] (since 1.28)
 104          */
 105         public static function addCallableUpdate(
 106                 $callable, $stage = self::POSTSEND, IDatabase $dbw = null
 107         ) {
 108                 self::addUpdate( new MWCallableUpdate( $callable, wfGetCaller(), $dbw ), $stage );
 109         }
 110
 111         /**
 112          * Do any deferred updates and clear the list
 113          *
 114          * @param string $mode Use "enqueue" to use the job queue when possible [Default: "run"]
 115          * @param integer $stage DeferredUpdates constant (PRESEND, POSTSEND, or ALL) (since 1.27)
 116          */
 117         public static function doUpdates( $mode = 'run', $stage = self::ALL ) {
 118                 $stageEffective = ( $stage === self::ALL ) ? self::POSTSEND : $stage;
 119
 120                 if ( $stage === self::ALL || $stage === self::PRESEND ) {
 121                         self::execute( self::$preSendUpdates, $mode, $stageEffective );
 122                 }
 123
 124                 if ( $stage === self::ALL || $stage == self::POSTSEND ) {
 125                         self::execute( self::$postSendUpdates, $mode, $stageEffective );
 126                 }
 127         }
 128
 129         /**
 130          * @param DeferrableUpdate[] $queue
 131          * @param DeferrableUpdate $update
 132          */
 133         private static function push( array &$queue, DeferrableUpdate $update ) {
 134                 if ( $update instanceof MergeableUpdate ) {
 135                         $class = get_class( $update ); // fully-qualified class
 136                         if ( isset( $queue[$class] ) ) {
 137                                 /** @var $existingUpdate MergeableUpdate */
 138                                 $existingUpdate = $queue[$class];
 139                                 $existingUpdate->merge( $update );
 140                         } else {
 141                                 $queue[$class] = $update;
 142                         }
 143                 } else {
 144                         $queue[] = $update;
 145                 }
 146         }
 147
 148         /**
 149          * Immediately run/queue a list of updates
 150          *
 151          * @param DeferrableUpdate[] &$queue List of DeferrableUpdate objects
 152          * @param string $mode Use "enqueue" to use the job queue when possible
 153          * @param integer $stage Class constant (PRESEND, POSTSEND) (since 1.28)
 154          * @throws ErrorPageError Happens on top-level calls
 155          * @throws Exception Happens on second-level calls
 156          */
 157         protected static function execute( array &$queue, $mode, $stage ) {
 158                 $services = MediaWikiServices::getInstance();
 159                 $stats = $services->getStatsdDataFactory();
 160                 $lbFactory = $services->getDBLoadBalancerFactory();
 161                 $method = RequestContext::getMain()->getRequest()->getMethod();
 162
 163                 $ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__ );
 164
 165                 /** @var ErrorPageError $reportableError */
 166                 $reportableError = null;
 167                 /** @var DeferrableUpdate[] $updates Snapshot of queue */
 168                 $updates = $queue;
 169
 170                 // Keep doing rounds of updates until none get enqueued...
 171                 while ( $updates ) {
 172                         $queue = []; // clear the queue
 173
 174                         if ( $mode === 'enqueue' ) {
 175                                 try {
 176                                         // Push enqueuable updates to the job queue and get the rest
 177                                         $updates = self::enqueueUpdates( $updates );
 178                                 } catch ( Exception $e ) {
 179                                         // Let other updates have a chance to run if this failed
 180                                         MWExceptionHandler::rollbackMasterChangesAndLog( $e );
 181                                 }
 182                         }
 183
 184                         // Order will be DataUpdate followed by generic DeferrableUpdate tasks
 185                         $updatesByType = [ 'data' => [], 'generic' => [] ];
 186                         foreach ( $updates as $du ) {
 187                                 if ( $du instanceof DataUpdate ) {
 188                                         $du->setTransactionTicket( $ticket );
 189                                         $updatesByType['data'][] = $du;
 190                                 } else {
 191                                         $updatesByType['generic'][] = $du;
 192                                 }
 193
 194                                 $name = ( $du instanceof DeferrableCallback )
 195                                         ? get_class( $du ) . '-' . $du->getOrigin()
 196                                         : get_class( $du );
 197                                 $stats->increment( 'deferred_updates.' . $method . '.' . $name );
 198                         }
 199
 200                         // Execute all remaining tasks...
 201                         foreach ( $updatesByType as $updatesForType ) {
 202                                 foreach ( $updatesForType as $update ) {
 203                                         self::$executeContext = [
 204                                                 'update' => $update,
 205                                                 'stage' => $stage,
 206                                                 'subqueue' => []
 207                                         ];
 208                                         /** @var DeferrableUpdate $update */
 209                                         $guiError = self::runUpdate( $update, $lbFactory, $stage );
 210                                         $reportableError = $reportableError ?: $guiError;
 211                                         // Do the subqueue updates for $update until there are none
 212                                         while ( self::$executeContext['subqueue'] ) {
 213                                                 $subUpdate = reset( self::$executeContext['subqueue'] );
 214                                                 $firstKey = key( self::$executeContext['subqueue'] );
 215                                                 unset( self::$executeContext['subqueue'][$firstKey] );
 216
 217                                                 if ( $subUpdate instanceof DataUpdate ) {
 218                                                         $subUpdate->setTransactionTicket( $ticket );
 219                                                 }
 220
 221                                                 $guiError = self::runUpdate( $subUpdate, $lbFactory, $stage );
 222                                                 $reportableError = $reportableError ?: $guiError;
 223                                         }
 224                                         self::$executeContext = null;
 225                                 }
 226                         }
 227
 228                         $updates = $queue; // new snapshot of queue (check for new entries)
 229                 }
 230
 231                 if ( $reportableError ) {
 232                         throw $reportableError; // throw the first of any GUI errors
 233                 }
 234         }
 235
 236         /**
 237          * @param DeferrableUpdate $update
 238          * @param LBFactory $lbFactory
 239          * @param integer $stage
 240          * @return ErrorPageError|null
 241          */
 242         private static function runUpdate( DeferrableUpdate $update, LBFactory $lbFactory, $stage ) {
 243                 $guiError = null;
 244                 try {
 245                         $fnameTrxOwner = get_class( $update ) . '::doUpdate';
 246                         $lbFactory->beginMasterChanges( $fnameTrxOwner );
 247                         $update->doUpdate();
 248                         $lbFactory->commitMasterChanges( $fnameTrxOwner );
 249                 } catch ( Exception $e ) {
 250                         // Reporting GUI exceptions does not work post-send
 251                         if ( $e instanceof ErrorPageError && $stage === self::PRESEND ) {
 252                                 $guiError = $e;
 253                         }
 254                         MWExceptionHandler::rollbackMasterChangesAndLog( $e );
 255                 }
 256
 257                 return $guiError;
 258         }
 259
 260         /**
 261          * Run all deferred updates immediately if there are no DB writes active
 262          *
 263          * If $mode is 'run' but there are busy databates, EnqueueableDataUpdate
 264          * tasks will be enqueued anyway for the sake of progress.
 265          *
 266          * @param string $mode Use "enqueue" to use the job queue when possible
 267          * @return bool Whether updates were allowed to run
 268          * @since 1.28
 269          */
 270         public static function tryOpportunisticExecute( $mode = 'run' ) {
 271                 // execute() loop is already running
 272                 if ( self::$executeContext ) {
 273                         return false;
 274                 }
 275
 276                 // Avoiding running updates without them having outer scope
 277                 if ( !self::getBusyDbConnections() ) {
 278                         self::doUpdates( $mode );
 279                         return true;
 280                 }
 281
 282                 if ( self::pendingUpdatesCount() >= self::BIG_QUEUE_SIZE ) {
 283                         // If we cannot run the updates with outer transaction context, try to
 284                         // at least enqueue all the updates that support queueing to job queue
 285                         self::$preSendUpdates = self::enqueueUpdates( self::$preSendUpdates );
 286                         self::$postSendUpdates = self::enqueueUpdates( self::$postSendUpdates );
 287                 }
 288
 289                 return !self::pendingUpdatesCount();
 290         }
 291
 292         /**
 293          * Enqueue a job for each EnqueueableDataUpdate item and return the other items
 294          *
 295          * @param DeferrableUpdate[] $updates A list of deferred update instances
 296          * @return DeferrableUpdate[] Remaining updates that do not support being queued
 297          */
 298         private static function enqueueUpdates( array $updates ) {
 299                 $remaining = [];
 300
 301                 foreach ( $updates as $update ) {
 302                         if ( $update instanceof EnqueueableDataUpdate ) {
 303                                 $spec = $update->getAsJobSpecification();
 304                                 JobQueueGroup::singleton( $spec['wiki'] )->push( $spec['job'] );
 305                         } else {
 306                                 $remaining[] = $update;
 307                         }
 308                 }
 309
 310                 return $remaining;
 311         }
 312
 313         /**
 314          * @return integer Number of enqueued updates
 315          * @since 1.28
 316          */
 317         public static function pendingUpdatesCount() {
 318                 return count( self::$preSendUpdates ) + count( self::$postSendUpdates );
 319         }
 320
 321         /**
 322          * Clear all pending updates without performing them. Generally, you don't
 323          * want or need to call this. Unit tests need it though.
 324          */
 325         public static function clearPendingUpdates() {
 326                 self::$preSendUpdates = [];
 327                 self::$postSendUpdates = [];
 328         }
 329
 330         /**
 331          * @return IDatabase[] Connection where commit() cannot be called yet
 332          */
 333         private static function getBusyDbConnections() {
 334                 $connsBusy = [];
 335
 336                 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
 337                 $lbFactory->forEachLB( function ( LoadBalancer $lb ) use ( &$connsBusy ) {
 338                         $lb->forEachOpenMasterConnection( function ( IDatabase $conn ) use ( &$connsBusy ) {
 339                                 if ( $conn->writesOrCallbacksPending() || $conn->explicitTrxActive() ) {
 340                                         $connsBusy[] = $conn;
 341                                 }
 342                         } );
 343                 } );
 344
 345                 return $connsBusy;
 346         }
 347 }