8000 Enqueue job to prepare chunk in case of honey pot job change by klakhov · Pull Request #8772 · cvat-ai/cvat · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Enqueue job to prepare chunk in case of honey pot job change #8772

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 6, 2024

Conversation

klakhov
Copy link
Contributor
@klakhov klakhov commented Dec 4, 2024

Motivation and context

Fixed a problem that occured in case if honeypots were changed in job and a chunk inside of job was requested immideately after that. (In such a case rq_job still exists but in "finished" status)

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

  • Bug Fixes
    • Improved job enqueueing logic to prevent issues with deleted jobs.
    • Enhanced error handling for cache item deletion, providing clearer logging for failures.

@klakhov klakhov requested a review from azhavoro December 4, 2024 13:52
@klakhov klakhov requested a review from Marishka17 as a code owner December 4, 2024 13:52
Copy link
Contributor
coderabbitai bot commented Dec 4, 2024

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 involve modifications to the enqueue_create_chunk_job and _delete_cache_item methods in the cvat/apps/engine/cache.py file. A new condition has been added to the job enqueueing logic to check the status of the rq_job, ensuring that a new job is only enqueued if the existing job is either not found or has finished. Additionally, error handling for cache item deletion has been improved to log errors related to pickle.UnpicklingError.

Changes

File Path Change Summary
cvat/apps/engine/cache.py - Updated enqueue_create_chunk_job to add a condition for job enqueueing.
- Enhanced error handling in _delete_cache_item to log pickle.UnpicklingError.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant JobQueue as Queue
    participant RQJob as Job

    User->>Queue: Request to create chunk job
    Queue->>RQJob: Check if job exists and status
    alt Job not found or finished
        Queue->>RQJob: Enqueue new job
    else Job exists and not finished
        Queue->>User: Job already in progress
    end
Loading

🐇 In the garden, where bunnies play,
A job is queued in a clever way.
With checks in place, no need to fret,
Errors logged, we won't forget!
Hopping along with a joyful cheer,
Cache management's better, oh dear!
Let's celebrate with a joyful leap! 🎉


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.

Copy link
Contributor
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
cvat/apps/engine/cache.py (1)

94-96: LGTM! Consider clarifying the comment.

The logic correctly handles the case when a chunk needs to be recreated after honeypot changes. The implementation is thread-safe and aligns with the PR objectives.

Consider making the comment more explicit about the honeypot scenario:

-            # Need to enqueue job in case of chunk been deleted but rq job is still exists
-            # This may happens in case of job with honey pots
+            # Need to enqueue a new job when a chunk is deleted but its RQ job still exists.
+            # This happens when honeypots are modified in a job, requiring chunk regeneration.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 022f45d and ad6b33f.

📒 Files selected for processing (1)
  • cvat/apps/engine/cache.py (1 hunks)

@klakhov klakhov requested a review from nmanovic as a code owner December 4, 2024 13:56
@codecov-commenter
Copy link
codecov-commenter commented Dec 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.94%. Comparing base (d86c816) to head (9c20720).
Report is 3 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8772      +/-   ##
===========================================
+ Coverage    73.92%   73.94%   +0.01%     
===========================================
  Files          409      409              
  Lines        43942    43945       +3     
  Branches      3985     3985              
===========================================
+ Hits         32483    32494      +11     
+ Misses       11459    11451       -8     
Components Coverage Δ
cvat-ui 78.38% <ø> (+0.03%) ⬆️
cvat-server 70.13% <100.00%> (+<0.01%) ⬆️

Co-authored-by: Maxim Zhiltsov <zhiltsov.max35@gmail.com>
Copy link
sonarqubecloud bot commented Dec 5, 2024

@klakhov klakhov merged commit 682d7dd into develop Dec 6, 2024
35 checks passed
@zhiltsov-max zhiltsov-max deleted the az/fix-chunk-job-enqueue branch December 6, 2024 09:04
@cvat-bot cvat-bot bot mentioned this pull request Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
0