feat(loan): implement create guarantor screen by sahilshivekar · Pull Request #2698 · openMF/mifos-x-field-officer-app

sahilshivekar · 2026-07-08T11:36:18Z

Before

create_guarantor_before.mp4

After

create_guarantor_after.mp4

coderabbitai · 2026-07-08T11:36:43Z

Walkthrough

Adds a create-guarantor flow across model, network, data, domain, and feature layers, including new screen and navigation wiring, plus removal of the Originators loan profile action and its strings.

Changes

Create Guarantor feature

Layer breakdown

Layer / File(s)	Summary
Guarantor models and network layer `[CreateGuarantor.kt](core/model/src/commonMain/kotlin/com/mifos/core/model/objects/account/loan/guarantor/CreateGuarantor.kt)`, `[CreateGuarantorInput.kt](core/model/src/commonMain/kotlin/com/mifos/core/model/objects/account/loan/guarantor/CreateGuarantorInput.kt)`, `[GuarantorTemplate.kt](core/model/src/commonMain/kotlin/com/mifos/core/model/objects/account/loan/guarantor/GuarantorTemplate.kt)`, `[CreateGuarantorResponseDto.kt](core/network/src/commonMain/kotlin/com/mifos/core/network/dto/loans/CreateGuarantorResponseDto.kt)`, `[GuarantorRequestDto.kt](core/network/src/commonMain/kotlin/com/mifos/core/network/dto/loans/GuarantorRequestDto.kt)`, `[GuarantorTemplateDto.kt](core/network/src/commonMain/kotlin/com/mifos/core/network/dto/loans/GuarantorTemplateDto.kt)`, `[DataManagerLoan.kt](core/network/src/commonMain/kotlin/com/mifos/core/network/datamanager/DataManagerLoan.kt)`, `[LoanService.kt](core/network/src/commonMain/kotlin/com/mifos/core/network/services/LoanService.kt)`, `[GetMakerCheckerResponse.kt](core/network/src/commonMain/kotlin/com/mifos/core/network/model/GetMakerCheckerResponse.kt)`	Adds guarantor domain models and DTOs, three new loan guarantor endpoints, corresponding data manager methods, and changes `loanId` to `Int?` in `GetMakerCheckerResponse`.
Data mappers and repository `[GuarantorMapper.kt](core/data/src/commonMain/kotlin/com/mifos/core/data/mappers/loan/GuarantorMapper.kt)`, `[LoanCreateGuarantorRepository.kt](core/data/src/commonMain/kotlin/com/mifos/core/data/repository/LoanCreateGuarantorRepository.kt)`, `[LoanCreateGuarantorRepositoryImp.kt](core/data/src/commonMain/kotlin/com/mifos/core/data/repositoryImp/LoanCreateGuarantorRepositoryImp.kt)`, `[RepositoryModule.kt](core/data/src/commonMain/kotlin/com/mifos/core/data/di/RepositoryModule.kt)`	Adds DTO-to-domain and input-to-DTO mappings, defines the guarantor repository contract and implementation, and registers it in Koin.
Domain use cases `[CreateGuarantorUseCase.kt](core/domain/src/commonMain/kotlin/com/mifos/core/domain/useCases/createGuarantor/CreateGuarantorUseCase.kt)`, `[GetGuarantorTemplateUseCase.kt](core/domain/src/commonMain/kotlin/com/mifos/core/domain/useCases/createGuarantor/GetGuarantorTemplateUseCase.kt)`, `[GetGuarantorAccountTemplateUseCase.kt](core/domain/src/commonMain/kotlin/com/mifos/core/domain/useCases/createGuarantor/GetGuarantorAccountTemplateUseCase.kt)`, `[UseCaseModule.kt](core/domain/src/commonMain/kotlin/com/mifos/core/domain/di/UseCaseModule.kt)`	Adds three guarantor use cases and registers them in the domain dependency graph.
Create Guarantor UI and navigation `[MifosSearchableDropdown.kt](core/designsystem/src/commonMain/kotlin/com/mifos/core/designsystem/component/MifosSearchableDropdown.kt)`, `[CreateGuarantorScreen.kt](feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/createGuarantor/CreateGuarantorScreen.kt)`, `[CreateGuarantorScreenRoute.kt](feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/createGuarantor/CreateGuarantorScreenRoute.kt)`, `[CreateGuarantorViewModel.kt](feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/createGuarantor/CreateGuarantorViewModel.kt)`, `[LoanModule.kt](feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/di/LoanModule.kt)`, `[LoanAccountActionNavigation.kt](feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/loanAccountAction/LoanAccountActionNavigation.kt)`, `[LoanNavigation.kt](feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/navigation/LoanNavigation.kt)`, `[strings.xml](feature/loan/src/commonMain/composeResources/values/strings.xml)`	Adds the reusable searchable dropdown, the create-guarantor screen and route, viewmodel state/action handling, navigation registration, DI wiring, and new UI strings.
Remove Originators loan action `[LoanAccountProfileActionItem.kt](feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/loanAccountProfile/components/LoanAccountProfileActionItem.kt)`, `[LoanAccountProfileScreen.kt](feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/loanAccountProfile/LoanAccountProfileScreen.kt)`, `[strings.xml](feature/loan/src/commonMain/composeResources/values/strings.xml)`, `[strings.xml](feature/loan/src/commonMain/composeResources/values-es/strings.xml)`	Removes the Originators action object, list entry, and related string resources.

Estimated code review effort: 4 (Complex) | ~60 minutes

Sequence Diagram(s)

Create guarantor submission flow

sequenceDiagram
  participant User
  participant CreateGuarantorScreen
  participant CreateGuarantorViewModel
  participant CreateGuarantorUseCase
  participant LoanCreateGuarantorRepository

  User->>CreateGuarantorScreen: fill form and tap submit
  CreateGuarantorScreen->>CreateGuarantorViewModel: Submit action
  CreateGuarantorViewModel->>CreateGuarantorViewModel: validateInput
  CreateGuarantorViewModel->>CreateGuarantorUseCase: invoke(loanId, CreateGuarantorInput)
  CreateGuarantorUseCase->>LoanCreateGuarantorRepository: createGuarantor(loanId, input)
  LoanCreateGuarantorRepository-->>CreateGuarantorUseCase: DataState<CreateGuarantor>
  CreateGuarantorUseCase-->>CreateGuarantorViewModel: result
  CreateGuarantorViewModel-->>CreateGuarantorScreen: success/failure event + navigate back

Possibly related PRs

openMF/mifos-x-field-officer-app#2660: Adds related loan account action wiring that this PR extends to navigate to the create-guarantor flow.
openMF/mifos-x-field-officer-app#2674: Touches the same loan navigation graph area used here for registering the new create-guarantor destination.
openMF/mifos-x-field-officer-app#2696: Modifies the same loan action navigation function that now routes CreateGuarantors to the new screen.

Suggested reviewers: revanthkumarJ, niyajali, Nagarjuna0033

Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 error, 1 warning)

Check name	Status	Explanation	Resolution
Jira Link And Before/After Sections	❌ Error	Jira link is present, but the Before/After sections are empty and contain no media.	Add non-empty Before: and After: sections, each with at least one image/video, and keep the valid Jira link.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title follows the required feat(scope): subject format and accurately summarizes the new guarantor screen work.
Description check	✅ Passed	The description is related to the PR and references the same Jira-backed create guarantor flow.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 7

🧹 Nitpick comments (3)

core/designsystem/src/commonMain/kotlin/com/mifos/core/designsystem/component/MifosSearchableDropdown.kt (1)

41-43: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Avoid non-trivial default modifier values.

When a caller passes their own modifier, the defaults (.clip(DesignToken.shapes.medium).fillMaxWidth()) are silently lost. The standard Compose convention is modifier: Modifier = Modifier with internal defaults applied in the composable body.

♻️ Proposed fix

 fun MifosSearchableDropdown(
     value: String,
     onValueChanged: (String) -> Unit,
     onOptionSelected: (Int, String) -> Unit,
     options: List<String>,
-    modifier: Modifier = Modifier
-        .clip(DesignToken.shapes.medium)
-        .fillMaxWidth(),
+    modifier: Modifier = Modifier,
     label: String? = null,
     enabled: Boolean = true,
     errorMessage: String? = null,
 ) {
     // ...
         OutlinedTextField(
             // ...
-            modifier = modifier.menuAnchor(
+            modifier = modifier
+                .clip(DesignToken.shapes.medium)
+                .fillMaxWidth()
+                .menuAnchor(
                 type = ExposedDropdownMenuAnchorType.PrimaryEditable,
                 enabled = enabled,
             ),
             // ...
         )

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In
`@core/designsystem/src/commonMain/kotlin/com/mifos/core/designsystem/component/MifosSearchableDropdown.kt`
around lines 41 - 43, The default modifier chain in MifosSearchableDropdown is
non-trivial and causes caller-provided modifiers to override the built-in
clip/fill behavior. Update the MifosSearchableDropdown composable to use
modifier: Modifier = Modifier and apply DesignToken.shapes.medium clipping and
fillMaxWidth inside the composable body so the defaults are preserved alongside
any caller modifier.

core/model/src/commonMain/kotlin/com/mifos/core/model/objects/account/loan/guarantor/CreateGuarantorInput.kt (1)

14-29: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Remove API serialization concerns (dateFormat, locale) from the domain model.

dateFormat and locale are API transport details that leak into the domain model. The domain CreateGuarantorInput should represent business intent only; the mapper or DTO layer should supply dateFormat and locale defaults when constructing GuarantorRequestDto.

♻️ Proposed refactor: move API defaults to the mapper

 data class CreateGuarantorInput(
     val clientRelationshipTypeId: Long,
-    val dateFormat: String = "dd-MM-yyyy",
+    // dateFormat and locale removed — they are API concerns
     val entityId: Int? = null,
     val guarantorTypeId: Long,
-    val locale: String = DateConstants.LOCALE,
     val firstname: String? = null,
     val lastname: String? = null,
     val dateOfBirth: String? = null,
     val addressLine1: String? = null,
     val addressLine2: String? = null,
     val city: String? = null,
     val zip: String? = null,
     val mobileNumber: String? = null,
     val housePhoneNumber: String? = null,
 )

Then in GuarantorMapper.kt, supply the API defaults:

 fun CreateGuarantorInput.toDto(): GuarantorRequestDto {
     return GuarantorRequestDto(
         clientRelationshipTypeId = clientRelationshipTypeId,
-        dateFormat = dateFormat,
+        dateFormat = "dd-MM-yyyy",
         entityId = entityId,
         guarantorTypeId = guarantorTypeId,
-        locale = locale,
+        locale = DateConstants.LOCALE,
         firstname = firstname,
         lastname = lastname,
         dateOfBirth = dateOfBirth,
         addressLine1 = addressLine1,
         addressLine2 = addressLine2,
         city = city,
         zip = zip,
         mobileNumber = mobileNumber,
         housePhoneNumber = housePhoneNumber,
     )
 }

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In
`@core/model/src/commonMain/kotlin/com/mifos/core/model/objects/account/loan/guarantor/CreateGuarantorInput.kt`
around lines 14 - 29, CreateGuarantorInput currently mixes domain data with API
transport defaults by carrying dateFormat and locale, so remove those fields
from the domain model and keep only business intent properties. Update the
GuarantorMapper path that builds GuarantorRequestDto to supply the API defaults
there instead, using the existing DateConstants values or equivalent mapper-side
defaults. Make sure any constructor calls or mappings referencing
CreateGuarantorInput are adjusted to match the slimmer model.

core/network/src/commonMain/kotlin/com/mifos/core/network/datamanager/DataManagerLoan.kt (1)

16-16: 🗄️ Data Integrity & Integration | 🔵 Trivial | 💤 Low value

Move CreateGuarantorResponseDto into the network DTO package. CreateGuarantorResponseDto.kt is treated as a transport response alongside GuarantorRequestDto, GuarantorTemplateDto, and GuarantorAccountTemplateDto, so keeping it under core/model makes the layering inconsistent.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In
`@core/network/src/commonMain/kotlin/com/mifos/core/network/datamanager/DataManagerLoan.kt`
at line 16, Move CreateGuarantorResponseDto out of the core model layer and into
the network DTO package so guarantor transport types are colocated with
GuarantorRequestDto, GuarantorTemplateDto, and GuarantorAccountTemplateDto.
Update the CreateGuarantorResponseDto definition and its import sites,
especially DataManagerLoan, to reference the new package path and keep the
network/data layering consistent.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@core/domain/src/commonMain/kotlin/com/mifos/core/domain/di/UseCaseModule.kt`:
- Around line 92-93: `UseCaseModule` is missing Koin wiring for
`GetGuarantorAccountTemplateUseCase`, so add its import alongside the other
guarantor use cases and register it in the relevant module definitions where
`CreateGuarantorUseCase` and `GetGuarantorTemplateUseCase` are declared. Make
sure the symbol `GetGuarantorAccountTemplateUseCase` is included wherever the
guarantor use cases are bound so any ViewModel constructor injection can resolve
it successfully.

In
`@core/model/src/commonMain/kotlin/com/mifos/core/model/objects/account/loan/guarantor/CreateGuarantorResponseDto.kt`:
- Around line 14-19: Move CreateGuarantorResponseDto out of core/model because
it is a network response DTO and must not keep `@Serializable` in the domain
layer. Relocate the type to core/network/dto, then update
LoanService.createGuarantor() to return the relocated DTO and adjust
GuarantorMapper to map between CreatedGuarantor and the new response DTO. Keep
the domain model separate and ensure any imports/usages of
CreateGuarantorResponseDto point to the network package.

In
`@feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/createGuarantor/CreateGuarantorScreen.kt`:
- Around line 267-296: The DatePicker dialog is embedded inline inside
CreateGuarantorContent, but it should be extracted into its own composable to
match the UI structure rules. Move the entire showDatePicker block, including
rememberDatePickerState, DatePickerDialog, and DatePicker, into a dedicated
composable such as CreateGuarantorDatePickerDialog, and pass in the needed
state/callbacks like state.dateOfBirthMillis, onAction, and the show/dismiss
handlers. Then call that composable from CreateGuarantorContent instead of
keeping the dialog logic inline.
- Around line 124-129: CreateGuarantorContent currently violates the Layer 2
contract by accepting a separate navigateBack lambda alongside onAction. Update
CreateGuarantorContent and its call sites so it only receives state and a single
onAction, and route back requests through a CreateGuarantorAction.Cancel (or
equivalent) instead of direct navigation. Then update the ViewModel handling for
that action to emit a CreateGuarantorEffect.NavigateBack, with the route
composable consuming the effect and performing the actual back navigation.
- Around line 132-138: Move the submit-enable logic out of CreateGuarantorScreen
and into the ViewModel/state layer. The relationship/client/name validation in
canSubmit is business logic, so add canSubmit to CreateGuarantorState and
compute it in the reducer inside the ViewModel’s handleAction whenever state
changes. Then update the composable to read state.canSubmit directly instead of
deriving it locally.

In
`@feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/createGuarantor/CreateGuarantorViewModel.kt`:
- Around line 366-397: The `searchClients` flow collector in
`CreateGuarantorViewModel` is mutating state and sending UI events directly,
which breaks the MVI reducer pattern. Refactor
`searchRepository.searchResources(...).collect { ... }` so it only translates
each `DataState` result into internal actions via `sendAction(...)`, and move
the `mutableStateFlow.update` and
`sendEvent(CreateGuarantorEffect.ShowMessage(...))` logic into `handleAction`
for the corresponding action type. Keep the existing `searchClients` entry
point, but make it dispatch results instead of updating `searchedClientOptions`
itself.
- Around line 193-214: The non-existing-client flow in CreateGuarantorViewModel
lacks a reliable source for guarantorTypeId, so validateInput can only pass if
stale existing-client state is present. Update the existing-client toggle
handling to clear guarantorTypeId when switching away from existing client, and
add logic in the non-existing-client path to populate guarantorTypeId from the
appropriate guarantor template data so validation can succeed independently.

---

Nitpick comments:
In
`@core/designsystem/src/commonMain/kotlin/com/mifos/core/designsystem/component/MifosSearchableDropdown.kt`:
- Around line 41-43: The default modifier chain in MifosSearchableDropdown is
non-trivial and causes caller-provided modifiers to override the built-in
clip/fill behavior. Update the MifosSearchableDropdown composable to use
modifier: Modifier = Modifier and apply DesignToken.shapes.medium clipping and
fillMaxWidth inside the composable body so the defaults are preserved alongside
any caller modifier.

In
`@core/model/src/commonMain/kotlin/com/mifos/core/model/objects/account/loan/guarantor/CreateGuarantorInput.kt`:
- Around line 14-29: CreateGuarantorInput currently mixes domain data with API
transport defaults by carrying dateFormat and locale, so remove those fields
from the domain model and keep only business intent properties. Update the
GuarantorMapper path that builds GuarantorRequestDto to supply the API defaults
there instead, using the existing DateConstants values or equivalent mapper-side
defaults. Make sure any constructor calls or mappings referencing
CreateGuarantorInput are adjusted to match the slimmer model.

In
`@core/network/src/commonMain/kotlin/com/mifos/core/network/datamanager/DataManagerLoan.kt`:
- Line 16: Move CreateGuarantorResponseDto out of the core model layer and into
the network DTO package so guarantor transport types are colocated with
GuarantorRequestDto, GuarantorTemplateDto, and GuarantorAccountTemplateDto.
Update the CreateGuarantorResponseDto definition and its import sites,
especially DataManagerLoan, to reference the new package path and keep the
network/data layering consistent.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 993e7c0a-4772-48a3-b9b8-bb085e2f7a8a

📥 Commits

Reviewing files that changed from the base of the PR and between 928fc44 and 7b9e75a.

📒 Files selected for processing (28)

core/data/src/commonMain/kotlin/com/mifos/core/data/di/RepositoryModule.kt
core/data/src/commonMain/kotlin/com/mifos/core/data/mappers/loan/GuarantorMapper.kt
core/data/src/commonMain/kotlin/com/mifos/core/data/repository/LoanCreateGuarantorRepository.kt
core/data/src/commonMain/kotlin/com/mifos/core/data/repositoryImp/LoanCreateGuarantorRepositoryImp.kt
core/designsystem/src/commonMain/kotlin/com/mifos/core/designsystem/component/MifosSearchableDropdown.kt
core/domain/src/commonMain/kotlin/com/mifos/core/domain/di/UseCaseModule.kt
core/domain/src/commonMain/kotlin/com/mifos/core/domain/useCases/createGuarantor/CreateGuarantorUseCase.kt
core/domain/src/commonMain/kotlin/com/mifos/core/domain/useCases/createGuarantor/GetGuarantorAccountTemplateUseCase.kt
core/domain/src/commonMain/kotlin/com/mifos/core/domain/useCases/createGuarantor/GetGuarantorTemplateUseCase.kt
core/model/src/commonMain/kotlin/com/mifos/core/model/objects/account/loan/guarantor/CreateGuarantorInput.kt
core/model/src/commonMain/kotlin/com/mifos/core/model/objects/account/loan/guarantor/CreateGuarantorResponseDto.kt
core/model/src/commonMain/kotlin/com/mifos/core/model/objects/account/loan/guarantor/CreatedGuarantor.kt
core/model/src/commonMain/kotlin/com/mifos/core/model/objects/account/loan/guarantor/GuarantorTemplate.kt
core/network/src/commonMain/kotlin/com/mifos/core/network/datamanager/DataManagerLoan.kt
core/network/src/commonMain/kotlin/com/mifos/core/network/dto/loans/GuarantorRequestDto.kt
core/network/src/commonMain/kotlin/com/mifos/core/network/dto/loans/GuarantorTemplateDto.kt
core/network/src/commonMain/kotlin/com/mifos/core/network/model/GetMakerCheckerResponse.kt
core/network/src/commonMain/kotlin/com/mifos/core/network/services/LoanService.kt
feature/loan/src/commonMain/composeResources/values-es/strings.xml
feature/loan/src/commonMain/composeResources/values/strings.xml
feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/createGuarantor/CreateGuarantorScreen.kt
feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/createGuarantor/CreateGuarantorScreenRoute.kt
feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/createGuarantor/CreateGuarantorViewModel.kt
feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/di/LoanModule.kt
feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/loanAccountAction/LoanAccountActionNavigation.kt
feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/loanAccountProfile/LoanAccountProfileScreen.kt
feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/loanAccountProfile/components/LoanAccountProfileActionItem.kt
feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/navigation/LoanNavigation.kt

💤 Files with no reviewable changes (2)

feature/loan/src/commonMain/composeResources/values-es/strings.xml
feature/loan/src/commonMain/kotlin/com/mifos/feature/loan/loanAccountProfile/components/LoanAccountProfileActionItem.kt

📜 Review details

⏰ Context from checks skipped due to timeout. (1)

GitHub Check: PR Checks / Static Analysis Check

🧰 Additional context used

📓 Path-based instructions (11)

**/{core-base,core}/**/*.kt