Add a management command to run a configured periodic job immediately #8909
Conversation
WalkthroughA new Django management command Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
This can be useful for testing.
SpecLad
force-pushed
the
run-periodic-job
branch
from
7304c35 to
ea47e87
Compare
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #8909 +/- ##
===========================================
- Coverage 73.93% 73.88% -0.05%
===========================================
Files 411 412 +1
Lines 44223 44261 +38
Branches 3993 3993
===========================================
+ Hits 32698 32704 +6
- Misses 11525 11557 +32
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
cvat/apps/engine/management/commands/runperiodicjob.py (1)
11-13: Consider enhancing argument handling with additional options.While the current implementation is functional, consider adding:
- Type validation for job_id
- A --dry-run flag to validate job existence without execution
- A --verbose flag for detailed execution information
def add_arguments(self, parser: ArgumentParser) -> None: - parser.add_argument("job_id", help="ID of the job to run") + parser.add_argument("job_id", help="ID of the job to run", type=str) + parser.add_argument( + "--dry-run", + action="store_true", + help="Validate job existence without executing it", + ) + parser.add_argument( + "--verbose", + action="store_true", + help="Show detailed execution information", + )
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
cvat/apps/engine/management/commands/runperiodicjob.py(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: testing
🔇 Additional comments (1)
cvat/apps/engine/management/commands/runperiodicjob.py (1)
1-9: LGTM! Clean imports and clear command definition.The imports are well-organized and the command class is properly defined following Django's management command patterns.
|
It feels like there should also be a way to list such jobs. |
There is - you run Okay, the real answer is that I expect this command to mostly be used by developers, and as a developer you presumably already know which job you want to run. |
Motivation and context
This can be useful for testing.
How has this been tested?
Manual testing.
Checklist
developbranch[ ] I have created a changelog fragment[ ] I have updated the documentation accordingly[ ] I have added tests to cover my changes[ ] I have linked related issues (see GitHub docs)[ ] I have increased versions of npm packages if it is necessary(cvat-canvas,
cvat-core,
cvat-data and
cvat-ui)
License
Feel free to contact the maintainers if that's a concern.
Summary by CodeRabbit