modify: workspace user link serializer

[sangeethailango]

Summary by CodeRabbit

• Refactor
  • Updated workspace and quick links processing to reference user ID rather than the full user object.
  • Streamlined the creation flow by delegating to established parent logic for more consistent handling.

[coderabbitai]

Walkthrough

This pull request updates owner reference handling for workspace-related API endpoints. In the WorkspaceUserLinkSerializer, the create and update methods now use owner_id for filtering and delegate instance creation to the parent class. Similarly, the QuickLinkViewSet now assigns owner_id from the request’s user rather than the full user object. These adjustments standardize owner references during both creation and update workflows across the backend components.

Changes

File Path	Change Summary
apiserver/plane/app/serializers/workspace.py	Updated WorkspaceUserLinkSerializer: modified filtering logic in create and update methods to use owner_id; adjusted create to call super().create(validated_data).
apiserver/.../views/workspace/quick_link.py	Modified QuickLinkViewSet.create: now assigns owner_id from request.user.id instead of owner=request.user, while keeping the rest of the logic intact.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant QLV as QuickLinkViewSet
    participant WSerializer as WorkspaceUserLinkSerializer
    participant Super as Parent Serializer

    U->>QLV: POST /quick_link (with data)
    QLV->>WSerializer: Call create(validated_data)
    WSerializer->>Super: super().create(validated_data)
    Super-->>WSerializer: Returns new instance
    WSerializer-->>QLV: Returns created instance
    QLV-->>U: Response with new instance

Loading

Possibly related PRs

• [WEB-3285] fix: creating and updating duplicate quick links #6557: Modifies WorkspaceUserLinkSerializer create & update methods by altering owner field logic and validation.
• [WEB-2937] feat: home recent activies list endpoint #6295: Alters the creation process in QuickLinkViewSet to use owner_id, aligning with similar owner field updates.
• [WEB-2928] feat: Home Quick links CRUD #6290: Focuses on modifications related to the owner field in both workspace serializers and views.

Suggested labels

⚙️backend

Suggested reviewers

• sriramveeraghanta
• pablohashescobar
• NarayanBavisetti

Poem

I'm a bunny hopping through fresh code fields,
Where owner_id now gracefully yields.
Serializers and views unite in a dance,
Guiding new logic with every prance.
With each change, my whiskers twitch in delight—
CodeRabbit cheers with hops through the night!
🐰 Hop on, let's code in pure delight!

✨ 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: 0

🧹 Nitpick comments (1)

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

173-177: Use owner_id for consistency.

For consistency with the create method, consider using owner_id instead of owner in the filter.

 workspace_user_link = WorkspaceUserLink.objects.filter(
         url=url, 
         workspace_id=instance.workspace_id, 
-        owner=instance.owner
+        owner_id=instance.owner_id
     )

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 16bc64e and 55c2511.

📒 Files selected for processing (2)

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

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

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

🔇 Additional comments (3)

apiserver/plane/app/views/workspace/quick_link.py (1)

24-24: LGTM! Good optimization.

Using owner_id instead of the full user object is more efficient as it avoids an unnecessary database join.

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

158-158: LGTM! Consistent owner reference.

Using owner_id in the filter is consistent with the view changes and more efficient.

---

165-166: LGTM! Better inheritance usage.

Using super().create() is a good practice as it ensures all base class validations and hooks are executed.