[DEPR]: Complete removal of EdxRestApiClient

[robrap]

Proposal Date

11 April 2023

Target Ticket Acceptance Date

11 April 2023

Earliest Open edX Named Release Without This Functionality

Q - 2023-10

Rationale

Note that this is not a new proposal, but is a ticket to track completion of the original DEPR documented here: #37.

This ticket is to clean-up some small remaining usages, and ultimately to remove the deprecated EdxRestApiClient so the code no longer lives in the platform.

Removal

Here is a general search for uses of EdxRestApiClient: https://github.com/search?q=org%3Aopenedx%20EdxRestApiClient&type=code

• Here is usage in edx-platform: https://github.com/openedx/edx-platform/blob/d622db59b7bfe2e4c11fc11b7cb2d475cfda551b/openedx/core/djangoapps/commerce/utils.py#L56
• Here is a comment that simply should no longer reference EdxRestApiClient: https://github.com/openedx/edx-analytics-data-api/blob/6916f071301c57457cad668ac1c33ae702b061fa/analyticsdataserver/settings/base.py#L325
• It's unclear if this is still an active use, but it definitely needs to be addressed: https://github.com/openedx/credentials/blob/b6090f97097aee61e927f375995a10582adc0731/credentials/apps/catalog/utils.py#L37
• Tests that should be removed. Do they need to be replaced? See https://github.com/openedx/edx-platform/blob/d622db59b7bfe2e4c11fc11b7cb2d475cfda551b/lms/djangoapps/commerce/tests/__init__.py#L28.
• More tests using the client. Are these credentials e2e tests still in use? See https://github.com/openedx/credentials/blob/b6090f97097aee61e927f375995a10582adc0731/acceptance_tests/e2e/mixins.py#L38.
• The final change should be removal of the actual class in a breaking change. We should also remove the slumber library, since we will no longer need this outdated library. See https://github.com/openedx/edx-rest-api-client/blob/8eb8837c2d5e94ef2cc809124ed371ef12509f50/edx_rest_api_client/client.py#L288
  • Includes tests for this class: https://github.com/openedx/edx-rest-api-client/blob/8eb8837c2d5e94ef2cc809124ed371ef12509f50/edx_rest_api_client/tests/test_client.py#L37
• There is a separate ticket for follow-up on an ADR detailed in Write an ADR for use of a user's JWT now that EdxApiRestClient has been removed edx-rest-api-client#277. Marking this closed to not block closing this DEPR, although the issue has not yet been addressed.
• The newly introduced DeprecatedEdxRestApiClient in edx-platform will need to be removed, in addition to slumber. This requires fixing the past bug found during the first attempt. See [DEPR]: Complete removal of EdxRestApiClient #189 (comment) for details. (This may die with ecommerce code in edx-platform. This should probably just get its own edx-platform ticket rather than trying to complete as part of this DEPR.)

Replacement

See original DEPR for details: #37

Deprecation

No response

Migration

No response

Additional Info

No response

[kdmccormick]

I support this deprecation! 😉

[idegtiarov]

me too )))

[dianakhuang]

This snuck back into edx-platform: openedx/openedx-platform@a35176e

[robrap]

Note that I have questions about some of the replacement work from the original DEPR ticket, but I have created the following ticket to address that: openedx/edx-rest-api-client#277

[Yagnesh1998]

assign me