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

[mehmet-yoti]

Automated PR created by n8n. Related Jira Issue:

[mehmet-yoti]

@copilot do To implement the new "enforce_handoff" configuration option as described, follow these detailed steps:

Preliminary Steps:

1. Understand Requirements:

   • Review the current implementation of allow_handoff.
   • Refer to DOCS-3523 for detailed requirements and constraints, as well as examples of expected behavior.

2. Evaluate Dependencies:

   • Identify SDK components and APIs interacting with allow_handoff.

3. Update IDV API Validation:

   • Confirm the API's current error-handling capabilities.
   • Plan enhancements to the IDV API, if necessary, to incorporate validation for the enforce_handoff property.

Implementation Steps:

Step 1: SDK Configuration Update

• 1.1 Update Configuration Schema:

  • Add a new boolean property enforce_handoff to the SDK configuration schema.
  • Set default value to false to maintain backward compatibility.

• 1.2 Implement Configuration Parsing:

  • Update the SDK configuration parser to recognize and correctly parse the new property.

Step 2: Enforce Business Logic

• 2.1 Validation Logic Implementation:

  • Implement logic within the SDK to validate that enforce_handoff cannot be true if allow_handoff is false.
  • Utilize existing validation methods where applicable.

• 2.2 Error Handling:

  • Ensure that the SDK utilizes the IDV API to validate the enforce_handoff setting.
  • Implement error handling to capture and surface any violation errors from the IDV API back to the user or logs.

Step 3: SDK Update

• 3.1 Code Integration:

  • Integrate the new and updated logic into the SDK's codebase.
  • Ensure that all changes are consistent with existing code styles and patterns.

• 3.2 Update SDK Documentation:

  • Revise SDK configuration documentation to include the enforce_handoff option.
  • Highlight behavior and constraints, particularly in relation to allow_handoff.

Step 4: Testing

• 4.1 Write Unit Tests:

  • Create unit tests to cover scenarios including:
    • Both allow_handoff and enforce_handoff set to true.
    • enforce_handoff set to true while allow_handoff is false.
    • Proper error messages are returned and logged.

• 4.2 Integration Testing:

  • Ensure the application that uses the SDK responds correctly to valid and invalid configurations.
  • Conduct regression testing to ensure existing functionality remains unaffected.

Step 5: Deployment

• 5.1 Prepare Release Notes:

  • Document changes, new features, known limitations, and upgrade instructions.

• 5.2 Deploy Updated SDK:

  • Coordinate with deployment teams to distribute the updated SDK version.

• 5.3 Monitor Deployment:

  • Monitor logs and error reports post-deployment to ensure the feature works as intended.

Step 6: Feedback and Iteration

• 6.1 Gather User Feedback:

  • Post-deployment, collect feedback from early users and address any reported issues or unexpected behavior.

• 6.2 Iterative Improvements:

  • Plan any necessary follow-up tasks to refine the implementation based on feedback.

This step-by-step plan ensures that the new configuration is effectively and seamlessly integrated, with robust validation, thorough testing, and clear documentation to support SDK users.

[Copilot]

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