[WEB-1435] chore: conflict free issue description

[aaryan610]

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced description_binary field to issue serializers for handling binary descriptions.
  • Added new endpoints for updating and retrieving issue descriptions, including support for archived issues.
  • Added methods for updating and retrieving binary descriptions in various view sets.
  • Implemented collaborative rich text editor components for enhanced editing capabilities.
  • New hooks and utilities for managing binary data and collaborative editing.
  • Added updateDescriptionBinary methods in services for updating issue descriptions using binary payloads.

• Bug Fixes

  • Improved error handling across various services and components related to issue descriptions.

• Documentation

  • Updated type definitions to include new properties and methods for managing issue descriptions.

• Chores

  • Cleaned up unused imports and simplified code structure in several components and services.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Review was skipped due to path filters

:no_entry: Files ignored due to path filters (1)

• yarn.lock is excluded by !**/yarn.lock, !**/*.lock

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request introduces comprehensive changes to handle issue descriptions in binary format across multiple components of the Plane application. The modifications span serializers, views, URLs, services, and frontend components, enabling a more flexible approach to storing and managing issue descriptions. Key changes include adding a description_binary field to serializers, creating new URL endpoints for description management, and updating frontend components to support binary description handling.

Changes

File	Change Summary
apiserver/plane/app/serializers/draft.py	Added description_binary field to DraftIssueDetailSerializer
apiserver/plane/app/serializers/issue.py	Introduced Base64BinaryField for handling binary data
apiserver/plane/app/urls/intake.py	Added new URL for inbox issue descriptions
apiserver/plane/app/urls/issue.py	Added URLs for issue and archived issue descriptions
apiserver/plane/app/urls/workspace.py	Added URL for draft issue descriptions
apiserver/plane/app/views/intake/base.py	Added methods to retrieve and update issue descriptions
apiserver/plane/app/views/issue/archive.py	Added method to retrieve archived issue descriptions
apiserver/plane/app/views/issue/base.py	Added methods to retrieve and update issue descriptions
apiserver/plane/app/views/workspace/draft.py	Added methods for draft issue description management
apiserver/plane/settings/common.py	Added LIVE_BASE_URL environment variable
web/core/services/issue/issue.service.ts	Added updateDescriptionBinary method
web/core/store/issue/issue-details/issue.store.ts	Updated IssueStore to support binary description updates
web/core/hooks/use-issue-description.ts	Introduced a hook for managing issue description state

Sequence Diagram

sequenceDiagram
    participant Client
    participant Frontend
    participant Backend
    participant Database

    Client->>Frontend: Request Issue Description
    Frontend->>Backend: Fetch Description Binary
    Backend->>Database: Retrieve Description
    Database-->>Backend: Return Binary Description
    Backend-->>Frontend: Send Binary Description
    Frontend->>Frontend: Convert Binary to HTML/JSON
    Frontend-->>Client: Display Description

Possibly related PRs

• #5636: The changes in this PR involve the addition of a new field description_binary in the IssueDetailSerializer, which is directly related to the addition of the same field in the DraftIssueDetailSerializer in the main PR.
• #5825: This PR also introduces a new field description_binary in the TIssue type, which aligns with the changes made in the main PR regarding the addition of description_binary in the serializer.
• #5868: The modifications in this PR involve the retrieval of issue details, which includes the description_binary field, thus connecting it to the changes made in the main PR.
• #5907: This PR enhances the functionality of the IssueViewSet, which now includes logic for handling the description_binary field, making it relevant to the changes in the main PR.
• #6243: The changes in this PR focus on retaining the issue description, which includes the description_binary field, thus linking it to the main PR's modifications.
• #6253: The updates in this PR involve the handling of labels, which may interact with the description_binary field in the context of issue management, making it relevant to the main PR.
• #6262: This PR enhances the modularity of activity components, which may include the handling of issue descriptions, including the description_binary field, thus connecting it to the main PR.

Suggested Labels

🧹chore, 🌟enhancement

Suggested Reviewers

• SatishGandham
• sriramveeraghanta

Poem

🐰 A Rabbit's Ode to Binary Bliss 🐰
In bytes and bits, descriptions dance,
A digital canvas, a coding trance.
From HTML to binary's embrace,
Our issues now have a flexible face!
Hop, hop, hooray for data's new might! 🚀

---

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.

[makeplane[bot]]

Pull Request Linked with Plane Work Items

• [WEB-1435] Conflict free Issue description

Comment Automatically Generated by Plane