fix: use correct case for authsource mongo #841
Conversation
johanseto
force-pushed
the
jlc/update-authsource-mongo
branch
from
016b2af
to
f7316b0
Compare
| @@ -13,7 +13,7 @@ | |||
| "password": {% if MONGODB_PASSWORD %}"{{ MONGODB_PASSWORD }}"{% else %}None{% endif %}, | |||
| # Connection/Authentication | |||
| "ssl": {{ MONGODB_USE_SSL }}, | |||
| "authSource": "{{ MONGODB_AUTH_SOURCE }}", | |||
| "authsource": "{{ MONGODB_AUTH_SOURCE }}", | |||
| "replicaSet": {% if MONGODB_REPLICA_SET %}"{{ MONGODB_REPLICA_SET }}"{% else %}None{% endif %}, | |||
There was a problem hiding this comment.
| "replicaSet": {% if MONGODB_REPLICA_SET %}"{{ MONGODB_REPLICA_SET }}"{% else %}None{% endif %}, | |
| "replicaset": {% if MONGODB_REPLICA_SET %}"{{ MONGODB_REPLICA_SET }}"{% else %}None{% endif %}, |
Looking more if pymongo use insensitive dict https://github.com/mongodb/mongo-python-driver/blob/3.12.3/pymongo/mongo_client.py#L651 we can test changing also replicaSet to replicaset in order to have mongo_db_parameters in standard way kwargs using lowercase.
There was a problem hiding this comment.
It ain't broken (yet) so let's not try to fix this.
There was a problem hiding this comment.
Happy to merge this @johanv26. I checked why we never ran into this issue and it's because we add the username and password to MONGODB_HOST and don't specify them separately.
- I read through the code
- I tested this locally to make sure the migration
split_modulestore_django.0002_data_migrationpasses for mongodb+srv urls if the username and password is encoded in theMONGODB_HOST.
There was a problem hiding this comment.
Looking good! Could you please add a changelog entry? https://docs.tutor.overhang.io/tutor.html#contributing
johanseto
force-pushed
the
jlc/update-authsource-mongo
branch
from
f7316b0
to
a3966de
Compare
Update `authSource` keyword argument to `authsource` Authsource was configurated in camelcase. https://github.com/overhangio/tutor/blob/master/tutor/templates/apps/openedx/settings/partials/common_all.py#L16 Something I think is ok because pymongo uses it in camelcase. https://pymongo.readthedocs.io/en/3.10.1/api/pymongo/mongo_client.html However, the error was presented because edx-platform use another variable when credentials are provided **(LOWERCASE)**. https://github.com/openedx/edx-platform/blob/master/xmodule/mongo_utils.py#L72 Looking more , the `auth_source `is configured with another key name: `authsource` **(LOWERCASE)** from the kwargs. https://github.com/openedx/edx-platform/blob/master/xmodule/mongo_utils.py#L34 This won't change the **kwargs behavior of the camelCase in pymongo `MongoClient` because pymongo has a caseInsentive method. https://github.com/mongodb/mongo-python-driver/blob/3.12.3/pymongo/mongo_client.py#L651 ``it's OK to pass `authsource` instead of authSource as a keyword argument.``
johanseto
force-pushed
the
jlc/update-authsource-mongo
branch
from
a3966de
to
0780d24
Compare
Changelog added, regards. |
Description
Update
authSourcekeyword argument toauthsourceAuthsource was configurated in camelcase.
https://github.com/overhangio/tutor/blob/master/tutor/templates/apps/openedx/settings/partials/common_all.py#L16 Something I think is ok because pymongo uses it in camelcase.
However, the error was presented because edx-platform use another variable when credentials are provided (LOWERCASE). https://github.com/openedx/edx-platform/blob/master/xmodule/mongo_utils.py#L72
Looking more , the
auth_sourceis configured with another key name:authsource(LOWERCASE) from the kwargs. https://github.com/openedx/edx-platform/blob/master/xmodule/mongo_utils.py#L34This won't change the **kwargs behavior of the camelCase in pymongo
MongoClientbecause pymongo has a caseInsentive method. https://github.com/mongodb/mongo-python-driver/blob/3.12.3/pymongo/mongo_client.py#L651it's probably OK to pass
authsourceinstead of authSource as a keyword argument.issues related
#823