Fix notification for background tasks with no verbose_name #2091
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When notifying about a failed or rescheduled task, if the task was created without a "verbose_name", use its "task_name" instead. (See console.tasks.task_rescheduled_handler and console.tasks.task_failed_handler, and note that verbose_name is nullable whereas task_name isn't.) When you create a task, specifying a verbose_name is recommended, as it can provide more human-readable information than the task_name and task_params. However, if no verbose_name is provided, we still need something to put in the email subject.
|
good catch! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background tasks can be created with a "verbose name" which provides a human-readable description. This is what the existing background tasks (mostly implemented by Felipe) all do, and the verbose name is used when sending email notifications.
However, if a task is created without an explicit verbose_name (as is done in pull #2086), the verbose_name is set to None, which causes the email notification functions to crash.
It's best to use a verbose_name, but if we don't do so, we still want the notifications to work. :)