Support redis migrations #8898

Marishka17 · 2025-01-03T17:32:13Z

Motivation and context

Sometimes we need to modify the data stored in Redis (for instance, in the near future we will change the identifiers of RQ jobs). This PR introduces a common mechanism for handling Redis migrations.

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.

coderabbitai · 2025-01-03T17:32:19Z

Important

Review skipped

Draft detected.

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.

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.

cvat/apps/engine/management/commands/migrateredis.py

cvat/apps/engine/models.py

sonarqubecloud · 2025-01-16T10:40:11Z

Quality Gate passed

Issues
2 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

cvat/apps/engine/redis_migrations/001_cleanup_scheduled_jobs.py

cvat/apps/redis_handler/apps.py

cvat/apps/redis_handler/management/commands/migrateredis.py

cvat/apps/redis_handler/migration_loader.py

dev/format_python_code.sh

cvat/apps/redis_handler/models.py

codecov-commenter · 2025-01-16T14:51:39Z

Codecov Report

Attention: Patch coverage is 68.57143% with 44 lines in your changes missing coverage. Please review.

Project coverage is 73.41%. Comparing base (30e900b) to head (98d0037).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #8898      +/-   ##
===========================================
- Coverage    73.41%   73.41%   -0.01%     
===========================================
  Files          418      427       +9     
  Lines        44299    44439     +140     
  Branches      3870     3870              
===========================================
+ Hits         32524    32625     +101     
- Misses       11775    11814      +39

Components	Coverage Δ
cvat-ui	`77.40% <ø> (+0.02%)`	⬆️
cvat-server	`70.11% <68.57%> (-0.01%)`	⬇️

backend_entrypoint.sh

…is-migrations

Marishka17 · 2025-01-17T16:54:24Z

I have no time to investigate what is going on with Helm tests

cvat/apps/redis_handler/migration_loader.py

Marishka17 · 2025-01-27T09:14:02Z

cvat-ui/src/components/export-backup/styles.scss

It looks like these changes were made by pre-commit hook
@bsekachev

backend_entrypoint.sh

cvat/apps/engine/redis_migrations/__init__.py

cvat/apps/redis_handler/management/commands/migrateredis.py

SpecLad · 2025-01-29T11:29:00Z

cvat/apps/redis_handler/migration_loader.py

+    applied_date: datetime = field(
+        validator=[validators.instance_of(datetime)], converter=to_datetime
+    )
+    identifier: UUID = field(factory=uuid4, converter=to_uuid)


Why do we need an extra identifier? Shouldn't <app_label>.<name> already be a unique key?

Yes, it should, probably I did so initially because I would not keep only the applied date in a hash item

cvat/apps/redis_handler/migration_loader.py

cvat/apps/redis_handler/management/commands/migrateredis.py

cvat/apps/redis_handler/migration_loader.py

sonarqubecloud · 2025-01-31T09:20:06Z

Quality Gate passed

Issues
3 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

Marishka17 · 2025-01-31T09:32:18Z

It seems that these tests are unstable. I've compared the latest logs with logs where there was a problem with helm tests related to resetting applied migrations from the Redis and waiting in workers for them. Workers are initialized correctly and start running.
https://github.com/cvat-ai/cvat/actions/runs/12833455817
https://github.com/cvat-ai/cvat/actions/runs/13054237659

Draft: add custom 'migrateredis' management command

7a32e8b

SpecLad reviewed Jan 7, 2025

View reviewed changes

Marishka17 added 2 commits January 10, 2025 11:16

Merge branch 'develop' into mk/redis-migrations

78338c7

[draft] Add MigrationLoader

10e3a1d

Marishka17 mentioned this pull request Jan 10, 2025

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

Merged

7 tasks

Marishka17 added 3 commits January 15, 2025 15:44

Move logic to a separate app

fae0974

Merge branch 'develop' into mk/redis-migrations

88ef5a0

Fix linter issues

dc1f3bb

Marishka17 force-pushed the mk/redis-migrations branch from 2e68c0f to dc1f3bb Compare January 15, 2025 14:51

Marishka17 added 3 commits January 16, 2025 11:38

Add test migration

233d0a9

Merge branch 'develop' into mk/redis-migrations

a9ae8fd

Run migrateredis before syncperiodicjobs

fac9f58

Marishka17 marked this pull request as ready for review January 16, 2025 10:39

Marishka17 requested a review from azhavoro as a code owner January 16, 2025 10:39

Marishka17 added 2 commits January 16, 2025 11:40

linters

603fe90

Notify if there are no migrations

0b49bbe

Marishka17 force-pushed the mk/redis-migrations branch from 152a52f to 0b49bbe Compare January 16, 2025 11:16

Marishka17 added the server label Jan 16, 2025

Marishka17 added 2 commits January 16, 2025 12:26

Support Redis migrations from enterprise apps

170e0f3

Run CI

2bb68c9

SpecLad reviewed Jan 16, 2025

View reviewed changes

Fix minor stupid comments

bd756e1

Marishka17 changed the title ~~Support redis migrations~~ [WIP] Support redis migrations Jan 16, 2025

Marishka17 added 3 commits January 17, 2025 10:21

Simplify the code

580f9a8

Move periodic job commands to redis_handler

bbb12b6

Update development guide

0bea986

SpecLad reviewed Jan 17, 2025

View reviewed changes

backend_entrypoint.sh Show resolved Hide resolved

Marishka17 added 3 commits January 17, 2025 17:44

allow using shared connection

96f7a7a

Merge remote-tracking branch 'origin/mk/redis-migrations' into mk/red…

1834099

…is-migrations

changelog

634f460

Marishka17 requested a review from nmanovic as a code owner January 17, 2025 16:52

Marishka17 changed the title ~~Support redis migrations~~ [do not merge] Support redis migrations Jan 17, 2025

Marishka17 commented Jan 17, 2025

View reviewed changes

cvat/apps/redis_handler/migration_loader.py Outdated Show resolved Hide resolved

Marishka17 added 2 commits January 17, 2025 17:58

Update cvat/apps/redis_handler/migration_loader.py

5582bd9

Resolve conflicts

36ae237

Marishka17 requested a review from bsekachev as a code owner January 27, 2025 09:07

Marishka17 added 2 commits January 27, 2025 10:08

add empty line

ba1ef79

fix black issue

942a78c

Marishka17 commented Jan 27, 2025

View reviewed changes

Marishka17 requested a review from zhiltsov-max as a code owner January 27, 2025 11:20

Marishka17 force-pushed the mk/redis-migrations branch from 180b858 to 66b3b25 Compare January 27, 2025 11:36

[tests] Do not reset cvat migrations from redis

32243a7

Marishka17 force-pushed the mk/redis-migrations branch from 66b3b25 to 32243a7 Compare January 27, 2025 11:36

Marishka17 changed the title ~~[do not merge] Support redis migrations~~ Support redis migrations Jan 27, 2025

Marishka17 requested review from SpecLad and removed request for zhiltsov-max, bsekachev, nmanovic and azhavoro January 27, 2025 12:34

SpecLad reviewed Jan 29, 2025

View reviewed changes

Marishka17 added 4 commits January 30, 2025 13:45

Apply comments

7478890

Merge branch 'develop' into mk/redis-migrations

f08bd9b

Merge branch 'develop' into mk/redis-migrations

4d5f70c

Merge branch 'develop' into mk/redis-migrations

98d0037

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support redis migrations #8898

Support redis migrations #8898

Marishka17 commented Jan 3, 2025 •

edited

Loading

coderabbitai bot commented Jan 3, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

sonarqubecloud bot commented Jan 16, 2025

codecov-commenter commented Jan 16, 2025 •

edited

Loading

Marishka17 commented Jan 17, 2025

Marishka17 Jan 27, 2025

SpecLad Jan 29, 2025

Marishka17 Jan 30, 2025

sonarqubecloud bot commented Jan 31, 2025

Marishka17 commented Jan 31, 2025

Support redis migrations #8898

Are you sure you want to change the base?

Support redis migrations #8898

Conversation

Marishka17 commented Jan 3, 2025 • edited Loading

Motivation and context

How has this been tested?

Checklist

License

coderabbitai bot commented Jan 3, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

sonarqubecloud bot commented Jan 16, 2025

Quality Gate passed

codecov-commenter commented Jan 16, 2025 • edited Loading

Codecov Report

Marishka17 commented Jan 17, 2025

Marishka17 Jan 27, 2025

Choose a reason for hiding this comment

SpecLad Jan 29, 2025

Choose a reason for hiding this comment

Marishka17 Jan 30, 2025

Choose a reason for hiding this comment

sonarqubecloud bot commented Jan 31, 2025

Quality Gate passed

Marishka17 commented Jan 31, 2025

Marishka17 commented Jan 3, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov-commenter commented Jan 16, 2025 •

edited

Loading