Do not start explicit transaction rounds for RecentChangesUpdateJob
authorAaron Schulz <aschulz@wikimedia.org>
Mon, 16 Apr 2018 20:38:01 +0000 (13:38 -0700)
committerAaron Schulz <aschulz@wikimedia.org>
Tue, 17 Apr 2018 12:39:05 +0000 (12:39 +0000)
The replaces the hacky use of onTransactionIdle(), which no longer runs
immediately in explicit transaction rounds since d4c31cf841.

Also clarified TransactionRoundDefiningUpdate comment about rounds.

Change-Id: Ie17eacdcaea4e47019cc94e1c7beed9d7fec5cf2

includes/deferred/TransactionRoundDefiningUpdate.php
includes/jobqueue/Job.php
includes/jobqueue/JobRunner.php
includes/jobqueue/jobs/RecentChangesUpdateJob.php

index 65baec5..a32d4a0 100644 (file)
@@ -1,8 +1,7 @@
 <?php
 
 /**
- * Deferrable update for closure/callback updates that need LBFactory and Database
- * to be outside any active transaction round.
+ * Deferrable update that must run outside of any explicit LBFactory transaction round
  *
  * @since 1.31
  */
index 8508861..f9c416f 100644 (file)
@@ -50,6 +50,12 @@ abstract class Job implements IJobSpecification {
        /** @var callable[] */
        protected $teardownCallbacks = [];
 
+       /** @var int Bitfield of JOB_* class constants */
+       protected $executionFlags = 0;
+
+       /** @var int Job must not be wrapped in the usual explicit LBFactory transaction round */
+       const JOB_NO_EXPLICIT_TRX_ROUND = 1;
+
        /**
         * Run the job
         * @return bool Success
@@ -108,6 +114,15 @@ abstract class Job implements IJobSpecification {
                }
        }
 
+       /**
+        * @param int $flag JOB_* class constant
+        * @return bool
+        * @since 1.31
+        */
+       public function hasExecutionFlag( $flag ) {
+               return ( $this->executionFlags && $flag ) === $flag;
+       }
+
        /**
         * Batch-insert a group of jobs into the queue.
         * This will be wrapped in a transaction with a forced commit.
index fa7d605..977fbda 100644 (file)
@@ -290,7 +290,9 @@ class JobRunner implements LoggerAwareInterface {
                $jobStartTime = microtime( true );
                try {
                        $fnameTrxOwner = get_class( $job ) . '::run'; // give run() outer scope
-                       $lbFactory->beginMasterChanges( $fnameTrxOwner );
+                       if ( !$job->hasExecutionFlag( $job::JOB_NO_EXPLICIT_TRX_ROUND ) ) {
+                               $lbFactory->beginMasterChanges( $fnameTrxOwner );
+                       }
                        $status = $job->run();
                        $error = $job->getLastError();
                        $this->commitMasterChanges( $lbFactory, $job, $fnameTrxOwner );
index 77daca7..8f50828 100644 (file)
@@ -35,6 +35,7 @@ class RecentChangesUpdateJob extends Job {
                        throw new Exception( "Missing 'type' parameter." );
                }
 
+               $this->executionFlags |= self::JOB_NO_EXPLICIT_TRX_ROUND;
                $this->removeDuplicates = true;
        }
 
@@ -127,124 +128,118 @@ class RecentChangesUpdateJob extends Job {
                $window = $wgActiveUserDays * 86400;
 
                $dbw = wfGetDB( DB_MASTER );
-               // JobRunner uses DBO_TRX, but doesn't call begin/commit itself;
-               // onTransactionIdle() will run immediately since there is no trx.
-               $dbw->onTransactionIdle(
-                       function () use ( $dbw, $days, $window ) {
-                               $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
-                               $ticket = $factory->getEmptyTransactionTicket( __METHOD__ );
-                               // Avoid disconnect/ping() cycle that makes locks fall off
-                               $dbw->setSessionOptions( [ 'connTimeout' => 900 ] );
-
-                               $lockKey = wfWikiID() . '-activeusers';
-                               if ( !$dbw->lock( $lockKey, __METHOD__, 0 ) ) {
-                                       // Exclusive update (avoids duplicate entries)… it's usually fine to just drop out here,
-                                       // if the Job is already running.
-                                       return;
-                               }
+               $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
+               $ticket = $factory->getEmptyTransactionTicket( __METHOD__ );
 
-                               $nowUnix = time();
-                               // Get the last-updated timestamp for the cache
-                               $cTime = $dbw->selectField( 'querycache_info',
-                                       'qci_timestamp',
-                                       [ 'qci_type' => 'activeusers' ]
-                               );
-                               $cTimeUnix = $cTime ? wfTimestamp( TS_UNIX, $cTime ) : 1;
-
-                               // Pick the date range to fetch from. This is normally from the last
-                               // update to till the present time, but has a limited window for sanity.
-                               // If the window is limited, multiple runs are need to fully populate it.
-                               $sTimestamp = max( $cTimeUnix, $nowUnix - $days * 86400 );
-                               $eTimestamp = min( $sTimestamp + $window, $nowUnix );
-
-                               // Get all the users active since the last update
-                               $actorQuery = ActorMigration::newMigration()->getJoin( 'rc_user' );
-                               $res = $dbw->select(
-                                       [ 'recentchanges' ] + $actorQuery['tables'],
-                                       [
-                                               'rc_user_text' => $actorQuery['fields']['rc_user_text'],
-                                               'lastedittime' => 'MAX(rc_timestamp)'
-                                       ],
-                                       [
-                                               $actorQuery['fields']['rc_user'] . ' > 0', // actual accounts
-                                               'rc_type != ' . $dbw->addQuotes( RC_EXTERNAL ), // no wikidata
-                                               'rc_log_type IS NULL OR rc_log_type != ' . $dbw->addQuotes( 'newusers' ),
-                                               'rc_timestamp >= ' . $dbw->addQuotes( $dbw->timestamp( $sTimestamp ) ),
-                                               'rc_timestamp <= ' . $dbw->addQuotes( $dbw->timestamp( $eTimestamp ) )
-                                       ],
-                                       __METHOD__,
-                                       [
-                                               'GROUP BY' => [ 'rc_user_text' ],
-                                               'ORDER BY' => 'NULL' // avoid filesort
-                                       ],
-                                       $actorQuery['joins']
-                               );
-                               $names = [];
-                               foreach ( $res as $row ) {
-                                       $names[$row->rc_user_text] = $row->lastedittime;
-                               }
+               $lockKey = wfWikiID() . '-activeusers';
+               if ( !$dbw->lock( $lockKey, __METHOD__, 0 ) ) {
+                       // Exclusive update (avoids duplicate entries)… it's usually fine to just
+                       // drop out here, if the Job is already running.
+                       return;
+               }
 
-                               // Find which of the recently active users are already accounted for
-                               if ( count( $names ) ) {
-                                       $res = $dbw->select( 'querycachetwo',
-                                               [ 'user_name' => 'qcc_title' ],
-                                               [
-                                                       'qcc_type' => 'activeusers',
-                                                       'qcc_namespace' => NS_USER,
-                                                       'qcc_title' => array_keys( $names ),
-                                                       'qcc_value >= ' . $dbw->addQuotes( $nowUnix - $days * 86400 ), // TS_UNIX
-                                                ],
-                                               __METHOD__
-                                       );
-                                       // Note: In order for this to be actually consistent, we would need
-                                       // to update these rows with the new lastedittime.
-                                       foreach ( $res as $row ) {
-                                               unset( $names[$row->user_name] );
-                                       }
-                               }
+               // Long-running queries expected
+               $dbw->setSessionOptions( [ 'connTimeout' => 900 ] );
 
-                               // Insert the users that need to be added to the list
-                               if ( count( $names ) ) {
-                                       $newRows = [];
-                                       foreach ( $names as $name => $lastEditTime ) {
-                                               $newRows[] = [
-                                                       'qcc_type' => 'activeusers',
-                                                       'qcc_namespace' => NS_USER,
-                                                       'qcc_title' => $name,
-                                                       'qcc_value' => wfTimestamp( TS_UNIX, $lastEditTime ),
-                                                       'qcc_namespacetwo' => 0, // unused
-                                                       'qcc_titletwo' => '' // unused
-                                               ];
-                                       }
-                                       foreach ( array_chunk( $newRows, 500 ) as $rowBatch ) {
-                                               $dbw->insert( 'querycachetwo', $rowBatch, __METHOD__ );
-                                               $factory->commitAndWaitForReplication( __METHOD__, $ticket );
-                                       }
-                               }
+               $nowUnix = time();
+               // Get the last-updated timestamp for the cache
+               $cTime = $dbw->selectField( 'querycache_info',
+                       'qci_timestamp',
+                       [ 'qci_type' => 'activeusers' ]
+               );
+               $cTimeUnix = $cTime ? wfTimestamp( TS_UNIX, $cTime ) : 1;
+
+               // Pick the date range to fetch from. This is normally from the last
+               // update to till the present time, but has a limited window for sanity.
+               // If the window is limited, multiple runs are need to fully populate it.
+               $sTimestamp = max( $cTimeUnix, $nowUnix - $days * 86400 );
+               $eTimestamp = min( $sTimestamp + $window, $nowUnix );
+
+               // Get all the users active since the last update
+               $actorQuery = ActorMigration::newMigration()->getJoin( 'rc_user' );
+               $res = $dbw->select(
+                       [ 'recentchanges' ] + $actorQuery['tables'],
+                       [
+                               'rc_user_text' => $actorQuery['fields']['rc_user_text'],
+                               'lastedittime' => 'MAX(rc_timestamp)'
+                       ],
+                       [
+                               $actorQuery['fields']['rc_user'] . ' > 0', // actual accounts
+                               'rc_type != ' . $dbw->addQuotes( RC_EXTERNAL ), // no wikidata
+                               'rc_log_type IS NULL OR rc_log_type != ' . $dbw->addQuotes( 'newusers' ),
+                               'rc_timestamp >= ' . $dbw->addQuotes( $dbw->timestamp( $sTimestamp ) ),
+                               'rc_timestamp <= ' . $dbw->addQuotes( $dbw->timestamp( $eTimestamp ) )
+                       ],
+                       __METHOD__,
+                       [
+                               'GROUP BY' => [ 'rc_user_text' ],
+                               'ORDER BY' => 'NULL' // avoid filesort
+                       ],
+                       $actorQuery['joins']
+               );
+               $names = [];
+               foreach ( $res as $row ) {
+                       $names[$row->rc_user_text] = $row->lastedittime;
+               }
+
+               // Find which of the recently active users are already accounted for
+               if ( count( $names ) ) {
+                       $res = $dbw->select( 'querycachetwo',
+                               [ 'user_name' => 'qcc_title' ],
+                               [
+                                       'qcc_type' => 'activeusers',
+                                       'qcc_namespace' => NS_USER,
+                                       'qcc_title' => array_keys( $names ),
+                                       'qcc_value >= ' . $dbw->addQuotes( $nowUnix - $days * 86400 ), // TS_UNIX
+                                ],
+                               __METHOD__
+                       );
+                       // Note: In order for this to be actually consistent, we would need
+                       // to update these rows with the new lastedittime.
+                       foreach ( $res as $row ) {
+                               unset( $names[$row->user_name] );
+                       }
+               }
+
+               // Insert the users that need to be added to the list
+               if ( count( $names ) ) {
+                       $newRows = [];
+                       foreach ( $names as $name => $lastEditTime ) {
+                               $newRows[] = [
+                                       'qcc_type' => 'activeusers',
+                                       'qcc_namespace' => NS_USER,
+                                       'qcc_title' => $name,
+                                       'qcc_value' => wfTimestamp( TS_UNIX, $lastEditTime ),
+                                       'qcc_namespacetwo' => 0, // unused
+                                       'qcc_titletwo' => '' // unused
+                               ];
+                       }
+                       foreach ( array_chunk( $newRows, 500 ) as $rowBatch ) {
+                               $dbw->insert( 'querycachetwo', $rowBatch, __METHOD__ );
+                               $factory->commitAndWaitForReplication( __METHOD__, $ticket );
+                       }
+               }
+
+               // If a transaction was already started, it might have an old
+               // snapshot, so kludge the timestamp range back as needed.
+               $asOfTimestamp = min( $eTimestamp, (int)$dbw->trxTimestamp() );
+
+               // Touch the data freshness timestamp
+               $dbw->replace( 'querycache_info',
+                       [ 'qci_type' ],
+                       [ 'qci_type' => 'activeusers',
+                               'qci_timestamp' => $dbw->timestamp( $asOfTimestamp ) ], // not always $now
+                       __METHOD__
+               );
+
+               $dbw->unlock( $lockKey, __METHOD__ );
 
-                               // If a transaction was already started, it might have an old
-                               // snapshot, so kludge the timestamp range back as needed.
-                               $asOfTimestamp = min( $eTimestamp, (int)$dbw->trxTimestamp() );
-
-                               // Touch the data freshness timestamp
-                               $dbw->replace( 'querycache_info',
-                                       [ 'qci_type' ],
-                                       [ 'qci_type' => 'activeusers',
-                                               'qci_timestamp' => $dbw->timestamp( $asOfTimestamp ) ], // not always $now
-                                       __METHOD__
-                               );
-
-                               $dbw->unlock( $lockKey, __METHOD__ );
-
-                               // Rotate out users that have not edited in too long (according to old data set)
-                               $dbw->delete( 'querycachetwo',
-                                       [
-                                               'qcc_type' => 'activeusers',
-                                               'qcc_value < ' . $dbw->addQuotes( $nowUnix - $days * 86400 ) // TS_UNIX
-                                       ],
-                                       __METHOD__
-                               );
-                       },
+               // Rotate out users that have not edited in too long (according to old data set)
+               $dbw->delete( 'querycachetwo',
+                       [
+                               'qcc_type' => 'activeusers',
+                               'qcc_value < ' . $dbw->addQuotes( $nowUnix - $days * 86400 ) // TS_UNIX
+                       ],
                        __METHOD__
                );
        }