refactor: rename MaintainersEdit to MaintainerOverlay, PackageEdit to PackageOverlay

Author: adekoder

src/shared/listeners/cache_suggestions.py

@@ -16,8 +16,8 @@
 from shared.models.cve import AffectedProduct, Metric, Reference, Version
 from shared.models.linkage import (
     CVEDerivationClusterProposal,
-    MaintainersEdit,
-    PackageEdit,
+    MaintainerOverlay,
+    PackageOverlay,
     ReferenceOverlay,
 )
 from shared.models.nix_evaluation import get_major_channel
@@ -112,8 +112,8 @@ class Reference(BaseModel):
     categorized_references: CategorizedReferences
 
 
-def apply_package_edits(
-    packages: dict, edits: list[PackageEdit]
+def apply_package_overlays(
+    packages: dict, edits: list[PackageOverlay]
 ) -> dict[str, CachedSuggestion.Package]:
     """
     Returns the packages dict with user-supplied package edits applied.
@@ -122,7 +122,7 @@ def apply_package_edits(
     to_skip = {
         edit.package_attribute
         for edit in edits
-        if edit.edit_type == PackageEdit.EditType.REMOVE
+        if edit.edit_type == MaintainerOverlay.Type.REMOVE
     }
 
     return {attr: data for attr, data in packages.items() if attr not in to_skip}
@@ -214,11 +214,11 @@ def cache_new_suggestions(suggestion: CVEDerivationClusterProposal) -> None:
 
     prefetched_metrics = Metric.objects.filter(container__cve=suggestion.cve)
     original_packages = channel_structure(all_versions, derivations)
-    maintainers_edits = list(
-        suggestion.maintainers_edits.select_related("maintainer").all()
+    maintainer_overlays = list(
+        suggestion.maintainer_overlays.select_related("maintainer").all()
     )
-    package_edits = list(suggestion.package_edits.all())
-    packages = apply_package_edits(original_packages, package_edits)
+    package_overlays = list(suggestion.package_overlays.all())
+    packages = apply_package_overlays(original_packages, package_overlays)
 
     only_relevant_data = CachedSuggestion(
         pk=suggestion.pk,
@@ -231,7 +231,7 @@ def cache_new_suggestions(suggestion: CVEDerivationClusterProposal) -> None:
         original_packages=packages,
         packages=packages,
         metrics=[to_dict(m) for m in prefetched_metrics],
-        categorized_maintainers=categorize_maintainers(packages, maintainers_edits),
+        categorized_maintainers=categorize_maintainers(packages, maintainer_overlays),
         categorized_references=categorize_references(
             suggestion.references, list(suggestion.reference_overlays.all())
         ),
@@ -397,7 +397,7 @@ def parse_drv_name(name: str) -> tuple[str, str]:
 
 
 def maintainers_list(
-    packages: dict, edits: list[MaintainersEdit]
+    packages: dict, edits: list[MaintainerOverlay]
 ) -> list[CachedSuggestion.Maintainer]:
     """
     Returns a deduplicated list (by GitHub ID) of all the maintainers, as dicts,
@@ -411,12 +411,12 @@ def maintainers_list(
     to_skip_or_seen: set[int] = {
         m.maintainer.github_id
         for m in edits
-        if m.edit_type == MaintainersEdit.EditType.REMOVE
+        if m.edit_type == MaintainerOverlay.Type.REMOVE
     }
     to_add: list[CachedSuggestion.Maintainer] = [
         CachedSuggestion.Maintainer.model_validate(to_dict(m.maintainer))
         for m in edits
-        if m.edit_type == MaintainersEdit.EditType.ADD
+        if m.edit_type == MaintainerOverlay.Type.ADD
     ]
 
     maintainers: list[CachedSuggestion.Maintainer] = list()
@@ -473,7 +473,7 @@ def categorize_references(
 
 def categorize_maintainers(
     packages: dict[str, CachedSuggestion.Package],
-    maintainers_edits: list[MaintainersEdit],
+    maintainer_overlays: list[MaintainerOverlay],
 ) -> CachedSuggestion.CategorizedMaintainers:
     """
     Categorize maintainers associated to the packages of a suggestion.
@@ -490,10 +490,10 @@ def categorize_maintainers(
     removed_github_ids = set()
     added_maintainers = []
 
-    for edit in maintainers_edits:
-        if edit.edit_type == MaintainersEdit.EditType.REMOVE:
+    for edit in maintainer_overlays:
+        if edit.edit_type == MaintainerOverlay.Type.REMOVE:
             removed_github_ids.add(edit.maintainer.github_id)
-        elif edit.edit_type == MaintainersEdit.EditType.ADD:
+        elif edit.edit_type == MaintainerOverlay.Type.ADD:
             added_maintainers.append(
                 CachedSuggestion.Maintainer.model_validate(to_dict(edit.maintainer))
             )

src/shared/logs/fetchers.py

@@ -25,8 +25,8 @@
 )
 from shared.models import (
     CVEDerivationClusterProposalStatusEvent,  # type: ignore
-    MaintainersEditEvent,  # type: ignore
-    PackageEditEvent,  # type: ignore
+    MaintainerOverlayEvent,  # type: ignore
+    PackageOverlayEvent,  # type: ignore
     ReferenceOverlayEvent,  # type: ignore
 )
 from shared.models.linkage import CVEDerivationClusterProposal
@@ -87,7 +87,7 @@ def fetch_suggestion_events(
         )
 
     package_qs = _annotate_username(
-        PackageEditEvent.objects.select_related("pgh_context").filter(
+        PackageOverlayEvent.objects.select_related("pgh_context").filter(
             suggestion_id__in=suggestion_ids
         )
     )
@@ -103,9 +103,9 @@ def fetch_suggestion_events(
         )
 
     maintainer_qs = _annotate_username(
-        MaintainersEditEvent.objects.select_related("pgh_context", "maintainer").filter(
-            suggestion_id__in=suggestion_ids
-        )
+        MaintainerOverlayEvent.objects.select_related(
+            "pgh_context", "maintainer"
+        ).filter(suggestion_id__in=suggestion_ids)
     )
     for m_event in maintainer_qs.iterator():
         result[m_event.suggestion_id].append(

src/shared/migrations/0077_rename_maintainersedit_and_packageedit_and_more.py

@@ -0,0 +1,76 @@
+# Generated by Django 5.2.9 on 2026-03-25 19:03
+
+import pgtrigger.compiler
+import pgtrigger.migrations
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('pghistory', '0007_auto_20250421_0444'),
+        ('shared', '0076_referenceoverlay_referenceoverlayevent_and_more'),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name='MaintainersEdit',
+            new_name='MaintainerOverlay',
+        ),
+        migrations.RenameModel(
+            old_name='PackageEdit',
+            new_name='PackageOverlay',
+        ),
+        migrations.AlterField(
+            model_name='maintaineroverlay',
+            name='suggestion',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='maintainer_overlays', to='shared.cvederivationclusterproposal'),
+        ),
+        migrations.AlterField(
+            model_name='packageoverlay',
+            name='suggestion',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='package_overlays', to='shared.cvederivationclusterproposal'),
+        ),
+        migrations.RenameModel(
+            old_name='MaintainersEditEvent',
+            new_name='MaintainerOverlayEvent',
+        ),
+        migrations.RenameModel(
+            old_name='PackageEditEvent',
+            new_name='PackageOverlayEvent',
+        ),
+        pgtrigger.migrations.RemoveTrigger(
+            model_name='maintaineroverlayevent',
+            name='append_only',
+        ),
+        pgtrigger.migrations.RemoveTrigger(
+            model_name='packageoverlayevent',
+            name='append_only',
+        ),
+        pgtrigger.migrations.AddTrigger(
+            model_name='maintaineroverlayevent',
+            trigger=pgtrigger.compiler.Trigger(name='append_only', sql=pgtrigger.compiler.UpsertTriggerSql(func="RAISE EXCEPTION 'pgtrigger: Cannot update or delete rows from % table', TG_TABLE_NAME;", hash='14c983337ff6aba25adee63596ad595ebc7addc0', operation='UPDATE OR DELETE', pgid='pgtrigger_append_only_57b9c', table='shared_maintaineroverlayevent', when='BEFORE')),
+        ),
+        pgtrigger.migrations.AddTrigger(
+            model_name='packageoverlayevent',
+            trigger=pgtrigger.compiler.Trigger(name='append_only', sql=pgtrigger.compiler.UpsertTriggerSql(func="RAISE EXCEPTION 'pgtrigger: Cannot update or delete rows from % table', TG_TABLE_NAME;", hash='f805545d1a2028c9aa53955c61c9f2df72d9e44b', operation='UPDATE OR DELETE', pgid='pgtrigger_append_only_c0ffc', table='shared_packageoverlayevent', when='BEFORE')),
+        ),
+
+         migrations.RemoveConstraint(
+            model_name='maintaineroverlay',
+            name='unique_maintainer_edit_per_suggestion',
+        ),
+        migrations.RemoveConstraint(
+            model_name='packageoverlay',
+            name='unique_package_edit_per_suggestion',
+        ),
+        migrations.AddConstraint(
+            model_name='maintaineroverlay',
+            constraint=models.UniqueConstraint(fields=('suggestion', 'maintainer'), name='unique_maintainer_overlay_per_suggestion'),
+        ),
+        migrations.AddConstraint(
+            model_name='packageoverlay',
+            constraint=models.UniqueConstraint(fields=('suggestion', 'package_attribute'), name='unique_package_overlay_per_suggestion'),
+        ),
+    ]

src/shared/models/__init__.py

@@ -4,16 +4,16 @@
 from .linkage import (
     CVEDerivationClusterProposal,
     DerivationClusterProposalLink,
-    MaintainersEdit,
-    PackageEdit,
+    MaintainerOverlay,
+    PackageOverlay,
     ProvenanceFlags,
 )
 from .nix_evaluation import *
 
 __all__ = [
     "CVEDerivationClusterProposal",
-    "MaintainersEdit",
-    "PackageEdit",
+    "MaintainerOverlay",
+    "PackageOverlay",
     "ProvenanceFlags",
     "DerivationClusterProposalLink",
 ]