3 * Redis-backed job queue code.
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.
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.
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
21 * @author Aaron Schulz
25 * Class to handle job queues stored in Redis
27 * This is a faster and less resource-intensive job queue than JobQueueDB.
28 * All data for a queue using this class is placed into one redis server.
30 * There are eight main redis keys used to track jobs:
31 * - l-unclaimed : A list of job IDs used for ready unclaimed jobs
32 * - z-claimed : A sorted set of (job ID, UNIX timestamp as score) used for job retries
33 * - z-abandoned : A sorted set of (job ID, UNIX timestamp as score) used for broken jobs
34 * - z-delayed : A sorted set of (job ID, UNIX timestamp as score) used for delayed jobs
35 * - h-idBySha1 : A hash of (SHA1 => job ID) for unclaimed jobs used for de-duplication
36 * - h-sha1ById : A hash of (job ID => SHA1) for unclaimed jobs used for de-duplication
37 * - h-attempts : A hash of (job ID => attempt count) used for job claiming/retries
38 * - h-data : A hash of (job ID => serialized blobs) for job storage
39 * A job ID can be in only one of z-delayed, l-unclaimed, z-claimed, and z-abandoned.
40 * If an ID appears in any of those lists, it should have a h-data entry for its ID.
41 * If a job has a SHA1 de-duplication value and its ID is in l-unclaimed or z-delayed, then
42 * there should be no other such jobs with that SHA1. Every h-idBySha1 entry has an h-sha1ById
43 * entry and every h-sha1ById must refer to an ID that is l-unclaimed. If a job has its
44 * ID in z-claimed or z-abandoned, then it must also have an h-attempts entry for its ID.
46 * Additionally, "rootjob:* keys track "root jobs" used for additional de-duplication.
47 * Aside from root job keys, all keys have no expiry, and are only removed when jobs are run.
48 * All the keys are prefixed with the relevant wiki ID information.
50 * This class requires Redis 2.6 as it makes use Lua scripts for fast atomic operations.
51 * Additionally, it should be noted that redis has different persistence modes, such
52 * as rdb snapshots, journaling, and no persistence. Appropriate configuration should be
53 * made on the servers based on what queues are using it and what tolerance they have.
59 class JobQueueRedis
extends JobQueue
{
60 /** @var RedisConnectionPool */
63 /** @var string Server address */
65 /** @var string Compression method to use */
66 protected $compression;
68 const MAX_AGE_PRUNE
= 604800; // integer; seconds a job can live once claimed (7 days)
70 /** @var string Key to prefix the queue keys with (used for testing) */
74 * @param array $params Possible keys:
75 * - redisConfig : An array of parameters to RedisConnectionPool::__construct().
76 * Note that the serializer option is ignored as "none" is always used.
77 * - redisServer : A hostname/port combination or the absolute path of a UNIX socket.
78 * If a hostname is specified but no port, the standard port number
79 * 6379 will be used. Required.
80 * - compression : The type of compression to use; one of (none,gzip).
81 * - daemonized : Set to true if the redisJobRunnerService runs in the background.
82 * This will disable job recycling/undelaying from the MediaWiki side
83 * to avoid redundance and out-of-sync configuration.
84 * @throws InvalidArgumentException
86 public function __construct( array $params ) {
87 parent
::__construct( $params );
88 $params['redisConfig']['serializer'] = 'none'; // make it easy to use Lua
89 $this->server
= $params['redisServer'];
90 $this->compression
= isset( $params['compression'] ) ?
$params['compression'] : 'none';
91 $this->redisPool
= RedisConnectionPool
::singleton( $params['redisConfig'] );
92 if ( empty( $params['daemonized'] ) ) {
93 throw new InvalidArgumentException(
94 "Non-daemonized mode is no longer supported. Please install the " .
95 "mediawiki/services/jobrunner service and update \$wgJobTypeConf as needed." );
99 protected function supportedOrders() {
100 return array( 'timestamp', 'fifo' );
103 protected function optimalOrder() {
107 protected function supportsDelayedJobs() {
112 * @see JobQueue::doIsEmpty()
114 * @throws JobQueueError
116 protected function doIsEmpty() {
117 return $this->doGetSize() == 0;
121 * @see JobQueue::doGetSize()
123 * @throws JobQueueError
125 protected function doGetSize() {
126 $conn = $this->getConnection();
128 return $conn->lSize( $this->getQueueKey( 'l-unclaimed' ) );
129 } catch ( RedisException
$e ) {
130 $this->throwRedisException( $conn, $e );
135 * @see JobQueue::doGetAcquiredCount()
137 * @throws JobQueueError
139 protected function doGetAcquiredCount() {
140 $conn = $this->getConnection();
142 $conn->multi( Redis
::PIPELINE
);
143 $conn->zSize( $this->getQueueKey( 'z-claimed' ) );
144 $conn->zSize( $this->getQueueKey( 'z-abandoned' ) );
146 return array_sum( $conn->exec() );
147 } catch ( RedisException
$e ) {
148 $this->throwRedisException( $conn, $e );
153 * @see JobQueue::doGetDelayedCount()
155 * @throws JobQueueError
157 protected function doGetDelayedCount() {
158 $conn = $this->getConnection();
160 return $conn->zSize( $this->getQueueKey( 'z-delayed' ) );
161 } catch ( RedisException
$e ) {
162 $this->throwRedisException( $conn, $e );
167 * @see JobQueue::doGetAbandonedCount()
169 * @throws JobQueueError
171 protected function doGetAbandonedCount() {
172 $conn = $this->getConnection();
174 return $conn->zSize( $this->getQueueKey( 'z-abandoned' ) );
175 } catch ( RedisException
$e ) {
176 $this->throwRedisException( $conn, $e );
181 * @see JobQueue::doBatchPush()
185 * @throws JobQueueError
187 protected function doBatchPush( array $jobs, $flags ) {
188 // Convert the jobs into field maps (de-duplicated against each other)
189 $items = array(); // (job ID => job fields map)
190 foreach ( $jobs as $job ) {
191 $item = $this->getNewJobFields( $job );
192 if ( strlen( $item['sha1'] ) ) { // hash identifier => de-duplicate
193 $items[$item['sha1']] = $item;
195 $items[$item['uuid']] = $item;
199 if ( !count( $items ) ) {
200 return; // nothing to do
203 $conn = $this->getConnection();
205 // Actually push the non-duplicate jobs into the queue...
206 if ( $flags & self
::QOS_ATOMIC
) {
207 $batches = array( $items ); // all or nothing
209 $batches = array_chunk( $items, 100 ); // avoid tying up the server
213 foreach ( $batches as $itemBatch ) {
214 $added = $this->pushBlobs( $conn, $itemBatch );
215 if ( is_int( $added ) ) {
218 $failed +
= count( $itemBatch );
222 wfDebugLog( 'JobQueueRedis', "Could not insert {$failed} {$this->type} job(s)." );
224 throw new RedisException( "Could not insert {$failed} {$this->type} job(s)." );
226 JobQueue
::incrStats( 'inserts', $this->type
, count( $items ) );
227 JobQueue
::incrStats( 'dupe_inserts', $this->type
,
228 count( $items ) - $failed - $pushed );
229 } catch ( RedisException
$e ) {
230 $this->throwRedisException( $conn, $e );
235 * @param RedisConnRef $conn
236 * @param array $items List of results from JobQueueRedis::getNewJobFields()
237 * @return int Number of jobs inserted (duplicates are ignored)
238 * @throws RedisException
240 protected function pushBlobs( RedisConnRef
$conn, array $items ) {
241 $args = array(); // ([id, sha1, rtime, blob [, id, sha1, rtime, blob ... ] ] )
242 foreach ( $items as $item ) {
243 $args[] = (string)$item['uuid'];
244 $args[] = (string)$item['sha1'];
245 $args[] = (string)$item['rtimestamp'];
246 $args[] = (string)$this->serialize( $item );
250 local kUnclaimed, kSha1ById, kIdBySha1, kDelayed, kData = unpack(KEYS)
251 if #ARGV % 4 ~= 0 then return redis.error_reply('Unmatched arguments') end
254 local id,sha1,rtimestamp,blob = ARGV[i],ARGV[i+1],ARGV[i+2],ARGV[i+3]
255 if sha1 == '' or redis.call('hExists',kIdBySha1,sha1) == 0 then
256 if 1*rtimestamp > 0 then
257 -- Insert into delayed queue (release time as score)
258 redis.call('zAdd',kDelayed,rtimestamp,id)
260 -- Insert into unclaimed queue
261 redis.call('lPush',kUnclaimed,id)
264 redis.call('hSet',kSha1ById,id,sha1)
265 redis.call('hSet',kIdBySha1,sha1,id)
267 redis.call('hSet',kData,id,blob)
273 return $conn->luaEval( $script,
276 $this->getQueueKey( 'l-unclaimed' ), # KEYS[1]
277 $this->getQueueKey( 'h-sha1ById' ), # KEYS[2]
278 $this->getQueueKey( 'h-idBySha1' ), # KEYS[3]
279 $this->getQueueKey( 'z-delayed' ), # KEYS[4]
280 $this->getQueueKey( 'h-data' ), # KEYS[5]
284 5 # number of first argument(s) that are keys
289 * @see JobQueue::doPop()
291 * @throws JobQueueError
293 protected function doPop() {
296 $conn = $this->getConnection();
299 $blob = $this->popAndAcquireBlob( $conn );
300 if ( !is_string( $blob ) ) {
301 break; // no jobs; nothing to do
304 JobQueue
::incrStats( 'job-pop', $this->type
);
305 $item = $this->unserialize( $blob );
306 if ( $item === false ) {
307 wfDebugLog( 'JobQueueRedis', "Could not unserialize {$this->type} job." );
311 // If $item is invalid, the runner loop recyling will cleanup as needed
312 $job = $this->getJobFromFields( $item ); // may be false
313 } while ( !$job ); // job may be false if invalid
314 } catch ( RedisException
$e ) {
315 $this->throwRedisException( $conn, $e );
322 * @param RedisConnRef $conn
323 * @return array Serialized string or false
324 * @throws RedisException
326 protected function popAndAcquireBlob( RedisConnRef
$conn ) {
329 local kUnclaimed, kSha1ById, kIdBySha1, kClaimed, kAttempts, kData = unpack(KEYS)
330 -- Pop an item off the queue
331 local id = redis.call('rPop',kUnclaimed)
332 if not id then return false end
333 -- Allow new duplicates of this job
334 local sha1 = redis.call('hGet',kSha1ById,id)
335 if sha1 then redis.call('hDel',kIdBySha1,sha1) end
336 redis.call('hDel',kSha1ById,id)
337 -- Mark the jobs as claimed and return it
338 redis.call('zAdd',kClaimed,ARGV[1],id)
339 redis.call('hIncrBy',kAttempts,id,1)
340 return redis.call('hGet',kData,id)
342 return $conn->luaEval( $script,
344 $this->getQueueKey( 'l-unclaimed' ), # KEYS[1]
345 $this->getQueueKey( 'h-sha1ById' ), # KEYS[2]
346 $this->getQueueKey( 'h-idBySha1' ), # KEYS[3]
347 $this->getQueueKey( 'z-claimed' ), # KEYS[4]
348 $this->getQueueKey( 'h-attempts' ), # KEYS[5]
349 $this->getQueueKey( 'h-data' ), # KEYS[6]
350 time(), # ARGV[1] (injected to be replication-safe)
352 6 # number of first argument(s) that are keys
357 * @see JobQueue::doAck()
360 * @throws UnexpectedValueException
361 * @throws JobQueueError
363 protected function doAck( Job
$job ) {
364 if ( !isset( $job->metadata
['uuid'] ) ) {
365 throw new UnexpectedValueException( "Job of type '{$job->getType()}' has no UUID." );
368 $uuid = $job->metadata
['uuid'];
369 $conn = $this->getConnection();
373 local kClaimed, kAttempts, kData = unpack(KEYS)
374 -- Unmark the job as claimed
375 redis.call('zRem',kClaimed,ARGV[1])
376 redis.call('hDel',kAttempts,ARGV[1])
377 -- Delete the job data itself
378 return redis.call('hDel',kData,ARGV[1])
380 $res = $conn->luaEval( $script,
382 $this->getQueueKey( 'z-claimed' ), # KEYS[1]
383 $this->getQueueKey( 'h-attempts' ), # KEYS[2]
384 $this->getQueueKey( 'h-data' ), # KEYS[3]
387 3 # number of first argument(s) that are keys
391 wfDebugLog( 'JobQueueRedis', "Could not acknowledge {$this->type} job $uuid." );
396 JobQueue
::incrStats( 'job-ack', $this->type
);
397 } catch ( RedisException
$e ) {
398 $this->throwRedisException( $conn, $e );
405 * @see JobQueue::doDeduplicateRootJob()
406 * @param IJobSpecification $job
408 * @throws JobQueueError
409 * @throws LogicException
411 protected function doDeduplicateRootJob( IJobSpecification
$job ) {
412 if ( !$job->hasRootJobParams() ) {
413 throw new LogicException( "Cannot register root job; missing parameters." );
415 $params = $job->getRootJobParams();
417 $key = $this->getRootJobCacheKey( $params['rootJobSignature'] );
419 $conn = $this->getConnection();
421 $timestamp = $conn->get( $key ); // current last timestamp of this job
422 if ( $timestamp && $timestamp >= $params['rootJobTimestamp'] ) {
423 return true; // a newer version of this root job was enqueued
426 // Update the timestamp of the last root job started at the location...
427 return $conn->set( $key, $params['rootJobTimestamp'], self
::ROOTJOB_TTL
); // 2 weeks
428 } catch ( RedisException
$e ) {
429 $this->throwRedisException( $conn, $e );
434 * @see JobQueue::doIsRootJobOldDuplicate()
437 * @throws JobQueueError
439 protected function doIsRootJobOldDuplicate( Job
$job ) {
440 if ( !$job->hasRootJobParams() ) {
441 return false; // job has no de-deplication info
443 $params = $job->getRootJobParams();
445 $conn = $this->getConnection();
447 // Get the last time this root job was enqueued
448 $timestamp = $conn->get( $this->getRootJobCacheKey( $params['rootJobSignature'] ) );
449 } catch ( RedisException
$e ) {
451 $this->throwRedisException( $conn, $e );
454 // Check if a new root job was started at the location after this one's...
455 return ( $timestamp && $timestamp > $params['rootJobTimestamp'] );
459 * @see JobQueue::doDelete()
461 * @throws JobQueueError
463 protected function doDelete() {
464 static $props = array( 'l-unclaimed', 'z-claimed', 'z-abandoned',
465 'z-delayed', 'h-idBySha1', 'h-sha1ById', 'h-attempts', 'h-data' );
467 $conn = $this->getConnection();
470 foreach ( $props as $prop ) {
471 $keys[] = $this->getQueueKey( $prop );
474 return ( $conn->delete( $keys ) !== false );
475 } catch ( RedisException
$e ) {
476 $this->throwRedisException( $conn, $e );
481 * @see JobQueue::getAllQueuedJobs()
483 * @throws JobQueueError
485 public function getAllQueuedJobs() {
486 $conn = $this->getConnection();
488 $uids = $conn->lRange( $this->getQueueKey( 'l-unclaimed' ), 0, -1 );
489 } catch ( RedisException
$e ) {
490 $this->throwRedisException( $conn, $e );
493 return $this->getJobIterator( $conn, $uids );
497 * @see JobQueue::getAllDelayedJobs()
499 * @throws JobQueueError
501 public function getAllDelayedJobs() {
502 $conn = $this->getConnection();
504 $uids = $conn->zRange( $this->getQueueKey( 'z-delayed' ), 0, -1 );
505 } catch ( RedisException
$e ) {
506 $this->throwRedisException( $conn, $e );
509 return $this->getJobIterator( $conn, $uids );
513 * @see JobQueue::getAllAcquiredJobs()
515 * @throws JobQueueError
517 public function getAllAcquiredJobs() {
518 $conn = $this->getConnection();
520 $uids = $conn->zRange( $this->getQueueKey( 'z-claimed' ), 0, -1 );
521 } catch ( RedisException
$e ) {
522 $this->throwRedisException( $conn, $e );
525 return $this->getJobIterator( $conn, $uids );
529 * @see JobQueue::getAllAbandonedJobs()
531 * @throws JobQueueError
533 public function getAllAbandonedJobs() {
534 $conn = $this->getConnection();
536 $uids = $conn->zRange( $this->getQueueKey( 'z-abandoned' ), 0, -1 );
537 } catch ( RedisException
$e ) {
538 $this->throwRedisException( $conn, $e );
541 return $this->getJobIterator( $conn, $uids );
545 * @param RedisConnRef $conn
546 * @param array $uids List of job UUIDs
547 * @return MappedIterator
549 protected function getJobIterator( RedisConnRef
$conn, array $uids ) {
552 return new MappedIterator(
554 function ( $uid ) use ( $that, $conn ) {
555 return $that->getJobFromUidInternal( $uid, $conn );
557 array( 'accept' => function ( $job ) {
558 return is_object( $job );
563 public function getCoalesceLocationInternal() {
564 return "RedisServer:" . $this->server
;
567 protected function doGetSiblingQueuesWithJobs( array $types ) {
568 return array_keys( array_filter( $this->doGetSiblingQueueSizes( $types ) ) );
571 protected function doGetSiblingQueueSizes( array $types ) {
572 $sizes = array(); // (type => size)
573 $types = array_values( $types ); // reindex
574 $conn = $this->getConnection();
576 $conn->multi( Redis
::PIPELINE
);
577 foreach ( $types as $type ) {
578 $conn->lSize( $this->getQueueKey( 'l-unclaimed', $type ) );
580 $res = $conn->exec();
581 if ( is_array( $res ) ) {
582 foreach ( $res as $i => $size ) {
583 $sizes[$types[$i]] = $size;
586 } catch ( RedisException
$e ) {
587 $this->throwRedisException( $conn, $e );
594 * This function should not be called outside JobQueueRedis
597 * @param RedisConnRef $conn
598 * @return Job|bool Returns false if the job does not exist
599 * @throws JobQueueError
600 * @throws UnexpectedValueException
602 public function getJobFromUidInternal( $uid, RedisConnRef
$conn ) {
604 $data = $conn->hGet( $this->getQueueKey( 'h-data' ), $uid );
605 if ( $data === false ) {
606 return false; // not found
608 $item = $this->unserialize( $data );
609 if ( !is_array( $item ) ) { // this shouldn't happen
610 throw new UnexpectedValueException( "Could not find job with ID '$uid'." );
612 $title = Title
::makeTitle( $item['namespace'], $item['title'] );
613 $job = Job
::factory( $item['type'], $title, $item['params'] );
614 $job->metadata
['uuid'] = $item['uuid'];
615 $job->metadata
['timestamp'] = $item['timestamp'];
618 } catch ( RedisException
$e ) {
619 $this->throwRedisException( $conn, $e );
624 * @param IJobSpecification $job
627 protected function getNewJobFields( IJobSpecification
$job ) {
629 // Fields that describe the nature of the job
630 'type' => $job->getType(),
631 'namespace' => $job->getTitle()->getNamespace(),
632 'title' => $job->getTitle()->getDBkey(),
633 'params' => $job->getParams(),
634 // Some jobs cannot run until a "release timestamp"
635 'rtimestamp' => $job->getReleaseTimestamp() ?
: 0,
636 // Additional job metadata
637 'uuid' => UIDGenerator
::newRawUUIDv4( UIDGenerator
::QUICK_RAND
),
638 'sha1' => $job->ignoreDuplicates()
639 ?
wfBaseConvert( sha1( serialize( $job->getDeduplicationInfo() ) ), 16, 36, 31 )
641 'timestamp' => time() // UNIX timestamp
646 * @param array $fields
649 protected function getJobFromFields( array $fields ) {
650 $title = Title
::makeTitle( $fields['namespace'], $fields['title'] );
651 $job = Job
::factory( $fields['type'], $title, $fields['params'] );
652 $job->metadata
['uuid'] = $fields['uuid'];
653 $job->metadata
['timestamp'] = $fields['timestamp'];
659 * @param array $fields
660 * @return string Serialized and possibly compressed version of $fields
662 protected function serialize( array $fields ) {
663 $blob = serialize( $fields );
664 if ( $this->compression
=== 'gzip'
665 && strlen( $blob ) >= 1024
666 && function_exists( 'gzdeflate' )
668 $object = (object)array( 'blob' => gzdeflate( $blob ), 'enc' => 'gzip' );
669 $blobz = serialize( $object );
671 return ( strlen( $blobz ) < strlen( $blob ) ) ?
$blobz : $blob;
678 * @param string $blob
679 * @return array|bool Unserialized version of $blob or false
681 protected function unserialize( $blob ) {
682 $fields = unserialize( $blob );
683 if ( is_object( $fields ) ) {
684 if ( $fields->enc
=== 'gzip' && function_exists( 'gzinflate' ) ) {
685 $fields = unserialize( gzinflate( $fields->blob
) );
691 return is_array( $fields ) ?
$fields : false;
695 * Get a connection to the server that handles all sub-queues for this queue
697 * @return RedisConnRef
698 * @throws JobQueueConnectionError
700 protected function getConnection() {
701 $conn = $this->redisPool
->getConnection( $this->server
);
703 throw new JobQueueConnectionError( "Unable to connect to redis server." );
710 * @param RedisConnRef $conn
711 * @param RedisException $e
712 * @throws JobQueueError
714 protected function throwRedisException( RedisConnRef
$conn, $e ) {
715 $this->redisPool
->handleError( $conn, $e );
716 throw new JobQueueError( "Redis server error: {$e->getMessage()}\n" );
720 * @param string $prop
721 * @param string|null $type
724 private function getQueueKey( $prop, $type = null ) {
725 $type = is_string( $type ) ?
$type : $this->type
;
726 list( $db, $prefix ) = wfSplitWikiID( $this->wiki
);
727 if ( strlen( $this->key
) ) { // namespaced queue (for testing)
728 return wfForeignMemcKey( $db, $prefix, 'jobqueue', $type, $this->key
, $prop );
730 return wfForeignMemcKey( $db, $prefix, 'jobqueue', $type, $prop );
738 public function setTestingPrefix( $key ) {