[DEPR]: EdxRestApiClient

[feanil]

Proposal Date

2 April 2019

Ticket Acceptance Date

2 May 2019

Technology Removal Date

30 May 2019

First Open edX Named Release Without This Functionality

Olive

Rationale

EdxRestApiClient is no longer supported, as you may have been able to tell from the many, many deprecation warnings.

In Progress or already done

• [DEPR] Remove EdxRestApiClient usage in course-discovery #49

Ready for Removal

Repos where we're still using EdxRestApiClient:

• [DEPR] Remove EdxRestApiClient usage in ecommerce #48
• [DEPR] Remove EdxRestApiClient usage in ecommerce-scripts #47
• [DEPR] Remove EdxRestApiClient usage in ecommerce-worker #46
• [DEPR] Remove EdxRestApiClient usage in edx-analytics-dashboard #45
• [DEPR] Remove EdxRestApiClient usage in edx-analatycis-data-api #44
• [DEPR] Remove EdxRestApiClient usage in edx-enterprise #42
• [DEPR] Remove EdxRestApiClient usage in edx-enterprise-data #41
• [DEPR] Remove EdxRestApiClient usage in edx-microsite #40
• [DEPR] Remove EdxRestApiClient usage in edx-platform #39
• [DEPR] Remove EdxRestApiClient usage in tubular #38
• [DEPR] Update Rest Client in taxonomy-connector #159
• Remove the old client and publish a new breaking version of the client.

Currently Private, can't move forward yet

• [DEPR] Remove EdxRestApiClient usage in edx-e2e-tests #43

Replacement

As an alternative, use OAuthAPIClient instead: https:/edx/edx-rest-api-client/blob/master/edx_rest_api_client/client.py#L88

We will be switching usages of the old client to OAuthAPIClient as part of this removal.

Deprecation

No response

Migration

No response

Additional Info

Original Jira Issue: https://openedx.atlassian.net/browse/DEPR-21

[e0d]

Discovery items:

• Is there an underlying application token we can use with the new library
• In some cases the request is on the behalf of the user and we are passing JOTs around. We will still need to do this, but the current client doesn’t have an interface for supporting JOTs.
• Need a proposed design for supporting JOTs
• Inventory of which uses are of each type, server to server versus

[dianakhuang]

Found a lingering instance of the EdxRestApiClient in openedx/taxonomy-connector: https:/openedx/taxonomy-connector/blob/e196006978e56c75dda56553e324cfbd06da50fb/taxonomy/emsi/client.py

[feanil]

We need to do one last search to confirm that there isn't any usage of the old code and then we can remove the class from the library and release a new breaking version.

[dianakhuang]

I checked in edx.org New Relic, and there aren't any active usages on edx.org left.

We will want to check again before merging the changes to the old library to verify that this is the case.

[robrap]

@feanil @dianakhuang: I noticed a little remaining around this:

• See https:/search?q=org%3Aopenedx%20EdxRestApiClient&type=code
• Example: https:/openedx/edx-platform/blob/6cae1fa42953ff4d8ef5891b40194b104c2e477c/openedx/core/djangoapps/commerce/utils.py#L56