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

Marishka17 · 2024-12-09T17:16:26Z

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 · 2024-12-09T17:16:34Z

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! 🚀

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 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 · 2024-12-10T16:10:19Z

/check

github-actions · 2024-12-10T16:10:32Z

❌ Some checks failed
📄 See logs here

…working with a file

Marishka17 · 2024-12-20T12:45:43Z

/check

github-actions · 2024-12-20T12:45:56Z

✔️ All checks completed successfully
📄 See logs here

Marishka17 · 2025-01-09T11:26:55Z

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

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.
in the previous implementation, 2 tmp dirs were created during export. This has been fixed.
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 · 2025-01-09T12:10:27Z

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.

Marishka17 · 2025-01-09T17:34:01Z

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)

zhiltsov-max · 2025-01-10T14:39:58Z

site/content/en/docs/administration/advanced/upgrade_guide.md

+
+In version 2.25.0, CVAT changed the location where the export cache is stored.
+To clean up the outdated cache, run the following command: `python manage.py exportcachecleanup`.
+


Enqueuing RQ jobs to backup a project/task: A filename argument was removed from the background function signature. Previously enqueued jobs will fail.

What do you think about adding a one-off migration script to avoid losing existing RQ jobs? Unlike cleanup jobs these are real user requests. It should probably just remove 1 parameter from the existing jobs.

In that case, we'll have to make this PR dependent on #8898

cvat/settings/base.py

cvat/apps/engine/views.py

zhiltsov-max · 2025-01-10T15:23:09Z

cvat/apps/engine/backup.py

@@ -542,7 +559,7 @@ def _export_task(self, zip_obj, target_dir=None):
        self._write_annotations(zip_obj, target_dir)
        self._write_annotation_guide(zip_obj, target_dir)

-    def export_to(self, file, target_dir=None):
+    def export_to(self, file: str | ZipFile, target_dir: str | None = None):


Not an error, but such annotations in inherited functions tend to become outdated quickly. Typically it's better to just use annotations from the original function instead of duplicating them everywhere.

zhiltsov-max · 2025-01-10T15:26:27Z

cvat/apps/engine/backup.py

+    # FUTURE-FIXME: there db_instance_id should be passed
+    db_instance: models.Project | models.Task,


Why not change this parameter if the function args are already changed in this PR?

zhiltsov-max · 2025-01-10T15:55:24Z

cvat/apps/dataset_manager/management/commands/exportcachecleanup.py

+            progress = (i + 1) / objects_count
+            done = int(progress_bar_len * progress)
+            progress_bar = "#" * done + "-" * (progress_bar_len - done)
+            self.stdout.write(f"\rProgress: |{progress_bar}| {progress:.0%}", ending="")


This might not work on mac and windows. Why not use tqdm?

Ask Roman about it

@SpecLad, I saw you were saying it's not installed, but why not install it? Do you see any problems with that?

cvat/apps/dataset_manager/management/commands/exportcachecleanup.py

zhiltsov-max · 2025-01-10T17:07:12Z

cvat/apps/dataset_manager/cron.py

+                log_exception(logger)
+
+
+def cleanup(thread_class_path: str) -> None:


python manage.py runperiodicjob cron_export_cache_cleanup

TypeError: cleanup() missing 1 required positional argument: 'thread_class_path'

seconds_left = rq_job.timeout - 60 AttributeError: 'NoneType' object has no attribute 'timeout'

Probably, default args should be passed.

The runperiodicjob command was added this week. This command should support passing args rather than setting the default value for the cleanup function.

AttributeError: 'NoneType' object has no attribute 'timeout'

because this command should be executed only from the worker process (by the current design). If you think that it will be useful to allow running this command not only by worker process, please provide reasons.

It's a periodic job, and we have a command to run periodic jobs manually. Probably, it should support such execution or clarify why it doesn't.

site/content/en/docs/administration/advanced/upgrade_guide.md

sonarqubecloud · 2025-01-10T18:41:55Z

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

zhiltsov-max · 2025-01-11T12:46:43Z

site/content/en/docs/administration/advanced/upgrade_guide.md

+{{< tabpane lang="shell" >}}
+  {{< tab header="Docker" >}}
+  docker exec -it cvat_server python manage.py exportcachecleanup
+  {{< /tab >}}
+  {{< tab header="Kubernetes" >}}
+  cvat_backend_pod=$(kubectl get pods -l component=server -o 'jsonpath={.items[0].metadata.name}')
+  kubectl exec -it ${cvat_backend_pod} -- python manage.py exportcachecleanup
+  {{< /tab >}}
+  {{< tab header="Development" >}}
+  python manage.py exportcachecleanup
+  {{< /tab >}}
+{{< /tabpane >}}


Suggested change

{{< tabpane lang="shell" >}}

{{< tab header="Docker" >}}

docker exec -it cvat_server python manage.py exportcachecleanup

{{< /tab >}}

{{< tab header="Kubernetes" >}}

cvat_backend_pod=$(kubectl get pods -l component=server -o 'jsonpath={.items[0].metadata.name}')

kubectl exec -it ${cvat_backend_pod} -- python manage.py exportcachecleanup

{{< /tab >}}

{{< tab header="Development" >}}

python manage.py exportcachecleanup

{{< /tab >}}

{{< /tabpane >}}



{{< tabpane lang="shell" >}}

{{< tab header="Docker" >}}

docker exec -it cvat_server python manage.py exportcachecleanup

{{< /tab >}}

{{< tab header="Kubernetes" >}}

cvat_backend_pod=$(kubectl get pods -l component=server -o 'jsonpath={.items[0].metadata.name}')

kubectl exec -it ${cvat_backend_pod} -- python manage.py exportcachecleanup

{{< /tab >}}

{{< tab header="Development" >}}

python manage.py exportcachecleanup

{{< /tab >}}

{{< /tabpane >}}



It looks like there is some bug in remarklint.

Move export cache cleaning into the cron jobs

4723737

Marishka17 force-pushed the mk/clear_cache_cron_job branch 2 times, most recently from b885dac to f20eadf Compare December 10, 2024 16:00

Refactor a bit

92f9d0b

Marishka17 force-pushed the mk/clear_cache_cron_job branch from f20eadf to 92f9d0b Compare December 10, 2024 16:09

Merge branch 'develop' into mk/clear_cache_cron_job

1605bdc

cvat-ai deleted a comment from github-actions bot Dec 10, 2024

Remove outdated code

e4c24ea

Marishka17 force-pushed the mk/clear_cache_cron_job branch from 14084b8 to e4c24ea Compare December 11, 2024 11:02

Add todo comments

3412993

Marishka17 changed the title ~~Move export cache cleaning into cron jobs~~ [WIP] Move export cache cleaning into cron jobs Dec 11, 2024

Marishka17 added 4 commits December 13, 2024 13:28

Merge branch 'develop' into mk/clear_cache_cron_job

137386d

[Backups] clean up export cache from a cron job && use locks duiring …

2cc395c

…working with a file

Merge branch 'develop' into mk/clear_cache_cron_job

35137fc

Fix pylint issues

028313f

Marishka17 changed the title ~~[WIP] Move export cache cleaning into cron jobs~~ [Dependent] Move export cache cleaning into cron jobs Dec 17, 2024

Marishka17 added 5 commits December 17, 2024 13:57

Remove todo

5292d29

typo

b18a008

Resolve conflicts

2b25b10

Update tests

8fec24a

Update after merging #8721

81ec1fc

Marishka17 changed the title ~~[Dependent] Move export cache cleaning into cron jobs~~ Move export cache cleaning into cron jobs Dec 20, 2024

Marishka17 added 2 commits December 20, 2024 12:08

Move touch_last_export_date() call into worker

0a6dbdc

[Unit tests] Check that cron job deletes files from cache

529b5c6

Move functions into separate engine module

32ef451

Marishka17 force-pushed the mk/clear_cache_cron_job branch from ed20c3d to 476c688 Compare January 9, 2025 11:02

Marishka17 added 3 commits January 9, 2025 12:04

Fix imports sorting

edd2268

Remove todo

ae68b9b

Merge branch 'develop' into mk/clear_cache_cron_job

47c0f65

Marishka17 changed the title ~~[WIP] Move export cache cleaning into cron jobs~~ [do not merge] Move export cache cleaning into cron jobs Jan 9, 2025

Run CI

aab5350

Marishka17 force-pushed the mk/clear_cache_cron_job branch from 7da8a17 to 2c6794a Compare January 9, 2025 13:22

Try to fix tests

716f13c

Marishka17 force-pushed the mk/clear_cache_cron_job branch from 2c6794a to 716f13c Compare January 9, 2025 13:26

os.replace -> shutil.move

7abd5ab

Marishka17 changed the title ~~[do not merge] Move export cache cleaning into cron jobs~~ Introduce cron jobs to clean up the export cache (data/cache/export/) and temporary files/directories (data/tmp/) Jan 9, 2025

Marishka17 added the server label Jan 9, 2025

Write to self.stdout

f3c4120

zhiltsov-max reviewed Jan 10, 2025

View reviewed changes

cvat/settings/base.py Outdated Show resolved Hide resolved

zhiltsov-max reviewed Jan 10, 2025

View reviewed changes

cvat/apps/engine/views.py Show resolved Hide resolved

zhiltsov-max reviewed Jan 10, 2025

View reviewed changes

cvat/apps/dataset_manager/management/commands/exportcachecleanup.py Outdated Show resolved Hide resolved

zhiltsov-max reviewed Jan 10, 2025

View reviewed changes

site/content/en/docs/administration/advanced/upgrade_guide.md Outdated Show resolved Hide resolved

Marishka17 added 3 commits January 10, 2025 18:43

Reduce max lifetime of tmp files/dirs

15cf958

Suppress exception

e393a10

Update doc

606c382

zhiltsov-max reviewed Jan 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

Marishka17 commented Dec 9, 2024 •

edited

Loading

coderabbitai bot commented Dec 9, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Marishka17 commented Dec 10, 2024

github-actions bot commented Dec 10, 2024 •

edited

Loading

Marishka17 commented Dec 20, 2024

github-actions bot commented Dec 20, 2024 •

edited

Loading

Marishka17 commented Jan 9, 2025 •

edited

Loading

zhiltsov-max commented Jan 9, 2025

Marishka17 commented Jan 9, 2025

zhiltsov-max Jan 10, 2025 •

edited

Loading

Marishka17 Jan 10, 2025

zhiltsov-max Jan 10, 2025

zhiltsov-max Jan 10, 2025

zhiltsov-max Jan 10, 2025

Marishka17 Jan 10, 2025

zhiltsov-max Jan 10, 2025

zhiltsov-max Jan 10, 2025 •

edited

Loading

Marishka17 Jan 10, 2025 •

edited

Loading

zhiltsov-max Jan 10, 2025

sonarqubecloud bot commented Jan 10, 2025

zhiltsov-max Jan 11, 2025


		In version 2.25.0, CVAT changed the location where the export cache is stored.
		To clean up the outdated cache, run the following command: `python manage.py exportcachecleanup`.

		# FUTURE-FIXME: there db_instance_id should be passed
		db_instance: models.Project \| models.Task,

		log_exception(logger)


		def cleanup(thread_class_path: str) -> None:

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

Are you sure you want to change the base?

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

Conversation

Marishka17 commented Dec 9, 2024 • edited Loading

Motivation and context

How has this been tested?

Checklist

License

Summary by CodeRabbit

coderabbitai bot commented Dec 9, 2024 • edited Loading

Review skipped

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Marishka17 commented Dec 10, 2024

github-actions bot commented Dec 10, 2024 • edited Loading

Marishka17 commented Dec 20, 2024

github-actions bot commented Dec 20, 2024 • edited Loading

Marishka17 commented Jan 9, 2025 • edited Loading

zhiltsov-max commented Jan 9, 2025

Marishka17 commented Jan 9, 2025

zhiltsov-max Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhiltsov-max Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

Marishka17 Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Jan 10, 2025

Quality Gate passed

Choose a reason for hiding this comment

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

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

Marishka17 commented Dec 9, 2024 •

edited

Loading

coderabbitai bot commented Dec 9, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Dec 10, 2024 •

edited

Loading

github-actions bot commented Dec 20, 2024 •

edited

Loading

Marishka17 commented Jan 9, 2025 •

edited

Loading

zhiltsov-max Jan 10, 2025 •

edited

Loading

zhiltsov-max Jan 10, 2025 •

edited

Loading

Marishka17 Jan 10, 2025 •

edited

Loading