diet preference options with kebab case value #9821

arhamathar · 2025-01-07T10:23:14Z

Proposed Changes

Fixes Failed to update encounters on selecting certain diet preference #9817
Updated the value of diet preferences from snake case to kebab case.

@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

Based on the comprehensive summary of changes, here are the high-level release notes:

New Features
- Added questionnaire editing functionality
- Enhanced patient context management
- Improved internationalization support
- Added new patient navigation components
Improvements
- Streamlined authentication and token management
- Updated routing for patient and facility navigation
- Refined allergy and encounter tracking
- Improved form handling and validation
Bug Fixes
- Updated error handling in various components
- Fixed data fetching and context management issues
Localization
- Added new translation keys
- Implemented internationalization across components
Performance
- Optimized context and state management
- Simplified component logic and data retrieval

coderabbitai · 2025-01-07T10:23:22Z

Walkthrough

This pull request introduces several significant changes across multiple components and files, focusing on improving patient data management, questionnaire handling, and authentication processes. The primary modifications include updating diet preference handling, refactoring context management for patient and authentication tokens, enhancing localization support, and streamlining component structures. The changes aim to improve code maintainability, user experience, and data consistency across the application.

Changes

File/Group	Change Summary
`src/components/Questionnaire/QuestionTypes/EncounterQuestion.tsx`	Replaced hardcoded diet preference options with dynamically generated `SelectItem` components using `DIET_PREFERENCE_OPTIONS`
`src/common/constants.tsx`	Added `DIET_PREFERENCE_OPTIONS` array with diet preference configurations
Authentication & Context Files	Replaced local storage token management with context-based authentication in multiple components
Routing Files	Updated routing configurations, removed some routes, added new navigation components
Localization Files	Added new translation keys for error messages and UI elements
Patient & Encounter Components	Enhanced patient data handling, added `patientId` to various components

Assessment against linked issues

Objective	Addressed	Explanation
Update encounters with diet preferences	✅	Added `DIET_PREFERENCE_OPTIONS` to handle diet preference selection
Resolve diet preference update errors	✅	Centralized diet preference options for consistent handling

Possibly related issues

cleanup CarePatientTokenKey #9828: Cleanup of CarePatientTokenKey - This PR partially addresses this by replacing local storage token management with context-based approaches

Possibly related PRs

Enhance AllergyQuestion component with improved UI and functionality.… #9647: Enhances allergy data management
Allergy intolerance Cleanup #9812: Streamlines questionnaire response handling
Appointment as structured question + other enhancements #9661: Adds follow-up appointment question functionality

Suggested labels

needs review, tested

Suggested reviewers

rithviknishad
Jacobjeevan

Poem

🥕 A Rabbit's Refactoring Tale 🐰

In lines of code, a transformation springs,
Context replaces tokens, how my heart sings!
Diet preferences dance with newfound grace,
Localization blooms in every space.
CodeRabbit's magic, clean and bright! 🌟

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.

netlify · 2025-01-07T10:23:37Z

✅ Deploy Preview for care-ohc ready!

Name	Link
🔨 Latest commit	`fc303d0`
🔍 Latest deploy log	https://app.netlify.com/sites/care-ohc/deploys/677e9732e66cdd00084975a1
😎 Deploy Preview	https://deploy-preview-9821--care-ohc.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

bodhish · 2025-01-07T13:13:40Z

src/components/Questionnaire/QuestionTypes/EncounterQuestion.tsx

+                  <SelectItem value="diary-free">Dairy Free</SelectItem>
+                  <SelectItem value="nut-free">Nut Free</SelectItem>
+                  <SelectItem value="gluten-free">Gluten Free</SelectItem>


All of these should be moved to constans

CC @Jacobjeevan @rithviknishad

@rithviknishad Shall I create a new PR as you have closed the issues as Not Planned

…ation

…components directly. (ohcnetwork#9847)

coderabbitai

Actionable comments posted: 15

🔭 Outside diff range comments (2)

src/components/Questionnaire/QuestionTypes/MedicationStatementQuestion.tsx (1)
Line range hint 27-32: Remove unused question prop from interface

The question prop has been removed from the component's parameters but is still defined in the interface. This creates an inconsistency between the interface and implementation.

Apply this diff to fix the interface:
 interface MedicationStatementQuestionProps {
-  question: Question;
   questionnaireResponse: QuestionnaireResponse;
   updateQuestionnaireResponseCB: (response: QuestionnaireResponse) => void;
   disabled?: boolean;
 }
src/components/Questionnaire/structured/types.ts (1)

Line range hint 1-1: ❌ PR Changes Don't Match Stated Objective

The PR's objective is to update diet preference values from snake case to kebab case (issue #9817). However, the reviewed files contain unrelated changes:

Authentication token management refactoring

Questionnaire UI improvements

Allergy intolerance data structure updates

Please either:

Update the PR description to accurately reflect all changes

Split the unrelated changes into separate PRs

Include the missing diet preference formatting changes

🧹 Nitpick comments (21)

src/pages/Facility/components/UserCard.tsx (2)
34-37: Simplify token validation logic and extract magic number

The token validation logic can be simplified and made more maintainable.

Consider this improvement:
+ const TOKEN_EXPIRY_MINUTES = 14;
  if (
-   tokenData &&
-   Object.keys(tokenData).length > 0 &&
+   tokenData?.createdAt &&
-   dayjs(tokenData.createdAt).isAfter(dayjs().subtract(14, "minutes"))
+   dayjs(tokenData.createdAt).isAfter(dayjs().subtract(TOKEN_EXPIRY_MINUTES, "minutes"))
  )
Line range hint 74-78: Consider moving user data to context

While the component moved away from localStorage for authentication, it's still using localStorage for user data. Consider maintaining consistency by moving this to context as well.

Consider creating a user context or extending the existing context to handle this data:
const { setSelectedUser } = useUserContext();  // New context
// Then in onClick:
setSelectedUser(user);
navigate(returnLink);
src/types/questionnaire/questionnaire.ts (1)
20-22: Add documentation and consider type refinement.

While the interface extension is clean, consider these improvements:

Add JSDoc documentation to explain the purpose of the QuestionnaireUpdate interface

Consider using a more specific type for organization IDs if they follow a particular format

Example documentation:
+/**
+ * Represents an updated questionnaire with associated organizations
+ * @extends {QuestionnaireDetail}
+ */
 export interface QuestionnaireUpdate extends QuestionnaireDetail {
   organizations: string[];
 }
src/components/Auth/Login.tsx (1)
153-153: Consider abstracting the redirect URL into a configuration or constant.

The redirect path '/patient/home' is hard-coded. For better maintainability and to avoid magic strings, consider defining it as a constant or retrieving it from a configuration file.

Apply this diff to abstract the redirect URL:
 const tokenData: TokenData = {
   token: access,
   phoneNumber: `+91${phone}`,
   createdAt: new Date().toISOString(),
 };
-patientLogin(tokenData, `/patient/home`);
+const PATIENT_HOME_URL = '/patient/home';
+patientLogin(tokenData, PATIENT_HOME_URL);
And define PATIENT_HOME_URL at the top or in a configuration file.
src/components/Questionnaire/QuestionnaireEditor.tsx (1)
487-487: Specify correct type for dragHandleProps

Using any reduces type safety. Specify a more precise type for dragHandleProps.

Apply this diff to specify the correct type:
+import { DraggableProvidedDragHandleProps } from "@hello-pangea/dnd";

 interface QuestionEditorProps {
   // ...
-  dragHandleProps?: any;
+  dragHandleProps?: DraggableProvidedDragHandleProps;
   // ...
 }
src/components/ui/sidebar/org-nav.tsx (2)
5-9: LGTM! Consider adding icon type constraint.

The NavigationLink interface is well-defined, but consider constraining the icon type to specific icon names for better type safety.
 interface NavigationLink {
   name: string;
   url: string;
-  icon?: string;
+  icon?: 'home' | 'user' | 'settings' | string; // Add commonly used icons
 }
15-22: LGTM! Consider adding URL validation.

The generateOrganizationLinks function is clean and focused. Consider adding URL validation for the organization IDs.
 function generateOrganizationLinks(
   organizations: Organization[],
 ): NavigationLink[] {
   return organizations.map((org) => ({
     name: org.name,
-    url: `/organization/${org.id}`,
+    url: `/organization/${encodeURIComponent(org.id)}`,
   }));
 }
src/types/emr/allergyIntolerance/allergyIntolerance.ts (1)
20-22: Improve comment clarity.

The comment "Added optional id here as this type is used only in one place" could be more descriptive:

Specify where this type is used

Explain why id is optional here but required in the base interface
-// Added optional id here as this type is used only in one place
+// Optional id in request type as it's only used in AllergyQuestion component
+// where new allergies don't have an id until saved
src/components/Questionnaire/QuestionLabel.tsx (2)
11-12: Consider moving style constants to a shared styles file

The style constants could be moved to a shared styles file to maintain consistency across components.

21-33: Enhance accessibility of the visual indicator

The visual indicator div should have an ARIA label for screen readers.
-        {groupLabel && <div className="h-1 w-4 rounded-full bg-indigo-600" />}
+        {groupLabel && (
+          <div 
+            className="h-1 w-4 rounded-full bg-indigo-600" 
+            role="presentation" 
+            aria-hidden="true" 
+          />
+        )}
src/components/ui/sidebar/patient-nav.tsx (2)
11-15: Consider extending NavigationLink interface.

The interface could benefit from additional properties for better type safety and future extensibility.
 interface NavigationLink {
   name: string;
   url: string;
   icon?: string;
+  isExternal?: boolean;
+  disabled?: boolean;
 }
23-30: Consider extracting organization traversal logic.

The organization traversal logic could be moved to a separate utility function for better reusability and testing.
+function findParentOrganization(organization: any) {
+  let parent = organization?.parent;
+  while (parent?.parent) {
+    if (parent.level_cache === 1) {
+      return parent;
+    }
+    parent = parent.parent;
+  }
+  return parent;
+}
+
 function generatePatientLinks(
   selectedUser: AppointmentPatient | null,
   t: TFunction,
 ): NavigationLink[] {
   if (!selectedUser) return [];

   const { geo_organization } = selectedUser;
-  let parentOrganization = geo_organization?.parent;
-  while (parentOrganization?.parent) {
-    if (parentOrganization.level_cache === 1) {
-      break;
-    }
-    parentOrganization = parentOrganization.parent;
-  }
+  const parentOrganization = findParentOrganization(geo_organization);
src/Providers/PatientUserProvider.tsx (2)
19-21: Consider adding error boundary for token validation.

The token validation and navigation logic could benefit from an error boundary to handle edge cases more gracefully.
+class TokenErrorBoundary extends React.Component {
+  componentDidCatch(error: Error) {
+    navigate("/");
+  }
+}

 export default function PatientUserProvider({ children }: Props) {
   // ... existing code ...

   if (!tokenData) {
-    navigate("/");
-    return null;
+    throw new Error("Invalid token");
   }

   return (
+    <TokenErrorBoundary>
       <PatientUserContext.Provider value={{...}}>
         {children}
       </PatientUserContext.Provider>
+    </TokenErrorBoundary>
   );
 }
Also applies to: 32-32, 58-61

35-41: Consider adding retry logic for failed queries.

The query configuration could benefit from retry logic for better resilience.
 const { data: userData } = useQuery({
   queryKey: ["patients", tokenData],
   queryFn: query(routes.otp.getPatient, {
     headers: {
       Authorization: `Bearer ${tokenData?.token}`,
     },
   }),
   enabled: !!tokenData?.token,
+  retry: 3,
+  retryDelay: (attemptIndex) => Math.min(1000 * 2 ** attemptIndex, 30000),
 });
src/components/ui/sidebar/patient-switcher.tsx (1)
Line range hint 46-51: Consider moving localStorage logic to context

The direct usage of localStorage within the component could be moved to the context to centralize patient data management.
- if (patient) {
-   patientUserContext.setSelectedPatient(patient);
-   localStorage.setItem("selectedPatient", JSON.stringify(patient));
- }
+ if (patient) {
+   patientUserContext.setSelectedPatient(patient);
+ }
src/components/Questionnaire/structured/handlers.ts (1)
30-44: LGTM! Efficient batch processing implementation.

The consolidation of allergy requests into a single batch operation is a good optimization. The implementation follows the same pattern as other handlers and maintains type safety.

Consider adding a batch size limit to prevent potential issues with very large arrays:
 getRequests: (allergies, { patientId, encounterId }) => {
+  const BATCH_SIZE = 100;
+  const batches = [];
+  for (let i = 0; i < allergies.length; i += BATCH_SIZE) {
+    const batch = allergies.slice(i, i + BATCH_SIZE);
+    batches.push({
+      url: `/api/v1/patient/${patientId}/allergy_intolerance/upsert/`,
+      method: "POST",
+      body: {
+        datapoints: batch.map((allergy) => ({
+          ...allergy,
+          encounter: encounterId,
+        })),
+      },
+      reference_id: `allergy_intolerance_batch_${i/BATCH_SIZE}`,
+    });
+  }
+  return batches;
 }
src/pages/Appoinments/PatientSelect.tsx (1)
Line range hint 33-37: Consider migrating remaining localStorage usage to context.

The component still uses localStorage for selectedSlot and reason. Consider moving these to the patient context as well for consistency.
-  const selectedSlot = JSON.parse(
-    localStorage.getItem("selectedSlot") ?? "",
-  ) as SlotAvailability;
-  const reason = localStorage.getItem("reason");
+  const { selectedSlot, reason } = patientUserContext?.appointmentData ?? {};
src/components/Facility/ConsultationDetails/QuestionnaireResponsesList.tsx (1)
211-244: Improve null checks in questionnaire response rendering.

The questionnaire response rendering logic has good null checks, but consider adding error boundaries to handle potential runtime errors gracefully.

Consider wrapping the questionnaire response section with an error boundary:
import { ErrorBoundary } from '@/components/Common/ErrorBoundary';

// Inside the render logic
<ErrorBoundary fallback={<div>Error loading questionnaire response</div>}>
  {item.questionnaire && (
    <div className="mt-3 border-t pt-3">
      // ... existing code
    </div>
  )}
</ErrorBoundary>
src/pages/Appoinments/auth/PatientLogin.tsx (1)
Line range hint 92-102: Enhance error handling in OTP mutation.

While the loading state handling is good, consider adding retry logic for network failures.

Add retry configuration to the mutation:
const { mutate: sendOTP, isPending: isSendOTPLoading } = useMutation({
  mutationFn: (phoneNumber: string) => // ... existing code,
  retry: 3,
  retryDelay: (attemptIndex) => Math.min(1000 * 2 ** attemptIndex, 30000),
  // ... rest of the config
});
src/components/Patient/PatientRegistration.tsx (2)
317-332: Improved form field implementation with proper accessibility.

The form fields are well-structured with:

Proper label associations

Required field indicators

Clear error messaging

However, the error handling could be optimized.

Consider using optional chaining for cleaner error handling:
-              {errors["name"] &&
-                errors["name"].map((error, i) => (
+              {errors["name"]?.map((error, i) => (
                   <div key={i} className="text-red-500 text-xs">
                     {error}
                   </div>
                 ))}
Also applies to: 334-358

🧰 Tools

🪛 Biome (1.9.4)

[error] 326-331: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

490-557: Comprehensive date input implementation.

The date input fields are well-implemented with:

Proper validation constraints

Clear labeling

Proper error handling

However, consider adding aria-labels for better screen reader support.
 <Input
   placeholder="DD"
   type="number"
+  aria-label={t("day")}
   value={form.date_of_birth?.split("-")[2] || ""}
   // ... other props
 />

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8deec25 and fc303d0.

⛔ Files ignored due to path filters (1)

package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (54)

crowdin.yml (1 hunks)
cypress/e2e/patient_spec/patient_search.cy.ts (1 hunks)
public/locale/en.json (6 hunks)
src/Providers/AuthUserProvider.tsx (5 hunks)
src/Providers/PatientUserProvider.tsx (3 hunks)
src/Routers/PatientRouter.tsx (2 hunks)
src/Routers/PublicRouter.tsx (0 hunks)
src/Routers/routes/ConsultationRoutes.tsx (1 hunks)
src/Routers/routes/questionnaireRoutes.tsx (1 hunks)
src/common/constants.tsx (1 hunks)
src/components/Auth/Login.tsx (1 hunks)
src/components/Facility/ConsultationDetails/QuestionnaireResponsesList.tsx (1 hunks)
src/components/Facility/ConsultationDetails/StructuredResponseView.tsx (0 hunks)
src/components/Patient/PatientInfoCard.tsx (5 hunks)
src/components/Patient/PatientRegistration.tsx (6 hunks)
src/components/Patient/allergy/list.tsx (3 hunks)
src/components/Questionnaire/QuestionLabel.tsx (1 hunks)
src/components/Questionnaire/QuestionRenderer.tsx (3 hunks)
src/components/Questionnaire/QuestionTypes/AllergyQuestion.tsx (11 hunks)
src/components/Questionnaire/QuestionTypes/EncounterQuestion.tsx (2 hunks)
src/components/Questionnaire/QuestionTypes/FollowUpAppointmentQuestion.tsx (1 hunks)
src/components/Questionnaire/QuestionTypes/MedicationStatementQuestion.tsx (2 hunks)
src/components/Questionnaire/QuestionTypes/QuestionGroup.tsx (6 hunks)
src/components/Questionnaire/QuestionTypes/QuestionInput.tsx (3 hunks)
src/components/Questionnaire/QuestionnaireEditor.tsx (1 hunks)
src/components/Questionnaire/QuestionnaireForm.tsx (1 hunks)
src/components/Questionnaire/structured/handlers.ts (1 hunks)
src/components/Questionnaire/structured/types.ts (3 hunks)
src/components/ui/errors.tsx (0 hunks)
src/components/ui/input-with-error.tsx (0 hunks)
src/components/ui/sidebar/app-sidebar.tsx (3 hunks)
src/components/ui/sidebar/facility-nav.tsx (1 hunks)
src/components/ui/sidebar/nav-user.tsx (2 hunks)
src/components/ui/sidebar/org-nav.tsx (1 hunks)
src/components/ui/sidebar/patient-nav.tsx (1 hunks)
src/components/ui/sidebar/patient-switcher.tsx (1 hunks)
src/hooks/useAuthOrPatientUser.ts (0 hunks)
src/hooks/useAuthUser.ts (1 hunks)
src/hooks/usePatientSignOut.ts (1 hunks)
src/hooks/usePatientUser.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 (3 hunks)
src/pages/Appoinments/auth/PatientLogin.tsx (9 hunks)
src/pages/Encounters/tabs/EncounterUpdatesTab.tsx (2 hunks)
src/pages/Facility/components/UserCard.tsx (5 hunks)
src/pages/FacilityOrganization/components/FacilityOrganizationSelector.tsx (4 hunks)
src/pages/Organization/components/OrganizationSelector.tsx (2 hunks)
src/pages/Patient/index.tsx (1 hunks)
src/types/emr/allergyIntolerance/allergyIntolerance.ts (2 hunks)
src/types/questionnaire/form.ts (2 hunks)
src/types/questionnaire/questionnaire.ts (1 hunks)
src/types/questionnaire/questionnaireApi.ts (2 hunks)

💤 Files with no reviewable changes (5)

src/components/ui/input-with-error.tsx
src/hooks/useAuthOrPatientUser.ts
src/Routers/PublicRouter.tsx
src/components/ui/errors.tsx
src/components/Facility/ConsultationDetails/StructuredResponseView.tsx

✅ Files skipped from review due to trivial changes (1)

src/components/Questionnaire/QuestionTypes/FollowUpAppointmentQuestion.tsx

🚧 Files skipped from review as they are similar to previous changes (1)

src/components/Questionnaire/QuestionTypes/EncounterQuestion.tsx

🧰 Additional context used

🪛 Biome (1.9.4)

src/components/Patient/PatientRegistration.tsx

[error] 326-331: Change to an optional chain.

Unsafe fix: Change to an optional chain.