feat: add issue attachment v1 endpoint

[pablohashescobar]

Description

Added the IssueAttachment endpoint to create and fetch attachments from v1 apis.

Type of Change

• Feature (non-breaking change which adds functionality)

Summary by CodeRabbit

• New Features

  • Enhanced issue attachment handling with improved validation
  • Added ability to retrieve individual attachments
  • Introduced new method to update existing attachments

• Bug Fixes

  • Refined file type validation and upload process
  • Implemented more robust attachment management

• Improvements

  • Added support for generating presigned URLs for file uploads and downloads
  • Improved error handling for attachment operations

[coderabbitai]

Walkthrough

The changes in the apiserver/plane/api/views/issue.py file focus on enhancing the IssueAttachmentEndpoint class's functionality for handling issue attachments. The modifications include improved validation for file uploads, a new UUID-based asset key generation, and refined methods for creating, retrieving, updating, and deleting attachments. The updates introduce more robust file handling, including checks for file types, size, and name, and implement a soft-delete approach for attachments.

Changes

File	Change Summary
apiserver/plane/api/views/issue.py	- Added validation for attachment uploads - Implemented UUID-based asset key generation - Updated FileAsset creation with new parameters - Modified delete method to soft-delete attachments - Added get method to retrieve individual attachments - Introduced patch method for updating attachment status

Sequence Diagram

sequenceDiagram
    participant Client
    participant IssueAttachmentEndpoint
    participant FileAsset
    participant S3Storage

    Client->>IssueAttachmentEndpoint: POST attachment
    IssueAttachmentEndpoint->>IssueAttachmentEndpoint: Validate attachment
    IssueAttachmentEndpoint->>FileAsset: Create FileAsset
    FileAsset-->>IssueAttachmentEndpoint: Return asset details
    IssueAttachmentEndpoint-->>S3Storage: Generate presigned URL
    IssueAttachmentEndpoint-->>Client: Return upload details

Loading

Poem

🐰 Attachments dance, a digital delight,
With UUIDs and checks so tight,
Soft deletes and uploads so neat,
Our issue tracker's now a treat!
Hop along, code rabbit's 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

apiserver/plane/api/views/issue.py (3)

948-1032: Solid attachment creation logic with a few suggestions.

1. Size-Capping vs. Rejection
   At line 961, the logic silently caps the file size using min(size, settings.FILE_SIZE_LIMIT), which might confuse users expecting an error if size exceeds the limit. Consider explicitly rejecting oversized files to align with typical behavior and user expectations.

2. File name sanitization
   At lines 949–950, we accept user-derived name and type. Although this is partially mitigated by random prefixing (line 973), you might want to ensure there's no path-traversal risk (e.g., ../). A quick check or sanitization can help avoid any edge-case vulnerabilities.

3. Long line warning
   Static analysis flagged line 997 (> 88 chars). Consider wrapping or splitting it per the project’s style:

   - "error": "Issue with the same external id and external source already exists",
   + "error": (
   +     "Issue with the same external id "
   +     "and external source already exists"
   + ),

4. Overall
   The rest of the logic—validating required fields, creating the FileAsset, generating a presigned URL, and returning it—appears consistent and robust.

🧰 Tools

🪛 Ruff (0.8.2)

997-997: Line too long (98 > 88)

(E501)

---

1035-1057: Soft-delete approach is reasonable but can be improved.

1. Consolidating saves
   The method calls issue_attachment.save() at lines 1041 and again at 1057. Merging these into a single save call after setting all desired fields can reduce overhead and minimize the risk of stale data between saves.

2. Soft-delete vs. S3 deletion
   Setting is_deleted to True (lines 1039-1041) does not remove the object from storage. This may be intentional. If you eventually need to free S3 space, consider scheduling or providing a separate process to delete the file from S3.

3. Optional check for is_deleted
   Because we rely on soft deletes, you might also want to exclude such attachments from future listings (e.g., in get methods) to ensure consistent user experience.

---

1094-1122: Patch method effectively finalizes uploads with a minor naming concern.

1. Event naming
   At lines 1102–1113, you trigger "attachment.activity.created". Consider leveraging "attachment.activity.uploaded" (or similar) to more accurately depict the event.

2. Idempotent design
   Checking if not issue_attachment.is_uploaded: ensures you only log the event once. This is a good approach to prevent duplicated notifications.

3. Test coverage
   If coverage is lacking, consider adding tests to ensure the patch operation consistently sets is_uploaded and triggers the correct activity log.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 873e433 and 8ff8518.

📒 Files selected for processing (1)

• apiserver/plane/api/views/issue.py (4 hunks)

🧰 Additional context used

🪛 Ruff (0.8.2)

apiserver/plane/api/views/issue.py

997-997: Line too long (98 > 88)

(E501)

🔇 Additional comments (2)

apiserver/plane/api/views/issue.py (2)

3-3: All new or updated imports appear correct.

These additions (e.g., uuid, DjangoJSONEncoder, and references to settings, Workspace, S3Storage, get_asset_object_metadata) support the new attachment workflow. No immediate concerns.

Also applies to: 6-7, 23-23, 54-54, 56-57

---

1060-1093: Confirm visibility of soft-deleted attachments.

1. Filtering out is_deleted
   The listing at lines 1084–1090 does not exclude files marked as deleted (is_deleted=True). If the intention is to hide soft-deleted records from users, add is_deleted=False in the filter.

2. Presigned URL redirect
   Lines 1074–1080 properly redirect to a presigned URL. This approach is straightforward. Just verify that returning an HTTP redirect is acceptable for your client’s workflow and security model (e.g., handling sensitive attachments).