Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Exception Message to Taks Notification Email #43666

Open
wants to merge 12 commits into
base: 5.1-dev
Choose a base branch
from

Conversation

brbrbr
Copy link

@brbrbr brbrbr commented Jun 17, 2024

Summary of Changes

The email sent by the system plugin task notification contains very little useful information. This adjustment adds the Exception message to the emails.
The emails point to the Joomla! backend for more information, however there is no info in the dashboard since the taskcontent is not stored and the logs are well hidden.

Testing Instructions

Enable email notifications for failure for any active task for example in sessiongc. Is enabled by default.

Throw an exception in that task, for example:
` private function sessionGC(ExecuteTaskEvent $event): int
{

    throw new \Exception('test');

...
`
execute the task

Actual result BEFORE applying this Pull Request

Email with little information

Expected result AFTER applying this Pull Request

Email with the exception message

Link to documentations

Please select:

  • Documentation link for docs.joomla.org:

  • No documentation changes for docs.joomla.org needed

  • Pull Request link for manual.joomla.org:

  • No documentation changes for manual.joomla.org needed

muhme and others added 2 commits June 17, 2024 09:07
…#43656)

- fixes issue joomla#43620 - if no 'rm' command is available on Windows
- fixes issue joomla#43622 - if cmsPath is set
- custom task 'deleteFolder' can also delete a file and ignores
  if the file does not exist -> exactly what we need
- once PR is merged i will create the next PR to rename 'deleteFolder' as 'deleteRelativePath'
  and also 'writeFile' as 'writeRelativeFile' to better represent the functions
@joomla-cms-bot joomla-cms-bot added Language Change This is for Translators PR-5.1-dev labels Jun 17, 2024
@brianteeman
Copy link
Contributor

If the email now includes the message is there any point in telling someone to go to the joomla admin etc?

@brbrbr
Copy link
Author

brbrbr commented Jun 18, 2024

If the email now includes the message is there any point in telling someone to go to the joomla admin etc?

Good point,

Actually, in the current situation, there is also no point of telling someone to go to the admin. Since there is no information there.
(unless you have an extension to view the logs).

Should I include the debug trace in the email as well? That one is neither stored nor logged.

Bram

Co-authored-by: Richard Fath <richard67@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Language Change This is for Translators PR-5.1-dev
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants