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

[WEB-3444] fix: work item attachment count mutations #6670

Merged
merged 1 commit into from
Feb 25, 2025

Conversation

anmolsinghbhatia
Copy link
Collaborator

@anmolsinghbhatia anmolsinghbhatia commented Feb 25, 2025

Description

This PR includes fix for attachment count mutation

Type of Change

  • Bug fix

Summary by CodeRabbit

  • New Features

    • Enhanced the issue details view to accurately display attachments based on a direct count, ensuring attachments are shown reliably when present.
  • Refactor

    • Centralized the attachment count logic during add and remove operations for improved consistency and maintainability in attachment handling.

Copy link
Contributor

coderabbitai bot commented Feb 25, 2025

Walkthrough

The changes update both the frontend component and the store for managing issue attachments. The component now calls a new method to retrieve the attachment count and adjusts its rendering logic based on that count. In the store, a new getAttachmentsCountByIssueId method is added to the interface and its implementation. This method is then used in the createAttachment and removeAttachment methods to update the attachment count, replacing previous direct count calculations.

Changes

File Change Summary
web/core/.../issue-detail-widget-collapsibles.tsx Updated the useIssueDetail hook to destructure and use getAttachmentsCountByIssueId in addition to getAttachmentsUploadStatusByIssueId, and modified the logic for rendering attachments based on the count.
web/core/.../attachment.store.ts Added the getAttachmentsCountByIssueId method in the IIssueAttachmentStore interface and its implementation in the IssueAttachmentStore class, and integrated this method within createAttachment and removeAttachment.

Sequence Diagram(s)

sequenceDiagram
    participant C as IssueDetailWidget
    participant S as AttachmentStore
    C->>S: getAttachmentsCountByIssueId(issueId)
    S-->>C: attachmentsCount
    alt attachments exist
       C->>C: Render attachments
    else no attachments
       C->>C: Skip rendering
    end
Loading
sequenceDiagram
    participant A as AttachmentActionHandler
    participant S as AttachmentStore
    A->>S: createAttachment(newAttachment)
    S-->>A: Updated attachments list & count
    A->>S: removeAttachment(attachmentId)
    S-->>A: Updated attachments list & count
Loading

Possibly related PRs

Suggested labels

🐛bug, 🌐frontend, 🧹chore

Suggested reviewers

  • sriramveeraghanta
  • aaryan610
  • prateekshourya29

Poem

Oh, what a hop, a delightful feat,
Fixing counts where attachments meet.
With code so clean and logic so bright,
We count each file in plain sight.
A joyful leap—a coder's delight! 🐰✨
Happy changes, may our issues be light!
Hop on and code all day and night!

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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

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 (1)
web/core/store/issue/issue-details/attachment.store.ts (1)

113-116: Good implementation of the new getter method

The implementation of getAttachmentsCountByIssueId is simple and effective, reusing the existing getAttachmentsByIssueId method and handling the null case appropriately.

Consider marking this method with computedFn like the getAttachmentsUploadStatusByIssueId method to enable memoization for better performance, especially if this method will be called frequently.

-  getAttachmentsCountByIssueId = (issueId: string) => {
+  getAttachmentsCountByIssueId = computedFn((issueId: string) => {
     const attachments = this.getAttachmentsByIssueId(issueId);
     return attachments?.length ?? 0;
-  };
+  });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between aa0b2c0 and f2b6c83.

📒 Files selected for processing (2)
  • web/core/components/issues/issue-detail-widgets/issue-detail-widget-collapsibles.tsx (2 hunks)
  • web/core/store/issue/issue-details/attachment.store.ts (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)
🔇 Additional comments (5)
web/core/components/issues/issue-detail-widgets/issue-detail-widget-collapsibles.tsx (2)

29-29: Good addition of the new getter method

The addition of getAttachmentsCountByIssueId in the destructuring pattern appropriately brings in the new functionality from the attachment store.


44-45: Improved approach for determining attachments rendering condition

The new implementation properly uses the dedicated method to retrieve attachment counts rather than relying on the issue object properties. This creates a more consistent way to determine whether to render the attachments section.

This change directly addresses the mutation issue mentioned in the PR objectives by ensuring the component always has access to the latest attachment count from the store.

web/core/store/issue/issue-details/attachment.store.ts (3)

54-54: Good interface definition update

The interface has been properly updated to include the new method signature.


169-171: Consistent approach for updating attachment count

Good change - now using the centralized method to update the attachment count in the issue object after creating an attachment.


201-201: Consistent approach for updating attachment count on removal

Good change - using the same centralized method to update the attachment count after removing an attachment. This ensures consistency in how attachment counts are calculated and updated throughout the application.

@sriramveeraghanta sriramveeraghanta merged commit fde8630 into preview Feb 25, 2025
5 of 6 checks passed
@sriramveeraghanta sriramveeraghanta deleted the fix-work-item-attachment-count-mutation branch February 25, 2025 07:24
sriramveeraghanta added a commit that referenced this pull request Mar 5, 2025
* fix: issue activity for project id validation (#6668)

* fix: work item attachment count mutation (#6670)

* updated the action to modify the release build assets (#6669)

* feat: russian translation (#6666)

* chore: ru translation updated (#6672)

* fix: state drop down refactor

* fix: intake work item creation refactor

* fix: cleanup for deprecated functions

* fix: date range picker on cycles and modules list (#6676)

* fix: Handled workspace switcher closing on click

* fix: replaced date range picker with date picker at some places

* chore: add common translation keys (#6688)

* chore: add missing translation keys

* chore: add russian translation keys

* fix: issue activity task (#6689)

* changed github workflow action ubuntu version to `ubuntu-22.04` (#6683)

* chore: update russian translation (#6682)

* chore: update russian translation

* chore: rename issues to work items in russian translation

* [PE-275] chore: editor line spacing variables (#6678)

* chore: variable editor line spacing

* chore: variable list spacing

---------

Co-authored-by: Aaryan Khandelwal <aaryankhandu123@gmail.com>

* [WEB-3475] fix: cycle dates dropdown (#6690)

* fix: Handled workspace switcher closing on click

* fix: Cycle date picker

* fix: Made onSelect optional in range range component

* fix: module date picker (#6691)

* fix: Handled workspace switcher closing on click

* fix: reverted module date picker changes

* chore: extended sidebar improvement (#6693)

* feat: italian translations (#6692)

* Create translations.json - ITALIAN translation (#6667)

* chore: italian translation updated

* feat: italian translation added

* fix: module end date translation

---------

Co-authored-by: Nicolas Bossi <nicolasbossi@gmail.com>
Co-authored-by: gakshita <akshitagoyal1516@gmail.com>

* fix: attachment item created by (#6695)

* fix: module flicker issue on property updation (#6699)

* [WEB-3477] fix: mutation issue on moving work items for a manually ended cycle (#6696)

* fix: package version update

* fix: esbuild version fix

* fix: package license repliation

* [WEB-3488] improvement: assignee validation for work item creation (#6701)

* fix: work item assignee update validation (#6704)

---------

Co-authored-by: Nikhil <118773738+pablohashescobar@users.noreply.github.com>
Co-authored-by: Anmol Singh Bhatia <121005188+anmolsinghbhatia@users.noreply.github.com>
Co-authored-by: Manish Gupta <59428681+mguptahub@users.noreply.github.com>
Co-authored-by: Nikita Mitasov <32384814+ch4og@users.noreply.github.com>
Co-authored-by: Akshita Goyal <36129505+gakshita@users.noreply.github.com>
Co-authored-by: Aaryan Khandelwal <65252264+aaryan610@users.noreply.github.com>
Co-authored-by: Akshat Jain <akshatjain9782@gmail.com>
Co-authored-by: Lakhan Baheti <94619783+1akhanBaheti@users.noreply.github.com>
Co-authored-by: Aaryan Khandelwal <aaryankhandu123@gmail.com>
Co-authored-by: Nicolas Bossi <nicolasbossi@gmail.com>
Co-authored-by: gakshita <akshitagoyal1516@gmail.com>
Co-authored-by: Prateek Shourya <prateekshourya29@gmail.com>
@sriramveeraghanta sriramveeraghanta added this to the v0.25.1 milestone Mar 9, 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