MDL-50287 completion: Separated slow task out from cron
authorJosh Willcock <me@joshwillcock.co.uk>
Wed, 20 May 2015 12:08:19 +0000 (13:08 +0100)
committerDan Poltawski <dan@moodle.com>
Thu, 27 Aug 2015 13:40:04 +0000 (14:40 +0100)
The mark started function for the completions scheduled task can be very
slow and causes performance issues when running. By splitting this into
it's own task it can be managed independantly from the other parts which
update regularly.

completion/cron.php
lang/en/admin.php
lib/classes/task/completion_cron_daily_task.php [moved from lib/classes/task/completion_cron_task.php with 77% similarity]
lib/classes/task/completion_cron_regular_task.php [new file with mode: 0644]
lib/db/tasks.php

index 23e682c..c252de4 100644 (file)
@@ -28,20 +28,38 @@ defined('MOODLE_INTERNAL') || die();
 require_once($CFG->libdir.'/completionlib.php');
 
 /**
+ * Legacy - here for plugin use only, not used in scheduled tasks. 
  * Update user's course completion statuses
  *
  * First update all criteria completions, then aggregate all criteria completions
- * and update overall course completions
+ * and update overall course completions.
  */
 function completion_cron() {
-
     completion_cron_mark_started();
 
     completion_cron_criteria();
 
     completion_cron_completions();
 }
-
+/**
+ * Update user's course completion statuses
+ *
+ * First update all criteria completions, then aggregate all criteria completions
+ * and update overall course completions
+ */
+function completion_regular_cron() {
+    // Two Functions which check criteria and learner completions regularly for accurate data.
+    completion_cron_criteria();
+    completion_cron_completions();
+}
+/**
+ * Marks users as started if the config option is set.
+ *
+ * One function which takes a long time 60+ minutes to enrol users onto completion started.
+ */
+function completion_daily_cron() {
+    completion_cron_mark_started();
+}
 /**
  * Mark users as started if the config option is set
  *
index 7e7f4c7..de8b022 100644 (file)
@@ -1020,6 +1020,8 @@ $string['taskcachecron'] = 'Background processing for caches';
 $string['taskcalendarcron'] = 'Send calendar notifications';
 $string['taskcheckforupdates'] = 'Check for updates';
 $string['taskcompletioncron'] = 'Calculate completion data';
+$string['taskcompletioncronregular'] = 'Calculate regular completion data';
+$string['taskcompletioncrondaily'] = 'Completion mark as started';
 $string['taskcontextcleanup'] = 'Cleanup contexts';
 $string['taskcreatecontexts'] = 'Create missing contexts';
 $string['taskdeletecachetext'] = 'Delete old text cache records';
similarity index 77%
rename from lib/classes/task/completion_cron_task.php
rename to lib/classes/task/completion_cron_daily_task.php
index b34860a..ace3a5b 100644 (file)
 namespace core\task;
 
 /**
- * Simple task to run the completion cron.
+ * Simple task to run the daily completion cron.
+ * @copyright  2013 onwards Martin Dougiamas  http://dougiamas.com.
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  */
-class completion_cron_task extends scheduled_task {
+class completion_cron_daily_task extends scheduled_task {
 
     /**
      * Get a descriptive name for this task (shown to admins).
@@ -34,7 +36,7 @@ class completion_cron_task extends scheduled_task {
      * @return string
      */
     public function get_name() {
-        return get_string('taskcompletioncron', 'admin');
+        return get_string('taskcompletioncrondaily', 'admin');
     }
 
     /**
@@ -45,9 +47,9 @@ class completion_cron_task extends scheduled_task {
         global $CFG;
 
         if ($CFG->enablecompletion) {
-            // Completion cron.
+            // Daily Completion cron.
             require_once($CFG->dirroot.'/completion/cron.php');
-            completion_cron();
+            completion_daily_cron();
         }
     }
 
diff --git a/lib/classes/task/completion_cron_regular_task.php b/lib/classes/task/completion_cron_regular_task.php
new file mode 100644 (file)
index 0000000..29a0c52
--- /dev/null
@@ -0,0 +1,56 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle 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 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle 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 Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * A scheduled task.
+ *
+ * @package    core
+ * @copyright  2013 onwards Martin Dougiamas  http://dougiamas.com
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace core\task;
+
+/**
+ * Simple task to run the regular completion cron.
+ * @copyright  2013 onwards Martin Dougiamas  http://dougiamas.com.
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+ */
+class completion_cron_regular_task extends scheduled_task {
+
+    /**
+     * Get a descriptive name for this task (shown to admins).
+     *
+     * @return string
+     */
+    public function get_name() {
+        return get_string('taskcompletioncronregular', 'admin');
+    }
+
+    /**
+     * Do the job.
+     * Throw exceptions on errors (the job will be retried).
+     */
+    public function execute() {
+        global $CFG;
+
+        if ($CFG->enablecompletion) {
+            // Regular Completion cron.
+            require_once($CFG->dirroot.'/completion/cron.php');
+            completion_regular_cron();
+        }
+    }
+
+}
index 6c4d7d2..9954d59 100644 (file)
@@ -159,7 +159,7 @@ $tasks = array(
         'month' => '*'
     ),
     array(
-        'classname' => 'core\task\completion_cron_task',
+        'classname' => 'core\task\completion_cron_regular_task',
         'blocking' => 0,
         'minute' => '*',
         'hour' => '*',
@@ -167,6 +167,15 @@ $tasks = array(
         'dayofweek' => '*',
         'month' => '*'
     ),
+    array(
+        'classname' => 'core\task\completion_cron_daily_task',
+        'blocking' => 0,
+        'minute' => 'R',
+        'hour' => 'R',
+        'day' => '*',
+        'dayofweek' => '*',
+        'month' => '*'
+    ),
     array(
         'classname' => 'core\task\portfolio_cron_task',
         'blocking' => 0,