Loading...

XML

Word

Printable

Type: Improvement
Resolution: Unresolved
Priority: Minor
Fix Version/s: None
Affects Version/s: Future Dev
Component/s: Report builder, Tasks
Labels:

Epic Link:
Report builder (reports) 5.1
Pull from Repository:
https://github.com/QT204/moodle
Pull Main Branch:
MDL-82173-task-custom-data
Pull Main Diff URL:
https://github.com/moodle/moodle/compare/main...QT204:moodle:MDL-82173-task-custom-data
Testing Instructions:
Hide

Install this plugin to help with testing
https://github.com/catalyst/moodle-tool_testtasks

Run this to create some test adhoc tasks
php admin/tool/testtasks/cli/queue_adhoc_tasks.php -n=10

Run cron to execute these and make some logs

Visit /admin/tasklogs.php and confirm you see all the logs for this task

Confirm for adhoc tasks you see the new suffix of the task id eg
"Timed adhoc task - Task ID: 768"

Confirm you see a new column exposing the Custom Data

Confirm you can filter to just one task eg Task ID 'is equal to' = 769

Remove that filter

Confirm you can filter tasks based on custom data, eg Custom Data, contains = 'loopdelay'
Show
Install this plugin to help with testing https://github.com/catalyst/moodle-tool_testtasks Run this to create some test adhoc tasks php admin/tool/testtasks/cli/queue_adhoc_tasks.php -n=10 Run cron to execute these and make some logs Visit /admin/tasklogs.php and confirm you see all the logs for this task Confirm for adhoc tasks you see the new suffix of the task id eg "Timed adhoc task - Task ID: 768" Confirm you see a new column exposing the Custom Data Confirm you can filter to just one task eg Task ID 'is equal to' = 769 Remove that filter Confirm you can filter tasks based on custom data, eg Custom Data, contains = 'loopdelay'
Pre-check results:
Hide

Code verified against automated checks with warnings.

Checked MDL-82173 using repository: https://github.com/QT204/moodle

main (0 errors / 4 warnings) [branch: MDL-82173-task-custom-data | CI Job]

overview (0/0), phplint (0/0), phpcs (0/1), js (0/0), css (0/0), phpdoc (0/0), commit (0/0), savepoint (0/0), thirdparty (0/0), externalbackup (0/3), grunt (0/0), shifter (0/0), mustache (0/0), gherkin (0/0),

Should these errors be fixed?

Built on: Wed Feb 26 02:08:23 AM UTC 2025
Show
Code verified against automated checks with warnings. Checked MDL-82173 using repository: https://github.com/QT204/moodle main (0 errors / 4 warnings) [branch: MDL-82173-task-custom-data | CI Job ] overview (0/0) , phplint (0/0) , phpcs (0/1) , js (0/0) , css (0/0) , phpdoc (0/0) , commit (0/0) , savepoint (0/0) , thirdparty (0/0) , externalbackup (0/3) , grunt (0/0) , shifter (0/0) , mustache (0/0) , gherkin (0/0) , Should these errors be fixed? Built on: Wed Feb 26 02:08:23 AM UTC 2025
Automated test results:
Hide

Launching automatic jobs for branch MDL-82173-task-custom-data

https://ci.moodle.org/view/Testing/job/DEV.02%20-%20Developer-requested%20PHPUnit/17253/ PHPUnit (sqlsrv)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/58792/ Behat (NonJS - boost and classic)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/58793/ Behat (Firefox - boost)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/58794/ Behat (Firefox - classic)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/58795/ App tests (stable app version)

Built on: Wed Nov 6 04:25:13 AM UTC 2024
Show
Launching automatic jobs for branch MDL-82173 -task-custom-data https://ci.moodle.org/view/Testing/job/DEV.02%20-%20Developer-requested%20PHPUnit/17253/ PHPUnit (sqlsrv) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/58792/ Behat (NonJS - boost and classic) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/58793/ Behat (Firefox - boost) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/58794/ Behat (Firefox - classic) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/58795/ App tests (stable app version) Built on: Wed Nov 6 04:25:13 AM UTC 2024

Lets say we have a plugin that does stuff and queues up an adhoc task, and it has custom data of {course: 12345}

In it's own logs it knows that the custom data was, it would be very nice to be able to deep link into the task logs page filtered to just the specific tasks we are interested in:

/admin/tasklogs.php?customdata=course:123

This would show all the instances of this task type with that specific custom data.

Or you should be able to search by the adhoc task id and see all the instance of that run (maybe is failed twice and then ran) like this:

/admin/tasklogs.php?taskid=2641

This is blocked by report builder generally not having deep links (see MDL-73292), and specifically here by not being able to filter via either the adhoc task id, or the custom data.

- - Sort By Name
  - Sort By Date
  - Ascending
  - Descending
  - Thumbnails
  - List
  - Download All

Screenshot 2024-11-11 at 15-25-51 Task logs (#82173) Integration Master.png
24 kB
12/Nov/24 12:19 AM

has a non-specific relationship to

MDL-73292 Report builder urls with filters, sort, pagination should be bookmarkable / deep linkable

Open

MDL-77305 Support logical boolean operators in custom report conditions

Open

MDL-82887 Include nullable ad-hoc task ID column in task logs

Open

is blocked by

MDL-83686 Custom Task logs report cannot be grouped by task name

Closed

will help resolve

MDL-81243 Task logs pretty useless for adhoc tasks - try fixing for quiz_statistics\task\recalculate

Open

Assignee:: Brendan Heywood

Reporter:: Brendan Heywood

Peer reviewer:: Djarran Cotleanu

Integrator:: Paul Holden

Participants:: Brendan Heywood, CiBoT, Djarran Cotleanu, Paul Holden

Votes:: 1 Vote for this issue

Watchers:: 7 Start watching this issue

Created:: 12/Jun/24 11:08 AM

Updated:: 03/Mar/25 10:06 PM

Details

Description

Attachments

Attachments

Issue Links

Activity

People

Dates

Clockify