Andal.LND/edx-platform
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix!: split modulestore's has_course(ignore_case=True) was not working (#38044)

Browse Source 
BREAKING CHANGE: this forces course IDs in modulestore to be unique (case insensitive). This was always supposed to be the case, but it wasn't working properly on MySQL. Upgrading past this commit may cause a migration failure if you have conflicting course IDs - see the migration 0004 docstring for details.
This commit is contained in:
Braden MacDonald
2026-02-19 15:12:41 -08:00
committed by Braden MacDonald
parent 3e522d5272
commit 12e9af4f5c
5 changed files with 117 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
common/djangoapps/split_modulestore_django/tests/test_models.py
View File

@@ -2,8 +2,10 @@
from datetime import datetime
from bson.objectid import ObjectId
from django.db import IntegrityError, transaction
from django.test import TestCase
from opaque_keys.edx.keys import CourseKey
import pytest
from common.djangoapps.split_modulestore_django.models import SplitModulestoreCourseIndex
from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order
@@ -16,12 +18,22 @@ class SplitModulestoreCourseIndexTest(TestCase):
"""
Make sure the course_id column is case sensitive.
2021 note:
Although the platform code generally tries to prevent having two courses whose IDs differ only by case
(e.g. https://git.io/J6voR , note `ignore_case=True`), we found at least one pair of courses on stage that
differs only by case in its `org` ID (`edx` vs `edX`). So for backwards compatibility with MongoDB and to avoid
issues for anyone else with similar course IDs that differ only by case, we've made the new version case
sensitive too. The system still tries to prevent creation of courses that differ only by course (that hasn't
changed), but now the MySQL version won't break if that has somehow happened.
2026 note:
Due to a serious bug where the system was NOT preventing duplicate courses from being created on MySQL, we
decided to tighten this up and introduce a new UNIQUE(LOWER(course_id)) index to prevent duplicates at the
database level. This does mean that the migration will fail if anyone has such duplicates in their system, but
those duplicates are going to have other bugs anyways; in such cases we recommend deleting one of the duplicate
SplitModulestoreCourseIndex entries, or changing its course_id to a dummy value.
"""
course_index_common = {
"course": "TL101",
@@ -38,8 +50,16 @@ class SplitModulestoreCourseIndexTest(TestCase):
data1 = SplitModulestoreCourseIndex.fields_from_v1_schema(course_index_1)
data2 = SplitModulestoreCourseIndex.fields_from_v1_schema(course_index_2)
SplitModulestoreCourseIndex(**data1).save()
# This next line will fail if the course_id column is not case-sensitive:
SplitModulestoreCourseIndex(**data2).save()
# Also check deletion, to ensure the course_id historical record is not unique or case sensitive:
SplitModulestoreCourseIndex.objects.get(course_id=CourseKey.from_string("course-v1:edx+TL101+2015")).delete()
SplitModulestoreCourseIndex.objects.get(course_id=CourseKey.from_string("course-v1:edX+TL101+2015")).delete()
# This next line should fail, because the database itself prevents duplicates:
with pytest.raises(IntegrityError):
with transaction.atomic():
SplitModulestoreCourseIndex(**data2).save()
id_1 = "course-v1:edx+TL101+2015"
id_2 = "course-v1:edX+TL101+2015"
# Retrieving a course by its exact course_id should work:
SplitModulestoreCourseIndex.objects.get(course_id=CourseKey.from_string(id_1))
# but retrieving a course with the wrong case should throw an error:
with pytest.raises(SplitModulestoreCourseIndex.DoesNotExist):
SplitModulestoreCourseIndex.objects.get(course_id=CourseKey.from_string(id_2))