Skip to content

on import from cloud, save resource to disk directly #8930

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 9 commits into from
Jan 14, 2025

Conversation

Eldies
Copy link
Contributor

@Eldies Eldies commented Jan 12, 2025

Motivation and context

when importing backups or datasets from a cloud, they first are loaded to memory and only then are saved to the disk.
If a dataset or backup is larger then available RAM, the worker terminates

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

  • Refactor
    • Updated cloud storage file downloading methods to use stream-based file handling
    • Improved type hinting for cloud storage file operations
    • Streamlined file download process across different cloud storage providers

@Eldies Eldies requested a review from Marishka17 as a code owner January 12, 2025 20:40
Copy link
Contributor

coderabbitai bot commented Jan 12, 2025

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 focus on modifying the file downloading mechanism in the cloud storage classes within the CVAT engine. The primary modification involves replacing the download_fileobj method with a new _download_fileobj_to_stream method across multiple cloud provider classes. This new method directly writes to a provided binary stream instead of returning a NamedBytesIO object, which simplifies the file downloading process and provides more direct control over file handling.

Changes

File Change Summary
cvat/apps/engine/cloud_provider.py - Renamed download_fileobj to _download_fileobj_to_stream in _CloudStorage, AWS_S3, AzureBlobContainer, and GoogleCloudStorage classes
- Updated method signature to accept a BinaryIO stream
- Modified method to write directly to the provided stream

Poem

🐰 Bytes dancing through the cloud so bright,
Streams now flow with streamlined might!
No more named bytes, just pure delight,
Cloud storage leaps with rabbit's insight,
Downloading files with elegant flight! 🚀


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.

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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3c8b22d and 98f8c05.

📒 Files selected for processing (1)
  • cvat/apps/engine/cloud_provider.py (6 hunks)
🧰 Additional context used
🪛 GitHub Actions: isort
cvat/apps/engine/cloud_provider.py

[error] 13-16: Imports are incorrectly sorted. The import statement 'from typing import Any, Callable, Optional, TypeVar, BinaryIO' needs to be reordered to 'from typing import Any, BinaryIO, Callable, Optional, TypeVar'

🪛 GitHub Actions: Pylint
cvat/apps/engine/cloud_provider.py

[error] Pylint analysis failed due to incompatibility with Python type aliases. The error occurs because the version of pylint (2.14.5) does not support 'typealias' syntax, which is present in the file.

⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: build
  • GitHub Check: testing
  • GitHub Check: generate_github_pages
  • GitHub Check: Analyze (python)
  • GitHub Check: Linter
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (7)
cvat/apps/engine/cloud_provider.py (7)

170-170: LGTM! Good abstraction design.

The new abstract method provides a clear contract for subclasses to implement direct streaming functionality.

🧰 Tools
🪛 GitHub Actions: Pylint

[error] Pylint analysis failed due to incompatibility with Python type aliases. The error occurs because the version of pylint (2.14.5) does not support 'typealias' syntax, which is present in the file.


173-179: LGTM! Good backward compatibility.

The reimplemented download_fileobj maintains backward compatibility while utilizing the new streaming functionality.

🧰 Tools
🪛 GitHub Actions: Pylint

[error] Pylint analysis failed due to incompatibility with Python type aliases. The error occurs because the version of pylint (2.14.5) does not support 'typealias' syntax, which is present in the file.


180-187: LGTM! Robust error handling.

The download_file implementation includes proper directory creation and cleanup on failure.

🧰 Tools
🪛 GitHub Actions: Pylint

[error] Pylint analysis failed due to incompatibility with Python type aliases. The error occurs because the version of pylint (2.14.5) does not support 'typealias' syntax, which is present in the file.


567-572: LGTM! Efficient implementation using boto3.

The implementation correctly uses boto3's download_fileobj with proper transfer configuration.

🧰 Tools
🪛 GitHub Actions: Pylint

[error] Pylint analysis failed due to incompatibility with Python type aliases. The error occurs because the version of pylint (2.14.5) does not support 'typealias' syntax, which is present in the file.


768-774: LGTM! Efficient implementation using Azure SDK.

The implementation correctly uses Azure's download_blob with proper concurrency control.

🧰 Tools
🪛 GitHub Actions: Pylint

[error] Pylint analysis failed due to incompatibility with Python type aliases. The error occurs because the version of pylint (2.14.5) does not support 'typealias' syntax, which is present in the file.


878-880: LGTM! Efficient implementation using Google Cloud Storage SDK.

The implementation correctly uses GCS's download_blob_to_file method.

🧰 Tools
🪛 GitHub Actions: Pylint

[error] Pylint analysis failed due to incompatibility with Python type aliases. The error occurs because the version of pylint (2.14.5) does not support 'typealias' syntax, which is present in the file.


1023-1023: LGTM! Memory-efficient implementation.

The function now uses download_file to save directly to disk, avoiding unnecessary memory usage.

🧰 Tools
🪛 GitHub Actions: Pylint

[error] Pylint analysis failed due to incompatibility with Python type aliases. The error occurs because the version of pylint (2.14.5) does not support 'typealias' syntax, which is present in the file.

@codecov-commenter
Copy link

codecov-commenter commented Jan 12, 2025

Codecov Report

Attention: Patch coverage is 36.36364% with 14 lines in your changes missing coverage. Please review.

Project coverage is 73.86%. Comparing base (13fd5a7) to head (f78c630).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8930      +/-   ##
===========================================
+ Coverage    73.82%   73.86%   +0.03%     
===========================================
  Files          412      412              
  Lines        44262    44258       -4     
  Branches      3993     3993              
===========================================
+ Hits         32678    32689      +11     
+ Misses       11584    11569      -15     
Components Coverage Δ
cvat-ui 78.41% <ø> (+0.04%) ⬆️
cvat-server 69.99% <36.36%> (+0.02%) ⬆️

@Eldies Eldies requested a review from azhavoro as a code owner January 13, 2025 08:37
Copy link
Contributor

@Marishka17 Marishka17 left a comment

Choose a reason for hiding this comment

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

Please update the changelog, otherwise LGTM

@Eldies Eldies requested a review from nmanovic as a code owner January 14, 2025 09:23
@Marishka17 Marishka17 merged commit b63f68a into develop Jan 14, 2025
35 checks passed
@Marishka17 Marishka17 deleted the dl/cloud-import-memory branch January 14, 2025 13:32
@cvat-bot cvat-bot bot mentioned this pull request Jan 27, 2025
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.

3 participants