feat: skip the history object creation

This change will add the modifications in which the history object
is created only if the model instance is changed not the otherwise.

PROD-3525

course_discovery/apps/course_metadata/admin.py

@@ -10,6 +10,7 @@
 from django.utils.translation import gettext_lazy as _
 from django_object_actions import DjangoObjectActions
 from parler.admin import TranslatableAdmin
+from simple_history.admin import SimpleHistoryAdmin
 from waffle import get_waffle_flag_model  # lint-amnesty, pylint: disable=invalid-django-waffle-import
 
 from course_discovery.apps.course_metadata.algolia_forms import SearchDefaultResultsConfigurationForm
@@ -122,7 +123,7 @@ class ProductValueAdmin(admin.ModelAdmin):
 
 
 @admin.register(Course)
-class CourseAdmin(DjangoObjectActions, admin.ModelAdmin):
+class CourseAdmin(DjangoObjectActions, SimpleHistoryAdmin):
     form = CourseAdminForm
     list_display = ('uuid', 'key', 'key_for_reruns', 'title', 'draft',)
     list_filter = ('partner', 'product_source')
@@ -217,7 +218,7 @@ class CourseEditorAdmin(admin.ModelAdmin):
 
 
 @admin.register(CourseEntitlement)
-class CourseEntitlementAdmin(admin.ModelAdmin):
+class CourseEntitlementAdmin(SimpleHistoryAdmin):
     list_display = ['course', 'get_course_key', 'mode', 'draft']
 
     def get_course_key(self, obj):
@@ -262,7 +263,7 @@ class CourseTypeAdmin(admin.ModelAdmin):
 
 
 @admin.register(CourseRun)
-class CourseRunAdmin(admin.ModelAdmin):
+class CourseRunAdmin(SimpleHistoryAdmin):
     inlines = (SeatInline,)
     list_display = ('uuid', 'key', 'external_key', 'title', 'status', 'draft',)
     list_filter = (
@@ -351,7 +352,7 @@ class ProgramLocationRestrictionAdmin(admin.ModelAdmin):
 
 
 @admin.register(Program)
-class ProgramAdmin(DjangoObjectActions, admin.ModelAdmin):
+class ProgramAdmin(DjangoObjectActions, SimpleHistoryAdmin):
     form = ProgramAdminForm
     list_display = ('id', 'uuid', 'title', 'type', 'partner', 'status', 'hidden')
     list_filter = ('partner', 'type', 'product_source', 'status', ProgramEligibilityFilter, 'hidden')
@@ -490,7 +491,7 @@ class ProgramTypeAdmin(TranslatableAdmin):
 
 
 @admin.register(Seat)
-class SeatAdmin(admin.ModelAdmin):
+class SeatAdmin(SimpleHistoryAdmin):
     list_display = ('course_run', 'type', 'draft', 'upgrade_deadline_override',)
     raw_id_fields = ('draft_version',)
     readonly_fields = ('_upgrade_deadline',)

course_discovery/apps/course_metadata/management/commands/tests/test_deduplicate_course_metadata_history.py

@@ -30,13 +30,16 @@ def _assert_normal_case_pre_command(self):
         """
         Verify the history count before running the clean-up command.
         """
-        # Induce a few history records:
-        # - 2 updates for courserun1
-        # - 0 updates for courserun2
-        # - 3 updates for courserun3
+        self.courserun1.title = 'test title'
         self.courserun1.save()
+
+        self.courserun3.title = 'test title'
         self.courserun3.save()
+
+        self.courserun1.title = 'test title again'
         self.courserun1.save()
+
+        self.courserun3.title = 'test title again'
         self.courserun3.save()
         factories.CourseRunFactory()  # Toss in a fourth create to mix things up.
         self.courserun3.save()
@@ -48,9 +51,9 @@ def _assert_normal_case_pre_command(self):
         # Ensure that there are multiple history records for each course run.  For each
         # course run, there should be 2 (baseline) + the amount we added at the
         # beginning of this test * 2 for the double save for enterprise inclusion boolean
-        assert courserun1_count_initial == ((2 + 2) * 2)
-        assert courserun2_count_initial == ((2 + 0) * 2)
-        assert courserun3_count_initial == ((2 + 3) * 2)
+        assert courserun1_count_initial == 3
+        assert courserun2_count_initial == 1
+        assert courserun3_count_initial == 3
 
     def _assert_normal_case_post_command(self):
         """
@@ -61,9 +64,10 @@ def _assert_normal_case_post_command(self):
         courserun3_count_final = CourseRun.history.filter(id=self.courserun3.id).count()  # pylint: disable=no-member
 
         # Ensure that the only history records left are the 3 original creates.
-        assert courserun1_count_final == 1
+        # count remains same because all history instances are unique.
+        assert courserun1_count_final == 3
         assert courserun2_count_final == 1
-        assert courserun3_count_final == 1
+        assert courserun3_count_final == 3
 
     def test_normal_case(self):
         """