Skip to content

fix: draft issue asset conversion to issue #5849

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

Merged
merged 1 commit into from
Oct 17, 2024
Merged

Conversation

pablohashescobar
Copy link
Collaborator

@pablohashescobar pablohashescobar commented Oct 16, 2024

Description

Update asset fields when moving drafts to project issues. Update entity_type and issue_id and remove draft_issue_id.

Summary by CodeRabbit

  • New Features

    • Enhanced functionality for managing file assets during the transition from draft issues to actual issues.
  • Bug Fixes

    • Improved handling of file asset updates associated with draft issues.

Copy link
Contributor

coderabbitai bot commented Oct 16, 2024

Walkthrough

The changes in this pull request involve modifications to the create_draft_to_issue method within the WorkspaceDraftIssueViewSet class located in apiserver/plane/app/views/workspace/draft.py. A new import statement for FileAsset has been added, and the method has been enhanced to update file assets linked to a draft issue by adjusting their issue_id, entity_type, and setting draft_issue_id to None after an issue is created from a draft.

Changes

File Path Change Summary
apiserver/plane/app/views/workspace/draft.py Added import for FileAsset and modified create_draft_to_issue to update file assets associated with draft issues.

Possibly related PRs

Suggested labels

🐛bug

Suggested reviewers

  • sriramveeraghanta
  • SatishGandham

🐇 In the meadow, where the drafts do play,
A file asset hops, in a new way!
With an update here, and a change so bright,
From draft to issue, it takes flight!
Hooray for the code, let’s celebrate,
For every small change, we appreciate! 🎉


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.

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

🧹 Outside diff range and nitpick comments (1)
apiserver/plane/app/views/workspace/draft.py (1)

324-331: Good addition of file asset transfer, but consider some improvements.

The implementation successfully transfers file assets from the draft issue to the newly created issue. However, there are a few points to consider:

  1. The entity_type is set to FileAsset.EntityTypeContext.ISSUE_DESCRIPTION for all assets. This might not be accurate if file assets can be associated with other parts of an issue.

  2. There's no error handling for the update operation. Consider adding a try-except block to handle potential exceptions.

Consider the following improvements:

  1. If possible, preserve the original entity_type of each file asset:
file_assets.update(
    issue_id=serializer.data.get("id", None),
    draft_issue_id=None,
)
  1. Add error handling:
try:
    file_assets.update(
        issue_id=serializer.data.get("id", None),
        draft_issue_id=None,
    )
except Exception as e:
    # Log the error
    logger.error(f"Error updating file assets: {str(e)}")
    # Optionally, you might want to rollback the issue creation or handle this error differently
  1. If different entity_type values are possible, consider updating them individually:
for asset in file_assets:
    asset.issue_id = serializer.data.get("id", None)
    asset.draft_issue_id = None
    # Only update entity_type if necessary
    if asset.entity_type == FileAsset.EntityTypeContext.DRAFT_ISSUE_DESCRIPTION:
        asset.entity_type = FileAsset.EntityTypeContext.ISSUE_DESCRIPTION
    asset.save()

This approach allows for more granular control over the entity_type update.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7d36d63 and 28b08a3.

📒 Files selected for processing (1)
  • apiserver/plane/app/views/workspace/draft.py (2 hunks)
🧰 Additional context used
🔇 Additional comments (1)
apiserver/plane/app/views/workspace/draft.py (1)

40-40: LGTM: New import added correctly.

The FileAsset import has been added appropriately to support the new functionality in the create_draft_to_issue method.

@pushya22 pushya22 merged commit 9b2ffaa into preview Oct 17, 2024
14 of 15 checks passed
@pushya22 pushya22 deleted the fix-draft-issue-asset branch October 17, 2024 07:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants