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

Remove MongoDBProxy and Migrate to Native PyMongo Retry Functionality #35213

Closed
wants to merge 1 commit into from

Conversation

yashathwani
Copy link

Description

This pull request removes the custom MongoDBProxy package from the edx-platform and updates the codebase to use PyMongo's built-in retryable reads and writes features. This change is intended to simplify the codebase by eliminating the need for the custom package and leveraging the native support provided by recent versions of PyMongo.

Impact on User Roles:

Developer: Developers will no longer need to maintain the MongoDBProxy package and will use PyMongo's built-in features for retries.
Operator: Operators will benefit from a more streamlined and supported connection handling process.

Resolves #35210

@openedx-webhooks
Copy link

Thanks for the pull request, @yashathwani!

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

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

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

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. 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:

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 1, 2024
@kdmccormick kdmccormick self-requested a review August 1, 2024 17:30
Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

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

Thanks for the quick PR @yashathwani !

In addition to the comments below, you'll need to reword your commit as a conventional commit. In your case you could simply do refactor: Replace MongoDBProxy usage with direct pymongo.MongoClient configuration

Lastly, please sign the CLA if you have not already: https://openedx.org/cla

@@ -66,14 +65,6 @@ def connect_to_mongodb(
connection_params.update({'username': user, 'password': password, 'authSource': db})

mongo_conn = pymongo.MongoClient(**connection_params)

if proxy:
Copy link
Member

Choose a reason for hiding this comment

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

Since proxy is now unused, could you remove it from the parameters list and the docstring for this method?

Comment on lines +31 to +32
# Assert that retries are handled correctly
self.assertGreater(mock_database.admin.command.call_count, 1) # Ensure retries happened
Copy link
Member

Choose a reason for hiding this comment

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

Nice, thanks for testing this.

@@ -12,7 +12,7 @@
from bson.son import SON
from fs.osfs import OSFS
from gridfs.errors import NoFile, FileExists
from mongodb_proxy import autoretry_read

Copy link
Member

Choose a reason for hiding this comment

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

to satisfy pycodestyle, you'll need to remove these now-empty lines

@kdmccormick
Copy link
Member

@yashathwani this is a really valuable PR, I hope you're still interested in getting it merged. Let me know if there is any way I can help with the CLA or with getting CI to pass.

@kdmccormick
Copy link
Member

kdmccormick commented Sep 5, 2024

@yashathwani , do you plan on finishing this PR?

@kdmccormick
Copy link
Member

@mphilbrick211 do you know what state this contributor's CLA is in?

kdmccormick added a commit to kdmccormick/edx-platform that referenced this pull request Sep 27, 2024
Inspired by openedx#35213

Closes openedx#35210

Co-Authored-By: Yash Athwani <yashathwani45@gmail.com>
@kdmccormick
Copy link
Member

Hi @yashathwani , since we have not heard from you, I have opened a new iteration of this PR: #35556

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NEED-CLA open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Remove MongoDBProxy
3 participants