[DEPR]: IDVerificationService.get_verification_details_by_id and IDVerificationSupportView

[MichaelRoytman]

Proposal Date

2024-09-09

Target Ticket Acceptance Date

2024-09-27

Earliest Open edX Named Release Without This Functionality

Sumac - 2024-10

Rationale

The get_verification_details_by_id method of the IDVerificationService is used to get information about an IDV attempt, given an ID.

This method is solely used by the IDVerificationSupportView, which is used by the VerifiedName component of the frontend-app-support-tools MFE to fetch and display the status of an IDV attempt associated with a verified name. A screenshot is included below.

With the introduction of the generic, vendor-agnostic [VerificationAttempt](https://github.com/openedx/edx-platform/blob/master/lms/djangoapps/verify_student/models.py#L1195) model to the [verify_student](https://github.com/openedx/edx-platform/tree/master/lms/djangoapps/verify_student) application, this service method poses a problem. The idsupported byget_verification_details_by_id` must be an ID of the classes that inherit from the IdVerificationAttempt abstract base class, so the VerificationAttempt model cannot be properly integrated into this method.

We are in the process of refactoring the edx-name-affirmation application and the frontend-app-support-tools MFE to remove the use of the IDVerificationSupportView.

The first stage of this is complete and can be viewed in this pull request: edx/edx-name-affirmation#215

We propose the removal of the get_verification_details_by_id method of the IDVerificationService and the IDVerificationSupportView that uses it.

Removal

The following is being removed.

• get_verification_details_by_id method of the IDVerificationService
• IDVerificationSupportView

Replacement

There will be no replacement.

Deprecation

This code will not be marked for deprecation.

Migration

No automated migration will be needed.

Additional Info

This deprecation is required by the IDV extensibility project, documented in this platform-roadmap ticket: openedx/platform-roadmap#367.

You can find the Discourse thread here.

Task List

• Add the status of an IDV attempt to the VerifiedNameHistoryView.
• Remove the use of the IDVerificationSupportView from the frontend-app-support-tools.
• Remove the get_verification_details_by_id method of the IDVerificationService and the IDVerificationSupportView.

[MichaelRoytman]

This DEPR has been communicated. A Discourse thread has been started here. The DEPR has been posted to the #general and #open-edx-proposals Slack channels in the Open edX Slack instance.

We are providing two weeks of review time before marking this DEPR approved. If no feedback is provided, this code will be removed sometime in late September or early-to-mid October.

[alangsto]

In the process of removing the code now.