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 image renaming collisions by appending UUID in mangle_image_name #8791

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

noahpav
Copy link

@noahpav noahpav commented Dec 8, 2024

Instead of appending an incremental integer to the end of files with colliding names we append a unique identifier, uuid.

Motivation and context

#8076
This change is required because currently, when you try to export a project that contains multiple tasks with the same image name, some can be overwritten on export.

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

    • Enhanced image naming system to ensure unique names using UUIDs.
  • Bug Fixes

    • Improved error handling for image name generation conflicts.

@noahpav noahpav requested a review from zhiltsov-max as a code owner December 8, 2024 08:04
Copy link
Contributor

coderabbitai bot commented Dec 8, 2024

Walkthrough

The changes in the pull request primarily involve modifications to the cvat/apps/dataset_manager/bindings.py file. The updates focus on enhancing the uniqueness of image names by incorporating UUIDs instead of using a simple incrementing integer. A new import statement for the uuid module is added, and the mangle_image_name function is revised to generate unique names and handle potential conflicts. An exception is now raised if a unique name cannot be generated after all options are exhausted.

Changes

File Path Change Summary
cvat/apps/dataset_manager/bindings.py - Added import for uuid module.
- Updated mangle_image_name function to use UUIDs for unique image names.
- Function now raises an exception if a unique name cannot be generated.

Poem

In the dataset's burrow, where images play,
A UUID hops in to brighten the day.
No more collisions, just names that are bright,
Unique little bunnies, a marvelous sight!
With each new creation, a hop and a cheer,
In the world of CVAT, uniqueness is here! 🐇✨


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/dataset_manager/bindings.py (1)

1901-1903: Simplify the UUID-based name generation logic

The implementation successfully uses UUIDs to prevent name collisions, but it can be simplified:

  1. The counter variable i is incremented but not used in the UUID generation.
  2. The loop with sys.maxsize check is unnecessary since UUID collisions are extremely unlikely.

Consider simplifying the code:

-            i = 1
             uid = uuid.uuid4().hex
-            while i < sys.maxsize:
+            new_image_name = f"{image_name}_{uid}"
+            if not names[(subset, new_image_name)]:
+                names[(subset, name)] += 1
+                return osp.extsep.join([new_image_name, ext])
-                new_image_name = f"{image_name}_{uid}"
-                if not names[(subset, new_image_name)]:
-                    names[(subset, name)] += 1
-                    return osp.extsep.join([new_image_name, ext])
-                i += 1

If you want to keep collision detection, consider generating a new UUID instead of incrementing i:

             while True:
                 uid = uuid.uuid4().hex
                 new_image_name = f"{image_name}_{uid}"
                 if not names[(subset, new_image_name)]:
                     names[(subset, name)] += 1
                     return osp.extsep.join([new_image_name, ext])
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 12eec54 and 1a7b551.

📒 Files selected for processing (1)
  • cvat/apps/dataset_manager/bindings.py (2 hunks)
🔇 Additional comments (1)
cvat/apps/dataset_manager/bindings.py (1)

11-11: LGTM!

The uuid import is correctly placed with other standard library imports and is necessary for generating unique identifiers.

Copy link

sonarqubecloud bot commented Dec 8, 2024

@Sanjay6388
Copy link

Sanjay6388 commented Dec 8, 2024

The proposed changes aim to resolve image name conflicts by appending a UUID to the image name in the mangle_image_name function. Let’s break this down to ensure it’s implemented correctly and robustly.

Updated Behavior

By appending a UUID (uuid.uuid4().hex), the function ensures:
Uniqueness: UUIDs are globally unique, minimizing the likelihood of collisions.
Efficiency: Avoids multiple iterations since the UUID guarantees uniqueness.

Updated Code

def mangle_image_name(name: str, subset: str, names: defaultdict[tuple[str, str], int]) -> str:
    """
    Ensures a unique image name by appending a UUID if a conflict is detected.
    
    Args:
        name (str): The original image name.
        subset (str): The subset name for categorization.
        names (defaultdict): A mapping of (subset, name) to occurrence counts.

    Returns:
        str: The mangled, unique image name.
    """
    image_name, ext = osp.splitext(name)
    
    if not names[(subset, name)]:
        names[(subset, name)] += 1
        return osp.extsep.join([image_name, ext])
    else:
        uid = uuid.uuid4().hex  # Generate a unique identifier
        new_image_name = f"{image_name}_{uid}"
        if not names[(subset, new_image_name)]:
            names[(subset, name)] += 1
            return osp.extsep.join([new_image_name, ext])

Changes Explained

  1. UUID for Uniqueness:
  • Replaced f"{image_name}_{i}" with f"{image_name}_{uid}".
  • A UUID is appended on the first conflict, avoiding repeated checks with an incrementing integer.
  1. Simplified Iteration:

    • Removed the while loop. Since a UUID guarantees uniqueness, there's no need for iterative attempts.
  2. Maintaining Names Dictionary:

    • Ensures the names dictionary tracks mangled names, maintaining its role in conflict detection.

Testing the Fix

  1. Test Case 1: Images with the same name in the same subset.

    • Input: image.jpg, image.jpg
    • Expected Output: image.jpg, image_<UUID>.jpg
  2. Test Case 2: Images with different names.

    • Input: image1.jpg, image2.jpg
    • Expected Output: No renaming.
  3. Test Case 3: Large-scale dataset with potential conflicts.

    • Simulate thousands of images and ensure no conflicts arise.

@zhiltsov-max
Copy link
Contributor

Hi, answered in #8076 (comment)

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