Skip to content

Conversation

@pablohashescobar
Copy link
Member

@pablohashescobar pablohashescobar commented Jul 27, 2025

Description

feat: add background color and goals field to Profile and Workspace models

Type of Change

  • Improvement (change that would cause existing functionality to not work as expected)

Test Scenarios

  • test user apis - /api/users/me/

References

WEB-4566

Summary by CodeRabbit

  • New Features
    • User profiles now include customizable goals and a background color.
    • Workspaces now have a background color, automatically assigned.
  • Chores
    • Improved internal code organization and removed unused imports.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 27, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new utility function for generating random hex color strings and add a background_color field to both the Profile and Workspace models, using this utility as the default value. Additionally, a goals JSONField is added to the Profile model. Import statements are cleaned up in the workspace model, and a migration file is added to reflect these schema changes.

Changes

File(s) Change Summary
apps/api/plane/db/models/user.py Added goals (JSONField) and background_color (CharField with random default) to Profile.
apps/api/plane/db/models/workspace.py Added background_color (CharField with random default) to Workspace; cleaned unused imports.
apps/api/plane/utils/color.py Added get_random_color function generating random hex color strings.
apps/api/plane/db/migrations/0098_profile_background_color_profile_goals_and_more.py Added migration for new background_color and goals fields in Profile and Workspace.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Poem

A splash of color, a dash of hue,
Profiles and workspaces now shine anew!
With random shades both bright and bold,
And goals for users, stories told.
The code hops forward, neat and spry—
A rabbit’s touch, a cheerful sky!
🐇🌈

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 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 393ab3e and 5cc1691.

📒 Files selected for processing (1)
  • apps/api/plane/db/migrations/0098_profile_background_color_profile_goals_and_more.py (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch onboarding-fields

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 generate unit tests to generate unit tests for 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.

@makeplane
Copy link

makeplane bot commented Jul 27, 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: 0

🧹 Nitpick comments (2)
apps/api/plane/utils/color.py (1)

9-9: Consider using consistent hex color casing.

The current implementation uses string.hexdigits which includes both uppercase and lowercase characters, potentially generating inconsistent hex colors like "#a1B2c3". Consider using only lowercase hex digits for consistency.

-    return "#" + "".join(random.choices(string.hexdigits, k=6))
+    return "#" + "".join(random.choices(string.hexdigits[:16], k=6))

Or for explicit lowercase:

-    return "#" + "".join(random.choices(string.hexdigits, k=6))
+    return "#" + "".join(random.choices("0123456789abcdef", k=6))
apps/api/plane/db/models/user.py (1)

225-225: Consider using lambda for mutable default.

Using default=dict can potentially cause issues where all instances share the same dictionary object. While Django typically handles this correctly by calling the callable for each instance, it's safer to use a lambda.

-    goals = models.JSONField(default=dict)
+    goals = models.JSONField(default=lambda: {})
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a5f3bd1 and 393ab3e.

📒 Files selected for processing (3)
  • apps/api/plane/db/models/user.py (2 hunks)
  • apps/api/plane/db/models/workspace.py (3 hunks)
  • apps/api/plane/utils/color.py (1 hunks)
🔇 Additional comments (5)
apps/api/plane/db/models/user.py (2)

18-18: Import looks good.

Clean import of the new utility function.


226-226: Background color field implementation looks correct.

The field correctly uses get_random_color as a callable default, which will generate a unique random color for each new Profile instance.

apps/api/plane/db/models/workspace.py (3)

3-3: Good import cleanup.

Removing unused imports and reducing the typing imports to only what's needed improves code cleanliness.


13-13: Import correctly added.

Clean import of the new utility function, consistent with the Profile model.


137-137: Background color field implementation is consistent and correct.

The field implementation matches the Profile model exactly, providing consistent behavior across both models. The use of get_random_color as a callable default will generate unique colors for each workspace.

@sriramveeraghanta sriramveeraghanta merged commit 4044ce2 into preview Jul 27, 2025
3 of 6 checks passed
@sriramveeraghanta sriramveeraghanta deleted the onboarding-fields branch July 27, 2025 15:40
lifeiscontent pushed a commit that referenced this pull request Aug 18, 2025
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