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

fix infinite loading #9354

Merged
merged 1 commit into from
Dec 11, 2024
Merged

Conversation

manmeetnagii
Copy link
Contributor

@manmeetnagii manmeetnagii commented Dec 10, 2024

Proposed Changes

Summary by CodeRabbit

  • Bug Fixes

    • Adjusted the dependency management in the AutoCompleteAsync component to improve performance.
  • Refactor

    • Streamlined the control flow for fetching data based on user input.

@manmeetnagii manmeetnagii requested a review from a team as a code owner December 10, 2024 13:17
Copy link
Contributor

coderabbitai bot commented Dec 10, 2024

Walkthrough

The pull request modifies the AutoCompleteAsync component in src/components/Form/AutoCompleteAsync.tsx by changing the dependency array in the useEffect hook. The previous dependencies included both query and fetchDataDebounced, while the updated version only includes query. This alteration affects when the fetchDataDebounced function is called, potentially impacting the component's behavior regarding data fetching.

Changes

File Change Summary
src/components/Form/AutoCompleteAsync.tsx Modified useEffect dependency array to only include query. Removed fetchDataDebounced.

Assessment against linked issues

Objective Addressed Explanation
The icons shouldn't keep flickering and clear icon should appear only if a facility is selected (#9351) The changes do not address the flickering issue.

Poem

🐰 In the meadow where queries play,
A change was made to save the day.
Fetching data, now more clear,
No flickering icons to bring us fear!
Hopping along, we cheer with glee,
For smoother searches, oh what a spree! 🌼


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. (Experiment)
  • @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 Dec 10, 2024

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit e2b3927
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/67583f6199263100087f37e7
😎 Deploy Preview https://deploy-preview-9354--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

🧹 Outside diff range and nitpick comments (3)
src/components/Form/AutoCompleteAsync.tsx (3)

Line range hint 91-94: Consider adding loading state cleanup.

To prevent any edge cases where the loading state might get stuck, consider adding a cleanup function to reset the loading state when the component unmounts or when the query changes.

 useEffect(() => {
   fetchDataDebounced(query);
+  return () => {
+    setLoading(false);
+  };
 }, [query]);

Line range hint 63-78: Consider implementing error state handling.

While the error is logged to console, it might be helpful to show a user-friendly error message in the UI when the fetch fails. This would improve the user experience by providing clear feedback.

 const fetchDataDebounced = useDebounce(async (searchQuery: string) => {
   setLoading(true);
+  setError(null);
   try {
     const fetchedData = (await fetchData(searchQuery)) || [];
     const filteredData = filter
       ? fetchedData.filter((item: any) => filter(item))
       : fetchedData;

     setData(
       showNOptions !== undefined
         ? filteredData.slice(0, showNOptions)
         : filteredData,
     );
   } catch (error) {
     console.error("Error fetching data:", error);
+    setError("Failed to fetch results. Please try again.");
   } finally {
     setLoading(false);
   }
 }, debounceTime);

Line range hint 116-127: Consider debouncing the onChange handler for the input.

While we're debouncing the fetch, the setQuery is still called on every keystroke. Consider debouncing the input change handler to reduce unnecessary state updates.

+const setQueryDebounced = useDebounce((value: string) => {
+  setQuery(value);
+}, 100);

<ComboboxInput
  id={id}
  name={name}
  className={classNames(
    "cui-input-base truncate pr-16",
    error && "border-danger-500",
  )}
  placeholder={/* ... */}
  displayValue={/* ... */}
- onChange={({ target }) => setQuery(target.value)}
+ onChange={({ target }) => setQueryDebounced(target.value)}
  onFocus={props.onFocus}
  onBlur={props.onBlur}
/>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b25ecd0 and e2b3927.

📒 Files selected for processing (1)
  • src/components/Form/AutoCompleteAsync.tsx (1 hunks)
🔇 Additional comments (1)
src/components/Form/AutoCompleteAsync.tsx (1)

95-95: LGTM! This change correctly fixes the infinite loading issue.

Removing fetchDataDebounced from the dependency array is the right approach as it prevents the infinite loop caused by the function being recreated on each render. The debounced function maintains a stable reference through useDebounce, so it doesn't need to be in the deps array.

Let's verify the loading state behavior:

✅ Verification successful

The search results show consistent usage of useDebounce across the codebase. Let's verify the dependency arrays in these components to ensure they follow the same pattern.


Let's verify one more aspect - the usage of loading state in other components to ensure our pattern is consistent.


The dependency array change is correct and follows consistent patterns across the codebase

The verification confirms that:

  1. The loading state management in AutoCompleteAsync follows the standard pattern used across the codebase, with proper setLoading(true) before async operations and setLoading(false) in the finally block
  2. Other components using useDebounce (PatientRegister, DiagnosesFilter) also maintain stable function references and don't include the debounced function in dependency arrays
  3. The loading state implementation is robust with proper error handling and cleanup
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other similar patterns in the codebase to ensure consistent implementation
ast-grep --pattern 'useDebounce($_, $_)' 

Length of output: 4028


Script:

#!/bin/bash
# Search for useEffect patterns with query dependencies in these files
ast-grep --pattern 'useEffect(() => {
  $$$
}, [$_])' src/components/Patient/PatientRegister.tsx src/components/Patient/DiagnosesFilter.tsx

Length of output: 2075


Script:

#!/bin/bash
# Search for loading state patterns in components using useDebounce
rg "setLoading\(" -A 2 -B 2

Length of output: 2788

@nihal467
Copy link
Member

nihal467 commented Dec 10, 2024

LGTM @khavinshankar the cypress is re-run , verify it before merging

@rithviknishad rithviknishad merged commit 67f9c6e into ohcnetwork:develop Dec 11, 2024
31 of 32 checks passed
Copy link

@manmeetnagii 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! 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants