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

fix: Respect the authsource kwarg for MongoDB connections #35239

Merged
merged 2 commits into from
Aug 22, 2024

Conversation

blarghmatey
Copy link
Contributor

Description

The changes for upgrading to PyMongo 4.4 introduced an authentication bug in Mongo connections. The authSource parameter was being hard-coded to use the database being connected to. In Mongo the admin db is typically the source of authentication, so unless the user was explicitly created in the target db then any attempts to connect would result in authentication failures.

This restores the behavior of allowing for the lowercased authsource kwarg to be used for the authSource connection parameter, while otherwise respecting the operator's configuration parameters.

Supporting information

This addresses an error introduced by #35179

Testing instructions

To test this change requires a MongoDB instance that is using a modulestore database name that is different than admin and does not contain the user that is authenticating (which is a fairly common scenario). Specifying either authsource or authSource in the configuration should allow the connection to be made without error.

Deadline

ASAP, as the master branch is broken for typical MongoDB installations.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 6, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @blarghmatey!

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

@mumarkhan999
Copy link
Member

@blarghmatey Tests are failing.
Can you please make this PR green?

xmodule/mongo_utils.py Outdated Show resolved Hide resolved
@blarghmatey blarghmatey force-pushed the tm/pymongo_authsource_fix branch 4 times, most recently from d950f21 to 90f6073 Compare August 7, 2024 14:55
@blarghmatey
Copy link
Contributor Author

@mumarkhan999 all of the checks are passing now.

xmodule/mongo_utils.py Outdated Show resolved Hide resolved
The changes for upgrading to PyMongo 4.4 introduced an authentication
bug in Mongo connections. The `authSource` parameter was being
hard-coded to use the database being connected to. In Mongo the `admin`
db is typically the source of authentication, so unless the user was
explicitly created in the target db then any attempts to connect would
result in authentication failures.

This restores the behavior of allowing for the lowercased `authsource`
kwarg to be used for the `authSource` connection parameter, while
otherwise respecting the operator's configuration parameters.
xmodule/mongo_utils.py Outdated Show resolved Hide resolved
The changes for upgrading to PyMongo 4.4 introduced an authentication
bug in Mongo connections. The `authSource` parameter was being
hard-coded to use the database being connected to. In Mongo the `admin`
db is typically the source of authentication, so unless the user was
explicitly created in the target db then any attempts to connect would
result in authentication failures.

This restores the behavior of allowing for the lowercased `authsource`
kwarg to be used for the `authSource` connection parameter, while
otherwise respecting the operator's configuration parameters.
@blarghmatey
Copy link
Contributor Author

@mumarkhan999 it looks like all of your comments have been addressed. Let me know if you run into any other issues while testing.

@mumarkhan999 mumarkhan999 merged commit 44112aa into openedx:master Aug 22, 2024
49 checks passed
@openedx-webhooks
Copy link

@blarghmatey 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

rediris pushed a commit to gymnasium/edx-platform that referenced this pull request Aug 27, 2024
)

* fix: Respect the authsource kwarg for MongoDB connections

The changes for upgrading to PyMongo 4.4 introduced an authentication
bug in Mongo connections. The `authSource` parameter was being
hard-coded to use the database being connected to. In Mongo the `admin`
db is typically the source of authentication, so unless the user was
explicitly created in the target db then any attempts to connect would
result in authentication failures.

This restores the behavior of allowing for the lowercased `authsource`
kwarg to be used for the `authSource` connection parameter, while
otherwise respecting the operator's configuration parameters.

* fix: Respect the authsource kwarg for MongoDB connections

The changes for upgrading to PyMongo 4.4 introduced an authentication
bug in Mongo connections. The `authSource` parameter was being
hard-coded to use the database being connected to. In Mongo the `admin`
db is typically the source of authentication, so unless the user was
explicitly created in the target db then any attempts to connect would
result in authentication failures.

This restores the behavior of allowing for the lowercased `authsource`
kwarg to be used for the `authSource` connection parameter, while
otherwise respecting the operator's configuration parameters.
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