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

GovtSelector isLoading Spinner #10105

Merged

Conversation

Jacobjeevan
Copy link
Contributor

@Jacobjeevan Jacobjeevan commented Jan 22, 2025

Proposed Changes

  • Adjusted the isLoading behavior (display spinner alongside the drop down, rather than instead of).

@ohcnetwork/care-fe-code-reviewers

Merge Checklist

  • Add specs that demonstrate bug / test a new feature.
  • Update product documentation.
  • Ensure that UI text is kept in I18n files.
  • Prep screenshot or demo video for changelog entry, and attach it to issue.
  • Request for Peer Reviews
  • Completion of QA

Summary by CodeRabbit

  • UI/UX Improvements
    • Enhanced organization selector component layout
    • Improved loading state rendering for better visual consistency
    • Maintained consistent spacing during loading and loaded states
    • Updated loading state terminology from isLoading to isFetching for clarity

@Jacobjeevan Jacobjeevan requested a review from a team as a code owner January 22, 2025 17:14
Copy link
Contributor

coderabbitai bot commented Jan 22, 2025

Walkthrough

The pull request modifies the GovtOrganizationSelector.tsx file, focusing on the state management and rendering logic within the OrganizationLevelSelect component. The variable isLoading has been renamed to isFetching, reflecting a change in terminology. The loading indicator is now conditionally rendered within a flex-layout div, ensuring the Autocomplete component is always present in the DOM, even during data fetching.

Changes

File Change Summary
src/pages/Organization/components/GovtOrganizationSelector.tsx Renamed isLoading to isFetching, refactored rendering logic for loading indicator and Autocomplete component.
src/hooks/useGovtOrganizationLevel.ts Renamed isLoading to isFetching in the context of the useQuery hook.

Possibly related PRs

  • Adds support for searching for OrganizationSelector and fix scroll for dropdown in sheet #9620: The changes in GovtOrganizationSelector.tsx and OrganizationSelector.tsx both involve modifications to the organization selection process, including updates to the rendering logic and state management, which may relate to the autocomplete functionality introduced in this PR.
  • GovtOrganization Selector  #10090: The GovtOrganizationSelector.tsx file is directly modified in this PR, which introduces a new component for organization level selection, aligning closely with the changes made in the main PR regarding state management and rendering logic in the OrganizationLevelSelect component.

Suggested labels

tested

Suggested reviewers

  • rithviknishad

Poem

🐰 In the land of code where rabbits play,
Fetching data in a smoother way,
No more hiding, the loader's in sight,
With Autocomplete shining so bright!
A hop, a skip, through logic we dance,
Rendering joy with every chance! 🎉

✨ 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

netlify bot commented Jan 22, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit bf1c9f8
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/67912be649c99100088cdaa7
😎 Deploy Preview https://deploy-preview-10105--care-ohc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

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)
src/pages/Organization/components/GovtOrganizationSelector.tsx (2)

Line range hint 71-84: LGTM! Consider enhancing accessibility.

The implementation successfully achieves the PR objective by showing the loading spinner alongside the dropdown. The flex layout ensures proper alignment and spacing.

Consider adding the aria-busy attribute to improve accessibility:

-      <div className="flex items-center gap-2">
+      <div className="flex items-center gap-2" aria-busy={isLoading}>

72-72: Consider adding a tooltip to the loading indicator.

Adding a tooltip would help users understand what's being loaded.

-        {isLoading && <Loader2 className="h-6 w-6 animate-spin" />}
+        {isLoading && (
+          <Loader2
+            className="h-6 w-6 animate-spin"
+            title={t('SYSTEM__loading_organizations')}
+          />
+        )}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 39caada and 2d92913.

📒 Files selected for processing (1)
  • src/pages/Organization/components/GovtOrganizationSelector.tsx (2 hunks)

@Jacobjeevan Jacobjeevan mentioned this pull request Jan 22, 2025
6 tasks
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)
src/hooks/useGovtOrganizationLevel.ts (1)

Line range hint 38-47: Consider adding error handling for the query.

The query could fail due to network issues or API errors. Consider destructuring and handling the error state from useQuery to provide appropriate feedback to users.

-  const { data: organizations, isFetching } = useQuery({
+  const { data: organizations, isFetching, error } = useQuery({
     queryKey: ["organizations-level", parentId, searchQuery],
     queryFn: query.debounced(organizationApi.list, {
       queryParams: {
         org_type: "govt",
         parent: parentId,
         name: searchQuery || undefined,
         limit: 200,
       },
       ...headers,
     }),
   });
+
+  // Handle error state
+  if (error) {
+    console.error('Failed to fetch organizations:', error);
+  }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2d92913 and bf1c9f8.

📒 Files selected for processing (2)
  • src/hooks/useGovtOrganizationLevel.ts (2 hunks)
  • src/pages/Organization/components/GovtOrganizationSelector.tsx (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/pages/Organization/components/GovtOrganizationSelector.tsx
🔇 Additional comments (2)
src/hooks/useGovtOrganizationLevel.ts (2)

38-38: Good choice using isFetching instead of isLoading!

The rename from isLoading to isFetching is more semantically accurate for React Query's state management. This better supports the UI requirement of showing the loading spinner alongside the dropdown during background refreshes.

Also applies to: 77-77


Line range hint 42-46: Verify the impact of the 200 item limit.

The query is limited to 200 results. Please verify if this limit is sufficient for all use cases and whether pagination should be implemented.

✅ Verification successful

200 item limit is appropriate for organization selector dropdowns

The limit is used in organization level selector components that render dropdown menus, not paginated lists. A 200 item limit is reasonable for dropdown UI/UX, as:

  • Displaying more items would degrade dropdown performance
  • Users typically don't need to scroll through more than 200 organizations
  • The search functionality in these components helps users find specific organizations quickly
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if there are any instances where the results might hit the 200 limit
rg -A 5 "limit.*200" .

Length of output: 32995


Script:

#!/bin/bash
# Find components using these hooks and check for pagination implementation
echo "=== Components using the hooks ==="
rg -B 2 -A 2 "useGovtOrganizationLevel|useOrganizationLevel" --type ts --type tsx

echo -e "\n=== Pagination related code near hook usage ==="
rg -B 5 -A 5 "pagination|Pagination|pageSize|currentPage" . --type ts --type tsx

echo -e "\n=== Error handling related to results limit ==="
rg -B 3 -A 3 "error.*limit|limit.*error|too many|maximum|exceeded" . --type ts --type tsx

Length of output: 643


Script:

#!/bin/bash
# Find components using these hooks
echo "=== Hook usage patterns ==="
ast-grep --pattern 'const $_ = useGovtOrganizationLevel($$$)'
ast-grep --pattern 'const $_ = useOrganizationLevel($$$)'

echo -e "\n=== Pagination related code ==="
rg "pagination|Pagination|pageSize|currentPage"

echo -e "\n=== Error handling patterns ==="
rg "error.*limit|limit.*error|too many|maximum|exceeded"

# Find any comments or documentation about the limit
echo -e "\n=== Comments about limits ==="
rg -B 2 -A 2 "\/\/.*limit|\/\*.*limit|\*.*limit|#.*limit" .

Length of output: 10099

@rithviknishad rithviknishad merged commit 6eea7f5 into ohcnetwork:develop Jan 22, 2025
19 of 20 checks passed
Copy link

@Jacobjeevan Your efforts have helped advance digital healthcare and TeleICU systems. 🚀 Thank you for taking the time out to make CARE better. We hope you continue to innovate and contribute; your impact is immense! 🙌

manmeetnagii pushed a commit to manmeetnagii/care_fe that referenced this pull request Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants