[WEB-3285] fix: creating and updating duplicate quick links

[sangeethailango]

Description

This PR will fix creating/updating duplicate quick links.

Summary by CodeRabbit

• New Features
  • Enhanced link validation in workspaces to prevent duplicate URLs. Users will receive a clear error if they try to add or modify a link that already exists for the same workspace and owner.

[coderabbitai]

Walkthrough

This pull request adds two new methods, create and update, to the WorkspaceUserLinkSerializer class. Both methods include validation logic to check for duplicate URLs within the same workspace and owner context before creating or updating a record. If a duplicate is found, a ValidationError is raised with the message "URL already exists for this workspace and owner." This ensures that each WorkspaceUserLink is unique per workspace and owner.

Changes

File Path	Change Summary
apiserver/plane/app/serializers/workspace.py	Added create and update methods in WorkspaceUserLinkSerializer to validate and prevent duplicate URLs by checking existing records.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Serializer
    participant DB
    User->>Serializer: call create(validated_data)
    Serializer->>DB: check for existing link (URL, workspace, owner)
    DB-->>Serializer: return result
    alt Link exists
        Serializer->>User: raise ValidationError ("URL already exists for this workspace and owner.")
    else No duplicate found
        Serializer->>DB: create new WorkspaceUserLink
        DB-->>Serializer: confirmation
        Serializer->>User: return new instance
    end

Loading

sequenceDiagram
    participant User
    participant Serializer
    participant DB
    User->>Serializer: call update(instance, validated_data)
    Serializer->>DB: check for duplicate link (excluding current instance)
    DB-->>Serializer: return result
    alt Duplicate found
        Serializer->>User: raise ValidationError ("URL already exists for this workspace and owner.")
    else No duplicate found
        Serializer->>DB: update WorkspaceUserLink instance
        DB-->>Serializer: confirmation
        Serializer->>User: return updated instance
    end

Loading

Possibly related PRs

• [WEB-2928] feat: Home Quick links CRUD #6290: The changes in the main PR, which enhance the WorkspaceUserLinkSerializer with new create and update methods, are directly related to the WorkspaceUserLinkSerializer introduced in the retrieved PR, as both involve modifications to the same serializer class.

Suggested labels

🐛bug, ⚙️backend

Suggested reviewers

• sriramveeraghanta
• pablohashescobar
• NarayanBavisetti

Poem

I'm a rabbit with hops so fleet,
Coding magic with a skip and beat.
New methods in my serializer glow,
Preventing duplicates, watch them go!
In the world of code, I always thrive,
With carrot-powered updates, I come alive!
🥕🐰 Happy coding, let's take a dive!

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 800c725 and e6365a0.

📒 Files selected for processing (1)

• apiserver/plane/app/serializers/workspace.py (1 hunks)

🧰 Additional context used

🪛 Ruff (0.8.2)

apiserver/plane/app/serializers/workspace.py

151-151: Line too long (97 > 88)

(E501)

---

168-168: Line too long (97 > 88)

(E501)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Analyze (javascript)
• GitHub Check: Analyze (python)

🔇 Additional comments (2)

apiserver/plane/app/serializers/workspace.py (2)

150-165: 🛠️ Refactor suggestion

Improve code readability and consistency.

The implementation can be improved in several ways:

1. Remove redundant comment
2. Use consistent error response format
3. Improve variable naming
4. Simplify query structure

Apply this diff to improve the code:

     def create(self, validated_data):
-        # Filtering the WorkspaceUserLink with the given url to check if the link already exists.
-        
         url = validated_data.get("url")
+        workspace_id = validated_data.get("workspace_id")
+        owner = validated_data.get("owner")
 
-        workspace_user_link = WorkspaceUserLink.objects.filter(
-            url=url, 
-            workspace_id=validated_data.get("workspace_id"), 
-            owner=validated_data.get("owner")
-        )
-
-        if workspace_user_link.exists():
+        duplicate_exists = WorkspaceUserLink.objects.filter(
+            url=url,
+            workspace_id=workspace_id,
+            owner=owner
+        ).exists()
+
+        if duplicate_exists:
             raise serializers.ValidationError(
-                {"error": "URL already exists for this workspace and owner"}
+                "URL already exists for this workspace and owner"
             )
         return WorkspaceUserLink.objects.create(**validated_data)

Likely invalid or redundant comment.

🧰 Tools

🪛 Ruff (0.8.2)

151-151: Line too long (97 > 88)

(E501)

---

167-183: 🛠️ Refactor suggestion

Improve code readability and consistency.

The implementation has similar issues to the create method:

1. Remove redundant comment
2. Use consistent error response format
3. Improve variable naming
4. Fix indentation

Apply this diff to improve the code:

     def update(self, instance, validated_data):
-        # Filtering the WorkspaceUserLink with the given url to check if the link already exists.
-
         url = validated_data.get("url")
-
-        workspace_user_link = WorkspaceUserLink.objects.filter(
-                url=url, 
-                workspace_id=instance.workspace_id, 
-                owner=instance.owner
-            )
-
-        if workspace_user_link.exclude(pk=instance.id).exists():
+        duplicate_exists = (
+            WorkspaceUserLink.objects.filter(
+                url=url,
+                workspace_id=instance.workspace_id,
+                owner=instance.owner
+            )
+            .exclude(pk=instance.id)
+            .exists()
+        )
+
+        if duplicate_exists:
             raise serializers.ValidationError(
-                {"error": "URL already exists for this workspace and owner"}
+                "URL already exists for this workspace and owner"
             )
-
         return super().update(instance, validated_data)

Likely invalid or redundant comment.

🧰 Tools

🪛 Ruff (0.8.2)

168-168: Line too long (97 > 88)

(E501)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

apiserver/plane/app/serializers/workspace.py (1)

133-147: Standardize error message format.

The error message format is inconsistent between validation methods:

• validate_url returns {"error": "Invalid URL format."}
• New methods return {"error": "URL already exists for this Issue"}

Consider standardizing the error message format:

-            raise serializers.ValidationError({"error": "Invalid URL format."})
+            raise serializers.ValidationError("Invalid URL format.")

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e244f48 and 800c725.

📒 Files selected for processing (1)

• apiserver/plane/app/serializers/workspace.py (1 hunks)

🧰 Additional context used

🪛 Ruff (0.8.2)

apiserver/plane/app/serializers/workspace.py

151-151: Line too long (125 > 88)

(E501)

---

161-161: Line too long (103 > 88)

(E501)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Analyze (javascript)
• GitHub Check: Analyze (python)

🔇 Additional comments (1)

apiserver/plane/app/serializers/workspace.py (1)

149-170: Implementation successfully addresses duplicate link handling.

The added validation logic in both create and update methods effectively prevents duplicate links within the same workspace and owner context, which aligns perfectly with the PR objectives.

🧰 Tools

🪛 Ruff (0.8.2)

151-151: Line too long (125 > 88)

(E501)

---

161-161: Line too long (103 > 88)

(E501)