SDK-2612: IDV - Support configuration for IDV shortened flow - Python

[mehmet-yoti]

Automated PR created by n8n. Related Jira Issue: SDK-2612

[mehmet-yoti]

@copilot do To implement the new configuration for omitting certain screens in the IDV flow via the suppressed_screens property in the sdk_config, we need to follow a structured plan. Below are the detailed steps to achieve this:

Task Breakdown

Task 1: Analyze Requirements

1. Review Existing Configuration: Understand the current configuration structure and how sdk_config is managed.
2. Understand Flow Impact: Determine how each screen currently fits into the IDV flow and how their omission might impact the user experience and backend processing.
3. Align With Team: Ensure alignment with the Product and Design teams to confirm which screens can indeed be optional via omission.

Task 2: Backend Implementation

1. Update Configuration Schema

   • Modify the schema of sdk_config to include suppressed_screens as an optional property.

2. Enable API Support for New Property

   • Update the backend API that initializes or updates the flow configuration to accept suppressed_screens.
   • Ensure that this field is processed correctly without breaking existing configurations.

3. Configuration Validation

   • Implement validation logic to check that the suppressed_screens array only contains valid and recognized screen identifiers.
   • Handle cases where the array might contain invalid entries by providing clear error messages.

4. Modify Flow Logic

   • Alter the IDV flow logic to skip screens that are listed in the suppressed_screens.
   • Ensure that the omission of these screens does not disrupt the overall flow logic.

5. Data Persistence

   • If necessary, ensure that any data implications of omitting a screen (e.g., expected data not being present) are handled gracefully.

6. Testing and Verification

   • Develop unit tests to verify correct configuration parsing, validation, and logic to skip screens.
   • Conduct integration tests to ensure the flow works correctly without the omitted screens.
   • Perform regression testing to confirm no other parts of the system are affected.

Task 3: Frontend Changes (if applicable)

1. Update UI Components

   • Ensure that the frontend respects the suppressed_screens configuration by not rendering or initializing the omitted screens.

2. UI Flow Testing

   • Conduct frontend tests to verify proper flow navigation when screens are omitted.

Task 4: Documentation Updates

1. Update API Documentation

   • Document the new suppressed_screens property with details on usage and screen options available for omission.

2. User Guide Modifications

   • Update user and developer guides to reflect the new optional configuration capability.

Task 5: Deployment Plan

1. Staging Deployment

   • Deploy changes to a staging environment for final verification and user acceptance testing.

2. Production Rollout

   • Prepare for production deployment, including a rollback plan in case of any issues.

3. Monitor Post-Deployment

   • Monitor logs and user feedback post-deployment to ensure the feature performs as expected and address any issues promptly.

By following these steps, the implementation for allowing RPs to configure and suppress certain IDV flow screens will be thorough and minimize disruption to users while adding flexibility to the configuration system.

[Copilot]

@mehmet-yoti I've opened a new pull request, #446, to work on those changes. Once the pull request is ready, I'll request review from you.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud