JobQueueGroupFactory.php

Go to the documentation of this file.

<?php
namespace MediaWiki\JobQueue;
 
use JobQueueGroup;
use LogicException;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\MainConfigNames;
use MediaWiki\WikiMap\WikiMap;
use Wikimedia\ObjectCache\WANObjectCache;
use Wikimedia\Rdbms\ReadOnlyMode;
use Wikimedia\Stats\IBufferingStatsdDataFactory;
use Wikimedia\UUID\GlobalIdGenerator;
 
class JobQueueGroupFactory {
    public const CONSTRUCTOR_OPTIONS = [
        MainConfigNames::JobClasses,
        MainConfigNames::JobTypeConf,
        MainConfigNames::JobTypesExcludedFromDefaultQueue,
        MainConfigNames::LocalDatabases,
    ];
 
    private $instances;
 
    private $options;
 
    private $readOnlyMode;
 
    private $statsdDataFactory;
 
    private $wanCache;
 
    private $globalIdGenerator;
 
    public function __construct(
        ServiceOptions $options,
        ReadOnlyMode $readOnlyMode,
        IBufferingStatsdDataFactory $statsdDataFactory,
        WANObjectCache $wanCache,
        GlobalIdGenerator $globalIdGenerator
    ) {
        $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
        $this->instances = [];
        $this->options = $options;
        $this->readOnlyMode = $readOnlyMode;
        $this->statsdDataFactory = $statsdDataFactory;
        $this->wanCache = $wanCache;
        $this->globalIdGenerator = $globalIdGenerator;
    }
 
    public function makeJobQueueGroup( $domain = false ): JobQueueGroup {
        if ( $domain === false ) {
            $domain = WikiMap::getCurrentWikiDbDomain()->getId();
        }
 
        // Make sure jobs are not getting pushed to bogus wikis. This can confuse
        // the job runner system into spawning endless RPC requests that fail (T171371).
        $isCurrentWiki = WikiMap::isCurrentWikiDbDomain( $domain );
        if ( !$isCurrentWiki ) {
            $wikiId = WikiMap::getWikiIdFromDbDomain( $domain );
            if ( !in_array( $wikiId, $this->options->get( MainConfigNames::LocalDatabases ) ) ) {
                // Do not enqueue job that cannot be run (T171371)
                throw new LogicException( "Domain '{$domain}' is not recognized." );
            }
        }
 
        if ( !isset( $this->instances[$domain] ) ) {
            $localJobClasses = $isCurrentWiki
                ? $this->options->get( MainConfigNames::JobClasses )
                : null;
 
            $this->instances[$domain] = new JobQueueGroup(
                $domain,
                $this->readOnlyMode,
                $localJobClasses,
                $this->options->get( MainConfigNames::JobTypeConf ),
                $this->options->get( MainConfigNames::JobTypesExcludedFromDefaultQueue ),
                $this->statsdDataFactory,
                $this->wanCache,
                $this->globalIdGenerator
            );
        }
 
        return $this->instances[$domain];
    }
}