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 address the implementation of the new configuration for omitting screens in the IDV flow based on the suppressed_screens list in the sdk_config, we need an organized and detailed implementation plan. This will include backend development, frontend changes, testing, and documentation. Below is the detailed implementation plan:

Task Breakdown

1. Backend (BE) Implementation

• Objective: Modify the backend to understand the new suppressed_screens configuration and propagate these settings correctly.

  Subtasks:

  • 1.1. Update Configuration Management:

    • Extend the existing configuration schema to include the suppressed_screens parameter.
    • Ensure this parameter is optional and validate the input format (it should be a list of strings).

  • 1.2. Database Changes:

    • If necessary, update the database schema to store suppressed screens configuration per client session.
    • Migrate existing configurations to accommodate the new suppressed_screens field.

  • 1.3. Session Middleware Update:

    • Update middleware or session management logic to parse the suppressed_screens during session creation or update.
    • Ensure suppressed screens are correctly interpreted and stored in session data for later use in determining flow behavior.

  • 1.4. API Endpoint Modifications:

    • Modify relevant API endpoints to handle the new configuration, ensuring that they can receive and correctly process the suppressed_screens list.

  • 1.5. Logic Layer Adjustments:

    • Based on the suppressed_screens, adjust the decision-making logic that determines which screens to display next in the flow.
    • Ensure this logic accounts for both existing controls and the new suppressive conditions.

2. Frontend (FE) Implementation

• Objective: Implement functionality to skip over screens based on backend-provided configuration.

  Subtasks:

  • 2.1. Update Client SDK Logic:

    • Modify the client SDK to consume the suppressed_screens list from the backend.
    • Implement logic to conditionally render or skip screens based on the list.

  • 2.2. UI Component Adjustments:

    • Ensure UI components respect the suppressed conditions, potentially adding default representations or empty states for skipped steps if needed.

3. Testing

• Objective: Thoroughly test new configuration settings to ensure proper screen suppression without breaking existing flows.

  Subtasks:

  • 3.1. Unit Testing:

    • Write unit tests for new backend logic handling suppressed_screens.
    • Ensure a high degree of coverage for edge cases, such as an empty list or invalid screen identifiers.

  • 3.2. Integration Testing:

    • Create integration tests to validate the correct flow sequence with different configurations of the suppressed_screens.
    • Test scenarios with partial, full, and no suppression.

  • 3.3. End-to-End Testing:

    • Perform end-to-end testing with full lifecycle scenarios to ensure real-world applicability.
    • Cross-verify that user experience aligns with expected configurations.

4. Documentation

• Objective: Update documentation to reflect changes and inform RP (Relying Parties) of the new configuration option.

  Subtasks:

  • 4.1. Update Configuration Documentation:

    • Add details about the new suppressed_screens field in technical documentation, including its usage, format, and effects.

  • 4.2. Update API Documentation:

    • Ensure API documentation shows examples with different suppressed_screens settings.

  • 4.3. Release Notes:

    • Prepare release notes to describe the new feature, how to use it, and its potential impact.

5. Deployment and Release

• Objective: Deploy the new feature confidently without causing any disruption to the service.

  Subtasks:

  • 5.1. Deployment Strategy:

    • Plan and execute a staged deployment, initially releasing to test/staging environments.

  • 5.2. Monitor and Rollback Plan:

    • Monitor performance and errors closely post-deployment.
    • Prepare a rollback plan in case of critical issues.

By following this implementation plan, we ensure a structured rollout of the new screen suppression feature in the IDV flow, enhancing flexibility for Relying Parties and maintaining a seamless user experience.

[Copilot]

@mehmet-yoti I've opened a new pull request, #448, 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