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 bug with recursion #9100

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Fix bug with recursion #9100

merged 1 commit into from
Nov 13, 2024

Conversation

shivankacker
Copy link
Member

@shivankacker shivankacker commented Nov 13, 2024

Proposed Changes

@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

  • New Features
    • Streamlined management of consultation tabs for improved performance.
  • Bug Fixes
    • Enhanced logic for determining the active tab, reducing complexity in tab validation.

@shivankacker shivankacker requested a review from a team as a code owner November 13, 2024 11:31
Copy link
Contributor

coderabbitai bot commented Nov 13, 2024

Walkthrough

The changes in the ConsultationDetails component involve a refactor of the tabs management system. The previous implementation used the useState hook for dynamic updates, which has been replaced with a direct initialization of tabs as a merged object of defaultTabs and pluginTabs. This adjustment simplifies the control flow by removing the useEffect that updated tabs based on pluginTabs. The logic for determining the active tab has also been streamlined, enhancing the efficiency of the component while maintaining its overall functionality.

Changes

File Change Summary
src/components/Facility/ConsultationDetails/index.tsx Refactored tabs management by removing useState and useEffect; initialized tabs directly from defaultTabs and pluginTabs. Streamlined logic for determining active tab.

Assessment against linked issues

Objective Addressed Explanation
Eliminate infinite use effect recursions (#9099)

Suggested labels

tested

Suggested reviewers

  • Jacobjeevan

Poem

In the land of tabs, where rabbits hop,
We’ve tidied up the code, made it stop!
No more loops that spin and twirl,
Just simple logic to make it swirl.
With a hop and a skip, the changes are done,
Now the Consultation page can have some fun! 🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/components/Facility/ConsultationDetails/index.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

Error: Failed to load parser '@typescript-eslint/parser' declared in '.eslintrc.json': Cannot find module '@typescript-eslint/parser'
Require stack:

  • /.eslintrc.json
    at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
    at Function.resolve (node:internal/modules/helpers:145:19)
    at Object.resolve (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2346:46)
    at ConfigArrayFactory._loadParser (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3325:39)
    at ConfigArrayFactory._normalizeObjectConfigDataBody (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3099:43)
    at _normalizeObjectConfigDataBody.next ()
    at ConfigArrayFactory._normalizeObjectConfigData (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3040:20)
    at _normalizeObjectConfigData.next ()
    at ConfigArrayFactory.loadInDirectory (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2886:28)
    at CascadingConfigArrayFactory._loadConfigInAncestors (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3871:46)

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

netlify bot commented Nov 13, 2024

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 4a56fbe
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/67348e2599055b0008d548ed
😎 Deploy Preview https://deploy-preview-9100--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.

@shivankacker shivankacker added P1 breaking issue or vital feature needs testing needs review labels Nov 13, 2024
@github-actions github-actions bot added needs-triage question Further information is requested labels Nov 13, 2024
@shivankacker shivankacker added needs testing and removed needs testing needs-triage question Further information is requested labels Nov 13, 2024
Copy link

Deploying care-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4a56fbe
Status: ✅  Deploy successful!
Preview URL: https://d3139334.care-fe.pages.dev
Branch Preview URL: https://tabs-deps-bug.care-fe.pages.dev

View logs

@github-actions github-actions bot added needs-triage question Further information is requested labels Nov 13, 2024
@shivankacker shivankacker self-assigned this Nov 13, 2024
@shivankacker shivankacker removed question Further information is requested needs-triage labels Nov 13, 2024
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 (2)
src/components/Facility/ConsultationDetails/index.tsx (2)

Line range hint 82-85: Consider optimizing the tab selection logic

The current tab selection logic works but could be more efficient and clearer:

-  let tab = undefined;
-  if (Object.keys(tabs).includes(props.tab.toUpperCase())) {
-    tab = props.tab.toUpperCase();
-  }
+  const upperTab = props.tab.toUpperCase();
+  const tab = tabs.hasOwnProperty(upperTab) ? upperTab : undefined;

This change:

  1. Performs the uppercase conversion once
  2. Uses direct property check instead of array operations
  3. Makes the undefined assignment more explicit

Line range hint 196-206: Optimize useEffect dependencies

The useEffect dependency array includes unnecessary dependencies that could trigger extra re-renders:

  useEffect(() => {
    const id = patientDataQuery.data?.id;
    if (!id) {
      return;
    }
    fetchData(id);
    triggerGoal("Patient Consultation Viewed", {
      facilityId: facilityId,
      consultationId: consultationId,
      userId: authUser.id,
    });
-  }, [patientDataQuery.data?.id]);
+  }, [patientDataQuery.data?.id, fetchData]);

Also update the fetchData useCallback:

  const fetchData = useCallback(
    async (id: string) => {
      // Get shifting data
      const shiftRequestsQuery = await request(routes.listShiftRequests, {
        query: { patient: id },
      });
      if (shiftRequestsQuery.data?.results) {
        setActiveShiftingData(shiftRequestsQuery.data.results);
      }
    },
-    [consultationId, patientData?.is_vaccinated],
+    [],
  );

These changes:

  1. Remove unnecessary dependencies that could cause extra re-renders
  2. Add fetchData to useEffect dependencies as it's used inside
  3. Remove consultationId and patientData?.is_vaccinated from fetchData dependencies as they're not used
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5bb46fa and 4a56fbe.

📒 Files selected for processing (1)
  • src/components/Facility/ConsultationDetails/index.tsx (1 hunks)
🔇 Additional comments (1)
src/components/Facility/ConsultationDetails/index.tsx (1)

77-80: LGTM! This change effectively fixes the infinite recursion issue.

The direct initialization of tabs by merging defaultTabs and pluginTabs is a better approach than using state management. This eliminates unnecessary re-renders and prevents the infinite recursion issue that was causing lag in the application.

Let's verify that all tabs are properly initialized and accessible:

✅ Verification successful

Verified: Tabs initialization effectively resolves the infinite recursion issue with no further issues found.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that all tab components are properly imported and used
# Look for any potential issues with tab imports or usage

# Check for proper tab component imports
echo "Checking tab component imports..."
rg -l "import.*ConsultationTab" src/

# Check for proper tab usage in the codebase
echo "Checking tab component usage..."
rg "tabs\[.*\]" src/

# Check for any TODO/FIXME comments related to tabs
echo "Checking for any known tab-related issues..."
rg -i "todo|fixme|hack|xxx|bug.*tab" src/

Length of output: 5136

Copy link

cypress bot commented Nov 13, 2024

CARE    Run #3903

Run Properties:  status check passed Passed #3903  •  git commit 4a56fbe08f: Fix bug with recursion
Project CARE
Branch Review tabs-deps-bug
Run status status check passed Passed #3903
Run duration 04m 52s
Commit git commit 4a56fbe08f: Fix bug with recursion
Committer Shivank Kacker
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 126
View all changes introduced in this branch ↗︎

@github-actions github-actions bot added needs-triage question Further information is requested labels Nov 13, 2024
@rithviknishad rithviknishad removed question Further information is requested needs-triage labels Nov 13, 2024
@rithviknishad rithviknishad merged commit 7acc8be into develop Nov 13, 2024
61 checks passed
@rithviknishad rithviknishad deleted the tabs-deps-bug branch November 13, 2024 12:10
Copy link

@shivankacker @shivankacker 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
Labels
needs review needs testing P1 breaking issue or vital feature
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Consultation Page has infinite use effect recursions
3 participants