Skip to content

[WEB-4281] chore: error code on project updation endpoint #7218

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

Draft
wants to merge 7 commits into
base: preview
Choose a base branch
from

Conversation

sangeethailango
Copy link
Member

@sangeethailango sangeethailango commented Jun 16, 2025

Description

This PR will add an error code on project updation.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

References

Related PR

Summary by CodeRabbit

  • Bug Fixes
    • Standardized error responses for duplicate project names and identifiers by including explicit error codes in addition to error messages. This improves clarity and consistency when handling project creation and updates.

Copy link
Contributor

coderabbitai bot commented Jun 16, 2025

Important

Review skipped

Draft detected.

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 partial_update method in the ProjectViewSet class now returns error responses with explicit error codes for duplicate project names and identifiers, aligning its behavior with the existing create method. No changes were made to public entity signatures.

Changes

File Change Summary
apiserver/plane/app/views/project/base.py Enhanced error responses in partial_update to include explicit error codes for uniqueness errors.

Poem

A hop and a skip, a project anew,
With codes for errors, now clearer for you.
No more confusion when names overlap—
The rabbit ensures a neat error map.
So onward you go, with updates precise,
Each project unique, each message concise!


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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

makeplane bot commented Jun 16, 2025

Pull Request Linked with Plane Work Items

Comment Automatically Generated by Plane

1 similar comment
Copy link

makeplane bot commented Jun 16, 2025

Pull Request Linked with Plane Work Items

Comment Automatically Generated by Plane

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 0983e5f and 38d427f.

📒 Files selected for processing (1)
  • apiserver/plane/app/views/project/base.py (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (1)
apiserver/plane/app/views/project/base.py (1)

440-445: serializers.ValidationError branch is probably unreachable

serializer.is_valid() returns False and puts details in serializer.errors; it does not raise ValidationError.
ValidationError is only raised from serializer.save() when update()/create() explicitly do so – your ProjectSerializer doesn’t appear to. In practice a duplicate identifier on partial update will fall into the IntegrityError path above, giving the wrong "name" payload.

Re-verify this branch ever triggers; if not, remove it and rely on the consolidated duplicate-key handler suggested earlier.

@sangeethailango sangeethailango marked this pull request as draft June 17, 2025 13:07
@dheeru0198 dheeru0198 added the tests required This PR needs test cases for approval label Jun 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tests required This PR needs test cases for approval
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants