Fix infinite lock for chunk preparing #8769

azhavoro · 2024-12-04T06:24:02Z

Motivation and context

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 a new constant CVAT_CHUNK_LOCK_TIMEOUT to manage lock acquisition duration during chunk cache operations.
Improvements
- Enhanced concurrency handling in cache operations with a new locking mechanism.
- Streamlined cache item creation by simplifying method logic and reducing redundancy.
Bug Fixes
- Updated method signatures to improve functionality and maintainability of the caching mechanism.

coderabbitai · 2024-12-04T06:24:09Z

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 changes primarily involve the MediaCache class in the cvat/apps/engine/cache.py file, where several methods have been updated to improve concurrency and class structure. The enqueue_create_chunk_job function now uses a configurable timeout value from settings. Two methods have been converted to class methods, enhancing their accessibility. Additionally, a locking mechanism has been introduced in the cache item creation process. A new constant, CVAT_CHUNK_LOCK_TIMEOUT, has been added to the default_settings.py file, defining the lock acquisition duration for cache operations.

Changes

File Path	Change Summary
cvat/apps/engine/cache.py	- Updated `enqueue_create_chunk_job` to use `settings.CVAT_CHUNK_LOCK_TIMEOUT` for `blocking_timeout`. - Changed `_get_queue` and `_make_queue_job_id` to class methods. - Added locking mechanism in `_create_and_set_cache_item`. - Simplified `_create_cache_item` by removing queue and job ID variables.
cvat/apps/engine/default_settings.py	- Added new constant `CVAT_CHUNK_LOCK_TIMEOUT = 50` with a docstring describing its purpose.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MediaCache
    participant CacheSystem

    User->>MediaCache: Request to create chunk job
    MediaCache->>CacheSystem: Enqueue create chunk job
    CacheSystem->>MediaCache: Lock acquisition attempt
    alt Lock acquired
        MediaCache->>CacheSystem: Create cache item
    else Lock not acquired
        MediaCache->>User: Return timeout error
    end

🐇 "In the cache where the chunks do play,
Locks are set without delay.
Class methods now hop with glee,
As settings guide them, wild and free!
A timeout constant, clear and bright,
Makes caching work just right!" 🐇

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.

codecov-commenter · 2024-12-04T11:54:14Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.94%. Comparing base (17ec908) to head (02ac9bf).
Report is 9 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #8769      +/-   ##
===========================================
- Coverage    73.97%   73.94%   -0.04%     
===========================================
  Files          409      409              
  Lines        43931    43950      +19     
  Branches      3985     3985              
===========================================
  Hits         32498    32498              
- Misses       11433    11452      +19

Components	Coverage Δ
cvat-ui	`78.38% <ø> (+<0.01%)`	⬆️
cvat-server	`70.14% <100.00%> (-0.07%)`	⬇️

Marishka17 · 2024-12-05T14:39:23Z

cvat/apps/engine/default_settings.py

@@ -24,3 +24,8 @@
 """
 Sets the frequency of checking the readiness of the chunk
 """
+
+CVAT_CHUNK_LOCK_TIMEOUT = 50


Lock timeout is lock ttl, but here it is a timeout for lock acquisition.
I also think that you need to change the default value of blocking_timeout inside get_rq_lock_for_job because IMHO it is a bad practice to allow endless waiting for a lock at least by default.

Marishka17 · 2024-12-06T10:51:37Z

cvat/apps/engine/utils.py

@@ -210,7 +210,7 @@ def get_rq_lock_by_user(queue: DjangoRQ, user_id: int, *, timeout: Optional[int]
        )
    return nullcontext()

-def get_rq_lock_for_job(queue: DjangoRQ, rq_id: str, *, timeout: Optional[int] = 60, blocking_timeout: Optional[int] = None) -> Lock:
+def get_rq_lock_for_job(queue: DjangoRQ, rq_id: str, *, timeout: Optional[int] = 60, blocking_timeout: Optional[int] = 60) -> Lock:


Shouldn't blocking_timeout be less than the request timeout? (to minimize 504 responses)

Marishka17 · 2024-12-06T10:55:08Z

cvat/apps/engine/default_settings.py

@@ -24,3 +24,8 @@
 """
 Sets the frequency of checking the readiness of the chunk
 """
+
+CVAT_CHUNK_LOCK_ACQUISITION_TIMEOUT = 50


Could you please clarify the benefit of introducing this constant? It looks like this timeout could be different depending on where the code is executed (but now the same value is used). For instance, in the case of request handling, this value should be less than request timeout (otherwise, we get 504), but in the case of running inside a worker process (I mean e.g. export process), I guess this could be more than lock TTL.
So, if we are not planning now to have the different values depending on where a code is running, I guess it's better just to use default values from get_rq_lock_for_job.

Marishka17 · 2024-12-06T11:47:24Z

cvat/apps/engine/utils.py

@@ -210,7 +210,7 @@ def get_rq_lock_by_user(queue: DjangoRQ, user_id: int, *, timeout: Optional[int]
        )
    return nullcontext()

-def get_rq_lock_for_job(queue: DjangoRQ, rq_id: str, *, timeout: Optional[int] = 60, blocking_timeout: Optional[int] = None) -> Lock:
+def get_rq_lock_for_job(queue: DjangoRQ, rq_id: str, *, timeout: Optional[int] = 60, blocking_timeout: Optional[int] = 50) -> Lock:


Suggested change

def get_rq_lock_for_job(queue: DjangoRQ, rq_id: str, *, timeout: Optional[int] = 60, blocking_timeout: Optional[int] = 50) -> Lock:

def get_rq_lock_for_job(queue: DjangoRQ, rq_id: str, *, timeout: int = 60, blocking_timeout: int = 50) -> Lock:

+ assert timeout and blocking_timeout are not None

sonarqubecloud · 2024-12-06T11:54:01Z

Quality Gate passed

Issues
0 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

azhavoro requested a review from Marishka17 as a code owner December 4, 2024 06:24

azhavoro force-pushed the az/fix-infinite-lock-for-chunks branch from 086e9c5 to 7252020 Compare December 4, 2024 06:25

Don't acquire lock forever from worker

d6c2ef2

azhavoro force-pushed the az/fix-infinite-lock-for-chunks branch from 7252020 to d6c2ef2 Compare December 4, 2024 11:00

Marishka17 reviewed Dec 5, 2024

View reviewed changes

azhavoro requested a review from nmanovic as a code owner December 6, 2024 07:46

azhavoro force-pushed the az/fix-infinite-lock-for-chunks branch from b36b1be to 337cfa3 Compare December 6, 2024 07:53

Apply comments

49b6736

azhavoro force-pushed the az/fix-infinite-lock-for-chunks branch from 337cfa3 to 49b6736 Compare December 6, 2024 08:38

Marishka17 reviewed Dec 6, 2024

View reviewed changes

Apply comments

2948e43

Marishka17 reviewed Dec 6, 2024

View reviewed changes

Apply comments

02ac9bf

Marishka17 approved these changes Dec 6, 2024

View reviewed changes

azhavoro merged commit a091d15 into develop Dec 6, 2024
35 checks passed

cvat-bot bot mentioned this pull request Dec 9, 2024

Release v2.23.1 #8794

Merged

bsekachev deleted the az/fix-infinite-lock-for-chunks branch December 11, 2024 08:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix infinite lock for chunk preparing #8769

Fix infinite lock for chunk preparing #8769

azhavoro commented Dec 4, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 4, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

codecov-commenter commented Dec 4, 2024 •

edited

Loading

Marishka17 Dec 5, 2024

Marishka17 Dec 6, 2024

Marishka17 Dec 6, 2024 •

edited

Loading

Marishka17 Dec 6, 2024 •

edited

Loading

sonarqubecloud bot commented Dec 6, 2024

	def get_rq_lock_for_job(queue: DjangoRQ, rq_id: str, *, timeout: Optional[int] = 60, blocking_timeout: Optional[int] = 50) -> Lock:
	def get_rq_lock_for_job(queue: DjangoRQ, rq_id: str, *, timeout: int = 60, blocking_timeout: int = 50) -> Lock:

Fix infinite lock for chunk preparing #8769

Fix infinite lock for chunk preparing #8769

Conversation

azhavoro commented Dec 4, 2024 • edited by coderabbitai bot Loading

Motivation and context

How has this been tested?

Checklist

License

Summary by CodeRabbit

coderabbitai bot commented Dec 4, 2024 • edited Loading

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

codecov-commenter commented Dec 4, 2024 • edited Loading

Codecov Report

Marishka17 Dec 5, 2024

Choose a reason for hiding this comment

Marishka17 Dec 6, 2024

Choose a reason for hiding this comment

Marishka17 Dec 6, 2024 • edited Loading

Choose a reason for hiding this comment

Marishka17 Dec 6, 2024 • edited Loading

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 6, 2024

Quality Gate passed

azhavoro commented Dec 4, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 4, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov-commenter commented Dec 4, 2024 •

edited

Loading

Marishka17 Dec 6, 2024 •

edited

Loading

Marishka17 Dec 6, 2024 •

edited

Loading