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: Pincode autofill in Patient Registration page in public page #10272

Closed

Conversation

Rishith25
Copy link
Contributor

@Rishith25 Rishith25 commented Jan 29, 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

  • New Features

    • Enhanced pincode input functionality with auto-fill and real-time feedback
    • Added support for optional authentication tokens in organization-related hooks
  • Improvements

    • Improved state management for organizational selections
    • Added visual indicators for auto-filled pincode information
  • Technical Updates

    • Updated hooks to support optional authentication tokens
    • Refined form handling and state management in patient registration process

@Rishith25 Rishith25 requested a review from a team as a code owner January 29, 2025 02:29
Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

Walkthrough

The pull request introduces an optional authToken parameter to the useOrganization and useStateAndDistrictFromPincode hooks, enabling authenticated requests to organization services. In the PatientRegistration component, new state management and useEffect hooks are added to support pincode-based auto-filling of state and district information. The changes enhance the functionality of organization-related data retrieval and improve the user experience in the patient registration form.

Changes

File Change Summary
src/hooks/useOrganization.ts Added optional authToken parameter to function and interface, enabling authenticated organization queries
src/hooks/useStateAndDistrictFromPincode.ts Introduced authToken parameter to support authenticated organization queries for state and district
src/pages/PublicAppointments/PatientRegistration.tsx Added state management for auto-filled pincode, integrated useStateAndDistrictFromPincode hook, enhanced rendering logic

Assessment against linked issues

Objective Addressed Explanation
Autofill states and districts on pincode entry

Possibly related PRs

Suggested labels

needs testing, needs review

Suggested reviewers

  • rithviknishad
  • Jacobjeevan

Poem

🐰 A rabbit's tale of code so bright,
Pincode magic, data's delight!
Tokens dance, organizations sing,
Autofill brings a joyful swing!
Hop, hop, hooray for smart design! 🎉

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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 29, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit adb18d6
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/6799929896aa9900081236fa
😎 Deploy Preview https://deploy-preview-10272--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.

@Rishith25 Rishith25 changed the title Fix: Pincode autofill in Patient Registration page in public appointments Fix: Pincode autofill in Patient Registration page in public page Jan 29, 2025
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 comments (1)
src/hooks/useOrganization.ts (1)

Line range hint 31-41: Consider cache implications and error handling improvements.

Two suggestions for improvement:

  1. Include !!authToken in the query key to prevent cache conflicts between authenticated and unauthenticated requests
  2. Add specific error handling for authentication failures
   const { data, isLoading, isError } = useQuery({
-    queryKey: ["organization", orgType, name, parentId],
+    queryKey: ["organization", orgType, name, parentId, !!authToken],
     queryFn: query(organizationApi.list, {
       queryParams: {
         org_type: orgType,
         parent: parentId,
         name,
       },
       ...headers,
     }),
     enabled: enabled && !!name,
+    retry: (failureCount, error: any) => {
+      // Don't retry on auth errors
+      if (error?.response?.status === 401) return false;
+      return failureCount < 3;
+    },
   });
🧹 Nitpick comments (2)
src/hooks/useOrganization.ts (1)

24-30: Consider adding token validation and simplifying headers construction.

While the current implementation works, consider these improvements:

  1. Validate the token format/content
  2. Trim any potential whitespace
  3. Simplify the headers object structure
-  const headers = authToken
-    ? {
-        headers: {
-          Authorization: `Bearer ${authToken}`,
-        },
-      }
-    : {};
+  const headers = authToken?.trim()
+    ? { headers: { Authorization: `Bearer ${authToken.trim()}` } }
+    : {};
+
+  if (headers.headers?.Authorization === 'Bearer ') {
+    throw new Error('Invalid auth token provided');
+  }
src/pages/PublicAppointments/PatientRegistration.tsx (1)

234-249: Consider debouncing pincode input.

The effect hook correctly manages the autofill states, but consider debouncing the pincode input to prevent unnecessary API calls while the user is typing.

+import { useDebounce } from "@/hooks/useDebounce";
+
 export function PatientRegistration(props: PatientRegistrationProps) {
   // ... existing code ...
+  const debouncedPincode = useDebounce(form.watch("pincode")?.toString() || "", 500);
+
   const { stateOrg, districtOrg } = useStateAndDistrictFromPincode({
-    pincode: form.watch("pincode")?.toString() || "",
+    pincode: debouncedPincode,
     authToken: tokenData.token,
   });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 881610a and adb18d6.

📒 Files selected for processing (3)
  • src/hooks/useOrganization.ts (2 hunks)
  • src/hooks/useStateAndDistrictFromPincode.ts (4 hunks)
  • src/pages/PublicAppointments/PatientRegistration.tsx (7 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: cypress-run (1)
🔇 Additional comments (10)
src/hooks/useOrganization.ts (3)

14-14: LGTM! Well-typed interface extension.

The optional authToken parameter is properly typed and integrated into the interface.


22-22: LGTM! Consistent parameter addition.

The authToken parameter is correctly added to match the interface definition.


Line range hint 1-53: Verify the authentication flow in the patient registration context.

Since these changes are part of the pincode autofill feature, please ensure:

  1. The authentication flow is tested with both valid and invalid tokens
  2. The pincode autofill functionality works correctly with authenticated requests
  3. The error handling provides meaningful feedback to users
src/hooks/useStateAndDistrictFromPincode.ts (3)

14-16: LGTM! Interface update follows TypeScript best practices.

The optional authToken parameter is correctly typed as an optional string.


24-26: LGTM! Function signature update maintains backward compatibility.

The optional parameter is correctly destructured, preserving compatibility with existing code.


47-49: Consider error handling for unauthorized requests.

While the authToken is correctly passed to both organization queries, there's no specific handling for unauthorized responses.

Let's verify the error handling in the useOrganization hook:

Also applies to: 61-63

src/pages/PublicAppointments/PatientRegistration.tsx (4)

4-4: LGTM! Clean import organization and state management.

The imports and state declarations are well-organized and follow React best practices.

Also applies to: 10-11, 28-28, 43-43, 86-88


229-232: LGTM! Proper hook integration with authentication.

The useStateAndDistrictFromPincode hook is correctly integrated with the required authentication token.


421-436: LGTM! Accessible feedback implementation.

The autofill feedback implementation follows accessibility best practices:

  • Uses semantic ARIA attributes
  • Provides visual feedback with icon
  • Includes proper text messaging

449-456: LGTM! Form state management improvement.

The change from direct field manipulation to form.setValue is a better approach for managing form state.

@Rishith25
Copy link
Contributor Author

@rithviknishad @Jacobjeevan can you review this PR

@rithviknishad
Copy link
Member

#10291

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