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

Add spinner to organization creation in work experiences #2683

Merged
merged 2 commits into from
Nov 12, 2024

Conversation

joanagmaia
Copy link
Contributor

@joanagmaia joanagmaia commented Nov 11, 2024

Changes proposed ✍️

What

copilot:summary

copilot:poem

Why

How

copilot:walkthrough

Checklist ✅

  • Label appropriately with Feature, Improvement, or Bug.
  • Add screenshots to the PR description for relevant FE changes
  • New backend functionality has been unit-tested.
  • API documentation has been updated (if necessary) (see docs on API documentation).
  • Quality standards are met.

Summary by CodeRabbit

  • New Features

    • Introduced dynamic placeholder text for organization creation, enhancing user feedback.
    • Added a spinner component to indicate ongoing organization creation.
  • Bug Fixes

    • Improved state management during the organization creation process to ensure accurate feedback.

Copy link

coderabbitai bot commented Nov 11, 2024

Walkthrough

The changes in organization-select.vue enhance the organization creation process by introducing a dynamic placeholder and a loading spinner. A new reactive reference, isCreatingOrganization, manages the loading state during organization creation. The createOrganization function is modified to set this state to true at the start and reset it in a finally block, ensuring accurate feedback. Additionally, a spinner component, LfSpinner, is conditionally rendered when isCreatingOrganization is true, providing visual feedback during the creation process.

Changes

File Path Change Summary
frontend/src/modules/organization/components/shared/organization-select.vue - Added reactive variable isCreatingOrganization.
- Updated createOrganization method to manage isCreatingOrganization state.
- Added conditional rendering for LfSpinner based on isCreatingOrganization.

Poem

In the meadow where bunnies play,
A new feature brightens the day.
"Creating organization," we cheer,
With a spinner that brings us near.
Feedback flows like a gentle stream,
Enhancing our workflow, a lovely dream! 🐇✨


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

@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

🧹 Outside diff range and nitpick comments (1)
frontend/src/modules/organization/components/shared/organization-select.vue (1)

97-119: Consider improving error handling and validation

While the loading state management is well implemented, there are a few areas that could be improved:

  1. The error case silently returns null without user feedback
  2. The error is caught but not logged, which might make debugging harder
  3. The organization creation payload could benefit from validation before submission

Consider applying these improvements:

 const createOrganization = (value: string) => {
   isCreatingOrganization.value = true;
+  
+  if (!value?.trim()) {
+    isCreatingOrganization.value = false;
+    return Promise.reject(new Error('Organization name is required'));
+  }

   return OrganizationService.create({
     name: value,
     attributes: {
       name: {
         default: value,
         custom: [value],
       },
     },
   })
     .then((newOrganization) => ({
       id: newOrganization.id,
       label: newOrganization.displayName || newOrganization.name,
       displayName: newOrganization.displayName || newOrganization.name,
       name: newOrganization.displayName || newOrganization.name,
     }))
-    .catch(() => null)
+    .catch((error) => {
+      console.error('Failed to create organization:', error);
+      // Assuming you have a toast notification system
+      useToast().error('Failed to create organization. Please try again.');
+      return null;
+    })
     .finally(() => {
       isCreatingOrganization.value = false;
     });
 };
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between be60f4b and b651ec8.

📒 Files selected for processing (1)
  • frontend/src/modules/organization/components/shared/organization-select.vue (5 hunks)
🔇 Additional comments (3)
frontend/src/modules/organization/components/shared/organization-select.vue (3)

6-6: LGTM! Well-implemented loading state UI

The loading state implementation provides clear visual feedback through both the placeholder text and spinner component. The conditional rendering is properly implemented using Vue's template syntax.

Also applies to: 14-16


58-58: LGTM! Required imports added

The necessary imports have been added for the new functionality, following the project's import structure.

Also applies to: 67-67


77-77: LGTM! Clear and typed state declaration

The loading state is properly declared using Vue's ref with appropriate typing and initial value.

Copy link

@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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b651ec8 and c5949f5.

📒 Files selected for processing (1)
  • frontend/src/modules/organization/components/shared/organization-select.vue (5 hunks)
🔇 Additional comments (3)
frontend/src/modules/organization/components/shared/organization-select.vue (3)

6-6: LGTM: Well-implemented loading state feedback!

The dynamic placeholder and loading spinner provide clear visual feedback during organization creation. The conditional rendering is properly structured.

Also applies to: 14-16


58-58: LGTM: Required imports added correctly.

The necessary imports for ref and LfSpinner component are properly added.

Also applies to: 67-67


77-77: LGTM: Well-typed reactive state.

The loading state is properly implemented using a typed ref.

Comment on lines +97 to +119
const createOrganization = (value: string) => {
isCreatingOrganization.value = true;

return OrganizationService.create({
name: value,
attributes: {
name: {
default: value,
custom: [value],
},
},
},
})
.then((newOrganization) => ({
id: newOrganization.id,
label: newOrganization.displayName || newOrganization.name,
displayName: newOrganization.displayName || newOrganization.name,
name: newOrganization.displayName || newOrganization.name,
}))
.catch(() => null);
})
.then((newOrganization) => ({
id: newOrganization.id,
label: newOrganization.displayName || newOrganization.name,
displayName: newOrganization.displayName || newOrganization.name,
name: newOrganization.displayName || newOrganization.name,
}))
.catch(() => null)
.finally(() => {
isCreatingOrganization.value = false;
});
};
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Improve error handling and user feedback.

While the loading state management is good, there are a few concerns with the error handling:

  1. Silent error handling might confuse users when organization creation fails
  2. Returning null in the catch block could lead to unexpected behavior
  3. The loading state cleanup is correct but could be more robust

Consider this improved implementation:

 const createOrganization = (value: string) => {
   isCreatingOrganization.value = true;

   return OrganizationService.create({
     name: value,
     attributes: {
       name: {
         default: value,
         custom: [value],
       },
     },
   })
     .then((newOrganization) => ({
       id: newOrganization.id,
       label: newOrganization.displayName || newOrganization.name,
       displayName: newOrganization.displayName || newOrganization.name,
       name: newOrganization.displayName || newOrganization.name,
     }))
-    .catch(() => null)
+    .catch((error) => {
+      // Notify user about the error
+      ElMessage.error('Failed to create organization. Please try again.');
+      // Re-throw to prevent selecting a null value
+      throw error;
+    })
     .finally(() => {
       isCreatingOrganization.value = false;
     });
 };

Committable suggestion skipped: line range outside the PR's diff.

@joanagmaia joanagmaia merged commit 5cf2427 into main Nov 12, 2024
6 checks passed
@joanagmaia joanagmaia deleted the improvement/organizations-create-spinner branch November 12, 2024 11:26
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.

2 participants