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

cleanup CarePatientTokenKey #9827

Merged

Conversation

Mahendar0701
Copy link
Contributor

@Mahendar0701 Mahendar0701 commented Jan 7, 2025

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

  • Refactor

    • Updated local storage key references from CarePatientTokenKey to LocalStorageKeys.patientTokenKey across multiple components
    • Removed deprecated constant CarePatientTokenKey
  • Localization

    • Added translation support for button labels and text strings in components
    • Replaced static text with localized versions using translation function

These changes improve code consistency and enhance internationalization support across the application.

@Mahendar0701 Mahendar0701 requested a review from a team as a code owner January 7, 2025 14:04
Copy link
Contributor

coderabbitai bot commented Jan 7, 2025

Walkthrough

This pull request involves a systematic update to local storage key management across multiple files. The primary change is replacing the deprecated CarePatientTokenKey constant with LocalStorageKeys.patientTokenKey in various components related to patient interactions. The modifications span several files in the appointments, authentication, and user management sections, focusing on standardizing how patient token data is retrieved from local storage.

Changes

File Path Change Summary
src/Providers/PatientUserProvider.tsx Updated token data retrieval to use LocalStorageKeys.patientTokenKey
src/common/constants.tsx Removed deprecated CarePatientTokenKey constant
src/hooks/usePatientSignOut.ts Updated local storage key for sign-out process
src/pages/Appointments/* Updated local storage key retrieval in multiple components (PatientRegistration, PatientSelect, Schedule, Success, PatientLogin)
src/pages/Facility/components/UserCard.tsx Updated local storage key and added localization for text elements

Possibly related PRs

Suggested Labels

tested, changes required

Suggested Reviewers

  • rithviknishad
  • Jacobjeevan

Poem

🐰 A Rabbit's Ode to Key Management 🔑

Local storage keys, once wild and free,
Now organized with clarity
From CarePatientTokenKey we part
To LocalStorageKeys, a fresh start!
Code refactored with bunny 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 Jan 7, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 7e98922
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/677d347fa1552e0008ed6aca
😎 Deploy Preview https://deploy-preview-9827--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.

@Mahendar0701
Copy link
Contributor Author

Mahendar0701 commented Jan 7, 2025

@rithviknishad i am also working on notification relplacement
But having some trouble with handling toast.error messages
Will raise PR for that soon

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 (4)
src/Providers/PatientUserProvider.tsx (1)

7-7: Add error handling for JSON.parse

The current implementation might throw if the localStorage value is malformed JSON.

Consider wrapping the JSON.parse in a try-catch:

 const tokenData: TokenData = JSON.parse(
-  localStorage.getItem(LocalStorageKeys.patientTokenKey) || "{}",
+  (() => {
+    try {
+      return localStorage.getItem(LocalStorageKeys.patientTokenKey) || "{}";
+    } catch (error) {
+      console.error("Failed to parse patient token:", error);
+      return "{}";
+    }
+  })(),
 );

Also applies to: 14-16

src/pages/Facility/components/UserCard.tsx (1)

31-33: Add error handling for JSON.parse

Similar to other files, the JSON.parse call needs error handling.

Consider adding a try-catch block:

 const tokenData: TokenData = JSON.parse(
-    localStorage.getItem(LocalStorageKeys.patientTokenKey) || "{}",
+    (() => {
+      try {
+        return localStorage.getItem(LocalStorageKeys.patientTokenKey) || "{}";
+      } catch (error) {
+        console.error("Failed to parse patient token:", error);
+        return "{}";
+      }
+    })(),
 );
src/pages/Appoinments/Success.tsx (2)

21-24: Add comprehensive error handling for localStorage operations

Both tokenData and userData parsing need error handling to prevent runtime exceptions.

Consider adding try-catch blocks for both operations:

-  const tokenData: TokenData = JSON.parse(
-    localStorage.getItem(LocalStorageKeys.patientTokenKey) || "{}",
-  );
-  const userData: UserModel = JSON.parse(localStorage.getItem("user") ?? "{}");
+  const tokenData: TokenData = (() => {
+    try {
+      return JSON.parse(localStorage.getItem(LocalStorageKeys.patientTokenKey) || "{}");
+    } catch (error) {
+      console.error("Failed to parse patient token:", error);
+      return {} as TokenData;
+    }
+  })();
+  const userData: UserModel = (() => {
+    try {
+      return JSON.parse(localStorage.getItem("user") ?? "{}");
+    } catch (error) {
+      console.error("Failed to parse user data:", error);
+      return {} as UserModel;
+    }
+  })();

Line range hint 1-1: Consider adding error handling across all files

There's a consistent pattern across these files where JSON.parse is used without error handling. While the key replacement is done correctly, adding try-catch blocks would improve the robustness of the application.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bd8ac7e and 7e98922.

📒 Files selected for processing (9)
  • src/Providers/PatientUserProvider.tsx (1 hunks)
  • src/common/constants.tsx (0 hunks)
  • src/hooks/usePatientSignOut.ts (1 hunks)
  • src/pages/Appoinments/PatientRegistration.tsx (2 hunks)
  • src/pages/Appoinments/PatientSelect.tsx (2 hunks)
  • src/pages/Appoinments/Schedule.tsx (2 hunks)
  • src/pages/Appoinments/Success.tsx (2 hunks)
  • src/pages/Appoinments/auth/PatientLogin.tsx (5 hunks)
  • src/pages/Facility/components/UserCard.tsx (5 hunks)
💤 Files with no reviewable changes (1)
  • src/common/constants.tsx
🔇 Additional comments (10)
src/hooks/usePatientSignOut.ts (1)

4-4: LGTM! Clean replacement of the deprecated key.

The changes correctly update the localStorage key while maintaining the existing sign-out functionality.

Also applies to: 12-12

src/pages/Facility/components/UserCard.tsx (1)

Line range hint 35-41: LGTM! Token expiry check is well implemented.

The dayjs usage for checking token expiry (14 minutes) is correct and maintains security.

src/pages/Appoinments/PatientSelect.tsx (2)

18-18: LGTM: Import of LocalStorageKeys.

The import is correctly added as part of the standardization of local storage key usage.


42-42: LGTM: Updated local storage key.

The change from CarePatientTokenKey to LocalStorageKeys.patientTokenKey is consistent with the PR's objective to standardize local storage key usage.

src/pages/Appoinments/auth/PatientLogin.tsx (2)

32-32: LGTM: Import of LocalStorageKeys.

The import is correctly added as part of the standardization of local storage key usage.


69-69: LGTM: Updated local storage key usage.

The changes consistently use LocalStorageKeys.patientTokenKey for all token-related local storage operations:

  1. Reading token data for initial auth check
  2. Reading token data for OTP validation
  3. Storing token data after successful login

Also applies to: 104-104, 163-166

src/pages/Appoinments/Schedule.tsx (2)

23-23: LGTM: Import of LocalStorageKeys.

The import is correctly added as part of the standardization of local storage key usage.


48-48: LGTM: Updated local storage key.

The change from CarePatientTokenKey to LocalStorageKeys.patientTokenKey is consistent with the PR's objective to standardize local storage key usage.

src/pages/Appoinments/PatientRegistration.tsx (2)

32-32: LGTM: Import of LocalStorageKeys.

The import is correctly added alongside GENDER_TYPES as part of the standardization of local storage key usage.


76-76: LGTM: Updated local storage key.

The change from CarePatientTokenKey to LocalStorageKeys.patientTokenKey is consistent with the PR's objective to standardize local storage key usage.

@rithviknishad rithviknishad merged commit ddac1c5 into ohcnetwork:develop Jan 7, 2025
22 of 23 checks passed
Copy link

github-actions bot commented Jan 7, 2025

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

@Mahendar0701 Mahendar0701 deleted the cleanup-CarePatientTokenKey branch January 7, 2025 14:26
@coderabbitai coderabbitai bot mentioned this pull request Jan 7, 2025
6 tasks
arhamathar pushed a commit to arhamathar/care_fe that referenced this pull request Jan 8, 2025
khavinshankar pushed a commit that referenced this pull request Jan 8, 2025
nihal467 added a commit that referenced this pull request Jan 13, 2025
* added patient home actions plugin hook

* expose core app env in global scope

* enable heatmap and fix appointments column size (#9713)

* Fix: Forgot password error should be handled properly  (#9707)

* forgot password mutation

* updated

* Added no user assingned message (#9666)

Co-authored-by: Rithvik Nishad <rithvikn2001@gmail.com>

* Remove facility name from facility users page (#9746)

* Enhance organization management by adding new organization types and updating related components. Refactor organization level retrieval to use metadata for improved localization. Remove deprecated organization levels constant and clean up unused code in various components.

* Cancel button fix in Book Appointment screen (#9757)

* Add public flag to facility (#9759)

* Auto-Hide Sidebar on mobile (#9758)

* Implement Permission Context and Update User Permissions Handling

- Introduced a new PermissionContext to manage user permissions and super admin status across the application.
- Updated AppRouter to utilize PermissionProvider for managing permissions.
- Changed UserModel to store permissions as strings instead of objects.
- Refactored OrganizationFacilities and OrganizationPatients components to use updated permission checks and organization identifiers.
- Enhanced OrganizationLayout to conditionally render navigation items based on user permissions.

This commit improves the permission management system and ensures consistent handling of user permissions throughout the application.

* Replaced ButtonV2's with Button in entire codebase (#9736)

* fixes overlapping text (#9767)

* Care Loading icon in organization and facility users (#9723)

* Clean up facility search in index

* Add searchPostFix prop to ValueSetSelect and related components

- Introduced a new `searchPostFix` prop in `ValueSetSelect` to allow appending a suffix to the search query.
- Updated `MedicationRequestQuestion` and `MedicationStatementQuestion` components to utilize the `searchPostFix` prop with a default value of " clinical drug".
- This change enhances search functionality by providing more context in search queries.

* Clean up patient login

* Fix cancel button in update encounter form (#9772)

* disabled image build and deploy for care stagin (#9779)

* Bump @tanstack/react-query-devtools from 5.62.11 to 5.62.15 (#9785)

Bumps [@tanstack/react-query-devtools](https://github.com/TanStack/query/tree/HEAD/packages/react-query-devtools) from 5.62.11 to 5.62.15.
- [Release notes](https://github.com/TanStack/query/releases)
- [Commits](https://github.com/TanStack/query/commits/HEAD/packages/react-query-devtools)

---
updated-dependencies:
- dependency-name: "@tanstack/react-query-devtools"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Patient encounter notes (#9617)

Co-authored-by: Bodhisha Thomas <bodhi@Bodhishas-MacBook-Air.local>
Co-authored-by: Bodhish Thomas <bodhish@gmail.com>

* Fix Auto hide without hook (#9780)

* Enhance encounter data handling by adding encounterId prop across multiple components (#9793)

* Disable encounter create during save (#9795)

* Enhance encounter data handling by adding encounterId prop across multiple components

- Added `encounterId` prop to `ObservationChart`, `ObservationHistoryTable`, `ObservationsList`, `QuestionnaireResponsesList`, and `StructuredResponseView` components to improve data fetching and display related to specific encounters.
- Updated query parameters in API calls to include `encounterId` for better data context.
- Refactored `EncounterPlotsTab` and `EncounterUpdatesTab` to pass the new `encounterId` prop, ensuring consistent data handling across the application.

This change improves the overall functionality and user experience by ensuring that encounter-specific data is accurately retrieved and displayed.

* fix: disable encounter create button during save to prevent multiple submissions #9794

* Refactor PatientHome and EncounterShow components; update FacilityOrganizationSelector labels

- Removed unused state and commented-out code in PatientHome for improved readability.
- Enhanced patient data display by updating the last updated and created by fields to use `updated_by` instead of `modified_by`.
- Updated date formatting functions to ensure consistent display of patient and encounter dates.
- Changed labels in FacilityOrganizationSelector from "Organization" to "Select Department" and adjusted related text for clarity.

These changes streamline the codebase and improve user interface clarity.

* Partial Cleanup Public Router | Public Pages Header

* Rewire enableWhen

* Remove localStorage watch from AuthUserProvider

* Implement immediate redirection after successful login

* Fix: Update the value to Home Health in Create Encounter Form (#9806)

* Update Questionnaire Styling

* Update Questionnaire Styling

* Update Auth Handling

* Cleanup Patient Auth State

* Handle Null created_by

* Types for null patient.created_by

* Bump i18next from 24.2.0 to 24.2.1 (#9818)

Bumps [i18next](https://github.com/i18next/i18next) from 24.2.0 to 24.2.1.
- [Release notes](https://github.com/i18next/i18next/releases)
- [Changelog](https://github.com/i18next/i18next/blob/master/CHANGELOG.md)
- [Commits](i18next/i18next@v24.2.0...v24.2.1)

---
updated-dependencies:
- dependency-name: i18next
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump input-otp from 1.4.1 to 1.4.2 (#9819)

Bumps [input-otp](https://github.com/guilhermerodz/input-otp/tree/HEAD/packages/input-otp) from 1.4.1 to 1.4.2.
- [Changelog](https://github.com/guilhermerodz/input-otp/blob/master/CHANGELOG.md)
- [Commits](https://github.com/guilhermerodz/input-otp/commits/HEAD/packages/input-otp)

---
updated-dependencies:
- dependency-name: input-otp
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Rename dosage field to frequency in ongoing medication form (#9811)

* feat: Add new fields to Question interface (#9824)

* Cleanup Labels in Questionnaire

* Allergy intolerance Cleanup (#9812)

* cleanup CarePatientTokenKey (#9827)

* changed the facility name (#9829)

* Cleanup localStorage Management in Patient Login; Fix Time in Confirmation

* Use PatientContext from Router when required

* Cleanup Navbars

* AllergyList: Add i18n; map key

* Add Actions in Encounter

* Remove Shortcut for Nursing Care

* Update Crowdin configuration file

* Update Crowdin configuration file

* Fix: Replace InputWithError and InputErrors components with ShadCN’s components directly. (#9847)

* fixed eslint errors caused while creating plugin map

* refactored the patient registration form using react hook form

* added patient registration form plugin hook

* updated validations

* added patient info card actions plugin hook

* set same_phone_number to true by default in patient registration

* set same_address to true and same_phone_number to false by default in patient registration

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Mohammed Nihal <57055998+nihal467@users.noreply.github.com>
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.

cleanup CarePatientTokenKey
2 participants