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 ( self::$executeContext && self::$executeContext['stage'] >= $stage ) {
  83                         // This is a sub-DeferredUpdate; run it right after its parent update.
  84                         // Also, while post-send updates are running, push any "pre-send" jobs to the
  85                         // active post-send queue to make sure they get run this round (or at all).
  86                         self::$executeContext['subqueue'][] = $update;
  87
  88                         return;
  89                 }
  90
  91                 if ( $stage === self::PRESEND ) {
  92                         self::push( self::$preSendUpdates, $update );
  93                 } else {
  94                         self::push( self::$postSendUpdates, $update );
  95                 }
  96
  97                 // Try to run the updates now if in CLI mode and no transaction is active.
  98                 // This covers scripts that don't/barely use the DB but make updates to other stores.
  99                 if ( $wgCommandLineMode ) {
 100                         self::tryOpportunisticExecute( 'run' );
 101                 }
 102         }
 103
 104         /**
 105          * Add a callable update. In a lot of cases, we just need a callback/closure,
 106          * defining a new DeferrableUpdate object is not necessary
 107          *
 108          * @see MWCallableUpdate::__construct()
 109          *
 110          * @param callable $callable
 111          * @param int $stage DeferredUpdates constant (PRESEND or POSTSEND) (since 1.27)
 112          * @param IDatabase|IDatabase[]|null $dbw Abort if this DB is rolled back [optional] (since 1.28)
 113          */
 114         public static function addCallableUpdate(
 115                 $callable, $stage = self::POSTSEND, $dbw = null
 116         ) {
 117                 self::addUpdate( new MWCallableUpdate( $callable, wfGetCaller(), $dbw ), $stage );
 118         }
 119
 120         /**
 121          * Do any deferred updates and clear the list
 122          *
 123          * @param string $mode Use "enqueue" to use the job queue when possible [Default: "run"]
 124          * @param int $stage DeferredUpdates constant (PRESEND, POSTSEND, or ALL) (since 1.27)
 125          */
 126         public static function doUpdates( $mode = 'run', $stage = self::ALL ) {
 127                 $stageEffective = ( $stage === self::ALL ) ? self::POSTSEND : $stage;
 128
 129                 if ( $stage === self::ALL || $stage === self::PRESEND ) {
 130                         self::execute( self::$preSendUpdates, $mode, $stageEffective );
 131                 }
 132
 133                 if ( $stage === self::ALL || $stage == self::POSTSEND ) {
 134                         self::execute( self::$postSendUpdates, $mode, $stageEffective );
 135                 }
 136         }
 137
 138         /**
 139          * @param DeferrableUpdate[] $queue
 140          * @param DeferrableUpdate $update
 141          */
 142         private static function push( array &$queue, DeferrableUpdate $update ) {
 143                 if ( $update instanceof MergeableUpdate ) {
 144                         $class = get_class( $update ); // fully-qualified class
 145                         if ( isset( $queue[$class] ) ) {
 146                                 /** @var MergeableUpdate $existingUpdate */
 147                                 $existingUpdate = $queue[$class];
 148                                 $existingUpdate->merge( $update );
 149                         } else {
 150                                 $queue[$class] = $update;
 151                         }
 152                 } else {
 153                         $queue[] = $update;
 154                 }
 155         }
 156
 157         /**
 158          * Immediately run/queue a list of updates
 159          *
 160          * @param DeferrableUpdate[] &$queue List of DeferrableUpdate objects
 161          * @param string $mode Use "enqueue" to use the job queue when possible
 162          * @param int $stage Class constant (PRESEND, POSTSEND) (since 1.28)
 163          * @throws ErrorPageError Happens on top-level calls
 164          * @throws Exception Happens on second-level calls
 165          */
 166         protected static function execute( array &$queue, $mode, $stage ) {
 167                 $services = MediaWikiServices::getInstance();
 168                 $stats = $services->getStatsdDataFactory();
 169                 $lbFactory = $services->getDBLoadBalancerFactory();
 170                 $method = RequestContext::getMain()->getRequest()->getMethod();
 171
 172                 $ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__ );
 173
 174                 /** @var ErrorPageError $reportableError */
 175                 $reportableError = null;
 176                 /** @var DeferrableUpdate[] $updates Snapshot of queue */
 177                 $updates = $queue;
 178
 179                 // Keep doing rounds of updates until none get enqueued...
 180                 while ( $updates ) {
 181                         $queue = []; // clear the queue
 182
 183                         // Order will be DataUpdate followed by generic DeferrableUpdate tasks
 184                         $updatesByType = [ 'data' => [], 'generic' => [] ];
 185                         foreach ( $updates as $du ) {
 186                                 if ( $du instanceof DataUpdate ) {
 187                                         $du->setTransactionTicket( $ticket );
 188                                         $updatesByType['data'][] = $du;
 189                                 } else {
 190                                         $updatesByType['generic'][] = $du;
 191                                 }
 192
 193                                 $name = ( $du instanceof DeferrableCallback )
 194                                         ? get_class( $du ) . '-' . $du->getOrigin()
 195                                         : get_class( $du );
 196                                 $stats->increment( 'deferred_updates.' . $method . '.' . $name );
 197                         }
 198
 199                         // Execute all remaining tasks...
 200                         foreach ( $updatesByType as $updatesForType ) {
 201                                 foreach ( $updatesForType as $update ) {
 202                                         self::$executeContext = [ 'stage' => $stage, 'subqueue' => [] ];
 203                                         try {
 204                                                 /** @var DeferrableUpdate $update */
 205                                                 $guiError = self::runUpdate( $update, $lbFactory, $mode, $stage );
 206                                                 $reportableError = $reportableError ?: $guiError;
 207                                                 // Do the subqueue updates for $update until there are none
 208                                                 while ( self::$executeContext['subqueue'] ) {
 209                                                         $subUpdate = reset( self::$executeContext['subqueue'] );
 210                                                         $firstKey = key( self::$executeContext['subqueue'] );
 211                                                         unset( self::$executeContext['subqueue'][$firstKey] );
 212
 213                                                         if ( $subUpdate instanceof DataUpdate ) {
 214                                                                 $subUpdate->setTransactionTicket( $ticket );
 215                                                         }
 216
 217                                                         $guiError = self::runUpdate( $subUpdate, $lbFactory, $mode, $stage );
 218                                                         $reportableError = $reportableError ?: $guiError;
 219                                                 }
 220                                         } finally {
 221                                                 // Make sure we always clean up the context.
 222                                                 // Losing updates while rewinding the stack is acceptable,
 223                                                 // losing updates that are added later is not.
 224                                                 self::$executeContext = null;
 225                                         }
 226                                 }
 227                         }
 228
 229                         $updates = $queue; // new snapshot of queue (check for new entries)
 230                 }
 231
 232                 if ( $reportableError ) {
 233                         throw $reportableError; // throw the first of any GUI errors
 234                 }
 235         }
 236
 237         /**
 238          * @param DeferrableUpdate $update
 239          * @param LBFactory $lbFactory
 240          * @param string $mode
 241          * @param int $stage
 242          * @return ErrorPageError|null
 243          */
 244         private static function runUpdate(
 245                 DeferrableUpdate $update, LBFactory $lbFactory, $mode, $stage
 246         ) {
 247                 $guiError = null;
 248                 try {
 249                         if ( $mode === 'enqueue' && $update instanceof EnqueueableDataUpdate ) {
 250                                 // Run only the job enqueue logic to complete the update later
 251                                 $spec = $update->getAsJobSpecification();
 252                                 JobQueueGroup::singleton( $spec['wiki'] )->push( $spec['job'] );
 253                         } elseif ( $update instanceof TransactionRoundDefiningUpdate ) {
 254                                 $update->doUpdate();
 255                         } else {
 256                                 // Run the bulk of the update now
 257                                 $fnameTrxOwner = get_class( $update ) . '::doUpdate';
 258                                 $lbFactory->beginMasterChanges( $fnameTrxOwner );
 259                                 $update->doUpdate();
 260                                 $lbFactory->commitMasterChanges( $fnameTrxOwner );
 261                         }
 262                 } catch ( Exception $e ) {
 263                         // Reporting GUI exceptions does not work post-send
 264                         if ( $e instanceof ErrorPageError && $stage === self::PRESEND ) {
 265                                 $guiError = $e;
 266                         }
 267                         MWExceptionHandler::rollbackMasterChangesAndLog( $e );
 268
 269                         // VW-style hack to work around T190178, so we can make sure
 270                         // PageMetaDataUpdater doesn't throw exceptions.
 271                         if ( defined( 'MW_PHPUNIT_TEST' ) ) {
 272                                 throw $e;
 273                         }
 274                 }
 275
 276                 return $guiError;
 277         }
 278
 279         /**
 280          * Run all deferred updates immediately if there are no DB writes active
 281          *
 282          * If there are many deferred updates pending, $mode is 'run', and there
 283          * are still busy LBFactory database handles, then any EnqueueableDataUpdate
 284          * tasks might be enqueued as jobs to be executed later.
 285          *
 286          * @param string $mode Use "enqueue" to use the job queue when possible
 287          * @return bool Whether updates were allowed to run
 288          * @since 1.28
 289          */
 290         public static function tryOpportunisticExecute( $mode = 'run' ) {
 291                 // execute() loop is already running
 292                 if ( self::$executeContext ) {
 293                         return false;
 294                 }
 295
 296                 // Avoiding running updates without them having outer scope
 297                 if ( !self::areDatabaseTransactionsActive() ) {
 298                         self::doUpdates( $mode );
 299                         return true;
 300                 }
 301
 302                 if ( self::pendingUpdatesCount() >= self::BIG_QUEUE_SIZE ) {
 303                         // If we cannot run the updates with outer transaction context, try to
 304                         // at least enqueue all the updates that support queueing to job queue
 305                         self::$preSendUpdates = self::enqueueUpdates( self::$preSendUpdates );
 306                         self::$postSendUpdates = self::enqueueUpdates( self::$postSendUpdates );
 307                 }
 308
 309                 return !self::pendingUpdatesCount();
 310         }
 311
 312         /**
 313          * Enqueue a job for each EnqueueableDataUpdate item and return the other items
 314          *
 315          * @param DeferrableUpdate[] $updates A list of deferred update instances
 316          * @return DeferrableUpdate[] Remaining updates that do not support being queued
 317          */
 318         private static function enqueueUpdates( array $updates ) {
 319                 $remaining = [];
 320
 321                 foreach ( $updates as $update ) {
 322                         if ( $update instanceof EnqueueableDataUpdate ) {
 323                                 $spec = $update->getAsJobSpecification();
 324                                 JobQueueGroup::singleton( $spec['wiki'] )->push( $spec['job'] );
 325                         } else {
 326                                 $remaining[] = $update;
 327                         }
 328                 }
 329
 330                 return $remaining;
 331         }
 332
 333         /**
 334          * @return int Number of enqueued updates
 335          * @since 1.28
 336          */
 337         public static function pendingUpdatesCount() {
 338                 return count( self::$preSendUpdates ) + count( self::$postSendUpdates );
 339         }
 340
 341         /**
 342          * @param int $stage DeferredUpdates constant (PRESEND, POSTSEND, or ALL)
 343          * @return DeferrableUpdate[]
 344          * @since 1.29
 345          */
 346         public static function getPendingUpdates( $stage = self::ALL ) {
 347                 $updates = [];
 348                 if ( $stage === self::ALL || $stage === self::PRESEND ) {
 349                         $updates = array_merge( $updates, self::$preSendUpdates );
 350                 }
 351                 if ( $stage === self::ALL || $stage === self::POSTSEND ) {
 352                         $updates = array_merge( $updates, self::$postSendUpdates );
 353                 }
 354                 return $updates;
 355         }
 356
 357         /**
 358          * Clear all pending updates without performing them. Generally, you don't
 359          * want or need to call this. Unit tests need it though.
 360          */
 361         public static function clearPendingUpdates() {
 362                 self::$preSendUpdates = [];
 363                 self::$postSendUpdates = [];
 364         }
 365
 366         /**
 367          * @return bool If a transaction round is active or connection is not ready for commit()
 368          */
 369         private static function areDatabaseTransactionsActive() {
 370                 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
 371                 if ( $lbFactory->hasTransactionRound() || !$lbFactory->isReadyForRoundOperations() ) {
 372                         return true;
 373                 }
 374
 375                 $connsBusy = false;
 376                 $lbFactory->forEachLB( function ( LoadBalancer $lb ) use ( &$connsBusy ) {
 377                         $lb->forEachOpenMasterConnection( function ( IDatabase $conn ) use ( &$connsBusy ) {
 378                                 if ( $conn->writesOrCallbacksPending() || $conn->explicitTrxActive() ) {
 379                                         $connsBusy = true;
 380                                 }
 381                         } );
 382                 } );
 383
 384                 return $connsBusy;
 385         }
 386 }