Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: renamed DeprecatedRestApiClient from EdxRestApiClient #33603

Closed
wants to merge 32 commits into from

Conversation

Yagnesh1998
Copy link
Contributor

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 openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 26, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Oct 26, 2023

Thanks for the pull request, @Yagnesh1998! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@Yagnesh1998 Yagnesh1998 marked this pull request as draft October 26, 2023 15:42
@Yagnesh1998 Yagnesh1998 marked this pull request as ready for review November 2, 2023 18:38
from edx_rest_api_client.auth import SuppliedJwtAuth
from edx_rest_api_client.client import EdxRestApiClient
from edx_rest_api_client.auth import BearerAuth, JwtAuth, SuppliedJwtAuth
from edx_rest_api_client.__version__ import __version__
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should pull out this value from the edx-rest-api-client library and make it a constant here, since we don't want this value to change as the library changes, since the deprecated client won't be updated as the library changes.

Copy link
Contributor

@dianakhuang dianakhuang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks reasonable to me. I'm going to merge it for now, but I will also make a revert PR just in case it needs to get backed out.

@dianakhuang
Copy link
Contributor

Actually, I'm going to get ask the purchase squad to review, just in case they have other concerns.

@robrap
Copy link
Contributor

robrap commented Nov 29, 2023

@dianakhuang: We also would need to add slumber to edx-platform, since it was removed in the other PR.

@dianakhuang @Yagnesh1998: Does it make sense to skip this PR, and simply replace this usage of the old client? Either way, I think that should be the next step to actually close out the DEPR. @Yagnesh1998: you could research how all the other uses of the old client were replaced in past PRs.

@robrap
Copy link
Contributor

robrap commented Dec 4, 2023

@Yagnesh1998: We should add slumber explicitly to base.in in this PR, because it will no longer come in as part of the client. After doing so, I think you can run make compile-requirements (rather than make upgrade) to fix the comments for the requirements.

Also, I discussed with @dianakhuang, and we will move ahead with this PR. I didn't realize that there was a bug found the last time this was attempted. I detailed that separately in openedx/public-engineering#189 (comment).

@Yagnesh1998
Copy link
Contributor Author

Yagnesh1998 commented Dec 4, 2023

@robrap Sure. Thanks for the update.

@robrap
Copy link
Contributor

robrap commented Dec 12, 2023

@Yagnesh1998: Do you plan to add slumber as requested in this comment? #33603 (comment). Note that there is also a github action that we can run (if you can't) to update dependencies once you add slumber to base.in.

@dianakhuang
Copy link
Contributor

@robrap I've been working with @Yagnesh1998 on this, and we've been trying to get slumber into kernel.in. We ran into issues getting make upgrade running, so thanks for the reminder of the GitHub action that we can use instead.

@robrap
Copy link
Contributor

robrap commented Dec 12, 2023

@robrap I've been working with @Yagnesh1998 on this, and we've been trying to get slumber into kernel.in. We ran into issues getting make upgrade running, so thanks for the reminder of the GitHub action that we can use instead.

I forgot about kernel.in. Sounds great. I'd just get that change in on this branch and work from there.

@@ -159,3 +159,4 @@ webob
web-fragments # Provides the ability to render fragments of web pages
XBlock[django] # Courseware component architecture
xss-utils # https:/edx/edx-platform/pull/20633 Fix XSS via Translations
slumber
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also add a comment about the fact that this dependency is unsupported and used by the DeprecatedRestApiClient?

requirements/edx/kernel.in Outdated Show resolved Hide resolved
@robrap
Copy link
Contributor

robrap commented Dec 12, 2023

@Yagnesh1998 @dianakhuang: I'm not clear if the github action can be used against the personal fork? See https://discuss.openedx.org/t/new-tools-for-managing-python-dependencies-in-edx-platform/11263. If not, you could run make upgrade-package package=slumber in the devstack lms shell, which can be started with make lms-shell.

@dianakhuang
Copy link
Contributor

@robrap I made a separate branch, ran the action on it, and then merged it: #33916

@robrap
Copy link
Contributor

robrap commented Dec 12, 2023

@robrap I made a separate branch, ran the action on it, and then merged it: #33916

Does that mean this should be closed?

@dianakhuang
Copy link
Contributor

We merged #33916 instead

@openedx-webhooks
Copy link

@Yagnesh1998 Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.

@Yagnesh1998
Copy link
Contributor Author

@robrap Yes that makes sense

@Yagnesh1998 Yagnesh1998 deleted the edx-depr218 branch December 12, 2023 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants