MDL-75191 task: implement task logs datasource for custom reporting.

Update existing entity to define remaining report elements. Add new
report source joining the entity to the user entity to provide data
for the reportbuilder editor.

admin/classes/local/entities/task_log.php

@@ -18,6 +18,7 @@ namespace core_admin\local\entities;
 
 use core_reportbuilder\local\filters\date;
 use core_reportbuilder\local\filters\duration;
+use core_reportbuilder\local\filters\number;
 use core_reportbuilder\local\filters\select;
 use core_reportbuilder\local\filters\text;
 use core_reportbuilder\local\filters\autocomplete;
@@ -62,15 +63,6 @@ class task_log extends base {
         return new lang_string('entitytasklog', 'admin');
     }
 
-    /**
-     * The default machine-readable name for this entity that will be used in the internal names of the columns/filters
-     *
-     * @return string
-     */
-    protected function get_default_entity_name(): string {
-        return 'task_log';
-    }
-
     /**
      * Initialise the entity
      *
@@ -82,9 +74,12 @@ class task_log extends base {
             $this->add_column($column);
         }
 
+        // All the filters defined by the entity can also be used as conditions.
         $filters = $this->get_all_filters();
         foreach ($filters as $filter) {
-            $this->add_filter($filter);
+            $this
+                ->add_filter($filter)
+                ->add_condition($filter);
         }
 
         return $this;
@@ -96,6 +91,7 @@ class task_log extends base {
      * @return column[]
      */
     protected function get_all_columns(): array {
+        global $DB;
 
         $tablealias = $this->get_table_alias('task_log');
 
@@ -118,11 +114,22 @@ class task_log extends base {
                     }
                 }
                 $output .= \html_writer::tag('div', "\\{$classname}", [
-                    'class' => 'task-class',
+                    'class' => 'small text-muted',
                 ]);
                 return $output;
             });
 
+        // Component column.
+        $columns[] = (new column(
+            'component',
+            new lang_string('plugin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TEXT)
+            ->add_field("{$tablealias}.component")
+            ->set_is_sortable(true);
+
         // Type column.
         $columns[] = (new column(
             'type',
@@ -130,11 +137,11 @@ class task_log extends base {
             $this->get_entity_name()
         ))
             ->add_joins($this->get_joins())
-            ->set_type(column::TYPE_INTEGER)
+            ->set_type(column::TYPE_TEXT)
             ->add_field("{$tablealias}.type")
             ->set_is_sortable(true)
-            ->add_callback(static function(int $value): string {
-                if (\core\task\database_logger::TYPE_SCHEDULED === $value) {
+            ->add_callback(static function($value): string {
+                if (\core\task\database_logger::TYPE_SCHEDULED === (int) $value) {
                     return get_string('task_type:scheduled', 'admin');
                 }
                 return get_string('task_type:adhoc', 'admin');
@@ -152,6 +159,18 @@ class task_log extends base {
             ->set_is_sortable(true)
             ->add_callback([format::class, 'userdate'], get_string('strftimedatetimeshortaccurate', 'core_langconfig'));
 
+        // End time column.
+        $columns[] = (new column(
+            'endtime',
+            new lang_string('task_endtime', 'admin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TIMESTAMP)
+            ->add_field("{$tablealias}.timeend")
+            ->set_is_sortable(true)
+            ->add_callback([format::class, 'userdate'], get_string('strftimedatetimeshortaccurate', 'core_langconfig'));
+
         // Duration column.
         $columns[] = (new column(
             'duration',
@@ -192,7 +211,9 @@ class task_log extends base {
             ->add_joins($this->get_joins())
             ->set_type(column::TYPE_INTEGER)
             ->add_field("{$tablealias}.pid")
-            ->set_is_sortable(true);
+            ->set_is_sortable(true)
+            // Although this is an integer column, it doesn't make sense to perform numeric aggregation on it.
+            ->set_disabled_aggregation(['avg', 'count', 'countdistinct', 'max', 'min', 'sum']);
 
         // Database column.
         $columns[] = (new column(
@@ -203,13 +224,37 @@ class task_log extends base {
             ->add_joins($this->get_joins())
             ->set_type(column::TYPE_INTEGER)
             ->add_fields("{$tablealias}.dbreads, {$tablealias}.dbwrites")
-            ->set_is_sortable(true)
+            ->set_is_sortable(true, ["{$tablealias}.dbreads", "{$tablealias}.dbwrites"])
             ->add_callback(static function(int $value, stdClass $row): string {
                 $output = '';
                 $output .= \html_writer::div(get_string('task_stats:dbreads', 'admin', $row->dbreads));
                 $output .= \html_writer::div(get_string('task_stats:dbwrites', 'admin', $row->dbwrites));
                 return $output;
-            });
+            })
+            // Although this is an integer column, it doesn't make sense to perform numeric aggregation on it.
+            ->set_disabled_aggregation(['avg', 'count', 'countdistinct', 'max', 'min', 'sum']);
+
+        // Database reads column.
+        $columns[] = (new column(
+            'dbreads',
+            new lang_string('task_dbreads', 'admin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_INTEGER)
+            ->add_fields("{$tablealias}.dbreads")
+            ->set_is_sortable(true);
+
+        // Database writes column.
+        $columns[] = (new column(
+            'dbwrites',
+            new lang_string('task_dbwrites', 'admin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_INTEGER)
+            ->add_fields("{$tablealias}.dbwrites")
+            ->set_is_sortable(true);
 
         // Result column.
         $columns[] = (new column(
@@ -218,11 +263,12 @@ class task_log extends base {
             $this->get_entity_name()
         ))
             ->add_joins($this->get_joins())
-            ->set_type(column::TYPE_INTEGER)
-            ->add_field("$tablealias.result")
+            ->set_type(column::TYPE_BOOLEAN)
+            // For accurate aggregation, we need to return boolean success = true by xor'ing the field value.
+            ->add_field($DB->sql_bitxor("{$tablealias}.result", 1), 'success')
             ->set_is_sortable(true)
-            ->add_callback(static function(int $value): string {
-                if ($value) {
+            ->add_callback(static function(bool $success): string {
+                if (!$success) {
                     return get_string('task_result:failed', 'admin');
                 }
                 return get_string('success');
@@ -266,6 +312,16 @@ class task_log extends base {
                 return $options;
             });
 
+        // Component filter.
+        $filters[] = (new filter(
+            text::class,
+            'component',
+            new lang_string('plugin'),
+            $this->get_entity_name(),
+            "{$tablealias}.component"
+        ))
+            ->add_joins($this->get_joins());
+
         // Type filter.
         $filters[] = (new filter(
             select::class,
@@ -290,20 +346,6 @@ class task_log extends base {
         ))
             ->add_joins($this->get_joins());
 
-        // Result filter.
-        $filters[] = (new filter(
-            select::class,
-            'result',
-            new lang_string('task_result', 'admin'),
-            $this->get_entity_name(),
-            "{$tablealias}.result"
-        ))
-            ->add_joins($this->get_joins())
-            ->set_options([
-                self::SUCCESS => get_string('success'),
-                self::FAILED => get_string('task_result:failed', 'admin'),
-            ]);
-
         // Start time filter.
         $filters[] = (new filter(
             date::class,
@@ -320,16 +362,66 @@ class task_log extends base {
                 date::DATE_CURRENT,
             ]);
 
+        // End time.
+        $filters[] = (new filter(
+            date::class,
+            'timeend',
+            new lang_string('task_endtime', 'admin'),
+            $this->get_entity_name(),
+            "{$tablealias}.timeend"
+        ))
+            ->add_joins($this->get_joins())
+            ->set_limited_operators([
+                date::DATE_ANY,
+                date::DATE_RANGE,
+                date::DATE_PREVIOUS,
+                date::DATE_CURRENT,
+            ]);
+
         // Duration filter.
         $filters[] = (new filter(
             duration::class,
             'duration',
             new lang_string('task_duration', 'admin'),
             $this->get_entity_name(),
-            "${tablealias}.timeend - {$tablealias}.timestart"
+            "{$tablealias}.timeend - {$tablealias}.timestart"
         ))
             ->add_joins($this->get_joins());
 
+        // Database reads.
+        $filters[] = (new filter(
+            number::class,
+            'dbreads',
+            new lang_string('task_dbreads', 'admin'),
+            $this->get_entity_name(),
+            "{$tablealias}.dbreads"
+        ))
+            ->add_joins($this->get_joins());
+
+        // Database writes.
+        $filters[] = (new filter(
+            number::class,
+            'dbwrites',
+            new lang_string('task_dbwrites', 'admin'),
+            $this->get_entity_name(),
+            "{$tablealias}.dbwrites"
+        ))
+            ->add_joins($this->get_joins());
+
+        // Result filter.
+        $filters[] = (new filter(
+            select::class,
+            'result',
+            new lang_string('task_result', 'admin'),
+            $this->get_entity_name(),
+            "{$tablealias}.result"
+        ))
+            ->add_joins($this->get_joins())
+            ->set_options([
+                self::SUCCESS => get_string('success'),
+                self::FAILED => get_string('task_result:failed', 'admin'),
+            ]);
+
         return $filters;
     }
 }

admin/classes/reportbuilder/datasource/task_logs.php

@@ -0,0 +1,117 @@
+<?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/>.
+
+declare(strict_types=1);
+
+namespace core_admin\reportbuilder\datasource;
+
+use core_reportbuilder\datasource;
+use core_reportbuilder\local\entities\user;
+use core_reportbuilder\local\filters\select;
+use core_admin\local\entities\task_log;
+
+/**
+ * Task logs datasource
+ *
+ * @package     core_admin
+ * @copyright   2022 Paul Holden <[email protected]>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class task_logs extends datasource {
+
+    /**
+     * Return user friendly name of the report source
+     *
+     * @return string
+     */
+    public static function get_name(): string {
+        return get_string('tasklogs', 'core_admin');
+    }
+
+    /**
+     * Initialise report
+     */
+    protected function initialise(): void {
+        $tasklogentity = new task_log();
+
+        $tasklogalias = $tasklogentity->get_table_alias('task_log');
+        $this->set_main_table('task_log', $tasklogalias);
+
+        $this->add_entity($tasklogentity);
+
+        // Join the user entity to represent the associated user.
+        $userentity = new user();
+        $useralias = $userentity->get_table_alias('user');
+        $this->add_entity($userentity->add_join("
+            LEFT JOIN {user} {$useralias}
+                   ON {$useralias}.id = {$tasklogalias}.userid")
+        );
+
+        // Add report elements from each of the entities we added to the report.
+        $this->add_all_from_entities();
+    }
+
+    /**
+     * Return the columns that will be added to the report upon creation
+     *
+     * @return string[]
+     */
+    public function get_default_columns(): array {
+        return [
+            'task_log:name',
+            'task_log:starttime',
+            'task_log:duration',
+            'task_log:result',
+        ];
+    }
+
+    /**
+     * Return the filters that will be added to the report upon creation
+     *
+     * @return string[]
+     */
+    public function get_default_filters(): array {
+        return [
+            'task_log:timestart',
+            'task_log:result',
+        ];
+    }
+
+    /**
+     * Return the conditions that will be added to the report upon creation
+     *
+     * @return string[]
+     */
+    public function get_default_conditions(): array {
+        return [
+            'task_log:type',
+            'task_log:timestart',
+            'task_log:result',
+        ];
+    }
+
+    /**
+     * Return the condition values that will be set for the report upon creation
+     *
+     * @return array
+     */
+    public function get_default_condition_values(): array {
+        return [
+            'task_log:type_operator' => select::EQUAL_TO,
+            'task_log:type_value' => \core\task\database_logger::TYPE_SCHEDULED,
+        ];
+    }
+}