Merge pull request #28280 from edx/mikix/override-notes

feat: add note field to course waffle overrides

openedx/core/djangoapps/waffle_utils/admin.py

@@ -22,7 +22,7 @@ class WaffleFlagCourseOverrideAdmin(KeyedConfigurationModelAdmin):
     search_fields = ['waffle_flag', 'course_id']
     fieldsets = (
         (None, {
-            'fields': ('waffle_flag', 'course_id', 'override_choice', 'enabled'),
+            'fields': ('waffle_flag', 'course_id', 'note', 'override_choice', 'enabled'),
             'description': 'Enter a valid course id and an existing waffle flag. The waffle flag name is not validated.'
         }),
     )

openedx/core/djangoapps/waffle_utils/migrations/0002_waffleflagcourseoverridemodel_note.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.2.24 on 2021-07-26 18:14
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('waffle_utils', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='waffleflagcourseoverridemodel',
+            name='note',
+            field=models.TextField(blank=True, help_text='e.g. why this exists and when/if it can be dropped'),
+        ),
+    ]

openedx/core/djangoapps/waffle_utils/models.py

@@ -2,8 +2,7 @@
 Models for configuring waffle utils.
 """
 
-from django.db.models import CharField
-from django.utils.encoding import python_2_unicode_compatible
+from django.db.models import CharField, TextField
 from django.utils.translation import ugettext_lazy as _
 from model_utils import Choices
 from opaque_keys.edx.django.models import CourseKeyField
@@ -12,7 +11,6 @@ from config_models.models import ConfigurationModel
 from openedx.core.lib.cache_utils import request_cached
 
 
-@python_2_unicode_compatible
 class WaffleFlagCourseOverrideModel(ConfigurationModel):
     """
     Used to force a waffle flag on or off for a course.
@@ -28,6 +26,7 @@ class WaffleFlagCourseOverrideModel(ConfigurationModel):
     waffle_flag = CharField(max_length=255, db_index=True)
     course_id = CourseKeyField(max_length=255, db_index=True)
     override_choice = CharField(choices=OVERRIDE_CHOICES, default=OVERRIDE_CHOICES.on, max_length=3)
+    note = TextField(blank=True, help_text='e.g. why this exists and when/if it can be dropped')
 
     @classmethod
     @request_cached()
@@ -56,10 +55,10 @@ class WaffleFlagCourseOverrideModel(ConfigurationModel):
         return cls.ALL_CHOICES.unset
 
     class Meta:
-        app_label = "waffle_utils"
+        app_label = 'waffle_utils'
         verbose_name = 'Waffle flag course override'
         verbose_name_plural = 'Waffle flag course overrides'
 
     def __str__(self):
-        enabled_label = "Enabled" if self.enabled else "Not Enabled"
-        return f"Course '{str(self.course_id)}': Persistent Grades {enabled_label}"
+        enabled_label = 'Enabled' if self.enabled else 'Not Enabled'
+        return f'Course {str(self.course_id)}: Waffle Override {enabled_label}'