Skip to content

Chore: replace relation choices with TextChoices in IssueRelation model#7295

Merged
sriramveeraghanta merged 1 commit intopreviewfrom
chore-issue-relation-choices
Jul 1, 2025
Merged

Chore: replace relation choices with TextChoices in IssueRelation model#7295
sriramveeraghanta merged 1 commit intopreviewfrom
chore-issue-relation-choices

Conversation

@dheeru0198
Copy link
Copy Markdown
Member

@dheeru0198 dheeru0198 commented Jul 1, 2025

Description

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

Screenshots and Media (if applicable)

Test Scenarios

References

Summary by CodeRabbit

  • Refactor
    • Improved the internal handling of issue relation types for better clarity and maintainability. No changes to visible features or user experience.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jul 1, 2025

Walkthrough

The update refactors the way issue relation types are defined in the Django model by introducing a TextChoices enumeration for relation types. The IssueRelation model now uses this enumeration for its relation_type field's choices and default value, replacing the previous tuple-based approach.

Changes

File(s) Change Summary
apiserver/plane/db/models/issue.py Replaced tuple-based RELATION_CHOICES with IssueRelationChoices enum; updated relation_type field to use enum.

Poem

In fields of enums, rabbits hop with glee,
Old tuples replaced, as clean as can be.
Choices now clear, with names that delight,
Code is more readable, elegant and light.
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

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
Copy Markdown
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

🧹 Nitpick comments (1)
apiserver/plane/db/models/issue.py (1)

274-279: Enum introduction looks good, but consider naming & i18n upfront

Great move adopting TextChoices; it improves type-safety and discoverability. A couple of minor points for future-proofing:

  1. IssueRelationType (or simply RelationType) would read clearer than IssueRelationChoices, because the class represents the domain type whereas .choices is just Django plumbing.
  2. If you ever localise UI labels, wrap the second tuple element with gettext_lazy now to avoid a noisy migration later.

Both are non-blocking; flagging as optional polish.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e7d888d and b76a2fd.

📒 Files selected for processing (1)
  • apiserver/plane/db/models/issue.py (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
apiserver/plane/db/models/issue.py (1)
apiserver/plane/db/models/project.py (1)
  • ProjectBaseModel (172-185)
🪛 Pylint (3.3.7)
apiserver/plane/db/models/issue.py

[refactor] 274-274: Too few public methods (0/2)

(R0903)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (2)
apiserver/plane/db/models/issue.py (2)

274-279: Static-analysis “too few public methods” warning is safe to ignore

TextChoices subclasses intentionally hold constants only; the pylint R0903 hit is a known false positive for this pattern.


289-294: No downstream changes required after default update

The default=IssueRelationChoices.BLOCKED_BY remains the same string value ("blocked_by"), so existing rows and any literal string comparisons continue to work without modification. No code or test updates are needed—this is purely a readability improvement if you later choose to reference the enum instead of the literal.

@sriramveeraghanta sriramveeraghanta merged commit f36d069 into preview Jul 1, 2025
5 of 6 checks passed
@sriramveeraghanta sriramveeraghanta deleted the chore-issue-relation-choices branch July 1, 2025 07:06
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.

2 participants