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-2878]fix: draft creation #6230

Merged
merged 2 commits into from
Dec 19, 2024
Merged

[WEB-2878]fix: draft creation #6230

merged 2 commits into from
Dec 19, 2024

Conversation

vamsikrishnamathala
Copy link
Collaborator

@vamsikrishnamathala vamsikrishnamathala commented Dec 19, 2024

Description

Avoided unnecessary API calls while creating issue draft.

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

References

WEB-2878

Summary by CodeRabbit

  • New Features

    • Enhanced issue creation and update process with improved handling for draft issues.
    • Streamlined search functionality and filter updates in the module view.
  • Bug Fixes

    • Improved error handling and user feedback for draft and non-draft issues.
  • Refactor

    • Reorganized import statements and optimized filter management logic.
  • Style

    • Refined conditions for displaying search input based on filter states.

Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

Walkthrough

The pull request introduces modifications to two components: CreateUpdateIssueModalBase and ModuleViewHeader. The changes primarily focus on improving the handling of draft issues in the issue creation modal and refining the filter and search functionality in the module view header. The modifications enhance user interaction, error handling, and state management without altering the core component structures.

Changes

File Change Summary
web/core/components/issues/issue-modal/base.tsx Added conditional logic to handle draft issues during creation/update, with refined error handling and toast notifications
web/core/components/modules/module-view-header.tsx Updated filter handling, search functionality, and added cn utility import; improved input and filter state management

Sequence Diagram

sequenceDiagram
    participant User
    participant IssueModal
    participant Backend
    
    User->>IssueModal: Create/Update Issue
    alt Is Draft Issue
        IssueModal->>Backend: Validate Draft
        Backend-->>IssueModal: Draft Validation Result
        IssueModal->>IssueModal: Skip Cycle/Module Assignment
    else Is Non-Draft Issue
        IssueModal->>Backend: Create/Update Issue
        Backend-->>IssueModal: Issue Creation Result
        IssueModal->>Backend: Assign to Cycle/Module
    end
    IssueModal->>User: Display Appropriate Notification
Loading

Possibly Related PRs

Suggested Reviewers

  • SatishGandham
  • sriramveeraghanta

Poem

🐰 A Rabbit's Ode to Code Refinement 🐰

In drafts and modules, logic takes flight,
Filters dancing with newfound might,
Conditional paths, so clean and bright,
Where user experience shines just right!
Code hops forward with elegant grace. 🚀


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.

@vamsikrishnamathala vamsikrishnamathala marked this pull request as draft December 19, 2024 10:34
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/components/issues/issue-modal/base.tsx (1)

190-204: LGTM: Optimized API calls for draft issues

The addition of the !is_draft_issue condition effectively prevents unnecessary API calls when creating draft issues. This optimization aligns perfectly with the PR objective.

However, we could improve code clarity by extracting the cycle and module addition logic into separate methods:

-if (!is_draft_issue) {
-  if (
-    payload.cycle_id &&
-    payload.cycle_id !== "" &&
-    (payload.cycle_id !== cycleId || storeType !== EIssuesStoreType.CYCLE)
-  ) {
-    await addIssueToCycle(response, payload.cycle_id);
-  }
-  if (
-    payload.module_ids &&
-    payload.module_ids.length > 0 &&
-    (!payload.module_ids.includes(moduleId?.toString()) || storeType !== EIssuesStoreType.MODULE)
-  ) {
-    await addIssueToModule(response, payload.module_ids);
-  }
+if (!is_draft_issue) {
+  await handleCycleAssignment(response, payload);
+  await handleModuleAssignment(response, payload);
}

+const handleCycleAssignment = async (issue: TIssue, payload: Partial<TIssue>) => {
+  if (
+    payload.cycle_id &&
+    payload.cycle_id !== "" &&
+    (payload.cycle_id !== cycleId || storeType !== EIssuesStoreType.CYCLE)
+  ) {
+    await addIssueToCycle(issue, payload.cycle_id);
+  }
+};
+
+const handleModuleAssignment = async (issue: TIssue, payload: Partial<TIssue>) => {
+  if (
+    payload.module_ids &&
+    payload.module_ids.length > 0 &&
+    (!payload.module_ids.includes(moduleId?.toString()) || storeType !== EIssuesStoreType.MODULE)
+  ) {
+    await addIssueToModule(issue, payload.module_ids);
+  }
+};
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 44d8de1 and ac8817a.

📒 Files selected for processing (2)
  • web/core/components/issues/issue-modal/base.tsx (1 hunks)
  • web/core/components/modules/module-view-header.tsx (1 hunks)
🔇 Additional comments (1)
web/core/components/modules/module-view-header.tsx (1)

13-13: LGTM: Clean utility import addition

The addition of the cn utility import from @plane/utils is clean and follows best practices.

@vamsikrishnamathala vamsikrishnamathala marked this pull request as ready for review December 19, 2024 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛bug Something isn't working 🌐frontend
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants