Skip to content
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

Revert "[WEB-1435] dev: conflict free issue descriptions" #6000

Merged
merged 1 commit into from
Nov 15, 2024

Conversation

aaryan610
Copy link
Collaborator

@aaryan610 aaryan610 commented Nov 15, 2024

Reverts #5912

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a new endpoint for creating draft issues from existing drafts.
    • Added bulk deletion capability for issues.
  • Bug Fixes

    • Improved error handling and user feedback for issue operations (update, remove, archive).
  • Refactor

    • Removed binary description handling from multiple services and components, simplifying the description management process.
    • Updated various components to streamline props and improve state management.
  • Documentation

    • Adjusted import paths for better clarity and organization.
  • Chores

    • Removed unused imports and files related to binary data handling.

Copy link
Contributor

coderabbitai bot commented Nov 15, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request involve the removal of the description_binary field across various serializers and services related to issue management. This includes updates to serializers, view sets, and URL routing that previously handled binary descriptions. The modifications also encompass the removal of methods associated with binary data processing and updates to the database schema to reflect these changes. Overall, the focus is on simplifying the handling of issue descriptions by eliminating binary data processing.

Changes

File Path Change Summary
apiserver/plane/app/serializers/draft.py Removed description_binary field from DraftIssueDetailSerializer.
apiserver/plane/app/serializers/issue.py Removed Base64BinaryField class and description_binary field from IssueDetailSerializer.
apiserver/plane/app/serializers/workspace.py Removed draft_issue_count field from WorkspaceMemberMeSerializer.
apiserver/plane/app/urls/intake.py Removed URL path for inbox issue descriptions.
apiserver/plane/app/urls/issue.py Removed URL paths for issue descriptions and archived issue descriptions.
apiserver/plane/app/urls/workspace.py Removed path for draft issue descriptions; added path for creating draft issues from drafts.
apiserver/plane/app/views/intake/base.py Removed retrieve_description and update_description methods from IntakeIssueViewSet.
apiserver/plane/app/views/issue/archive.py Removed retrieve_description method from IssueArchiveViewSet.
apiserver/plane/app/views/issue/base.py Removed retrieve_description and update_description methods from IssueListEndpoint. Added BulkDeleteIssuesEndpoint class.
apiserver/plane/app/views/workspace/draft.py Removed retrieve_description and update_description methods from WorkspaceDraftIssueViewSet.
apiserver/plane/db/migrations/0085_intake_intakeissue_remove_inboxissue_created_by_and_more.py Renamed models and fields related to inbox and intake issues.
apiserver/plane/settings/common.py Removed LIVE_BASE_URL environment variable setting.
live/.prettierignore Removed file.
live/.prettierrc Removed file.
live/src/core/helpers/page.ts Added functions for handling document formats in collaborative editing.
live/src/core/lib/page.ts Updated import statements and function signatures.
live/src/core/resolve-conflicts.ts Removed file.
live/src/server.ts Added cors middleware; removed resolve-document-conflicts endpoint.
packages/editor/src/core/components/editors/document/collaborative-editor.tsx Renamed hook from useCollaborativeDocumentEditor to useCollaborativeEditor.
packages/editor/src/core/components/editors/document/collaborative-read-only-editor.tsx Renamed hook from useCollaborativeDocumentReadOnlyEditor to useReadOnlyCollaborativeEditor.
packages/editor/src/core/components/editors/editor-wrapper.tsx Updated type signature for extensions prop.
packages/editor/src/core/components/editors/rich-text/collaborative-editor.tsx Removed file.
packages/editor/src/core/components/editors/rich-text/collaborative-read-only-editor.tsx Removed file.
packages/editor/src/core/components/editors/rich-text/index.ts Removed exports for collaborative editors; added exports for rich text editors.
packages/editor/src/core/helpers/yjs-utils.ts Removed file containing utility functions for binary data handling.
packages/editor/src/core/helpers/yjs.ts Added applyUpdates function for Yjs document updates.
packages/editor/src/core/hooks/use-collaborative-editor.ts Renamed hook and updated prop types.
packages/editor/src/core/hooks/use-collaborative-rich-text-editor.ts Removed file.
packages/editor/src/core/hooks/use-collaborative-rich-text-read-only-editor.ts Removed file.
packages/editor/src/core/hooks/use-editor.ts Updated prop types to use HocuspocusProvider.
packages/editor/src/core/hooks/use-read-only-collaborative-editor.ts Renamed hook and updated prop types.
packages/editor/src/core/hooks/use-read-only-editor.ts Updated prop types to use HocuspocusProvider.
packages/editor/src/core/providers/custom-collaboration-provider.ts Removed file.
packages/editor/src/core/providers/index.ts Removed export for custom collaboration provider.
packages/editor/src/core/types/collaboration.ts Updated and renamed several collaborative editor types.
packages/editor/src/core/types/editor.ts Modified collaborative editor interfaces and removed obsolete types.
packages/editor/src/core/types/index.ts Updated exports to focus on collaboration types.
packages/editor/src/index.ts Removed exports for collaborative rich text editors; updated Yjs utility exports.
packages/editor/src/lib.ts Updated export source for editor functionalities.
packages/types/src/issues/issue.d.ts Introduced new issue types and removed description_binary.
web/core/components/core/modals/gpt-assistant-popover.tsx Updated import paths and enhanced error handling.
web/core/components/editor/rich-text-editor/collaborative-editor.tsx Removed file.
web/core/components/editor/rich-text-editor/collaborative-read-only-editor.tsx Removed file.
web/core/components/editor/rich-text-editor/index.ts Updated exports to focus on rich text editors.
web/core/components/inbox/content/issue-root.tsx Updated issue operations and removed updateDescription method.
web/core/components/inbox/modals/create-modal/issue-description.tsx Updated import path for RichTextEditor.
web/core/components/issues/description-input.tsx Updated props and state management using react-hook-form.
web/core/components/issues/issue-detail/main-content.tsx Updated rendering logic for IssueDescriptionInput.
web/core/components/issues/issue-detail/root.tsx Removed updateDescription method from TIssueOperations.
web/core/components/issues/peek-overview/issue-detail.tsx Updated handling of issue descriptions.
web/core/components/issues/peek-overview/root.tsx Removed updateIssueDescription method from issueOperations.
web/core/components/pages/editor/page-root.tsx Enhanced error handling for fetching page descriptions.
web/core/components/profile/activity/activity-list.tsx Updated import path for RichTextReadOnlyEditor.
web/core/components/profile/activity/profile-activity-list.tsx Updated import path for RichTextReadOnlyEditor.
web/core/hooks/use-issue-description.ts Removed file.
web/core/hooks/use-page-fallback.ts Updated binary data encoding and return types.
web/core/services/inbox/inbox-issue.service.ts Removed updateDescriptionBinary method.
web/core/services/issue/issue.service.ts Removed updateDescriptionBinary method.
web/core/services/page/project-page.service.ts Added dependency on FileUploadService and updated return type for fetchDescriptionBinary.
web/core/store/inbox/inbox-issue.store.ts Removed updateIssueDescription method from IInboxIssueStore.
web/core/store/issue/issue-details/issue.store.ts Removed updateIssueDescription method and simplified constructor.
web/core/store/issue/issue-details/root.store.ts Removed updateIssueDescription method and simplified property initialization.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Frontend
    participant Backend
    participant Database

    User->>Frontend: Request to update issue description
    Frontend->>Backend: Send update request (description_html)
    Backend->>Database: Update issue description
    Database-->>Backend: Confirmation
    Backend-->>Frontend: Success response
    Frontend-->>User: Update successful notification
Loading

Possibly related PRs

Suggested labels

🐛bug, ⚙️backend, 🔄migrations

Suggested reviewers

  • SatishGandham
  • pablohashescobar

Poem

🐰 In the fields where issues play,
A binary tale has gone away.
No more the weight of data's bind,
Just HTML, clear and kind.
With each update, we hop along,
Simplifying where we belong! 🐇


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
🪧 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 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.

@pushya22 pushya22 merged commit 9408e92 into preview Nov 15, 2024
12 of 15 checks passed
@sriramveeraghanta sriramveeraghanta deleted the revert-5912-chore/conflict-free-issue-description branch December 5, 2024 12:50
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