feat: Savings Application Preview screen by itsPronay · Pull Request #3053 · openMF/mifos-mobile

itsPronay · 2026-01-02T22:52:26Z

Didn't create a Jira ticket, click here to create new.

Please Add Screenshots If there are any UI changes.

Before	After

Please make sure these boxes are checked before submitting your pull request - thanks!

Run the static analysis check ./gradlew check or ci-prepush.sh to make sure you didn't break anything
If you have multiple commits please combine them into one commit by squashing them.

Summary by CodeRabbit

Release Notes

New Features
- Added a confirmation screen to review savings application details before submission.
Refactoring
- Streamlined the savings application workflow with updated navigation steps.
- Removed field officer selection from the application process.
- Optimized navigation routing for improved user experience.
Style
- Updated code formatting configuration settings.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2026-01-02T22:52:37Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🔍 Trigger a full review

📝 Walkthrough

Walkthrough

This PR introduces a new savings confirmation details screen integrated into the application flow, replacing the direct authentication navigation path. It restructures the savings application journey to include an explicit confirmation step between form submission and authentication. Additionally, field officer selection logic is removed from the apply screen.

Changes

Cohort / File(s)	Summary
Configuration `config/detekt/detekt.yml`	MaxLineLength threshold increased from 120 to 140 characters
Confirmation Details Feature `feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/confirmDetails/ConfirmDetailsRoute.kt`, `ConfirmDetailsScreen.kt`, `ConfirmDetailsViewModel.kt`	New serializable route data class, Compose screen, and ViewModel for savings confirmation details screen. Wires up navigation callbacks (back, authenticate, status) and state management for displaying pre-submission details.
Fill Application Module `feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationRoute.kt`, `FillApplicationScreen.kt`, `FillApplicationViewModel.kt`	Navigation refactored to replace fieldOfficerId/fieldOfficerName parameters with savingsProductName. Updated event/action flow to emit NavigateToConfirmDetails instead of NavigateToAuthentication. Removed form validation gating on Next button.
Apply Screen Module `feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyRoute.kt`, `SavingsApplyScreen.kt`, `SavingsApplyViewModel.kt`	Removed field officer selection and fetching logic. Updated navigation callback signature from (Long, Long, String) to (Long, String), eliminating officer ID and name parameters.
DI & Navigation `feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/di/SavingsApplicationModule.kt`, `navigation/SavingsApplicationNavGraph.kt`	Added DI binding for SavingsConfirmDetailsViewModel. Updated navigation graph to wire confirmation details destination with authenticate/status callbacks.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant Apply as SavingsApply<br/>Screen
    participant Fill as SavingsFill<br/>Application Screen
    participant ApplyVM as SavingsApply<br/>ViewModel
    participant FillVM as SavingsFill<br/>ViewModel
    participant Confirm as SavingsConfirm<br/>Details Screen
    participant ConfirmVM as SavingsConfirm<br/>ViewModel
    participant Auth as Auth Flow

    User->>Apply: Select Savings Product
    Apply->>ApplyVM: FieldOfficerChange (removed)
    ApplyVM-->>Apply: Update Field Officer State (removed)
    
    User->>Apply: Click Continue
    Apply->>ApplyVM: (removed: GetFieldOfficer)
    ApplyVM->>Apply: navigateToFillDetailsScreen(productId, productName)
    
    Note over Apply,Fill: New Flow: Direct to Fill Details
    Apply->>Fill: Navigate with (productId, productName)
    
    User->>Fill: Fill Application Form
    Fill->>FillVM: Submit Form
    FillVM-->>FillVM: Build NavigateToConfirmDetails<br/>Event with payload
    FillVM->>Confirm: navigateToSavingsConfirmDetailsScreen(...)
    
    Confirm->>ConfirmVM: Initialize with Route Data
    ConfirmVM-->>Confirm: Render Confirmation Details
    
    User->>Confirm: Review & Click Apply
    Confirm->>ConfirmVM: SubmitSavingsAccount Action
    ConfirmVM->>Auth: navigateToAuthenticateScreen()
    
    rect rgb(200, 220, 255)
    Note over FillVM,Auth: Removed: Direct Auth from<br/>Fill Application Screen
    end

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

Mm 441 docs update #3000: Modifies savings-application navigation structure and DI configuration, aligning with ViewModel registration changes in this PR.
feat(recent-transaction): redesign screen and update state management #3045: Implements type-safe @Serializable route patterns similar to the new SavingsConfirmDetailsRoute introduced here.

Suggested reviewers

WizCoderr
biplab1

🐰 A new confirmation card hops into view,
Where details dance in a gentle review,
No officers needed, just forms and a way,
To confirm every detail before savings day! 🌟

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	Docstring coverage is 88.89% which is sufficient. The required threshold is 80.00%.
Title check	✅ Passed	The title 'feat: Savings Application Preview screen' accurately reflects the main change: introducing a new Confirm Details (Preview) screen for the savings application flow with comprehensive navigation and state management.

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 and usage tips.}

coderabbitai

Actionable comments posted: 3

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (4)

feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyViewModel.kt (2)

278-326: Dead code: handleFieldOfficers function is never called.

The handleFieldOfficers function remains in the ViewModel but is no longer invoked after the field officer logic was removed. This should be deleted to avoid confusion.

🔎 Remove unused function

-    /**
-     * Handles the result of the `fetchFieldOfficer` network call.
-     * On success, it maps the field officer options and updates the state.
-     * On failure, it shows an error dialog and navigates back.
-     *
-     * @param template The [DataState] containing the savings template data,
-     * including field officer options.
-     */
-    private fun handleFieldOfficers(template: DataState<SavingsAccountTemplate?>) {
-        when (template) {
-            is DataState.Loading -> {
-                updateState {
-                    it.copy(
-                        showOverlay = true,
-                    )
-                }
-            }
-            is DataState.Success -> {
-                updateState {
-                    it.copy(
-                        showOverlay = false,
-                    )
-                }
-                val mappedSavingsFieldOfficer: Map<Long, String> = template.data?.fieldOfficerOptions
-                    ?.mapNotNull { option ->
-                        val id = option.id?.toLong()
-                        val name = option.displayName
-                        if (id != null && name != null) id to name else null
-                    }
-                    ?.takeIf { it.isNotEmpty() }
-                    ?.toMap() ?: emptyMap()
-
-                updateState {
-                    it.copy(
-                        savingsProductTemplate = template.data,
-                    )
-                }
-            }
-
-            is DataState.Error -> {
-                updateState {
-                    it.copy(
-                        showOverlay = false,
-                    )
-                }
-                updateState {
-                    it.copy(
-                        uiState = if (template.exception.cause is IOException) {
-                            ScreenUiState.Network
-                        } else {
-                            ScreenUiState.Error(Res.string.feature_apply_savings_error_server)
-                        },
-                    )
-                }
-            }
-        }
-    }

504-537: Remove debug println statement and unused state field.

Line 534 contains println(todayMillis) which is debug code that should be removed before merging. Additionally, selectedFieldOfficerId (line 511) appears unused after the field officer logic removal.

🔎 Proposed cleanup

     @OptIn(ExperimentalTime::class)
     val submittedOnDate: String
         get() {
             val todayMillis = Clock.System.now().toEpochMilliseconds()
-            println(todayMillis)
             return DateHelper.getDateMonthYearString(todayMillis)
         }

Also consider removing selectedFieldOfficerId from the state if it's no longer used.

feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyScreen.kt (2)

64-66: Update documentation to reflect the removal of officer information.

The KDoc at line 64-65 states the lambda passes "product and officer information," but the actual signature now only passes product ID and product name. Field officer selection has been removed from this flow.
🔎 Suggested documentation fix
 * @param navigateBack A lambda function to handle back navigation events.
 * @param navigateToFillDetailsScreen A lambda to navigate to the detailed application form,
-*   passing product and officer information.
+*   passing the selected product ID and product name.
 * @param viewModel The ViewModel responsible for the screen's logic and state.
140-149: Update function documentation to remove reference to field officer dropdown.

The KDoc mentions "dropdowns for selecting a savings product and a field officer," but the field officer dropdown has been removed from the UI in this PR.
🔎 Suggested documentation fix
 /**
  * A stateless composable that renders the main UI for the "Apply for Savings" screen.
  *
  * It conditionally displays UI based on the [ScreenUiState] (e.g., loading, error, success).
- * The success state includes dropdowns for selecting a savings product and a field officer.
+ * The success state includes a dropdown for selecting a savings product.
  *
  * @param state The current [SavingsApplicationState] to render.
  * @param onAction A callback to send user actions to the ViewModel.
  * @param modifier The [Modifier] to be applied to the layout.
  */

🧹 Nitpick comments (8)

config/detekt/detekt.yml (1)

803-803: Consider refactoring navigation code instead of relaxing the line length limit.

Increasing the line length limit from 120 to 140 to accommodate long navigation parameter lists may mask an underlying design issue. If the new navigation code has parameter lists that exceed 120 characters, consider:

Using parameter objects or data classes to group related parameters

Breaking down complex navigation signatures into smaller, more focused functions

Applying the builder pattern for complex navigation scenarios

Relaxing linting standards project-wide to fit new code can gradually erode code quality over time.

</review_comment_end>
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/confirmDetails/ConfirmDetailsViewModel.kt (2)
116-123: Auth result collection lacks cancellation awareness.

The observeAuthResult() coroutine collects indefinitely without checking for cancellation. While viewModelScope handles cancellation on ViewModel clear, consider using launchIn with onEach for cleaner flow handling, or ensure this pattern is intentional.

180-189: Redundant coroutine launch when sending action.

In handleSavingsApplyRequest, the viewModelScope.launch wrapper around sendAction is unnecessary if sendAction is already a synchronous or non-blocking call. This adds overhead without benefit.
🔎 Proposed simplification
     private fun handleSavingsApplyRequest(isAuthenticated: Boolean) {
         if (isAuthenticated) {
-            viewModelScope.launch {
-                sendAction(SavingsConfirmDetailsAction.Internal.ApplySavings)
-            }
+            sendAction(SavingsConfirmDetailsAction.Internal.ApplySavings)
         } else {
             // Authentication failed or was cancelled, hide any loading state
             updateState { it.copy(showOverlay = false) }
         }
     }
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationScreen.kt (1)
79-79: Consider using a data class for navigation parameters.

The navigateToConfirmDetailsScreen callback with 10 positional parameters is error-prone and hard to maintain. A data class would provide type safety and named parameters.
🔎 Suggested approach

Define a data class for navigation parameters:
data class ConfirmDetailsNavArgs(
    val savingsProductId: Long,
    val applicantName: String,
    val savingsProductName: String,
    val currency: String,
    val minOpeningBalance: String,
    val frequency: String,
    val frequencyTypeName: String,
    val frequencyTypeId: Long,
    val allowOverdraft: Boolean,
    val submittedOnDate: String,
)
Then update the callback signature:
-    navigateToConfirmDetailsScreen: (Long, String, String, String, String, String, String, Long, Boolean, String) -> Unit,
+    navigateToConfirmDetailsScreen: (ConfirmDetailsNavArgs) -> Unit,
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationRoute.kt (1)

65-73: Same 10-parameter callback concern applies here.

The navigateToConfirmDetailsScreen callback signature in savingsFillApplicationDestination has the same maintainability concern noted earlier. Consider a data class approach for consistency across the navigation layer.

feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationViewModel.kt (1)

196-196: Stray empty line - minor formatting.

Line 196 appears to be an extra blank line that could be cleaned up for consistency.
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/di/SavingsApplicationModule.kt (1)
35-35: Add KDoc for consistency with other ViewModel registrations.

The SavingsConfirmDetailsViewModel registration lacks the descriptive comment that other ViewModels have (lines 25-28 and 30-33). Consider adding one for consistency.
🔎 Suggested addition
     viewModelOf(::SavingsFillApplicationViewModel)
+    /**
+     * Provides an instance of [SavingsConfirmDetailsViewModel].
+     * This ViewModel handles the logic for the savings confirmation preview screen.
+     */
     viewModelOf(::SavingsConfirmDetailsViewModel)
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/confirmDetails/ConfirmDetailsRoute.kt (1)

32-44: Consider reducing parameter count for improved maintainability.

The route has 10 parameters, which makes the API somewhat brittle. Any future changes to the confirmation screen's data requirements will necessitate updates across multiple call sites.

Consider one of these alternatives:

Pass only savingsProductId and load the full details in the ViewModel

Create a dedicated serializable wrapper class for the confirmation data

However, for a preview/confirmation screen where all data is already collected and needs to be displayed, the current approach is acceptable and avoids additional data loading overhead.

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aca5f62 and a953429.

📒 Files selected for processing (12)

config/detekt/detekt.yml
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/confirmDetails/ConfirmDetailsRoute.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/confirmDetails/ConfirmDetailsScreen.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/confirmDetails/ConfirmDetailsViewModel.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/di/SavingsApplicationModule.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationRoute.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationScreen.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationViewModel.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/navigation/SavingsApplicationNavGraph.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyRoute.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyScreen.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyViewModel.kt

🧰 Additional context used

📓 Path-based instructions (2)

**/*.{kt,kts}

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.{kt,kts}: Use Koin for dependency injection across all platforms
Implement ScreenState pattern for handling loading/success/error states in features

Files:

feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyRoute.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/confirmDetails/ConfirmDetailsViewModel.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/di/SavingsApplicationModule.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationRoute.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyScreen.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/confirmDetails/ConfirmDetailsRoute.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationScreen.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyViewModel.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/navigation/SavingsApplicationNavGraph.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationViewModel.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/confirmDetails/ConfirmDetailsScreen.kt

**/*ViewModel.kt

📄 CodeRabbit inference engine (CLAUDE.md)

Use ViewModels with StateFlow/SharedFlow for state management

Files:

feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/confirmDetails/ConfirmDetailsViewModel.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/savingsApplication/SavingsApplyViewModel.kt
feature/savings-application/src/commonMain/kotlin/org/mifos/mobile/feature/savings/application/fillApplication/FillApplicationViewModel.kt

🧠 Learnings (5)