[#2636] stop using human-friendly names for tasks #1320
Merged
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #1320 +/- ##
===========================================
- Coverage 95.13% 95.13% -0.01%
===========================================
Files 991 991
Lines 35887 35885 -2
===========================================
- Hits 34141 34139 -2
Misses 1746 1746 ☔ View full report in Codecov by Sentry. |
The Celery docs make clear that the name parameter of the task decorator should be unique and that generally it functions as an identifier the task. From this we can also infer that names that change at runtime, due to gettext, are undesirable. This in fact created issue with triggering certain periodic tasks in the admin, due to a mismatch between the registered name (English) and the translated name used at runtime (Dutch). TLDR: let Celery generate the name, and directly translate the periodic task names for Beat so that the entries in the Django periodic task admin are human-readable. This is not ideal as we would like to use (lazy) gettext here, but Celery doesn't allow that, so this strikes the balance between human-readability and predictable task discovery.
swrichards
force-pushed
the
issues/2636-fix-task-names
branch
from
e70cc71 to
7e96e60
Compare
pi-sigma
approved these changes
Jul 24, 2024
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.
The Celery docs make clear that the name parameter of the task decorator should be unique and that generally it functions as an identifier the task. From this we can also infer that names that change at runtime, due to gettext, are undesirable. This in fact created issue with triggering certain periodic tasks in the admin, due to a mismatch between the registered name (English) and the translated name used at runtime (Dutch).
TLDR: let Celery generate the name, and directly translate the periodic task names for Beat so that the entries in the Django periodic task admin are human-readable. This is not ideal as we would like to use (lazy) gettext here, but Celery doesn't allow that, so this strikes the balance between human-readability and predictable task discovery.
Taiga 2636.