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-2678]feat: added functionality to add labels directly from dropdown #6208

Open
wants to merge 1 commit into
base: preview
Choose a base branch
from

Conversation

mathalav55
Copy link
Collaborator

@mathalav55 mathalav55 commented Dec 16, 2024

Description

Added functionality to add labels directly from drop-down if the label does not exist.

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

Summary by CodeRabbit

  • New Features

    • Users can now create new labels directly from the label selection interface.
    • Enhanced submission tracking for label creation with visual feedback (loading spinner).
    • New functionality to add labels when pressing the "Enter" key during label input.
  • Bug Fixes

    • Improved error handling for label creation, ensuring appropriate notifications for users.
  • Documentation

    • Updated component props to reflect new functionalities related to label creation.

@mathalav55 mathalav55 added 🌟enhancement New feature or request 🌐frontend labels Dec 16, 2024
@mathalav55 mathalav55 added this to the v0.24.2 milestone Dec 16, 2024
@mathalav55 mathalav55 self-assigned this Dec 16, 2024
Copy link
Contributor

coderabbitai bot commented Dec 16, 2024

Walkthrough

The pull request introduces changes to the label management components across multiple files in the web application. The modifications primarily focus on simplifying label creation and handling, removing explicit user permission checks, and adding a more streamlined mechanism for creating labels directly from various issue-related components. The changes enhance the label selection and creation process by introducing a new onAddLabel method and improving the user interaction flow for adding labels.

Changes

File Change Summary
web/core/components/issues/issue-detail/label/root.tsx Removed useUserPermissions import and related permission checks
web/core/components/issues/issue-detail/label/select/label-select.tsx Added onAddLabel method, new submitting state, and enhanced label creation logic
web/core/components/issues/issue-detail/label/select/root.tsx Added onAddLabel prop to IssueLabelSelect component
web/core/components/issues/issue-layouts/properties/labels.tsx Introduced handleAddLabel function, updated useLabel hook, added label creation capabilities

Sequence Diagram

sequenceDiagram
    participant User
    participant LabelSelect
    participant LabelOperations
    participant Backend

    User->>LabelSelect: Enter new label name
    LabelSelect->>LabelOperations: onAddLabel()
    LabelOperations->>Backend: Create Label
    Backend-->>LabelOperations: Label Created
    LabelOperations-->>LabelSelect: Return New Label
    LabelSelect->>User: Update UI with New Label
Loading

Possibly related PRs

Suggested labels

🌟improvement, 🎨UI / UX

Suggested reviewers

  • rahulramesha
  • sriramveeraghanta
  • SatishGandham

Poem

🐰 Hop, hop, labels take flight!
Permissions fade, simplicity's might
Enter key pressed, magic unfurls
New labels dance, our workflow twirls
Code rabbit sings of streamlined delight! 🏷️

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request.


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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 438cc33 and 00c15da.

📒 Files selected for processing (4)
  • web/core/components/issues/issue-detail/label/root.tsx (1 hunks)
  • web/core/components/issues/issue-detail/label/select/label-select.tsx (3 hunks)
  • web/core/components/issues/issue-detail/label/select/root.tsx (1 hunks)
  • web/core/components/issues/issue-layouts/properties/labels.tsx (7 hunks)
🔇 Additional comments (2)
web/core/components/issues/issue-detail/label/select/root.tsx (1)

29-29: LGTM!

The addition of the onAddLabel prop correctly passes the createLabel function to the IssueLabelSelect component, enhancing label creation functionality.

web/core/components/issues/issue-detail/label/root.tsx (1)

10-13: Simplification by removing permission checks is acceptable

The removal of useUserPermissions import and related permission checks simplifies the IssueLabel component. Assuming that permission checks are enforced elsewhere, this change is appropriate.

Comment on lines +106 to +111
const handleAddLabel = async (labelName: string) => {
setSubmitting(true);
const label = await onAddLabel(workspaceSlug, projectId, { name: labelName, color: getRandomLabelColor() });
onSelect([...values, label.id]);
setQuery("");
setSubmitting(false);
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 error handling in handleAddLabel to prevent unhandled exceptions

The handleAddLabel function does not handle potential exceptions from onAddLabel. If an error occurs during label creation, setSubmitting(false) may not be called, leaving the component in a loading state, and the user won't receive feedback about the failure.

Apply this diff to add error handling:

const handleAddLabel = async (labelName: string) => {
+  try {
    setSubmitting(true);
    const label = await onAddLabel(workspaceSlug, projectId, { name: labelName, color: getRandomLabelColor() });
    onSelect([...values, label.id]);
    setQuery("");
+  } catch (error) {
+    // Handle error, possibly show error message to user
+    console.error(error);
+  } finally {
    setSubmitting(false);
+  }
};
📝 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 handleAddLabel = async (labelName: string) => {
setSubmitting(true);
const label = await onAddLabel(workspaceSlug, projectId, { name: labelName, color: getRandomLabelColor() });
onSelect([...values, label.id]);
setQuery("");
setSubmitting(false);
const handleAddLabel = async (labelName: string) => {
try {
setSubmitting(true);
const label = await onAddLabel(workspaceSlug, projectId, { name: labelName, color: getRandomLabelColor() });
onSelect([...values, label.id]);
setQuery("");
} catch (error) {
// Handle error, possibly show error message to user
console.error(error);
} finally {
setSubmitting(false);
}
};

Comment on lines +265 to +273
const handleAddLabel = async (labelName: string) => {
if (!projectId) return;
setSubmitting(true);
const label = await createLabel(workspaceSlug, projectId, { name: labelName, color: getRandomLabelColor() });
onChange([...value, label.id]);
setQuery("");
setSubmitting(false);
};

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 error handling in handleAddLabel to prevent unhandled exceptions

The handleAddLabel function does not handle potential exceptions from createLabel. If an error occurs during label creation, setSubmitting(false) may not be called, leaving the component in a loading state, and the user won't receive feedback about the failure.

Apply this diff to add error handling:

const handleAddLabel = async (labelName: string) => {
  if (!projectId) return;
+  try {
    setSubmitting(true);
    const label = await createLabel(workspaceSlug, projectId, { name: labelName, color: getRandomLabelColor() });
    onChange([...value, label.id]);
    setQuery("");
+  } catch (error) {
+    // Handle error, possibly show error message to user
+    console.error(error);
+  } finally {
    setSubmitting(false);
+  }
};
📝 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 handleAddLabel = async (labelName: string) => {
if (!projectId) return;
setSubmitting(true);
const label = await createLabel(workspaceSlug, projectId, { name: labelName, color: getRandomLabelColor() });
onChange([...value, label.id]);
setQuery("");
setSubmitting(false);
};
const handleAddLabel = async (labelName: string) => {
if (!projectId) return;
try {
setSubmitting(true);
const label = await createLabel(workspaceSlug, projectId, { name: labelName, color: getRandomLabelColor() });
onChange([...value, label.id]);
setQuery("");
} catch (error) {
// Handle error, possibly show error message to user
console.error(error);
} finally {
setSubmitting(false);
}
};

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌟enhancement New feature or request 🌐frontend
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant