[JobQueue] Added a test job that just replaces itself.
authorAaron Schulz <aschulz@wikimedia.org>
Wed, 31 Oct 2012 00:25:36 +0000 (17:25 -0700)
committerAaron Schulz <aschulz@wikimedia.org>
Wed, 31 Oct 2012 19:47:52 +0000 (12:47 -0700)
Change-Id: I257d68099660a9c95e68f7662ae8d5cf1ebefe27

includes/AutoLoader.php
includes/DefaultSettings.php
includes/job/jobs/NullJob.php [new file with mode: 0644]

index 0cd81c3..5da18b6 100644 (file)
@@ -656,6 +656,7 @@ $wgAutoloadLocalClasses = array(
        'EmaillingJob' => 'includes/job/jobs/EmaillingJob.php',
        'EnotifNotifyJob' => 'includes/job/jobs/EnotifNotifyJob.php',
        'HTMLCacheUpdateJob' => 'includes/job/jobs/HTMLCacheUpdateJob.php',
+       'NullJob' => 'includes/job/jobs/NullJob.php',
        'RefreshLinksJob' => 'includes/job/jobs/RefreshLinksJob.php',
        'RefreshLinksJob2' => 'includes/job/jobs/RefreshLinksJob.php',
        'UploadFromUrlJob' => 'includes/job/jobs/UploadFromUrlJob.php',
index 6cdacc1..a06724b 100644 (file)
@@ -5414,14 +5414,15 @@ $wgHooks = array();
  * can add to this to provide custom jobs
  */
 $wgJobClasses = array(
-       'refreshLinks' => 'RefreshLinksJob',
-       'refreshLinks2' => 'RefreshLinksJob2',
-       'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
+       'refreshLinks'      => 'RefreshLinksJob',
+       'refreshLinks2'     => 'RefreshLinksJob2',
+       'htmlCacheUpdate'   => 'HTMLCacheUpdateJob',
        'html_cache_update' => 'HTMLCacheUpdateJob', // backwards-compatible
-       'sendMail' => 'EmaillingJob',
-       'enotifNotify' => 'EnotifNotifyJob',
+       'sendMail'          => 'EmaillingJob',
+       'enotifNotify'      => 'EnotifNotifyJob',
        'fixDoubleRedirect' => 'DoubleRedirectJob',
-       'uploadFromUrl' => 'UploadFromUrlJob',
+       'uploadFromUrl'     => 'UploadFromUrlJob',
+       'null'              => 'NullJob'
 );
 
 /**
diff --git a/includes/job/jobs/NullJob.php b/includes/job/jobs/NullJob.php
new file mode 100644 (file)
index 0000000..eef3bf7
--- /dev/null
@@ -0,0 +1,58 @@
+<?php
+/**
+ * Degenerate job that just replaces itself in the queue.
+ *
+ * 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
+ * @ingroup Cache
+ */
+
+/**
+ * Degenerate job that just replace itself in the queue.
+ * Useful for lock contention and performance testing.
+ *
+ * @ingroup JobQueue
+ */
+class NullJob extends Job {
+       /**
+        * @param $title Title (can be anything)
+        * @param $params Array: job parameters (lives, usleep)
+        * @param $id Integer: job id
+        */
+       function __construct( $title, $params, $id = 0 ) {
+               parent::__construct( 'null', $title, $params, $id );
+               if ( !isset( $this->params['lives'] ) ) {
+                       $this->params['lives'] = 1;
+               }
+               if ( !isset( $this->params['usleep'] ) ) {
+                       $this->params['usleep'] = 0;
+               }
+       }
+
+       public function run() {
+               if ( $this->params['usleep'] > 0 ) {
+                       usleep( $this->params['usleep'] );
+               }
+               if ( $this->params['lives'] > 1 ) {
+                       $params = $this->params;
+                       $params['lives']--;
+                       $job = new self( $this->title, $params );
+                       $job->insert();
+               }
+               return true;
+       }
+}