cvat Add a mechanism for statically defining periodic background jobs

Motivation and context

My main motivation was really to add a mechanism to statically define periodic jobs in the project configuration (which I need to do for a feature I'm working on). Such a mechanism is needed for a few reasons:

There's no good place to put code that creates periodic jobs. You could do it on app initialization, but that means you have to run Redis to use manage.py, which is inconvenient for development; and it causes much more Redis traffic than necessary, since the code will run whenever any backend service starts (or restarts). This patch fixes this by adding a new management command, syncperiodicjobs, that runs once per deployment.
It allows to find and delete jobs that are no longer needed. This is done by recording all created jobs in a Redis set. Without this, even when you delete the code that creates a job, the job itself would persist in Redis forever and require manual intervention to delete.
It contains common logic to recreate a job when its parameters change.

Besides the general mechanism, I also added one concrete job that cleans up expired Django sessions. This helps to demonstrate the mechanism, and is useful in its own right.

How has this been tested?

Manual testing.

Checklist

[x] I submit my changes into the develop branch
[x] I have created a changelog fragment
[x] 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

[x] I submit my code changes under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

New Features
- Introduced a new management command to synchronize periodic jobs with configuration settings.
- Added a session cleanup functionality to automatically clear expired sessions from the database daily.
- Updated development environment documentation for improved setup instructions.
Changelog
- Documented changes regarding daily session cleanup in the changelog.
Bug Fixes
- Enhanced backend initialization to ensure Redis service availability before executing commands.

Oct 16 '24 17:10 SpecLad

Walkthrough

The changes in this pull request introduce several enhancements across multiple files. A new debugging configuration for synchronizing periodic jobs has been added, along with modifications to the backend entrypoint script to initialize services. A new Django management command for syncing periodic jobs has been created, and a session cleanup function has been implemented. Additionally, the settings file now includes a scheduled job for daily session cleanup, and the development environment documentation has been updated to assist users.

Changes

File(s)	Change Summary
`.vscode/launch.json`	Added a new debug configuration for syncing periodic jobs.
`backend_entrypoint.sh`	Modified to include a `cmd_init` command that waits for Redis before executing sync jobs.
`changelog.d/20241017_133125_roman_periodic_jobs.md`	Added a changelog entry for daily clearing of expired sessions.
`cvat/apps/engine/management/commands/syncperiodicjobs.py`	Introduced a new management command for syncing periodic jobs with Redis.
`cvat/apps/iam/utils.py`	Added `clean_up_sessions` function for clearing expired sessions; modified `get_dummy_user`.
`cvat/settings/base.py`	Added a new periodic job `PERIODIC_RQ_JOBS` for daily session cleanup.
`site/content/en/docs/contributing/development-environment.md`	Updated documentation with new commands and notes for Mac and Arch Linux users.

Poem

🐰 In the garden where jobs align,
A new command, oh how divine!
With sessions cleared, our paths are bright,
Syncing jobs, all day and night.
For every rabbit, a cleaner space,
In our code, we find our grace! 🌼

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?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Oct 17 '24 10:10 coderabbitai[bot]

Codecov Report

Attention: Patch coverage is 72.34043% with 13 lines in your changes missing coverage. Please review.

Project coverage is 74.23%. Comparing base (0abe52f) to head (68942d0). Report is 1 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #8552      +/-   ##
===========================================
- Coverage    74.26%   74.23%   -0.03%     
===========================================
  Files          400      403       +3     
  Lines        43224    43273      +49     
  Branches      3909     3909              
===========================================
+ Hits         32100    32124      +24     
- Misses       11124    11149      +25