Skip to content
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

Fix invalid parsing for old export cache cleanup calls #8039

Merged
merged 6 commits into from
Jun 25, 2024

Conversation

zhiltsov-max
Copy link
Contributor

@zhiltsov-max zhiltsov-max commented Jun 17, 2024

Motivation and context

In #7864, a new file naming scheme was introduced for dataset cache entries, while the old naming convention was deprecated. The old names were parsed incorrectly, leading to failing cache cleanup attempts in clear_export_cache(). A test was added in that PR, but it didn't reproduce the old behavior at the full extent.

  • Fixed old dataset filename parsing (ValueError: Couldn't parse filename components in 'annotations_cvat-for-images-11.ZIP errors)
  • Fixed the test for old cache cleanup

How has this been tested?

Unit tests.

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 handling of export file paths to correctly extract instance_timestamp and format_tag in dataset exports.
    • Updated test cases to check for the correct export paths, ensuring robust verification of export functionalities.

Copy link
Contributor

coderabbitai bot commented Jun 17, 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 recent modifications update the CVAT application's dataset manager tests and utility functionality for handling export paths. Tests were enhanced to accommodate new export path scenarios, and utility functions were refined for better parsing of export path details, including handling of timestamps and format tags.

Changes

Files Summary of Changes
cvat/apps/dataset_manager/tests/test_rest_api_formats.py Added import, updated test function, renamed export paths, and revised assertions to new paths.
cvat/apps/dataset_manager/util.py Refined parse_export_file_path regex and handling for extracting instance_timestamp and format_tag.

Poem

In pathways where the datasets sleep,
I journey with a rabbit's leap.
Old paths were swift, now deftly changed,
With timestamps and formats rearranged.
Tests now in new patterns twine,
Ensuring all results align.
Onward with code, precise and neat,
The data dance, a coder's feat.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8d4c42e and 804c77e.

Files selected for processing (2)
  • cvat/apps/dataset_manager/tests/test_rest_api_formats.py (4 hunks)
  • cvat/apps/dataset_manager/util.py (2 hunks)
Additional comments not posted (3)
cvat/apps/dataset_manager/util.py (2)

220-221: The use of the walrus operator (:=) here is a modern Python feature that improves readability by combining the assignment and condition in a single expression.


198-198: Ensure the regex pattern used here handles both the old and new filename formats correctly.

cvat/apps/dataset_manager/tests/test_rest_api_formats.py (1)

Line range hint 1975-2015: The test simulates an old file path and uses backward compatibility to ensure that cleanup tasks can still be executed on files from previous versions. This is crucial for avoiding disruptions in environments where long-running tasks might still be using older versions of the API.

@codecov-commenter
Copy link

codecov-commenter commented Jun 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.63%. Comparing base (62485fe) to head (e245c50).
Report is 3 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8039      +/-   ##
===========================================
- Coverage    83.65%   83.63%   -0.03%     
===========================================
  Files          383      383              
  Lines        40440    40440              
  Branches      3815     3815              
===========================================
- Hits         33830    33821       -9     
- Misses        6610     6619       +9     
Components Coverage Δ
cvat-ui 79.63% <ø> (-0.06%) ⬇️
cvat-server 87.28% <100.00%> (+<0.01%) ⬆️

@@ -195,7 +195,7 @@ def parse_export_file_path(file_path: os.PathLike[str]) -> ParsedExportFilename:
(
r'(?P<export_mode>dataset|annotations)'
r'(?:-instance(?P<instance_timestamp>\d+\.\d+))?' # optional for backward compatibility
r'-(?P<format_tag>.+)'
r'(?(instance_timestamp)-|_)(?P<format_tag>.+)'
Copy link
Contributor

Choose a reason for hiding this comment

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

The conditional regex here seems unnecessary. Wouldn't it be possible to express the same thing as (?:-instance(?P<instance_timestamp>\d+\.\d+)-|_)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, seems to be working as well.

r'(?:-instance(?P<instance_timestamp>\d+\.\d+))?' # optional for backward compatibility
r'-(?P<format_tag>.+)'
# optional for backward compatibility
r'(?:-instance(?P<instance_timestamp>\d+\.\d+)-|_)?'
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
r'(?:-instance(?P<instance_timestamp>\d+\.\d+)-|_)?'
r'(?:-instance(?P<instance_timestamp>\d+\.\d+)-|_)'

At least a separator must be present, right?

Copy link

sonarcloud bot commented Jun 25, 2024

@zhiltsov-max zhiltsov-max merged commit 7aa699d into develop Jun 25, 2024
33 checks passed
@bsekachev bsekachev deleted the zm/fix-export-cache-cleanup branch June 26, 2024 06:15
@cvat-bot cvat-bot bot mentioned this pull request Jul 2, 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