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 Wikimedia\Rdbms\IDatabase;
  23 use MediaWiki\MediaWikiServices;
  24 use Wikimedia\Rdbms\LBFactory;
  25 use Wikimedia\Rdbms\LoadBalancer;
  26
  27 /**
  28  * Class for managing the deferred updates
  29  *
  30  * In web request mode, deferred updates can be run at the end of the request, either before or
  31  * after the HTTP response has been sent. In either case, they run after the DB commit step. If
  32  * an update runs after the response is sent, it will not block clients. If sent before, it will
  33  * run synchronously. These two modes are defined via PRESEND and POSTSEND constants, the latter
  34  * being the default for addUpdate() and addCallableUpdate().
  35  *
  36  * Updates that work through this system will be more likely to complete by the time the client
  37  * makes their next request after this one than with the JobQueue system.
  38  *
  39  * In CLI mode, deferred updates will run:
  40  *   - a) During DeferredUpdates::addUpdate if no LBFactory DB handles have writes pending
  41  *   - b) On commit of an LBFactory DB handle if no other such handles have writes pending
  42  *   - c) During an LBFactory::waitForReplication call if no LBFactory DBs have writes pending
  43  *   - d) When the queue is large and an LBFactory DB handle commits (EnqueueableDataUpdate only)
  44  *   - e) At the completion of Maintenance::execute()
  45  *
  46  * @see Maintenance::setLBFactoryTriggers
  47  *
  48  * When updates are deferred, they go into one two FIFO "top-queues" (one for pre-send and one
  49  * for post-send). Updates enqueued *during* doUpdate() of a "top" update go into the "sub-queue"
  50  * for that update. After that method finishes, the sub-queue is run until drained. This continues
  51  * for each top-queue job until the entire top queue is drained. This happens for the pre-send
  52  * top-queue, and later on, the post-send top-queue, in execute().
  53  *
  54  * @since 1.19
  55  */
  56 class DeferredUpdates {
  57         /** @var DeferrableUpdate[] Updates to be deferred until before request end */
  58         private static $preSendUpdates = [];
  59         /** @var DeferrableUpdate[] Updates to be deferred until after request end */
  60         private static $postSendUpdates = [];
  61
  62         const ALL = 0; // all updates; in web requests, use only after flushing the output buffer
  63         const PRESEND = 1; // for updates that should run before flushing output buffer
  64         const POSTSEND = 2; // for updates that should run after flushing output buffer
  65
  66         const BIG_QUEUE_SIZE = 100;
  67
  68         /** @var array|null Information about the current execute() call or null if not running */
  69         private static $executeContext;
  70
  71         /**
  72          * Add an update to the deferred list to be run later by execute()
  73          *
  74          * In CLI mode, callback magic will also be used to run updates when safe
  75          *
  76          * @param DeferrableUpdate $update Some object that implements doUpdate()
  77          * @param int $stage DeferredUpdates constant (PRESEND or POSTSEND) (since 1.27)
  78          */
  79         public static function addUpdate( DeferrableUpdate $update, $stage = self::POSTSEND ) {
  80                 global $wgCommandLineMode;
  81
  82                 if (
  83                         self::$executeContext &&
  84                         self::$executeContext['stage'] >= $stage &&
  85                         !( $update instanceof MergeableUpdate )
  86                 ) {
  87                         // This is a sub-DeferredUpdate; run it right after its parent update.
  88                         // Also, while post-send updates are running, push any "pre-send" jobs to the
  89                         // active post-send queue to make sure they get run this round (or at all).
  90                         self::$executeContext['subqueue'][] = $update;
  91
  92                         return;
  93                 }
  94
  95                 if ( $stage === self::PRESEND ) {
  96                         self::push( self::$preSendUpdates, $update );
  97                 } else {
  98                         self::push( self::$postSendUpdates, $update );
  99                 }
 100
 101                 // Try to run the updates now if in CLI mode and no transaction is active.
 102                 // This covers scripts that don't/barely use the DB but make updates to other stores.
 103                 if ( $wgCommandLineMode ) {
 104                         self::tryOpportunisticExecute( 'run' );
 105                 }
 106         }
 107
 108         /**
 109          * Add a callable update. In a lot of cases, we just need a callback/closure,
 110          * defining a new DeferrableUpdate object is not necessary
 111          *
 112          * @see MWCallableUpdate::__construct()
 113          *
 114          * @param callable $callable
 115          * @param int $stage DeferredUpdates constant (PRESEND or POSTSEND) (since 1.27)
 116          * @param IDatabase|IDatabase[]|null $dbw Abort if this DB is rolled back [optional] (since 1.28)
 117          */
 118         public static function addCallableUpdate(
 119                 $callable, $stage = self::POSTSEND, $dbw = null
 120         ) {
 121                 self::addUpdate( new MWCallableUpdate( $callable, wfGetCaller(), $dbw ), $stage );
 122         }
 123
 124         /**
 125          * Do any deferred updates and clear the list
 126          *
 127          * @param string $mode Use "enqueue" to use the job queue when possible [Default: "run"]
 128          * @param int $stage DeferredUpdates constant (PRESEND, POSTSEND, or ALL) (since 1.27)
 129          */
 130         public static function doUpdates( $mode = 'run', $stage = self::ALL ) {
 131                 $stageEffective = ( $stage === self::ALL ) ? self::POSTSEND : $stage;
 132                 // For ALL mode, make sure that any PRESEND updates added along the way get run.
 133                 // Normally, these use the subqueue, but that isn't true for MergeableUpdate items.
 134                 do {
 135                         if ( $stage === self::ALL || $stage === self::PRESEND ) {
 136                                 self::execute( self::$preSendUpdates, $mode, $stageEffective );
 137                         }
 138
 139                         if ( $stage === self::ALL || $stage == self::POSTSEND ) {
 140                                 self::execute( self::$postSendUpdates, $mode, $stageEffective );
 141                         }
 142                 } while ( $stage === self::ALL && self::$preSendUpdates );
 143         }
 144
 145         /**
 146          * @param DeferrableUpdate[] $queue
 147          * @param DeferrableUpdate $update
 148          */
 149         private static function push( array &$queue, DeferrableUpdate $update ) {
 150                 if ( $update instanceof MergeableUpdate ) {
 151                         $class = get_class( $update ); // fully-qualified class
 152                         if ( isset( $queue[$class] ) ) {
 153                                 /** @var MergeableUpdate $existingUpdate */
 154                                 $existingUpdate = $queue[$class];
 155                                 $existingUpdate->merge( $update );
 156                                 // Move the update to the end to handle things like mergeable purge
 157                                 // updates that might depend on the prior updates in the queue running
 158                                 unset( $queue[$class] );
 159                                 $queue[$class] = $existingUpdate;
 160                         } else {
 161                                 $queue[$class] = $update;
 162                         }
 163                 } else {
 164                         $queue[] = $update;
 165                 }
 166         }
 167
 168         /**
 169          * Immediately run/queue a list of updates
 170          *
 171          * @param DeferrableUpdate[] &$queue List of DeferrableUpdate objects
 172          * @param string $mode Use "enqueue" to use the job queue when possible
 173          * @param int $stage Class constant (PRESEND, POSTSEND) (since 1.28)
 174          * @throws ErrorPageError Happens on top-level calls
 175          * @throws Exception Happens on second-level calls
 176          */
 177         protected static function execute( array &$queue, $mode, $stage ) {
 178                 $services = MediaWikiServices::getInstance();
 179                 $stats = $services->getStatsdDataFactory();
 180                 $lbFactory = $services->getDBLoadBalancerFactory();
 181                 $method = RequestContext::getMain()->getRequest()->getMethod();
 182
 183                 $ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__ );
 184
 185                 /** @var ErrorPageError $reportableError */
 186                 $reportableError = null;
 187                 /** @var DeferrableUpdate[] $updates Snapshot of queue */
 188                 $updates = $queue;
 189
 190                 // Keep doing rounds of updates until none get enqueued...
 191                 while ( $updates ) {
 192                         $queue = []; // clear the queue
 193
 194                         // Order will be DataUpdate followed by generic DeferrableUpdate tasks
 195                         $updatesByType = [ 'data' => [], 'generic' => [] ];
 196                         foreach ( $updates as $du ) {
 197                                 if ( $du instanceof DataUpdate ) {
 198                                         $du->setTransactionTicket( $ticket );
 199                                         $updatesByType['data'][] = $du;
 200                                 } else {
 201                                         $updatesByType['generic'][] = $du;
 202                                 }
 203
 204                                 $name = ( $du instanceof DeferrableCallback )
 205                                         ? get_class( $du ) . '-' . $du->getOrigin()
 206                                         : get_class( $du );
 207                                 $stats->increment( 'deferred_updates.' . $method . '.' . $name );
 208                         }
 209
 210                         // Execute all remaining tasks...
 211                         foreach ( $updatesByType as $updatesForType ) {
 212                                 foreach ( $updatesForType as $update ) {
 213                                         self::$executeContext = [ 'stage' => $stage, 'subqueue' => [] ];
 214                                         try {
 215                                                 /** @var DeferrableUpdate $update */
 216                                                 $guiError = self::runUpdate( $update, $lbFactory, $mode, $stage );
 217                                                 $reportableError = $reportableError ?: $guiError;
 218                                                 // Do the subqueue updates for $update until there are none
 219                                                 while ( self::$executeContext['subqueue'] ) {
 220                                                         $subUpdate = reset( self::$executeContext['subqueue'] );
 221                                                         $firstKey = key( self::$executeContext['subqueue'] );
 222                                                         unset( self::$executeContext['subqueue'][$firstKey] );
 223
 224                                                         if ( $subUpdate instanceof DataUpdate ) {
 225                                                                 $subUpdate->setTransactionTicket( $ticket );
 226                                                         }
 227
 228                                                         $guiError = self::runUpdate( $subUpdate, $lbFactory, $mode, $stage );
 229                                                         $reportableError = $reportableError ?: $guiError;
 230                                                 }
 231                                         } finally {
 232                                                 // Make sure we always clean up the context.
 233                                                 // Losing updates while rewinding the stack is acceptable,
 234                                                 // losing updates that are added later is not.
 235                                                 self::$executeContext = null;
 236                                         }
 237                                 }
 238                         }
 239
 240                         $updates = $queue; // new snapshot of queue (check for new entries)
 241                 }
 242
 243                 if ( $reportableError ) {
 244                         throw $reportableError; // throw the first of any GUI errors
 245                 }
 246         }
 247
 248         /**
 249          * @param DeferrableUpdate $update
 250          * @param LBFactory $lbFactory
 251          * @param string $mode
 252          * @param int $stage
 253          * @return ErrorPageError|null
 254          */
 255         private static function runUpdate(
 256                 DeferrableUpdate $update, LBFactory $lbFactory, $mode, $stage
 257         ) {
 258                 $guiError = null;
 259                 try {
 260                         if ( $mode === 'enqueue' && $update instanceof EnqueueableDataUpdate ) {
 261                                 // Run only the job enqueue logic to complete the update later
 262                                 $spec = $update->getAsJobSpecification();
 263                                 JobQueueGroup::singleton( $spec['wiki'] )->push( $spec['job'] );
 264                         } elseif ( $update instanceof TransactionRoundDefiningUpdate ) {
 265                                 $update->doUpdate();
 266                         } else {
 267                                 // Run the bulk of the update now
 268                                 $fnameTrxOwner = get_class( $update ) . '::doUpdate';
 269                                 $lbFactory->beginMasterChanges( $fnameTrxOwner );
 270                                 $update->doUpdate();
 271                                 $lbFactory->commitMasterChanges( $fnameTrxOwner );
 272                         }
 273                 } catch ( Exception $e ) {
 274                         // Reporting GUI exceptions does not work post-send
 275                         if ( $e instanceof ErrorPageError && $stage === self::PRESEND ) {
 276                                 $guiError = $e;
 277                         }
 278                         MWExceptionHandler::rollbackMasterChangesAndLog( $e );
 279
 280                         // VW-style hack to work around T190178, so we can make sure
 281                         // PageMetaDataUpdater doesn't throw exceptions.
 282                         if ( defined( 'MW_PHPUNIT_TEST' ) ) {
 283                                 throw $e;
 284                         }
 285                 }
 286
 287                 return $guiError;
 288         }
 289
 290         /**
 291          * Run all deferred updates immediately if there are no DB writes active
 292          *
 293          * If there are many deferred updates pending, $mode is 'run', and there
 294          * are still busy LBFactory database handles, then any EnqueueableDataUpdate
 295          * tasks might be enqueued as jobs to be executed later.
 296          *
 297          * @param string $mode Use "enqueue" to use the job queue when possible
 298          * @return bool Whether updates were allowed to run
 299          * @since 1.28
 300          */
 301         public static function tryOpportunisticExecute( $mode = 'run' ) {
 302                 // execute() loop is already running
 303                 if ( self::$executeContext ) {
 304                         return false;
 305                 }
 306
 307                 // Avoiding running updates without them having outer scope
 308                 if ( !self::areDatabaseTransactionsActive() ) {
 309                         self::doUpdates( $mode );
 310                         return true;
 311                 }
 312
 313                 if ( self::pendingUpdatesCount() >= self::BIG_QUEUE_SIZE ) {
 314                         // If we cannot run the updates with outer transaction context, try to
 315                         // at least enqueue all the updates that support queueing to job queue
 316                         self::$preSendUpdates = self::enqueueUpdates( self::$preSendUpdates );
 317                         self::$postSendUpdates = self::enqueueUpdates( self::$postSendUpdates );
 318                 }
 319
 320                 return !self::pendingUpdatesCount();
 321         }
 322
 323         /**
 324          * Enqueue a job for each EnqueueableDataUpdate item and return the other items
 325          *
 326          * @param DeferrableUpdate[] $updates A list of deferred update instances
 327          * @return DeferrableUpdate[] Remaining updates that do not support being queued
 328          */
 329         private static function enqueueUpdates( array $updates ) {
 330                 $remaining = [];
 331
 332                 foreach ( $updates as $update ) {
 333                         if ( $update instanceof EnqueueableDataUpdate ) {
 334                                 $spec = $update->getAsJobSpecification();
 335                                 JobQueueGroup::singleton( $spec['wiki'] )->push( $spec['job'] );
 336                         } else {
 337                                 $remaining[] = $update;
 338                         }
 339                 }
 340
 341                 return $remaining;
 342         }
 343
 344         /**
 345          * @return int Number of enqueued updates
 346          * @since 1.28
 347          */
 348         public static function pendingUpdatesCount() {
 349                 return count( self::$preSendUpdates ) + count( self::$postSendUpdates );
 350         }
 351
 352         /**
 353          * @param int $stage DeferredUpdates constant (PRESEND, POSTSEND, or ALL)
 354          * @return DeferrableUpdate[]
 355          * @since 1.29
 356          */
 357         public static function getPendingUpdates( $stage = self::ALL ) {
 358                 $updates = [];
 359                 if ( $stage === self::ALL || $stage === self::PRESEND ) {
 360                         $updates = array_merge( $updates, self::$preSendUpdates );
 361                 }
 362                 if ( $stage === self::ALL || $stage === self::POSTSEND ) {
 363                         $updates = array_merge( $updates, self::$postSendUpdates );
 364                 }
 365                 return $updates;
 366         }
 367
 368         /**
 369          * Clear all pending updates without performing them. Generally, you don't
 370          * want or need to call this. Unit tests need it though.
 371          */
 372         public static function clearPendingUpdates() {
 373                 self::$preSendUpdates = [];
 374                 self::$postSendUpdates = [];
 375         }
 376
 377         /**
 378          * @return bool If a transaction round is active or connection is not ready for commit()
 379          */
 380         private static function areDatabaseTransactionsActive() {
 381                 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
 382                 if ( $lbFactory->hasTransactionRound() || !$lbFactory->isReadyForRoundOperations() ) {
 383                         return true;
 384                 }
 385
 386                 $connsBusy = false;
 387                 $lbFactory->forEachLB( function ( LoadBalancer $lb ) use ( &$connsBusy ) {
 388                         $lb->forEachOpenMasterConnection( function ( IDatabase $conn ) use ( &$connsBusy ) {
 389                                 if ( $conn->writesOrCallbacksPending() || $conn->explicitTrxActive() ) {
 390                                         $connsBusy = true;
 391                                 }
 392                         } );
 393                 } );
 394
 395                 return $connsBusy;
 396         }
 397 }