Introduce cron jobs to clean up the export cache (data/cache/export/) and temporary files/directories (data/tmp/)

[Marishka17]

Motivation and context

Depends on #8721
PR introduces the following changes:

• [Export datasets|backups] Cache cleaning moved into a separate cron job. A separate RQ job is no longer enqueued after each export process
• [Export datasets|backups] Temporary directory is created inside the common CVAT tmp directory (data/tmp/) instead of project|task|job/id/tmp/export_cache/
• [Export datasets] One tmp directory (instead of 2) is created during the export process
• Added the exportcachecleanup management command to remove outdated project|task|job/id/tmp/export_cache/ directories
• Added a cron job to clean up the data/tmp/ directory. The new setting TMP_FILE_OR_DIR_RETENTION_DAYS is used to determine whether a file or directory should be removed
• Locks are now used when working with backups as they are used for export

Notes:

• data/project|task|job/id/tmp/ is still used during uploading annotations/datasets, but this should be fixed in a separate PR.

Breaking changes:

• Enqueuing RQ jobs to backup a project/task: A filename argument was removed from the background function signature. Previously enqueued jobs will fail.
• Cleaning cache after exporting backups or datasets: Scheduled RQ jobs will fail due to cvat.apps.dataset_manager.views.clear_export_cache was moved and cvat.apps.engine.backup._clear_export_cache was deleted.

How has this been tested?

Checklist

• I submit my changes into the develop branch
• 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

• 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 periodic tasks for automatic cleanup of export caches for projects, tasks, and jobs.
  • Added new functionality for managing and cleaning up export cache files.

• Bug Fixes

  • Enhanced error handling for expired files in export processes.

• Refactor

  • Restructured export and cleanup functionalities for improved clarity and maintainability.
  • Updated test methods for better focus on export and cleanup operations.

• Documentation

  • Added deprecation warnings for outdated environment variables related to caching settings.

• Chores

  • Expanded formatting script to include new files for consistent code style.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces a comprehensive refactoring of the export and cache management system in the CVAT application. The changes span multiple files and focus on improving the modularity, error handling, and organization of export-related functionality. Key modifications include introducing new classes for file type management, restructuring export cache handling, adding periodic cleanup jobs for export caches, and enhancing the overall file management process across projects, tasks, and jobs.

Changes

File	Change Summary
cvat/apps/dataset_manager/util.py	Added ExportFileType enum, refactored filename parsing classes, introduced ExportCacheManager with new methods for file path generation
cvat/apps/dataset_manager/views.py	Removed get_export_cache_dir, updated export function, renamed _retry_current_rq_job to public method
cvat/apps/engine/models.py	Added abstract base classes _FileSystemRelatedModel and _Exportable, updated Project, Task, and Job models
cvat/apps/engine/cron.py	New file for managing export cache cleanup, added clear_export_cache and cron_export_cache_cleanup functions
cvat/settings/base.py	Added periodic jobs for export cache cleanup for projects, tasks, and jobs

Poem

🐰 Hop, hop, through export's maze,
Cleaning caches in clever ways,
Enum and manager, hand in paw,
Refactoring code without a flaw,
CVAT's rabbit leaps with glee! 🚀

Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[Marishka17]

/check

[github-actions]

❌ Some checks failed
📄 See logs here

[Marishka17]

/check

[github-actions]

✔️ All checks completed successfully
📄 See logs here

[Marishka17]

@zhiltsov-max, @SpecLad, okay, I've made several changes related to working with tmp dirs (including the export process):

1. The data/tmp/ directory is used now during the export process, and a specific prefix (export-<task|project|job>-...) is added to the directories created during the export process. I've initially included the resource type in a directory name to be able to use TTL_CONSTS. However, this is not used now due to the third point.
2. in the previous implementation, 2 tmp dirs were created during export. This has been fixed.
3. added a separate cron job to clear the data/tmp/ directory. This cron job iterates over all files and directories from data/tmp/ and deletes all items that were not accessed in the last N days (the default value is set to 2 weeks). This approach can guarantee that we won't have files/directories that should have been deleted but remained.

[zhiltsov-max]

and deletes all items that were not accessed in the last N days (the default value is set to 2 weeks)

Do you know why any value other than 1 day may be needed? Is there anything potentially useful in that directory?

The data/tmp/ directory is used now during the export process

The only concern I have about this is that we're still using os.replace() to finalize export, and it just an alias of os.rename() on linux, which doesn't support moving different disks. Probably, it's not a bit problem so far, but it can fire if someone tries to use a different mount for data/tmp. They will need to change os.replace to shutil.move.

[sonarqubecloud]

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.8% Duplication on New Code

See analysis details on SonarQube Cloud

[Marishka17]

Do you know why any value other than 1 day may be needed? Is there anything potentially useful in that directory?

No, I don't. I set this value to make sure I don't delete something we need too early.
As I can see, there are several cases when common tmp directory is used (not taking into account changes from this PR):

• to store some data when exporting events (in that case file should be removed after 1h)

  cvat/cvat/apps/events/export.py

  Line 162 in f8f40e2

  output_filename = os.path.join(settings.TMP_FILES_ROOT, f"{query_id}.csv")

• to store files when uploading by TUS (backups) and not(annotations|datasets|backups)

  cvat/cvat/apps/engine/views.py

  Line 3394 in f8f40e2

  dir=settings.TMP_FILES_ROOT,

  cvat/cvat/apps/engine/backup.py

  Line 1160 in f8f40e2

  return settings.TMP_FILES_ROOT

• to store some TUS-related files

  cvat/cvat/apps/engine/mixins.py

  Line 109 in f8f40e2

  return os.path.join(upload_dir, f"{file_id}.meta")

  (in case of uploading backups)