Skip to content

Part 1: Remove nonfunctional retirement API methods and references#38414

Open
VAIBHAVPANT07 wants to merge 3 commits intoopenedx:masterfrom
VAIBHAVPANT07:fix/remove-nonfunctional-retirement-code
Open

Part 1: Remove nonfunctional retirement API methods and references#38414
VAIBHAVPANT07 wants to merge 3 commits intoopenedx:masterfrom
VAIBHAVPANT07:fix/remove-nonfunctional-retirement-code

Conversation

@VAIBHAVPANT07
Copy link
Copy Markdown

@VAIBHAVPANT07 VAIBHAVPANT07 commented Apr 22, 2026

Summary

Part 1 of #37720 — Removes nonfunctional retirement API methods from edx_api.py
and cleans up their direct references in the user retirement pipeline.

This is an incremental PR. Doc updates and any remaining references
will be addressed in Part 2 and Part 3.


What Was Removed

Methods deleted from edx_api.py:

  • EcommerceApi.retire_learner
  • EcommerceApi.get_tracking_key
  • CredentialsApi.retire_learner

References cleaned up in retirement pipeline:

  • Obsolete ecommerce tracking-id helper path
  • Obsolete pipeline steps tied to removed methods in retire_one_user.py

Tests & Docs:

  • Updated existing tests to reflect the removed methods
  • Documentation update will follow in a later PR

Validation

python -m pytest -q test_retire_one_learner.py test_edx_api.py

Result: 33 passed, 0 failed


Risk Assessment

Low. All changes are contained within this repository.
External configs that reference these method names at runtime
may require separate updates outside this repo, as noted in the issue.


Status

Partially addresses #37720

  • Part 1 — Remove nonfunctional methods and direct references ← (this PR)
  • Part 2 — Remove remaining dynamic references
  • Part 3 — Update driver_setup.rst documentation

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 22, 2026
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @VAIBHAVPANT07!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are 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
🔘 Submit a signed contributor agreement (CLA)

⚠️ We ask all contributors to the Open edX project to submit a signed contributor agreement or indicate their institutional affiliation.
Please see the CONTRIBUTING file for more information.

If you've signed an agreement in the past, you may need to re-sign.
See The New Home of the Open edX Codebase for details.

Once you've signed the CLA, please allow 1 business day for it to be processed.
After this time, you can re-run the CLA check by adding a comment below that you have signed it.
If the CLA check continues to fail, you can tag the @openedx/cla-problems team in a comment for further assistance.

🔘 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.

Details
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:

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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Apr 22, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Needs Tests Run or CLA Signed in Contributions Apr 22, 2026
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Apr 22, 2026
@mphilbrick211
Copy link
Copy Markdown

Hi @VAIBHAVPANT07, and thank you for this contribution! You should be receiving a document via Docusign to send back to us so we can get your CLA check to turn green. If you don't see it, please check any spam / junk folders.

@VAIBHAVPANT07
Copy link
Copy Markdown
Author

Hi @mphilbrick211 , thanks for the heads up! I've already signed the CLA via DocuSign. Please let me know if there's anything else needed on my end.

@e0d
Copy link
Copy Markdown
Contributor

e0d commented Apr 23, 2026

@VAIBHAVPANT07 Your branch was behind the base. I've pulled in changes from master as a merge commit which will update your branch and cause the tests to be re-run. You should pull the changes into your local branch.

@VAIBHAVPANT07 VAIBHAVPANT07 force-pushed the fix/remove-nonfunctional-retirement-code branch from 213590b to 08e5fef Compare April 23, 2026 20:44
@VAIBHAVPANT07 VAIBHAVPANT07 requested a review from a team as a code owner April 23, 2026 20:44
@VAIBHAVPANT07 VAIBHAVPANT07 force-pushed the fix/remove-nonfunctional-retirement-code branch from 08e5fef to c4c7fe9 Compare April 23, 2026 20:48
@VAIBHAVPANT07
Copy link
Copy Markdown
Author

Hi @e0d , I've re-pushed with conventional commit messages fixed. I've also already signed the CLA via DocuSign. Could you please verify the CLA status and approve the workflows to re-run the checks?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs test run Author's first PR to this repository, awaiting test authorization from Axim open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Tests Run or CLA Signed

Development

Successfully merging this pull request may close these issues.

4 participants