1f4efc6c34
This class implements EnqueueableDataUpdate and can be pushed as a
job if it fails to run via DeferredUpdates.
Unlike a1f7fd3ada, make RefreshSecondaryDataUpdate skip failing
updates in doUpdate(). Instead of throwing the first exception from
any update, log any exceptions that occur and try all the other
updates. The first error will be re-thrown afterwards.
Also, make sure that each DataUpdate still has outer transaction
scope. This property is documented at mediawiki.org and should not
be changed.
Add integration tests for RefreshSecondaryDataUpdateTest.
Bug: T218456
Bug: T206283
Change-Id: I7c6554a4d4cd76dfe7cd2967afe30b3aa1069fcb
138 lines
3.9 KiB
PHP
138 lines
3.9 KiB
PHP
<?php
|
|
/**
|
|
* Updater for secondary data after a page edit.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
use MediaWiki\Revision\RevisionRecord;
|
|
use MediaWiki\Storage\DerivedPageDataUpdater;
|
|
use Wikimedia\Rdbms\ILBFactory;
|
|
|
|
/**
|
|
* Update object handling the cleanup of secondary data after a page was edited.
|
|
*
|
|
* This makes makes it possible for DeferredUpdates to have retry logic using a
|
|
* single refreshLinks job if any of the bundled updates fail.
|
|
*
|
|
* @since 1.34
|
|
*/
|
|
class RefreshSecondaryDataUpdate extends DataUpdate
|
|
implements TransactionRoundAwareUpdate, EnqueueableDataUpdate
|
|
{
|
|
/** @var ILBFactory */
|
|
private $lbFactory;
|
|
/** @var WikiPage */
|
|
private $page;
|
|
/** @var DerivedPageDataUpdater */
|
|
private $updater;
|
|
/** @var bool */
|
|
private $recursive;
|
|
|
|
/** @var Revision|null */
|
|
private $revision;
|
|
/** @var User|null */
|
|
private $user;
|
|
|
|
/**
|
|
* @param ILBFactory $lbFactory
|
|
* @param User $user
|
|
* @param WikiPage $page Page we are updating
|
|
* @param RevisionRecord $revision
|
|
* @param DerivedPageDataUpdater $updater
|
|
* @param array $options Options map; supports "recursive"
|
|
*/
|
|
public function __construct(
|
|
ILBFactory $lbFactory,
|
|
User $user,
|
|
WikiPage $page,
|
|
RevisionRecord $revision,
|
|
DerivedPageDataUpdater $updater,
|
|
array $options
|
|
) {
|
|
parent::__construct();
|
|
|
|
$this->lbFactory = $lbFactory;
|
|
$this->user = $user;
|
|
$this->page = $page;
|
|
$this->revision = new Revision( $revision );
|
|
$this->updater = $updater;
|
|
$this->recursive = !empty( $options['recursive'] );
|
|
}
|
|
|
|
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->setRevision( $this->revision );
|
|
$update->setTriggeringUser( $this->user );
|
|
}
|
|
if ( $update instanceof DataUpdate ) {
|
|
$update->setCause( $this->causeAction, $this->causeAgent );
|
|
}
|
|
}
|
|
|
|
$e = null;
|
|
foreach ( $updates as $update ) {
|
|
try {
|
|
DeferredUpdates::attemptUpdate( $update, $this->lbFactory );
|
|
} catch ( Exception $e ) {
|
|
// Try as many updates as possible on the first pass
|
|
MWExceptionHandler::rollbackMasterChangesAndLog( $e );
|
|
}
|
|
}
|
|
|
|
if ( $e instanceof Exception ) {
|
|
throw $e; // trigger RefreshLinksJob enqueue via getAsJobSpecification()
|
|
}
|
|
}
|
|
|
|
public function getAsJobSpecification() {
|
|
return [
|
|
'domain' => $this->lbFactory->getLocalDomainID(),
|
|
'job' => new JobSpecification(
|
|
'refreshLinksPrioritized',
|
|
[
|
|
'namespace' => $this->page->getTitle()->getNamespace(),
|
|
'title' => $this->page->getTitle()->getDBkey(),
|
|
// Reuse the parser cache if it was saved
|
|
'rootJobTimestamp' => $this->revision
|
|
? $this->revision->getTimestamp()
|
|
: null,
|
|
'useRecursiveLinksUpdate' => $this->recursive,
|
|
'triggeringUser' => $this->user
|
|
? [
|
|
'userId' => $this->user->getId(),
|
|
'userName' => $this->user->getName()
|
|
]
|
|
: null,
|
|
'triggeringRevisionId' => $this->revision
|
|
? $this->revision->getId()
|
|
: null,
|
|
'causeAction' => $this->getCauseAction(),
|
|
'causeAgent' => $this->getCauseAgent()
|
|
],
|
|
[ 'removeDuplicates' => true ]
|
|
)
|
|
];
|
|
}
|
|
}
|