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-2630] chore: double click action added to draft issue and code refactor #5821

Merged
merged 1 commit into from
Oct 14, 2024

Conversation

anmolsinghbhatia
Copy link
Collaborator

@anmolsinghbhatia anmolsinghbhatia commented Oct 14, 2024

Changes:

This PR includes following changes:

  • Added a double-click feature to open the "Move Issue to Project" modal for workspace draft issues.
  • Refactored the workspace draft issues quick action.

Reference:

[WEB-2630]

Summary by CodeRabbit

  • New Features

    • Enhanced issue management with new modal functionalities for editing, duplicating, and deleting issues.
    • Introduced a context menu for quick actions related to issues, improving user interaction.
  • Bug Fixes

    • Refactored issue management actions to streamline functionality and improve overall performance.
  • Documentation

    • Updated component interfaces to reflect changes in props and functionalities.

Copy link
Contributor

coderabbitai bot commented Oct 14, 2024

Walkthrough

The pull request introduces significant enhancements to the DraftIssueBlock and WorkspaceDraftIssueQuickActions components. New state variables are added to manage modal visibility and issue editing in the DraftIssueBlock, while the WorkspaceDraftIssueQuickActions component's interface is updated to utilize a new MENU_ITEMS constant for context menu actions. This refactor streamlines issue management by delegating action handling to the context menu, thereby improving the overall structure and user interaction of the issue management system.

Changes

File Path Change Summary
web/core/components/issues/workspace-draft/draft-issue-block.tsx - Added state variables: moveToIssue, createUpdateIssueModal, issueToEdit, deleteIssueModal.
- Introduced MENU_ITEMS constant for context menu actions.
- Adjusted JSX structure for new modals and context menu.
web/core/components/issues/workspace-draft/quick-action.tsx - Updated interface from IQuickActionProps to Props, requiring parentRef and MENU_ITEMS.
- Removed several state variables, refactoring action handling to rely on MENU_ITEMS.

Possibly related PRs

Suggested labels

🌟enhancement

Suggested reviewers

  • sriramveeraghanta
  • SatishGandham

Poem

In the burrow where issues dwell,
New modals rise, all is swell.
With actions quick and menus bright,
Drafts take flight, oh what a sight!
Hopping through the code so neat,
A rabbit's joy, a coder's feat! 🐇✨


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: 4

🧹 Outside diff range and nitpick comments (2)
web/core/components/issues/workspace-draft/quick-action.tsx (2)

9-11: Consider using a more descriptive interface name.

The interface Props could be more specific to enhance code readability and maintainability. For example, renaming it to WorkspaceDraftIssueQuickActionsProps would clearly indicate its association with the WorkspaceDraftIssueQuickActions component.


22-22: Ensure consistent menu placement across the application.

The placement prop is set to "bottom-end". Please verify that this placement aligns with the design specifications and is consistent with other menus in the application to maintain a uniform user experience.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 701af73 and cbd3fb1.

📒 Files selected for processing (2)
  • web/core/components/issues/workspace-draft/draft-issue-block.tsx (4 hunks)
  • web/core/components/issues/workspace-draft/quick-action.tsx (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
web/core/components/issues/workspace-draft/quick-action.tsx (1)

14-15: 🛠️ Refactor suggestion

Verify the necessity of the observer wrapper.

The component WorkspaceDraftIssueQuickActions is wrapped with the observer from mobx-react, but there are no observable properties or MobX reactions within this component. If the component doesn't rely on MobX observables, removing the observer wrapper can improve performance.

To confirm whether observer is needed, run the following script to check for MobX observable usage within the component:

✅ Verification successful

Remove the unnecessary observer wrapper.

The component WorkspaceDraftIssueQuickActions does not utilize any MobX observables or reactions. Removing the observer wrapper can improve performance.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for MobX observable usage in the component.

# Test: Search for MobX observable patterns. Expect: No occurrences found.
rg --type js --type ts 'observable|computed|action|useLocalObservable|useAsObservableSource|makeObservable|makeAutoObservable' web/core/components/issues/workspace-draft/quick-action.tsx

Length of output: 217


Script:

#!/bin/bash
# Description: Extract import statements from the component to verify the source of `action`.

rg '^import' web/core/components/issues/workspace-draft/quick-action.tsx

Length of output: 230

// hooks
const { getIssueById, updateIssue, deleteIssue, moveIssue } = useWorkspaceDraftIssues();
const { getIssueById, updateIssue, deleteIssue } = useWorkspaceDraftIssues();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Include createIssue in the imports from useWorkspaceDraftIssues

To enable creating new issues when issueToEdit is undefined, import createIssue from useWorkspaceDraftIssues.

Apply this diff:

- const { getIssueById, updateIssue, deleteIssue } = useWorkspaceDraftIssues();
+ const { getIssueById, updateIssue, deleteIssue, createIssue } = useWorkspaceDraftIssues();
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const { getIssueById, updateIssue, deleteIssue } = useWorkspaceDraftIssues();
const { getIssueById, updateIssue, deleteIssue, createIssue } = useWorkspaceDraftIssues();

Comment on lines +111 to +114
onSubmit={async (data) => {
if (issueToEdit) await updateIssue(workspaceSlug, issueId, data);
}}
storeType={EIssuesStoreType.WORKSPACE_DRAFT}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Add logic to handle creation of new issues in the onSubmit handler

Currently, the onSubmit handler only updates an issue when issueToEdit is defined. When making a copy or creating a new issue, issueToEdit is undefined, and no action is taken. Add logic to create a new issue when issueToEdit is undefined.

Apply this diff:

onSubmit={async (data) => {
  if (issueToEdit) {
    await updateIssue(workspaceSlug, issueId, data);
  }
+ else {
+   await createIssue(workspaceSlug, data);
+ }
}}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
onSubmit={async (data) => {
if (issueToEdit) await updateIssue(workspaceSlug, issueId, data);
}}
storeType={EIssuesStoreType.WORKSPACE_DRAFT}
onSubmit={async (data) => {
if (issueToEdit) {
await updateIssue(workspaceSlug, issueId, data);
}
else {
await createIssue(workspaceSlug, data);
}
}}
storeType={EIssuesStoreType.WORKSPACE_DRAFT}

Comment on lines +123 to 126
setIssueToEdit(issue);
setCreateUpdateIssueModal(true);
}}
>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Reuse the extracted function for handling issue editing

After extracting the common logic, use the new handleEditIssue function here to maintain consistency and reduce duplication.

Apply this diff:

onDoubleClick={() => {
- setIssueToEdit(issue);
- setCreateUpdateIssueModal(true);
+ handleEditIssue();
}}

Committable suggestion was skipped due to low confidence.

Comment on lines +63 to +66
setIssueToEdit(issue);
setCreateUpdateIssueModal(true);
},
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Extract repeated code into a separate function for reusability

The action logic here is duplicated in the onDoubleClick handler. Consider extracting this logic into a separate function to promote reusability and reduce code duplication.

Apply this diff:

+ const handleEditIssue = () => {
+   setIssueToEdit(issue);
+   setCreateUpdateIssueModal(true);
+ };
...
{
  key: "edit",
  title: "Edit",
  icon: Pencil,
  action: () => {
-   setIssueToEdit(issue);
-   setCreateUpdateIssueModal(true);
+   handleEditIssue();
  },
},

Committable suggestion was skipped due to low confidence.

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.

3 participants