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

Fixed blinking issue while lazy loading plugin components #10702

Merged
merged 3 commits into from
Feb 19, 2025

Conversation

khavinshankar
Copy link
Member

@khavinshankar khavinshankar commented Feb 19, 2025

Wrapping the components with Suspense fixed the issue.

Summary by CodeRabbit

  • New Features
    • Enhanced the application’s loading experience by displaying a clear loading indicator while plugin components and encounter tabs are being loaded.
    • Updated the encounters view to now provide visual feedback during asynchronous loading, ensuring smoother and more responsive interactions for users.

@khavinshankar khavinshankar requested a review from a team as a code owner February 19, 2025 13:32
Copy link
Contributor

coderabbitai bot commented Feb 19, 2025

Walkthrough

This pull request updates the asynchronous loading behavior across plugin and encounter tab components by incorporating React’s Suspense. The PluginEngine now wraps its plugin components with a Suspense that displays a fallback UI during loading, and the ESLint directive regarding literal strings has been removed. In the care apps hook, a new higher-order component withSuspense is introduced to wrap encounter tabs similarly. Additionally, the EncounterShow page now imports and uses encounter tabs instead of consultation tabs.

Changes

File(s) Change Summary
src/PluginEngine.tsx, src/hooks/useCareApps.tsx Components now use React.Suspense for asynchronous loading. Added the withSuspense HOC in useCareApps.tsx and removed an outdated ESLint directive.
src/pages/.../EncounterShow.tsx Updated the import and usage from useCareAppConsultationTabs to useCareAppEncounterTabs, changing the source of the rendered tabs in the Encounter component.

Sequence Diagram(s)

sequenceDiagram
    participant P as PluginEngine
    participant S as React.Suspense
    participant L as Loader
    
    P->>S: Wrap plugin component (fallback: Loading...)
    S->>L: Initiate async loading
    alt Component not loaded
        S-->>P: Render fallback UI
    else Component loaded
        L-->>S: Return loaded plugin component
        S-->>P: Render plugin component
    end
Loading
sequenceDiagram
    participant U as Encounter Component
    participant H as withSuspense HOC
    participant S as React.Suspense
    participant T as Encounter Tab
    
    U->>H: Request Encounter Tab
    H->>S: Wrap Encounter Tab (fallback: Loading)
    S->>T: Initiate async loading
    alt Tab not loaded
        S-->>H: Render fallback UI
    else Tab loaded
        T-->>S: Return loaded Encounter Tab
        S-->>H: Render Encounter Tab
    end
    H-->>U: Return wrapped Encounter Tab
Loading

Possibly related PRs

Suggested labels

tested, reviewed

Suggested reviewers

  • rithviknishad
  • Jacobjeevan

Poem

I'm a coding rabbit, swift and keen,
Hopping through code in a land unseen.
Suspense wraps my components with a gentle grace,
Fallbacks appear as I quicken my pace.
With each new change, my whiskers twitch in delight 🐇!


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 Feb 19, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit d32c66f
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/67b5ddb3e2112600083b5d91
😎 Deploy Preview https://deploy-preview-10702.preview.ohc.network
📱 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

cloudflare-workers-and-pages bot commented Feb 19, 2025

Deploying care-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: d32c66f
Status: ✅  Deploy successful!
Preview URL: https://67c2ea0b.care-fe.pages.dev
Branch Preview URL: https://khavinshankar-fix-fix-plugga.care-fe.pages.dev

View logs

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/PluginEngine.tsx (1)

54-58: LGTM! The Suspense wrapper effectively addresses the blinking issue.

The implementation correctly wraps plugin components with Suspense, providing a smooth loading experience during lazy loading.

However, consider using the shared Loading component for consistency with other loading states in the application.

-          <React.Suspense key={plugin.plugin} fallback={<div>Loading...</div>}>
+          <React.Suspense key={plugin.plugin} fallback={<Loading />}>
src/hooks/useCareApps.tsx (1)

37-49: Consider optimizing the reduce operations.

While the current implementation works well for a small number of tabs, the use of spread operators in reducers can lead to O(n²) complexity.

Consider using Object.assign or maintaining an array instead:

  return careApps.reduce((acc, app) => {
-    const appTabs = Object.entries(app.encounterTabs ?? {}).reduce(
-      (acc, [key, Component]) => {
-        return { ...acc, [key]: withSuspense(Component) };
-      },
-      {},
-    );
-
-    return { ...acc, ...appTabs };
+    return Object.assign(acc, 
+      Object.fromEntries(
+        Object.entries(app.encounterTabs ?? {})
+          .map(([key, Component]) => [key, withSuspense(Component)])
+      )
+    );
  }, {});
🧰 Tools
🪛 Biome (1.9.4)

[error] 43-43: Avoid the use of spread (...) syntax on accumulators.

Spread syntax should be avoided on accumulators (like those in .reduce) because it causes a time complexity of O(n^2).
Consider methods such as .splice or .push instead.

(lint/performance/noAccumulatingSpread)


[error] 48-48: Avoid the use of spread (...) syntax on accumulators.

Spread syntax should be avoided on accumulators (like those in .reduce) because it causes a time complexity of O(n^2).
Consider methods such as .splice or .push instead.

(lint/performance/noAccumulatingSpread)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 56defe9 and d32c66f.

📒 Files selected for processing (3)
  • src/PluginEngine.tsx (1 hunks)
  • src/hooks/useCareApps.tsx (2 hunks)
  • src/pages/Encounters/EncounterShow.tsx (2 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
src/hooks/useCareApps.tsx

[error] 43-43: Avoid the use of spread (...) syntax on accumulators.

Spread syntax should be avoided on accumulators (like those in .reduce) because it causes a time complexity of O(n^2).
Consider methods such as .splice or .push instead.

(lint/performance/noAccumulatingSpread)


[error] 48-48: Avoid the use of spread (...) syntax on accumulators.

Spread syntax should be avoided on accumulators (like those in .reduce) because it causes a time complexity of O(n^2).
Consider methods such as .splice or .push instead.

(lint/performance/noAccumulatingSpread)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: cypress-run (1)
🔇 Additional comments (2)
src/hooks/useCareApps.tsx (1)

26-35: LGTM! The withSuspense HOC is well-implemented.

The implementation correctly wraps components with Suspense and maintains proper TypeScript typing.

src/pages/Encounters/EncounterShow.tsx (1)

11-11: LGTM! The switch to encounter tabs is appropriate.

The change from consultation tabs to encounter tabs aligns better with the component's purpose and maintains proper functionality with the new Suspense-wrapped tabs.

Also applies to: 55-55

Copy link

cypress bot commented Feb 19, 2025

CARE    Run #4877

Run Properties:  status check failed Failed #4877  •  git commit d32c66fa45: Fixed blinking issue while lazy loading plugin components
Project CARE
Branch Review khavinshankar/fix/fix-pluggable-blinking-issue
Run status status check failed Failed #4877
Run duration 07m 18s
Commit git commit d32c66fa45: Fixed blinking issue while lazy loading plugin components
Committer Khavin Shankar
View all properties for this run ↗︎

Test results
Tests that failed  Failures 1
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 10
View all changes introduced in this branch ↗︎

Tests for review

Failed  cypress/e2e/patient_spec/patient_encounter.cy.ts • 1 failed test

View Output

Test Artifacts
Patient Encounter Questionnaire > Create a new ABG questionnaire and verify the values Test Replay Screenshots

@gigincg gigincg merged commit d8857ae into develop Feb 19, 2025
21 of 23 checks passed
@gigincg gigincg deleted the khavinshankar/fix/fix-pluggable-blinking-issue branch February 19, 2025 14:10
Copy link

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

@khavinshankar khavinshankar self-assigned this Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants