feat: DEPR EdxRestApiClient

[Yagnesh1998]

Description:

As Per this DEPR: openedx/public-engineering#218

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

Move EdxRestApiClient into a location near where it is used in edx-platform and rename it to DeprecatedRestApiClient

[openedx-webhooks]

Thanks for the pull request, @Yagnesh1998!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/openedx-unmaintained. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[dianakhuang]

Another note: you will want to bump the version number for this library (in the version file) to a new major version (so 6.0.0) and add a note to the README that there is a breaking change here.

[e0d]

Hi @Yagnesh1998 looks like there are some CI failures, can you have a look?

[Yagnesh1998]

@mphilbrick211 two workflows awaiting approval.

[mphilbrick211]

Hi @Yagnesh1998! I'm seeing that the workflows are enabled. Would you mind looking into the failing checks?

[Yagnesh1998]

@mphilbrick211 After adding a commit on this repo it always gives me 2 workflows waiting for approval. can I approve it myself?

[mphilbrick211]

@Yagnesh1998 - it looks like you should be able to rebase and have the tests run again. Let me know if that doesn't work.

[Yagnesh1998]

@mphilbrick211 doesn't work. my question is in my local system I can see the failing test but when I push commit here it always gives me 2 workflows waiting for approval. But when I worked on the commits in the edx-platform repo in the past, I did not see this type of problem, and all the tests were passed.

[Yagnesh1998]

@mphilbrick211 can u please approve the workflow so the tests are starting to run?

[mphilbrick211]

@Yagnesh1998 - looks like all the tests ran and are passing.

@openedx/arch-bom - this is ready for review!

[robrap]

• Hopefully slumber can be fully removed from this library, including the requirements files. That means removing from the *.in requirement files, and then running make upgrade in the top-level directory to generate the updated *.txt requirement files.
• It looks like slumber is also used in an exceptions file: https://github.com/search?q=repo%3Aopenedx%2Fedx-rest-api-client%20slumber&type=code
• You still need to do a major upgrade of the version to 6.0.0 here:

  edx-rest-api-client/edx_rest_api_client/__version__.py

  Line 1 in 6bbb88e

  __version__ = '5.6.1'

  , and update the CHANGELOG.rst. See https://open-edx-proposals.readthedocs.io/en/latest/best-practices/oep-0051-bp-conventional-commits.html for handling backward incompatible changes like this one.

[robrap]

@Yagnesh1998: A reminder to update CHANGELOG.rst. See https://open-edx-proposals.readthedocs.io/en/latest/best-practices/oep-0051-bp-conventional-commits.html for handling backward incompatible changes like this one.

[Yagnesh1998]

@robrap I think it's done. Any suggestions or any feedback.

[robrap]

@dianakhuang: Do we want to add a local version to edx-platform, which will also require adding slumber to edx-platform directly, or is it possible to repeat the fixes that were done in the first place to retire the client?

UPDATE: I moved this comment to openedx/edx-platform#33603 (comment)

[dianakhuang]

Could you also update CHANGELOG.rst for version 6.0.0 mentioning that we are removing EdxRestApiClient and that it's a breaking change?

[mphilbrick211]

@dianakhuang - would you mind enabling tests on this again? Thanks!

[mphilbrick211]

@robrap - is this something you can review / merge?

[dianakhuang]

@Yagnesh1998 could you rebase and resolve conflicts? I can re-review it once that's done.

[mphilbrick211]

Hi @Yagnesh1998 - checking in on this. Are you planning to pursue this pull request? If so, there's branch conflicts that need to be resolved before the pull request can be merged. Thanks!

[Yagnesh1998]

I will do that currently I am on holiday but I will finish that soon.Thanks for reminding and commenting :) @mphilbrick211

[mphilbrick211]

Hi @Yagnesh1998 - friendly check in on this :)

[mphilbrick211]

Closing for now. Can reopen in the future if needed.

[feanil]

Gonna re-open and see if DEPR WG can get it over the line.

[feanil]

@robrap @dianakhuang this is good to go now I think, also, while doing this I noticed other maintenance that needs to be done so I made a PR for that here: #362

I'd love to land both before the major version bump.