RefreshSecondaryDataUpdate.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Deferred;
 
use Exception;
use MediaWiki\Deferred\LinksUpdate\LinksUpdate;
use MediaWiki\Exception\MWExceptionHandler;
use MediaWiki\JobQueue\JobSpecification;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Storage\DerivedPageDataUpdater;
use MediaWiki\User\UserIdentity;
use Wikimedia\Rdbms\ILBFactory;
 
class RefreshSecondaryDataUpdate extends DataUpdate
    implements TransactionRoundAwareUpdate, EnqueueableDataUpdate
{
    private $lbFactory;
    private $page;
    private $updater;
    private $recursive;
    private $freshness;
 
    private $revisionRecord;
    private $user;
 
    public function __construct(
        ILBFactory $lbFactory,
        UserIdentity $user,
        PageIdentity $page,
        RevisionRecord $revisionRecord,
        DerivedPageDataUpdater $updater,
        array $options
    ) {
        parent::__construct();
 
        $this->lbFactory = $lbFactory;
        $this->user = $user;
        $this->page = $page;
        $this->revisionRecord = $revisionRecord;
        $this->updater = $updater;
        $this->recursive = !empty( $options['recursive'] );
        $this->freshness = $options['freshness'] ?? false;
    }
 
    public function getTransactionRoundRequirement() {
        return self::TRX_ROUND_ABSENT;
    }
 
    public function doUpdate() {
        $updates = $this->updater->getSecondaryDataUpdates( $this->recursive );
        foreach ( $updates as $update ) {
            if ( $update instanceof LinksUpdate ) {
                $update->setRevisionRecord( $this->revisionRecord );
                $update->setTriggeringUser( $this->user );
            }
            if ( $update instanceof DataUpdate ) {
                $update->setCause( $this->causeAction, $this->causeAgent );
            }
        }
 
        // T221577, T248003: flush any transaction; each update needs outer transaction scope
        // and the code above may have implicitly started one.
        $this->lbFactory->commitPrimaryChanges( __METHOD__ );
 
        $e = null;
        foreach ( $updates as $update ) {
            try {
                DeferredUpdates::attemptUpdate( $update );
            } catch ( Exception $e ) {
                // Try as many updates as possible on the first pass
                MWExceptionHandler::rollbackPrimaryChangesAndLog( $e );
            }
        }
 
        if ( $e instanceof Exception ) {
            // FIXME: The possible checked exception types should be better documented
            // @phan-suppress-next-line PhanThrowTypeAbsent
            throw $e; // trigger RefreshLinksJob enqueue via getAsJobSpecification()
        }
    }
 
    public function getAsJobSpecification() {
        return [
            'domain' => $this->lbFactory->getLocalDomainID(),
            'job' => new JobSpecification(
                'refreshLinksPrioritized',
                [
                    'namespace' => $this->page->getNamespace(),
                    'title' => $this->page->getDBkey(),
                    // Ensure fresh data are used, for normal data reuse the parser cache if it was saved
                    'rootJobTimestamp' => $this->freshness ?: $this->revisionRecord->getTimestamp(),
                    'useRecursiveLinksUpdate' => $this->recursive,
                    'triggeringUser' => [
                        'userId' => $this->user->getId(),
                        'userName' => $this->user->getName()
                    ],
                    'triggeringRevisionId' => $this->revisionRecord->getId(),
                    'causeAction' => $this->getCauseAction(),
                    'causeAgent' => $this->getCauseAgent()
                ],
                [ 'removeDuplicates' => true ]
            )
        ];
    }
}
class_alias( RefreshSecondaryDataUpdate::class, 'RefreshSecondaryDataUpdate' );