SDK-2745: Add Enforce Handoff to SDKs for IDV Create Session

[mehmet-yoti]

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

[mehmet-yoti]

@copilot do To implement the new "enforce_handoff" configuration in the SDK, the following detailed implementation plan is outlined. Each step should be carefully executed to ensure the correct integration of the new configuration.

Step 1: Review Requirements and Documentation

1. Access and Review DOCS-3523:

   • Ensure you have access to the DOCS-3523 ticket.
   • Understand the relationship between "enforce_handoff" and "allow_handoff" properties as described in the ticket.

2. Understand Existing SDK Setup:

   • Familiarize yourself with the current implementation of "allow_handoff".
   • Review any dependencies and integration points within the SDK related to handoff configurations.

Step 2: Design

1. Design Data Structure:

   • Decide where the "enforce_handoff" setting will be stored within the configuration file or object structure of the SDK.

2. Outline Validation Logic:

   • Design validation logic to check the compatibility of "enforce_handoff" with "allow_handoff".
   • Define error messages and states for when "allow_handoff" is false, and "enforce_handoff" is attempted to be set to true.

Step 3: Implementation

1. Update Configuration Parsing:

   • Modify the configuration parsing module to include the "enforce_handoff" property.
   • Ensure the property is correctly recognized whether set by users or by default.

2. Implement Validation Logic:

   • Implement a function to validate "enforce_handoff" against "allow_handoff".
   • Ensure that when "allow_handoff" is false, enabling "enforce_handoff" triggers the correct API validation and error handling.

3. Error Handling:

   • Integrate error handling that captures the error returned from the IDV API when the configuration is invalid.
   • Display or log the error in a user-friendly manner.

Step 4: Testing

1. Unit Tests:

   • Write unit tests for the configuration parsing module to ensure it accurately recognizes and stores "enforce_handoff".
   • Create tests for validation logic to handle all scenarios (e.g., compatible settings, incompatible settings).

2. Integration Tests:

   • Test the integration of the "enforce_handoff" configuration with relevant SDK components to ensure seamless functionality.
   • Simulate scenarios where "enforce_handoff" is enabled/disabled in conjunction with "allow_handoff".

3. Error Scenario Tests:

   • Test scenarios where "allow_handoff" is false, and "enforce_handoff" is true, to ensure the SDK properly returns and handles API errors.

Step 5: Documentation

1. Update SDK Documentation:

   • Document the new "enforce_handoff" property in the SDK’s configuration guide.
   • Explain the constraints related to "allow_handoff" and how the SDK handles invalid configurations.

2. Create or Update Developer Guides:

   • Update developer guides and examples to illustrate the correct use of both "enforce_handoff" and "allow_handoff".
   • Provide scenarios and example configurations highlighting best practices.

Step 6: Deployment

1. Review and Approval:

   • Perform a code review and seek approval from peers or a senior developer.
   • Ensure the implementation meets all requirements and adheres to best coding practices.

2. Release Management:

   • Tag and branch the codebase for release.
   • Prepare release notes highlighting the new feature and any breaking changes.

3. Deploy Updates:

   • Deploy the updated SDK to the appropriate repositories or distribution channels.
   • Monitor deployment for any potential issues reported by users or automated feedback systems.

This detailed plan ensures a comprehensive approach to implementing the "enforce_handoff" configuration in a controlled and reliable manner, keeping any potential impacts minimal and functionality optimal.

[Copilot]

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