includes/deferred/JobQueueEnqueueUpdate.php

   1 <?php
   2 /**
   3  * Handler for triggering the enqueuing of lazy-pushed jobs
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 use Wikimedia\Assert\Assert;
  24
  25 /**
  26  * Enqueue lazy-pushed jobs that have accumulated from JobQueueGroup
  27  *
  28  * @ingroup JobQueue
  29  * @since 1.33
  30  */
  31 class JobQueueEnqueueUpdate implements DeferrableUpdate, MergeableUpdate {
  32         /** @var array[] Map of (domain ID => IJobSpecification[]) */
  33         private $jobsByDomain;
  34
  35         /**
  36          * @param string $domain DB domain ID
  37          * @param IJobSpecification[] $jobs
  38          */
  39         public function __construct( $domain, array $jobs ) {
  40                 $this->jobsByDomain[$domain] = $jobs;
  41         }
  42
  43         public function merge( MergeableUpdate $update ) {
  44                 /** @var JobQueueEnqueueUpdate $update */
  45                 Assert::parameterType( __CLASS__, $update, '$update' );
  46
  47                 foreach ( $update->jobsByDomain as $domain => $jobs ) {
  48                         $this->jobsByDomain[$domain] = $this->jobsByDomain[$domain] ?? [];
  49                         $this->jobsByDomain[$domain] = array_merge( $this->jobsByDomain[$domain], $jobs );
  50                 }
  51         }
  52
  53         public function doUpdate() {
  54                 foreach ( $this->jobsByDomain as $domain => $jobs ) {
  55                         $group = JobQueueGroup::singleton( $domain );
  56                         try {
  57                                 $group->push( $jobs );
  58                         } catch ( Exception $e ) {
  59                                 // Get in as many jobs as possible and let other post-send updates happen
  60                                 MWExceptionHandler::logException( $e );
  61                         }
  62                 }
  63         }
  64 }