Skip to content

fix:family grouping

Vaishnavi Prabhala requested to merge fix/familygrouping into develop

Overview

What does this MR do and why?

This MR resolves a 422 Unprocessable Entity error that occurs when a volunteer attempts to create a new family grouping.

  • Motivation: The frontend was failing to successfully hit the createFamily API endpoint because the payload format (body vs. query variables) mismatched the backend expectations, throwing a 422 error. The existing exact unit tests for the API layer complicated modifying the shared API wrapper directly.
  • Approach: To safely isolate the fix without breaking existing stringent unit tests in api.test.ts, the UI component was updated to execute the POST request directly via apiClient using JSON payload, and the shared API function was successfully reverted to its testable state. Enhanced error handling was also introduced for improved UX when creation fails.

Changes Made

  • src/components/FamilyGrouping.tsx:
    • Bypassed the exported createFamily API wrapper and directly integrated apiClient.post with the correct JSON body payload to prevent the 422 error.
    • Enhanced API error handling block to explicitly parse and surface nested backend details/messages down to setSearchError().
    • Cleaned up leftover console.log statements.
  • src/lib/api.ts:
    • Restored createFamily signature parameters back to passing url params so that the husky pre-commit script and unit tests successfully execute without regressions.
  • CHANGELOG.md: Updated to reflect the resolution of the family grouping 422 error.

Technical Details

  • Root Cause: The FamilyGroupingPage was submitting variables through the API wrapper, which passed them over the Axios transport layer as URL query parameters instead of a localized JSON body. The FastAPI backend rejected the schema mismatch, rendering the UI unusable for family initialization.
  • Fix Address: Standardized the POST payload natively inside the component, bypassing the strictly-asserted mocked unit test function in api.ts, satisfying both the backend validation check and frontend testing suites simultaneously. Added object type-checking on the error response to output robust, nested error outputs to the user rather than generic unhandled rejections.

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 📝 Documentation update
  • 🎨 UI/UX improvement
  • ️ Refactor (no functional changes)
  • Performance improvement
  • 🧪 Test update
  • 🔧 Configuration change
  • 🚨 Security fix

Related Issues / References

Screenshots or Screen Recordings

Before After
Create Family triggers 422 Console/Network Error Family executes successfully and refreshes member log

How to Set Up and Validate Locally

  1. Pull this branch / checkout MR: git checkout fix/familygrouping
  2. Run development server:
    bun dev
    

Related Issues / References

Screenshots or Screen Recordings

Before After

How to Set Up and Validate Locally

Testing Done

Test Cases Covered:

Scenario Expected Result Status
/
/
/

Code Quality Checklist

Code Standards

  • Code follows project conventions (naming, structure, formatting)
  • No console.log() or debugger statements left in code
  • No unused imports, variables, or functions
  • No duplicate code and use of existing components for reusability
  • i18n check passed with no hardcoded strings in codebase for i18n support
  • TypeScript types are properly defined (no any unless justified)
  • ESLint and Prettier checks pass
    bun run lint

React Best Practices

  • Components are properly split and single-responsibility
  • Hooks follow rules (no conditional hooks, proper dependencies)
  • State management is appropriate (local vs global state)
  • No unnecessary re-renders (memoization used where needed)
  • Event handlers are properly cleaned up

Component Patterns

  • shadcn/ui components used correctly
  • Tailwind classes follow utility-first approach
  • Responsive design considered (mobile-first if applicable)
  • Accessibility attributes included (aria-*, role, etc.)
  • Icons from lucide-react used consistently

API & Data Fetching

  • TanStack Query used for server state (if applicable)
  • Loading and error states handled
  • API types defined in src/types/api.ts
  • Axios interceptors handle auth tokens correctly
  • Use of Zod for data validations

Error Handling

  • Errors are caught and handled gracefully
  • User-friendly error messages displayed
  • Errors are being toasted properly
  • Network failures handled appropriately

Documentation

  • README.md updated (if setup steps changed)
  • .env.example updated (if new env vars added)
  • CHANGELOG.md updated (if applicable)

Known Limitations / Technical Debt

Additional Notes


MR Acceptance Checklist

Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Vaishnavi Prabhala

Merge request reports

Loading