SDK-2759: Support handled_check_limit property for checks in IDV sandbox

[mehmet-yoti]

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

[mehmet-yoti]

@copilot do To implement the new handled_check_limit property in the IDV sandbox for configuring check reports, we need to follow a structured approach to ensure that the feature is correctly integrated and functions as expected. Below is a breakdown of the implementation plan:

Step 1: Requirements Analysis

• Objective: Understand the full scope of the feature and its impact on existing functionality.
• Tasks:
  • Review the Jira task description to understand the new handled_check_limit feature.
  • Identify all parts of the system that interact with check report configurations to determine where code changes will be needed.
  • Confirm requirements with stakeholders if any ambiguities are present.

Step 2: Design

• Objective: Plan how the new property will be integrated into the system.
• Tasks:
  • Design the schema update for the check report configuration to include handled_check_limit.
  • Plan data validation strategies to ensure handled_check_limit is correctly validated when setting configurations.
  • Update data models to accommodate the new attribute.

Step 3: Update Backend

• Objective: Implement the feature on the server-side to handle the new property.
• Tasks:
  • Modify the data model for check reports in the backend to include a handled_check_limit attribute.
  • Implement logic to decrement the handled_check_limit each time a check response is used.
  • Add logic to switch to a successful check result after the limit is reached.
  • Configure the system to validate the handled_check_limit value (ensure it's a non-negative integer).
  • Update API endpoints to support initialization and configuration of the handled_check_limit.

Step 4: Testing

• Objective: Ensure the new property functions correctly within the system.
• Tasks:
  • Develop unit tests to verify the decrementing of the handled_check_limit and switching to success after the limit.
  • Create integration tests to validate the end-to-end functionality of the feature.
  • Test data validation logic by attempting to set invalid handled_check_limit values and ensuring proper error handling.
  • Perform regression testing on existing functionalities to ensure no breaking changes.

Step 5: Update Documentation

• Objective: Ensure all documentation reflects the new changes for future reference and user guidance.
• Tasks:
  • Update API documentation to include the new handled_check_limit property, with examples.
  • Update any user guides or configuration manuals to explain the new feature and its usage.
  • If applicable, update system design documents to incorporate the architectural changes.

Step 6: Deployment

• Objective: Roll out the feature in a controlled manner.
• Tasks:
  • Develop a deployment plan, including backups and rollback strategies.
  • Deploy changes to a staging environment for final verification.
  • Once verified, promote the changes to the production environment.
  • Monitor the system post-deployment to quickly identify and resolve any arising issues.

Step 7: Post-Deployment Review

• Objective: Evaluate the implementation and identify areas for improvement.
• Tasks:
  • Conduct a review meeting with the development and QA team to discuss what went well and what could be improved.
  • Gather feedback from users to assess the functionality and utility of the new feature.
• Outcome: Document lessons learned and update practices for future tasks.

By following this detailed implementation plan, the development team can successfully integrate the handled_check_limit property into the IDV sandbox, ensuring it meets the business needs and adheres to quality standards.

[Copilot]

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