Skip to content

Commit

Permalink
MDL-70427 task: correct missing component when queuing adhoc task.
Browse files Browse the repository at this point in the history
If the task belongs to a component, and doesn't have it's own
component property set then we can lazy-load it based on class
namespace.
  • Loading branch information
paulholden committed Jul 12, 2021
1 parent 689e20c commit 42281e4
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 0 deletions.
22 changes: 22 additions & 0 deletions lib/classes/task/task_base.php
Expand Up @@ -136,6 +136,28 @@ public function set_component($component) {
* @return string
*/
public function get_component() {
if (empty($this->component)) {
// The component should be the root of the class namespace.
$classname = get_class($this);
$parts = explode('\\', $classname);

if (count($parts) === 1) {
$component = substr($classname, 0, strpos($classname, '_task'));
} else {
[$component] = $parts;
}

// Load component information from plugin manager.
if ($component !== 'core' && strpos($component, 'core_') !== 0) {
$plugininfo = \core_plugin_manager::instance()->get_plugin_info($component);
if ($plugininfo && $plugininfo->component) {
$this->set_component($plugininfo->component);
} else {
debugging("Component not set and the class namespace does not match a valid component ({$component}).");
}
}
}

return $this->component;
}

Expand Down
40 changes: 40 additions & 0 deletions lib/tests/adhoc_task_test.php
Expand Up @@ -110,6 +110,46 @@ public function test_get_next_adhoc_task_future() {
\core\task\manager::adhoc_task_complete($task);
}

/**
* Test queueing an adhoc task belonging to a component, where we set the task component accordingly
*/
public function test_queue_adhoc_task_for_component(): void {
$this->resetAfterTest();

$task = new \mod_forum\task\refresh_forum_post_counts();
$task->set_component('mod_test');

\core\task\manager::queue_adhoc_task($task);
$this->assertDebuggingNotCalled();
}

/**
* Test queueing an adhoc task belonging to a component, where we do not set the task component
*/
public function test_queue_task_for_component_without_set_component(): void {
$this->resetAfterTest();

$task = new \mod_forum\task\refresh_forum_post_counts();

\core\task\manager::queue_adhoc_task($task);
$this->assertDebuggingNotCalled();

// Assert the missing component was set.
$this->assertEquals('mod_forum', $task->get_component());
}

/**
* Test queueing an adhoc task belonging to an invalid component, where we do not set the task component
*/
public function test_queue_task_for_invalid_component_without_set_component(): void {
$this->resetAfterTest();

$task = new \mod_fake\task\adhoc_component_task();

\core\task\manager::queue_adhoc_task($task);
$this->assertDebuggingCalled('Component not set and the class namespace does not match a valid component (mod_fake).');
}

/**
* Test empty set of adhoc tasks
*/
Expand Down
8 changes: 8 additions & 0 deletions lib/tests/fixtures/task_fixtures.php
Expand Up @@ -62,3 +62,11 @@ public function get_name() {
public function execute() {
}
}

namespace mod_fake\task;

class adhoc_component_task extends \core\task\adhoc_task {
public function execute() {

}
}

0 comments on commit 42281e4

Please sign in to comment.