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-3207] fix: minor fixes for issue relations list and retrieval #6444

Merged
merged 1 commit into from
Jan 23, 2025

Conversation

prateekshourya29
Copy link
Member

@prateekshourya29 prateekshourya29 commented Jan 22, 2025

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

WEB-3207

Summary by CodeRabbit

  • New Features

    • Added support for distinguishing epic issues from regular issues
    • Implemented conditional rendering for issue-related operations based on issue type
  • Bug Fixes

    • Prevented editing, copying, and deleting actions for epic issues
  • Refactor

    • Updated issue service and store to include is_epic property for better issue type identification

Copy link
Contributor

coderabbitai bot commented Jan 22, 2025

Walkthrough

The pull request introduces changes to handle epic issues differently across multiple frontend components. The modifications focus on conditionally rendering issue-related operations based on whether an issue is an epic. Specifically, the changes update the RelationIssueListItem component to hide editing, copying, and deleting options for epic issues, modify the IssueService to flag epic issues, and update the IssueStore to include an is_epic property when adding issues to the store.

Changes

File Change Summary
web/core/components/issues/relations/issue-list-item.tsx Conditionally render issue operations only for non-epic issues
web/core/services/issue/issue.service.ts Add is_epic flag when retrieving epic issues
web/core/store/issue/issue-details/issue.store.ts Include is_epic property when adding issues to the store

Possibly related PRs

Suggested labels

🐛bug, 🌐frontend, 🌟improvement

Suggested reviewers

  • sriramveeraghanta
  • rahulramesha
  • gurusainath

Poem

🐰 Epic tales of code so bright,
Rendering logic takes its flight,
No edits for epics, clean and neat,
A rabbit's refactor, oh so sweet!
Conditional magic, smooth and light 🌟

✨ 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 (2)
web/core/components/issues/relations/issue-list-item.tsx (1)

137-192: LGTM! Consider extracting menu items into a separate component.

The conditional rendering for non-epic issues is implemented correctly. However, the menu items could be extracted into a separate component to improve code organization and reusability.

Consider this refactor:

+ const IssueOperationsMenu: FC<{
+   disabled: boolean;
+   onEdit: (e: React.MouseEvent) => void;
+   onCopyLink: (e: React.MouseEvent) => void;
+   onRemoveRelation: (e: React.MouseEvent) => void;
+   onDelete: (e: React.MouseEvent) => void;
+ }> = ({ disabled, onEdit, onCopyLink, onRemoveRelation, onDelete }) => (
+   <CustomMenu placement="bottom-end" ellipsis>
+     {!disabled && (
+       <CustomMenu.MenuItem onClick={onEdit}>
+         <div className="flex items-center gap-2">
+           <Pencil className="h-3.5 w-3.5" strokeWidth={2} />
+           <span>Edit issue</span>
+         </div>
+       </CustomMenu.MenuItem>
+     )}
+     <CustomMenu.MenuItem onClick={onCopyLink}>
+       <div className="flex items-center gap-2">
+         <LinkIcon className="h-3.5 w-3.5" strokeWidth={2} />
+         <span>Copy issue link</span>
+       </div>
+     </CustomMenu.MenuItem>
+     {!disabled && (
+       <CustomMenu.MenuItem onClick={onRemoveRelation}>
+         <div className="flex items-center gap-2">
+           <X className="h-3.5 w-3.5" strokeWidth={2} />
+           <span>Remove relation</span>
+         </div>
+       </CustomMenu.MenuItem>
+     )}
+     {!disabled && (
+       <CustomMenu.MenuItem onClick={onDelete}>
+         <div className="flex items-center gap-2">
+           <Trash className="h-3.5 w-3.5" strokeWidth={2} />
+           <span>Delete issue</span>
+         </div>
+       </CustomMenu.MenuItem>
+     )}
+   </CustomMenu>
+ );

Then use it in the component:

- <CustomMenu placement="bottom-end" ellipsis>
-   {/* ... menu items ... */}
- </CustomMenu>
+ <IssueOperationsMenu
+   disabled={disabled}
+   onEdit={handleEditIssue}
+   onCopyLink={handleCopyIssueLink}
+   onRemoveRelation={handleRemoveRelation}
+   onDelete={handleDeleteIssue}
+ />
web/core/services/issue/issue.service.ts (1)

120-123: LGTM! Consider adding a comment explaining the flag's purpose.

The is_epic flag is correctly set for epic service type. Consider adding a brief comment explaining why this flag is necessary for the UI rendering decisions.

+ // Set is_epic flag to true for epic service type to control UI rendering in RelationIssueListItem
  if (response.data && this.serviceType === EIssueServiceType.EPICS) {
    response.data.is_epic = true;
  }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8f3a0be and 2374c09.

📒 Files selected for processing (3)
  • web/core/components/issues/relations/issue-list-item.tsx (1 hunks)
  • web/core/services/issue/issue.service.ts (1 hunks)
  • web/core/store/issue/issue-details/issue.store.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)
🔇 Additional comments (1)
web/core/store/issue/issue-details/issue.store.ts (1)

191-191: LGTM! Necessary addition for epic issue handling.

The is_epic property is correctly added to the issue payload with proper optional chaining.

@pushya22 pushya22 merged commit 586a320 into preview Jan 23, 2025
12 of 14 checks passed
@pushya22 pushya22 deleted the fix/issue-relations branch January 23, 2025 07:12
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