Class to handle enqueueing of background jobs. More...

Collaboration diagram for JobQueueGroup:

[legend]

Public Member Functions
	__destruct ()

	ack (Job $job)
	Acknowledge that a job was completed.

	deduplicateRootJob (Job $job)
	Register the "root job" of a given job into the queue for de-duplication.

	get ( $type)
	Get the job queue object for a given queue type.

	getDefaultQueueTypes ()
	Get the list of default queue types.

	getQueueSizes ()
	Get the size of the queus for a list of job types.

	getQueuesWithJobs ()
	Get the list of job types that have non-empty queues.

	getQueueTypes ()
	Get the list of queue types.

	lazyPush ( $jobs)
	Buffer jobs for insertion via push() or call it now if in CLI mode.

	pop ( $qtype=self::TYPE_DEFAULT, $flags=0, array $blacklist=[])
	Pop a job off one of the job queues.

	push ( $jobs)
	Insert jobs into the respective queues of which they belong.

	queuesHaveJobs ( $type=self::TYPE_ANY)
	Check if there are any queues with jobs (this is cached)

	waitForBackups ()
	Wait for any replica DBs or backup queue servers to catch up.

Static Public Member Functions
static	destroySingletons ()
	Destroy the singleton instances.

static	pushLazyJobs ()
	Push all jobs buffered via lazyPush() into their respective queues.

static	singleton ( $wiki=false)

Public Attributes
const	CACHE_VERSION = 1

const	PROC_CACHE_TTL = 15

const	TYPE_ANY = 2

const	TYPE_DEFAULT = 1

const	USE_CACHE = 1

Protected Member Functions
	__construct ( $wiki, $readOnlyReason)

	getCoalescedQueues ()

Protected Attributes
Job[]	$bufferedJobs = []

ProcessCacheLRU	$cache

array	$coalescedQueues
	Map of (bucket => (queue => JobQueue, types => list of types)

string bool	$readOnlyReason
	Read only rationale (or false if r/w)

string	$wiki
	Wiki ID.

Static Protected Attributes
static JobQueueGroup[]	$instances = []

Private Member Functions
	assertValidJobs (array $jobs)

	getCachedConfigVar ( $name)

Detailed Description

Class to handle enqueueing of background jobs.

Since: 1.21

Definition at line 30 of file JobQueueGroup.php.

Constructor & Destructor Documentation

◆ __construct()

JobQueueGroup::__construct	(	$wiki,
		$readOnlyReason
	)

protected

Parameters

string	$wiki	Wiki ID
string \| bool	$readOnlyReason	Read-only reason or false

Definition at line 61 of file JobQueueGroup.php.

References $readOnlyReason, $wiki, cache, and wiki.

◆ __destruct()

JobQueueGroup::__destruct ( )

Definition at line 447 of file JobQueueGroup.php.

References $type.

Member Function Documentation

◆ ack()

JobQueueGroup::ack ( Job $job )

Acknowledge that a job was completed.

Parameters

Job $job

Returns: void

Definition at line 260 of file JobQueueGroup.php.

References $job, ack(), and Job\getType().

Referenced by ack().

◆ assertValidJobs()

JobQueueGroup::assertValidJobs ( array $jobs )

private

Parameters

array $jobs

Exceptions

InvalidArgumentException

Definition at line 439 of file JobQueueGroup.php.

References $job, and as.

Referenced by lazyPush(), and push().

◆ deduplicateRootJob()

JobQueueGroup::deduplicateRootJob ( Job $job )

Register the "root job" of a given job into the queue for de-duplication.

This should only be called right after all the new jobs have been inserted.

Parameters

Job $job

Returns: bool

Definition at line 271 of file JobQueueGroup.php.

References $job, deduplicateRootJob(), and Job\getType().

Referenced by deduplicateRootJob().

◆ destroySingletons()

static JobQueueGroup::destroySingletons ( )

static

Destroy the singleton instances.

Returns: void

Examples: /src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 85 of file JobQueueGroup.php.

Referenced by MediaWikiTestCase\doLightweightServiceReset(), ForkController\prepareEnvironment(), CategoryMembershipChangeJobTest\runJobs(), WikiPageTest\testDoDeleteArticle(), WikiPageTest\testDoDeleteUpdates(), and TemplateCategoriesTest\testTemplateCategories().

◆ get()

JobQueueGroup::get ( $type )

Get the job queue object for a given queue type.

Parameters

string $type

Returns: JobQueue

Definition at line 95 of file JobQueueGroup.php.

References $readOnlyReason, $type, $wgJobTypeConf, $wiki, JobQueue\factory(), global, and JobQueueAggregator\singleton().

◆ getCachedConfigVar()

JobQueueGroup::getCachedConfigVar ( $name )

private

Parameters

string $name

Returns: mixed

Definition at line 413 of file JobQueueGroup.php.

References $cache, $GLOBALS, $name, $value, $wgConf, $wiki, global, use, wfWikiID(), and wiki.

Referenced by getQueueTypes().

◆ getCoalescedQueues()

JobQueueGroup::getCoalescedQueues ( )

protected

Returns: array

Definition at line 382 of file JobQueueGroup.php.

References $coalescedQueues, $queue, $type, $wgJobTypeConf, as, JobQueue\factory(), getQueueTypes(), global, and wiki.

Referenced by getQueueSizes(), and getQueuesWithJobs().

◆ getDefaultQueueTypes()

JobQueueGroup::getDefaultQueueTypes ( )

Get the list of default queue types.

Returns: array List of strings

Definition at line 305 of file JobQueueGroup.php.

References $wgJobTypesExcludedFromDefaultQueue, getQueueTypes(), and global.

Referenced by pop(), and queuesHaveJobs().

◆ getQueueSizes()

JobQueueGroup::getQueueSizes ( )

Get the size of the queus for a list of job types.

Returns: array Map of (job type => size)

Definition at line 363 of file JobQueueGroup.php.

References $type, as, getCoalescedQueues(), and getQueueTypes().

◆ getQueuesWithJobs()

JobQueueGroup::getQueuesWithJobs ( )

Get the list of job types that have non-empty queues.

Returns: array List of job types that have non-empty queues

Definition at line 340 of file JobQueueGroup.php.

References $type, as, getCoalescedQueues(), and getQueueTypes().

Referenced by pop(), and queuesHaveJobs().

◆ getQueueTypes()

JobQueueGroup::getQueueTypes ( )

Get the list of queue types.

Returns: array List of strings

Definition at line 296 of file JobQueueGroup.php.

References getCachedConfigVar().

Referenced by getCoalescedQueues(), getDefaultQueueTypes(), getQueueSizes(), and getQueuesWithJobs().

◆ lazyPush()

JobQueueGroup::lazyPush ( $jobs )

Buffer jobs for insertion via push() or call it now if in CLI mode.

Note that pushLazyJobs() is registered as a deferred update just before DeferredUpdates::doUpdates() in MediaWiki and JobRunner classes in order to be executed as the very last deferred update (T100085, T154425).

Parameters

IJobSpecification | IJobSpecification[] $jobs A single Job or a list of Jobs

Returns: void

Since: 1.26

Definition at line 174 of file JobQueueGroup.php.

References assertValidJobs(), and push().

◆ pop()

JobQueueGroup::pop	(		$qtype = `self::TYPE_DEFAULT`,
			$flags = `0`,
		array	$blacklist = `[]`
	)

Pop a job off one of the job queues.

This pops a job off a queue as specified by $wgJobTypeConf and updates the aggregate job queue information cache as needed.

Parameters

int \| string	$qtype	JobQueueGroup::TYPE_* constant or job type string
int	$flags	Bitfield of JobQueueGroup::USE_* constants
array	$blacklist	List of job types to ignore

Returns: Job|bool Returns false on failure

Definition at line 217 of file JobQueueGroup.php.

References $flags, $job, $type, as, cache, getDefaultQueueTypes(), getQueuesWithJobs(), and pop().

Referenced by pop().

◆ push()

JobQueueGroup::push ( $jobs )

Insert jobs into the respective queues of which they belong.

This inserts the jobs into the queue specified by $wgJobTypeConf and updates the aggregate job queue information cache as needed.

Parameters

IJobSpecification | IJobSpecification[] $jobs A single Job or a list of Jobs

Exceptions

InvalidArgumentException

Returns: void

Definition at line 122 of file JobQueueGroup.php.

References $cache, $job, $type, $wgJobTypesExcludedFromDefaultQueue, as, assertValidJobs(), cache, global, push(), and ProcessCacheLRU\set().

Referenced by lazyPush(), and push().

◆ pushLazyJobs()

static JobQueueGroup::pushLazyJobs ( )

static

Push all jobs buffered via lazyPush() into their respective queues.

Returns: void

Since: 1.26

Definition at line 194 of file JobQueueGroup.php.

References $e, and as.

◆ queuesHaveJobs()

JobQueueGroup::queuesHaveJobs ( $type = self::TYPE_ANY )

Check if there are any queues with jobs (this is cached)

Parameters

int $type JobQueueGroup::TYPE_* constant

Returns: bool

Since: 1.23

Definition at line 318 of file JobQueueGroup.php.

References $cache, $type, $value, ProcessCacheLRU\get(), getDefaultQueueTypes(), getQueuesWithJobs(), and wiki.

◆ singleton()

static JobQueueGroup::singleton ( $wiki = false )

static

Parameters

bool | string $wiki Wiki ID

Returns: JobQueueGroup

Examples: /src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 71 of file JobQueueGroup.php.

References $wiki, false, wfConfiguredReadOnlyReason(), and wfWikiID().

Referenced by Job\batchInsert(), WikiPage\doEditUpdates(), CdnCacheUpdate\doUpdate(), HTMLCacheUpdate\doUpdate(), DeferredUpdates\enqueueUpdates(), CopyJobQueue\execute(), ShowJobs\execute(), JobQueueAggregator\findPendingWikiQueues(), DoubleRedirectJob\fixRedirects(), ApiUpload\getChunkResult(), Job\insert(), SiteStats\jobs(), EmailNotification\notifyOnPageChange(), ApiUpload\performUpload(), LocalFile\prerenderThumbnails(), FixDoubleRedirects\queueJobs(), LinksUpdate\queueRecursiveJobs(), LinksUpdate\queueRecursiveJobsForTable(), EnqueueJob\run(), HTMLCacheUpdateJob\run(), NullJob\run(), RefreshLinksJob\run(), JobRunner\run(), LinksUpdateTest\runAllRelatedJobs(), RecentChange\save(), MediaWikiTestCase\teardownTestDB(), UploadFromUrlTest\testClearQueue(), UploadFromUrlTest\testSyncDownload(), MediaWiki\triggerJobs(), and WikiPage\triggerOpportunisticLinksUpdate().

◆ waitForBackups()

JobQueueGroup::waitForBackups ( )

Wait for any replica DBs or backup queue servers to catch up.

This does nothing for certain queue classes.

Returns: void

Definition at line 282 of file JobQueueGroup.php.

References $type, $wgJobTypeConf, as, global, and waitForBackups().

Referenced by waitForBackups().

Member Data Documentation

◆ $bufferedJobs

Job [] JobQueueGroup::$bufferedJobs = []

protected

Definition at line 46 of file JobQueueGroup.php.

◆ $cache

ProcessCacheLRU JobQueueGroup::$cache

protected

Definition at line 35 of file JobQueueGroup.php.

Referenced by getCachedConfigVar(), push(), and queuesHaveJobs().

◆ $coalescedQueues

array JobQueueGroup::$coalescedQueues

protected

Map of (bucket => (queue => JobQueue, types => list of types)

Definition at line 43 of file JobQueueGroup.php.

Referenced by getCoalescedQueues().

◆ $instances

JobQueueGroup [] JobQueueGroup::$instances = []

staticprotected

Definition at line 32 of file JobQueueGroup.php.

◆ $readOnlyReason

string bool JobQueueGroup::$readOnlyReason

protected

Read only rationale (or false if r/w)

Definition at line 40 of file JobQueueGroup.php.

Referenced by __construct(), and get().

◆ $wiki

string JobQueueGroup::$wiki

protected

Wiki ID.

Definition at line 38 of file JobQueueGroup.php.

Referenced by __construct(), get(), getCachedConfigVar(), and singleton().

◆ CACHE_VERSION

const JobQueueGroup::CACHE_VERSION = 1

Definition at line 55 of file JobQueueGroup.php.

◆ PROC_CACHE_TTL

const JobQueueGroup::PROC_CACHE_TTL = 15

Definition at line 53 of file JobQueueGroup.php.

◆ TYPE_ANY

const JobQueueGroup::TYPE_ANY = 2

Definition at line 49 of file JobQueueGroup.php.

◆ TYPE_DEFAULT

const JobQueueGroup::TYPE_DEFAULT = 1

Definition at line 48 of file JobQueueGroup.php.

Referenced by JobRunner\run(), and MediaWiki\triggerJobs().

◆ USE_CACHE

const JobQueueGroup::USE_CACHE = 1

Definition at line 51 of file JobQueueGroup.php.

Referenced by JobRunner\run().

The documentation for this class was generated from the following file:

includes/jobqueue/JobQueueGroup.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ ack()

◆ assertValidJobs()

◆ deduplicateRootJob()

◆ destroySingletons()

◆ get()

◆ getCachedConfigVar()

◆ getCoalescedQueues()

◆ getDefaultQueueTypes()

◆ getQueueSizes()

◆ getQueuesWithJobs()

◆ getQueueTypes()

◆ lazyPush()

◆ pop()

◆ push()

◆ pushLazyJobs()

◆ queuesHaveJobs()

◆ singleton()

◆ waitForBackups()

Member Data Documentation

◆ $bufferedJobs

◆ $cache

◆ $coalescedQueues

◆ $instances

◆ $readOnlyReason

◆ $wiki

◆ CACHE_VERSION

◆ PROC_CACHE_TTL

◆ TYPE_ANY

◆ TYPE_DEFAULT

◆ USE_CACHE