MediaWiki REL1_32
JobQueueFederated.php
Go to the documentation of this file.
1<?php
50 protected $partitionRing;
52 protected $partitionQueues = [];
53
56
74 protected function __construct( array $params ) {
75 parent::__construct( $params );
76 $section = $params['sectionsByWiki'][$this->wiki] ?? 'default';
77 if ( !isset( $params['partitionsBySection'][$section] ) ) {
78 throw new MWException( "No configuration for section '$section'." );
79 }
80 $this->maxPartitionsTry = $params['maxPartitionsTry'] ?? 2;
81 // Get the full partition map
82 $partitionMap = $params['partitionsBySection'][$section];
83 arsort( $partitionMap, SORT_NUMERIC );
84 // Get the config to pass to merge into each partition queue config
85 $baseConfig = $params;
86 foreach ( [ 'class', 'sectionsByWiki', 'maxPartitionsTry',
87 'partitionsBySection', 'configByPartition', ] as $o
88 ) {
89 unset( $baseConfig[$o] ); // partition queue doesn't care about this
90 }
91 // The class handles all aggregator calls already
92 unset( $baseConfig['aggregator'] );
93 // Get the partition queue objects
94 foreach ( $partitionMap as $partition => $w ) {
95 if ( !isset( $params['configByPartition'][$partition] ) ) {
96 throw new MWException( "No configuration for partition '$partition'." );
97 }
98 $this->partitionQueues[$partition] = JobQueue::factory(
99 $baseConfig + $params['configByPartition'][$partition] );
100 }
101 // Ring of all partitions
102 $this->partitionRing = new HashRing( $partitionMap );
103 }
104
105 protected function supportedOrders() {
106 // No FIFO due to partitioning, though "rough timestamp order" is supported
107 return [ 'undefined', 'random', 'timestamp' ];
108 }
109
110 protected function optimalOrder() {
111 return 'undefined'; // defer to the partitions
112 }
113
114 protected function supportsDelayedJobs() {
115 foreach ( $this->partitionQueues as $queue ) {
116 if ( !$queue->supportsDelayedJobs() ) {
117 return false;
118 }
119 }
120
121 return true;
122 }
123
124 protected function doIsEmpty() {
125 $empty = true;
126 $failed = 0;
127 foreach ( $this->partitionQueues as $queue ) {
128 try {
129 $empty = $empty && $queue->doIsEmpty();
130 } catch ( JobQueueError $e ) {
131 ++$failed;
132 $this->logException( $e );
133 }
134 }
135 $this->throwErrorIfAllPartitionsDown( $failed );
136
137 return $empty;
138 }
139
140 protected function doGetSize() {
141 return $this->getCrossPartitionSum( 'size', 'doGetSize' );
142 }
143
144 protected function doGetAcquiredCount() {
145 return $this->getCrossPartitionSum( 'acquiredcount', 'doGetAcquiredCount' );
146 }
147
148 protected function doGetDelayedCount() {
149 return $this->getCrossPartitionSum( 'delayedcount', 'doGetDelayedCount' );
150 }
151
152 protected function doGetAbandonedCount() {
153 return $this->getCrossPartitionSum( 'abandonedcount', 'doGetAbandonedCount' );
154 }
155
161 protected function getCrossPartitionSum( $type, $method ) {
162 $count = 0;
163 $failed = 0;
164 foreach ( $this->partitionQueues as $queue ) {
165 try {
166 $count += $queue->$method();
167 } catch ( JobQueueError $e ) {
168 ++$failed;
169 $this->logException( $e );
170 }
171 }
172 $this->throwErrorIfAllPartitionsDown( $failed );
173
174 return $count;
175 }
176
177 protected function doBatchPush( array $jobs, $flags ) {
178 // Local ring variable that may be changed to point to a new ring on failure
180 // Try to insert the jobs and update $partitionsTry on any failures.
181 // Retry to insert any remaning jobs again, ignoring the bad partitions.
182 $jobsLeft = $jobs;
183 // phpcs:ignore Generic.CodeAnalysis.ForLoopWithTestFunctionCall
184 for ( $i = $this->maxPartitionsTry; $i > 0 && count( $jobsLeft ); --$i ) {
185 try {
187 } catch ( UnexpectedValueException $e ) {
188 break; // all servers down; nothing to insert to
189 }
190 $jobsLeft = $this->tryJobInsertions( $jobsLeft, $partitionRing, $flags );
191 }
192 if ( count( $jobsLeft ) ) {
193 throw new JobQueueError(
194 "Could not insert job(s), {$this->maxPartitionsTry} partitions tried." );
195 }
196 }
197
205 protected function tryJobInsertions( array $jobs, HashRing &$partitionRing, $flags ) {
206 $jobsLeft = [];
207
208 // Because jobs are spread across partitions, per-job de-duplication needs
209 // to use a consistent hash to avoid allowing duplicate jobs per partition.
210 // When inserting a batch of de-duplicated jobs, QOS_ATOMIC is disregarded.
211 $uJobsByPartition = []; // (partition name => job list)
213 foreach ( $jobs as $key => $job ) {
214 if ( $job->ignoreDuplicates() ) {
215 $sha1 = sha1( serialize( $job->getDeduplicationInfo() ) );
216 $uJobsByPartition[$partitionRing->getLiveLocation( $sha1 )][] = $job;
217 unset( $jobs[$key] );
218 }
219 }
220 // Get the batches of jobs that are not de-duplicated
221 if ( $flags & self::QOS_ATOMIC ) {
222 $nuJobBatches = [ $jobs ]; // all or nothing
223 } else {
224 // Split the jobs into batches and spread them out over servers if there
225 // are many jobs. This helps keep the partitions even. Otherwise, send all
226 // the jobs to a single partition queue to avoids the extra connections.
227 $nuJobBatches = array_chunk( $jobs, 300 );
228 }
229
230 // Insert the de-duplicated jobs into the queues...
231 foreach ( $uJobsByPartition as $partition => $jobBatch ) {
233 $queue = $this->partitionQueues[$partition];
234 try {
235 $ok = true;
236 $queue->doBatchPush( $jobBatch, $flags | self::QOS_ATOMIC );
237 } catch ( JobQueueError $e ) {
238 $ok = false;
239 $this->logException( $e );
240 }
241 if ( !$ok ) {
242 if ( !$partitionRing->ejectFromLiveRing( $partition, 5 ) ) { // blacklist
243 throw new JobQueueError( "Could not insert job(s), no partitions available." );
244 }
245 $jobsLeft = array_merge( $jobsLeft, $jobBatch ); // not inserted
246 }
247 }
248
249 // Insert the jobs that are not de-duplicated into the queues...
250 foreach ( $nuJobBatches as $jobBatch ) {
251 $partition = ArrayUtils::pickRandom( $partitionRing->getLiveLocationWeights() );
252 $queue = $this->partitionQueues[$partition];
253 try {
254 $ok = true;
255 $queue->doBatchPush( $jobBatch, $flags | self::QOS_ATOMIC );
256 } catch ( JobQueueError $e ) {
257 $ok = false;
258 $this->logException( $e );
259 }
260 if ( !$ok ) {
261 if ( !$partitionRing->ejectFromLiveRing( $partition, 5 ) ) { // blacklist
262 throw new JobQueueError( "Could not insert job(s), no partitions available." );
263 }
264 $jobsLeft = array_merge( $jobsLeft, $jobBatch ); // not inserted
265 }
266 }
267
268 return $jobsLeft;
269 }
270
271 protected function doPop() {
272 $partitionsTry = $this->partitionRing->getLiveLocationWeights(); // (partition => weight)
273
274 $failed = 0;
275 while ( count( $partitionsTry ) ) {
276 $partition = ArrayUtils::pickRandom( $partitionsTry );
277 if ( $partition === false ) {
278 break; // all partitions at 0 weight
279 }
280
282 $queue = $this->partitionQueues[$partition];
283 try {
284 $job = $queue->pop();
285 } catch ( JobQueueError $e ) {
286 ++$failed;
287 $this->logException( $e );
288 $job = false;
289 }
290 if ( $job ) {
291 $job->metadata['QueuePartition'] = $partition;
292
293 return $job;
294 } else {
295 unset( $partitionsTry[$partition] ); // blacklist partition
296 }
297 }
298 $this->throwErrorIfAllPartitionsDown( $failed );
299
300 return false;
301 }
302
303 protected function doAck( Job $job ) {
304 if ( !isset( $job->metadata['QueuePartition'] ) ) {
305 throw new MWException( "The given job has no defined partition name." );
306 }
307
308 $this->partitionQueues[$job->metadata['QueuePartition']]->ack( $job );
309 }
310
311 protected function doIsRootJobOldDuplicate( Job $job ) {
312 $signature = $job->getRootJobParams()['rootJobSignature'];
313 $partition = $this->partitionRing->getLiveLocation( $signature );
314 try {
315 return $this->partitionQueues[$partition]->doIsRootJobOldDuplicate( $job );
316 } catch ( JobQueueError $e ) {
317 if ( $this->partitionRing->ejectFromLiveRing( $partition, 5 ) ) {
318 $partition = $this->partitionRing->getLiveLocation( $signature );
319 return $this->partitionQueues[$partition]->doIsRootJobOldDuplicate( $job );
320 }
321 }
322
323 return false;
324 }
325
327 $signature = $job->getRootJobParams()['rootJobSignature'];
328 $partition = $this->partitionRing->getLiveLocation( $signature );
329 try {
330 return $this->partitionQueues[$partition]->doDeduplicateRootJob( $job );
331 } catch ( JobQueueError $e ) {
332 if ( $this->partitionRing->ejectFromLiveRing( $partition, 5 ) ) {
333 $partition = $this->partitionRing->getLiveLocation( $signature );
334 return $this->partitionQueues[$partition]->doDeduplicateRootJob( $job );
335 }
336 }
337
338 return false;
339 }
340
341 protected function doDelete() {
342 $failed = 0;
344 foreach ( $this->partitionQueues as $queue ) {
345 try {
346 $queue->doDelete();
347 } catch ( JobQueueError $e ) {
348 ++$failed;
349 $this->logException( $e );
350 }
351 }
352 $this->throwErrorIfAllPartitionsDown( $failed );
353 return true;
354 }
355
356 protected function doWaitForBackups() {
357 $failed = 0;
359 foreach ( $this->partitionQueues as $queue ) {
360 try {
361 $queue->waitForBackups();
362 } catch ( JobQueueError $e ) {
363 ++$failed;
364 $this->logException( $e );
365 }
366 }
367 $this->throwErrorIfAllPartitionsDown( $failed );
368 }
369
370 protected function doFlushCaches() {
372 foreach ( $this->partitionQueues as $queue ) {
373 $queue->doFlushCaches();
374 }
375 }
376
377 public function getAllQueuedJobs() {
378 $iterator = new AppendIterator();
379
381 foreach ( $this->partitionQueues as $queue ) {
382 $iterator->append( $queue->getAllQueuedJobs() );
383 }
384
385 return $iterator;
386 }
387
388 public function getAllDelayedJobs() {
389 $iterator = new AppendIterator();
390
392 foreach ( $this->partitionQueues as $queue ) {
393 $iterator->append( $queue->getAllDelayedJobs() );
394 }
395
396 return $iterator;
397 }
398
399 public function getAllAcquiredJobs() {
400 $iterator = new AppendIterator();
401
403 foreach ( $this->partitionQueues as $queue ) {
404 $iterator->append( $queue->getAllAcquiredJobs() );
405 }
406
407 return $iterator;
408 }
409
410 public function getAllAbandonedJobs() {
411 $iterator = new AppendIterator();
412
414 foreach ( $this->partitionQueues as $queue ) {
415 $iterator->append( $queue->getAllAbandonedJobs() );
416 }
417
418 return $iterator;
419 }
420
421 public function getCoalesceLocationInternal() {
422 return "JobQueueFederated:wiki:{$this->wiki}" .
423 sha1( serialize( array_keys( $this->partitionQueues ) ) );
424 }
425
426 protected function doGetSiblingQueuesWithJobs( array $types ) {
427 $result = [];
428
429 $failed = 0;
431 foreach ( $this->partitionQueues as $queue ) {
432 try {
433 $nonEmpty = $queue->doGetSiblingQueuesWithJobs( $types );
434 if ( is_array( $nonEmpty ) ) {
435 $result = array_unique( array_merge( $result, $nonEmpty ) );
436 } else {
437 return null; // not supported on all partitions; bail
438 }
439 if ( count( $result ) == count( $types ) ) {
440 break; // short-circuit
441 }
442 } catch ( JobQueueError $e ) {
443 ++$failed;
444 $this->logException( $e );
445 }
446 }
447 $this->throwErrorIfAllPartitionsDown( $failed );
448
449 return array_values( $result );
450 }
451
452 protected function doGetSiblingQueueSizes( array $types ) {
453 $result = [];
454 $failed = 0;
456 foreach ( $this->partitionQueues as $queue ) {
457 try {
458 $sizes = $queue->doGetSiblingQueueSizes( $types );
459 if ( is_array( $sizes ) ) {
460 foreach ( $sizes as $type => $size ) {
461 $result[$type] = isset( $result[$type] ) ? $result[$type] + $size : $size;
462 }
463 } else {
464 return null; // not supported on all partitions; bail
465 }
466 } catch ( JobQueueError $e ) {
467 ++$failed;
468 $this->logException( $e );
469 }
470 }
471 $this->throwErrorIfAllPartitionsDown( $failed );
472
473 return $result;
474 }
475
476 protected function logException( Exception $e ) {
477 wfDebugLog( 'JobQueueFederated', $e->getMessage() . "\n" . $e->getTraceAsString() );
478 }
479
487 protected function throwErrorIfAllPartitionsDown( $down ) {
488 if ( $down >= count( $this->partitionQueues ) ) {
489 throw new JobQueueError( 'No queue partitions available.' );
490 }
491 }
492}
serialize()
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Convenience class for weighted consistent hash rings.
Definition HashRing.php:39
getLiveLocationWeights()
Get the map of "live" locations to weight (does not include zero weight items)
Definition HashRing.php:247
getLiveLocation( $item)
Get the location of an item on the "live" ring.
Definition HashRing.php:225
ejectFromLiveRing( $location, $ttl)
Remove a location from the "live" hash ring.
Definition HashRing.php:205
Class to handle enqueueing and running of background jobs for federated queues.
getAllDelayedJobs()
Get an iterator to traverse over all delayed jobs in this queue.
doGetSiblingQueuesWithJobs(array $types)
tryJobInsertions(array $jobs, HashRing &$partitionRing, $flags)
doGetSiblingQueueSizes(array $types)
getAllAcquiredJobs()
Get an iterator to traverse over all claimed jobs in this queue.
optimalOrder()
Get the default queue order to use if configuration does not specify one.
doDeduplicateRootJob(IJobSpecification $job)
int $maxPartitionsTry
Maximum number of partitions to try.
doBatchPush(array $jobs, $flags)
supportsDelayedJobs()
Find out if delayed jobs are supported for configuration validation.
getCoalesceLocationInternal()
Do not use this function outside of JobQueue/JobQueueGroup.
JobQueue[] $partitionQueues
(partition name => JobQueue) reverse sorted by weight
throwErrorIfAllPartitionsDown( $down)
Throw an error if no partitions available.
getCrossPartitionSum( $type, $method)
getAllAbandonedJobs()
Get an iterator to traverse over all abandoned jobs in this queue.
logException(Exception $e)
doIsRootJobOldDuplicate(Job $job)
supportedOrders()
Get the allowed queue orders for configuration validation.
__construct(array $params)
getAllQueuedJobs()
Get an iterator to traverse over all available jobs in this queue.
Class to handle enqueueing and running of background jobs.
Definition JobQueue.php:31
string $type
Job type.
Definition JobQueue.php:35
static factory(array $params)
Get a job queue object of the specified type.
Definition JobQueue.php:104
string $wiki
Wiki ID.
Definition JobQueue.php:33
Class to both describe a background job and handle jobs.
Definition Job.php:30
MediaWiki exception.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED since 1.16! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:2042
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition hooks.txt:3107
returning false will NOT prevent logging $e
Definition hooks.txt:2226
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
Job queue task description interface.
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
if(count( $args)< 1) $job
$params