Make course ids and usage ids opaque to LMS and Studio [partial commit]

This commit updates common/djangoapps.

These keys are now objects with a limited interface, and the particular
internal representation is managed by the data storage layer (the
modulestore).

For the LMS, there should be no outward-facing changes to the system.
The keys are, for now, a change to internal representation only. For
Studio, the new serialized form of the keys is used in urls, to allow
for further migration in the future.

Co-Author: Andy Armstrong <andya@edx.org>
Co-Author: Christina Roberts <christina@edx.org>
Co-Author: David Baumgold <db@edx.org>
Co-Author: Diana Huang <dkh@edx.org>
Co-Author: Don Mitchell <dmitchell@edx.org>
Co-Author: Julia Hansbrough <julia@edx.org>
Co-Author: Nimisha Asthagiri <nasthagiri@edx.org>
Co-Author: Sarina Canelake <sarina@edx.org>

[LMS-2370]

common/djangoapps/user_api/middleware.py

@@ -5,6 +5,7 @@ Adds user's tags to tracking event context.
 from track.contexts import COURSE_REGEX
 from eventtracking import tracker
 from user_api.models import UserCourseTag
+from xmodule.modulestore.locations import SlashSeparatedCourseKey
 
 
 class UserTagsEventContextMiddleware(object):
@@ -19,6 +20,7 @@ class UserTagsEventContextMiddleware(object):
         course_id = None
         if match:
             course_id = match.group('course_id')
+            course_key = SlashSeparatedCourseKey.from_deprecated_string(course_id)
 
         context = {}
 
@@ -29,7 +31,7 @@ class UserTagsEventContextMiddleware(object):
                 context['course_user_tags'] = dict(
                     UserCourseTag.objects.filter(
                         user=request.user.pk,
-                        course_id=course_id
+                        course_id=course_key,
                     ).values_list('key', 'value')
                 )
             else:

common/djangoapps/user_api/models.py

@@ -2,6 +2,8 @@ from django.contrib.auth.models import User
 from django.core.validators import RegexValidator
 from django.db import models
 
+from xmodule_django.models import CourseKeyField
+
 
 class UserPreference(models.Model):
     """A user's preference, stored as generic text to be processed by client"""
@@ -44,7 +46,7 @@ class UserCourseTag(models.Model):
     """
     user = models.ForeignKey(User, db_index=True, related_name="+")
     key = models.CharField(max_length=255, db_index=True)
-    course_id = models.CharField(max_length=255, db_index=True)
+    course_id = CourseKeyField(max_length=255, db_index=True)
     value = models.TextField()
 
     class Meta:  # pylint: disable=missing-docstring

common/djangoapps/user_api/tests/factories.py

@@ -3,6 +3,7 @@ from factory.django import DjangoModelFactory
 from factory import SubFactory
 from student.tests.factories import UserFactory
 from user_api.models import UserPreference, UserCourseTag
+from xmodule.modulestore.locations import SlashSeparatedCourseKey
 
 # Factories don't have __init__ methods, and are self documenting
 # pylint: disable=W0232, C0111
@@ -18,6 +19,6 @@ class UserCourseTagFactory(DjangoModelFactory):
     FACTORY_FOR = UserCourseTag
 
     user = SubFactory(UserFactory)
-    course_id = 'org/course/run'
+    course_id = SlashSeparatedCourseKey('org', 'course', 'run')
     key = None
     value = None

common/djangoapps/user_api/tests/test_user_service.py

@@ -5,6 +5,7 @@ from django.test import TestCase
 
 from student.tests.factories import UserFactory
 from user_api import user_service
+from xmodule.modulestore.locations import SlashSeparatedCourseKey
 
 
 class TestUserService(TestCase):
@@ -13,7 +14,7 @@ class TestUserService(TestCase):
     """
     def setUp(self):
         self.user = UserFactory.create()
-        self.course_id = 'test_org/test_course_number/test_run'
+        self.course_id = SlashSeparatedCourseKey('test_org', 'test_course_number', 'test_run')
         self.test_key = 'test_key'
 
     def test_get_set_course_tag(self):