TTMServerMessageUpdateJob.php

Go to the documentation of this file.

<?php
use MediaWiki\Extension\Translate\MessageLoading\MessageHandle;
use MediaWiki\Extension\Translate\Services;
use MediaWiki\Extension\Translate\TtmServer\WritableTtmServer;
use MediaWiki\Extension\Translate\Utilities\Utilities;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
use MediaWiki\Title\Title;
use Psr\Log\LoggerInterface;
 
class TTMServerMessageUpdateJob extends Job {
    protected const MAX_ERROR_RETRY = 4;
 
    protected const WRITE_BACKOFF_EXPONENT = 7;
    private $jobQueueGroup;
    private const CHANNEL_NAME = 'Translate.TtmServerUpdates';
    private LoggerInterface $logger;
 
    public static function newJob( MessageHandle $handle, $command ) {
        $job = new self( $handle->getTitle(), [ 'command' => $command ] );
 
        return $job;
    }
 
    public function __construct( $title, $params = [] ) {
        parent::__construct(
            'TTMServerMessageUpdateJob',
            $title,
            $params + [
                'command' => 'rebuild',
                'service' => null,
                'errorCount' => 0,
            ]
        );
 
        $this->jobQueueGroup = MediaWikiServices::getInstance()->getJobQueueGroup();
        $this->logger = LoggerFactory::getInstance( self::CHANNEL_NAME );
    }
 
    public function run() {
        $services = $this->getServersToUpdate( $this->params['service'] );
        foreach ( $services as $serviceId => $service ) {
            $this->runCommandWithRetry( $service, $serviceId );
        }
        return true;
    }
 
    public function allowRetries() {
        return false;
    }
 
    private function runCommandWithRetry( WritableTtmServer $ttmServer, string $serviceName ): void {
        try {
            $this->runCommand( $ttmServer, $serviceName );
        } catch ( Exception $e ) {
            $this->requeueError( $serviceName, $e );
        }
    }
 
    private function requeueError( $serviceName, $e ) {
        $this->logger->warning(
            'Exception thrown while running {command} on ' .
            'service {service}: {errorMessage}',
            [
                'command' => $this->params['command'],
                'service' => $serviceName,
                'errorMessage' => $e->getMessage(),
                'exception' => $e,
            ]
        );
        if ( $this->params['errorCount'] >= self::MAX_ERROR_RETRY ) {
            $this->logger->warning(
                'Dropping failing job {command} for service {service} ' .
                'after repeated failure',
                [
                    'command' => $this->params['command'],
                    'service' => $serviceName,
                ]
            );
            return;
        }
 
        $delay = self::backoffDelay( $this->params['errorCount'] );
        $job = clone $this;
        $job->params['errorCount']++;
        $job->params['service'] = $serviceName;
        $job->setDelay( $delay );
        $this->logger->info(
            'Update job reported failure on service {service}. ' .
            'Requeueing job with delay of {delay}.',
            [
                'service' => $serviceName,
                'delay' => $delay
            ]
        );
        $this->resend( $job );
    }
 
    protected function resend( self $job ) {
        $this->jobQueueGroup->push( $job );
    }
 
    private function runCommand( WritableTtmServer $ttmServer, string $serverName ) {
        $handle = $this->getHandle();
        $command = $this->params['command'];
 
        if ( $command === 'delete' ) {
            $this->updateItem( $ttmServer, $handle, null, false );
        } elseif ( $command === 'rebuild' ) {
            $this->updateMessage( $ttmServer, $handle );
        } elseif ( $command === 'refresh' ) {
            $this->updateTranslation( $ttmServer, $handle );
        }
 
        $this->logger->info(
            "{command} command completed on {server} for {handle}",
            [
                'command' => $command,
                'server' => $serverName,
                'handle' => $handle->getTitle()->getPrefixedText()
            ]
        );
    }
 
    protected function getHandle() {
        return new MessageHandle( $this->title );
    }
 
    protected function getTranslation( MessageHandle $handle ) {
        return Utilities::getMessageContent(
            $handle->getKey(),
            $handle->getCode(),
            $handle->getTitle()->getNamespace()
        );
    }
 
    private function updateMessage( WritableTtmServer $ttmserver, MessageHandle $handle ) {
        // Base page update, e.g. group change. Update everything.
        $translations = Utilities::getTranslations( $handle );
        foreach ( $translations as $page => $data ) {
            $tTitle = Title::makeTitle( $this->title->getNamespace(), $page );
            $tHandle = new MessageHandle( $tTitle );
            $this->updateItem( $ttmserver, $tHandle, $data[0], $tHandle->isFuzzy() );
        }
    }
 
    private function updateTranslation( WritableTtmServer $ttmserver, MessageHandle $handle ) {
        // Update only this translation
        $translation = $this->getTranslation( $handle );
        $this->updateItem( $ttmserver, $handle, $translation, $handle->isFuzzy() );
    }
 
    private function updateItem( WritableTtmServer $ttmserver, MessageHandle $handle, $text, $fuzzy ) {
        if ( $fuzzy ) {
            $text = null;
        }
        $ttmserver->update( $handle, $text );
    }
 
    private function getServersToUpdate( ?string $requestedServiceId ): array {
        $ttmServerFactory = Services::getInstance()->getTtmServerFactory();
        if ( $requestedServiceId ) {
            if ( !$ttmServerFactory->has( $requestedServiceId ) ) {
                $this->logger->warning(
                    'Received update job for a an unknown service {service}.',
                    [ 'service' => $requestedServiceId ]
                );
                return [];
            }
 
            return [ $requestedServiceId => $ttmServerFactory->create( $requestedServiceId ) ];
        }
 
        try {
            return $ttmServerFactory->getWritable();
        } catch ( Exception $e ) {
            $this->logger->error(
                'There was an error while fetching writable TTM services. Error: {error}',
                [ 'error' => $e->getMessage() ]
            );
        }
 
        return [];
    }
 
    public function setDelay( $delay ) {
        $jobQueue = $this->jobQueueGroup->get( $this->getType() );
        if ( !$delay || !$jobQueue->delayedJobsEnabled() ) {
            return;
        }
        $oldTime = $this->getReleaseTimestamp();
        $newTime = time() + $delay;
        if ( $oldTime !== null && $oldTime >= $newTime ) {
            return;
        }
        $this->params[ 'jobReleaseTimestamp' ] = $newTime;
    }
 
    public static function backoffDelay( $errorCount ) {
        return ceil( pow(
            2,
            static::WRITE_BACKOFF_EXPONENT + rand( 0, min( $errorCount, 4 ) )
        ) );
    }
}