fix(core): simplify trigger name resolution to prevent duplicates

A new settings added `PGHISTORY_SIMPLIFY_TRIGGER_NAMES` default to False

Author: Francesco

pghistory/core.py

@@ -5,12 +5,14 @@
 import copy
 import re
 import sys
+import warnings
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Type, Union
 
 import django
 import pgtrigger
 import pgtrigger.core
 from django.apps import apps
+from django.conf import settings
 from django.db import connections, models
 from django.db.models import sql
 from django.db.models.fields.related import RelatedField
@@ -46,6 +48,26 @@ def quote(self, obj):
 _registered_trackers = {}
 
 
+# avoid default trigger name duplication
+def _simplify_trigger_names() -> bool:
+    """Return True if simplified trigger names are enabled.
+
+    Reads PGHISTORY_SIMPLIFY_TRIGGER_NAMES from Django settings at call time
+    so that override_settings() works correctly in tests and avoids emitting
+    a DeprecationWarning at module import time.
+    """
+    enabled = getattr(settings, "PGHISTORY_SIMPLIFY_TRIGGER_NAMES", False)
+    if not enabled:
+        warnings.warn(
+            "Trigger names like 'update_update' are deprecated. "
+            "Set PGHISTORY_SIMPLIFY_TRIGGER_NAMES=True to enable simplified names. "
+            "This will become the default in a future release.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+    return enabled
+
+
 class Tracker:
     """For tracking an event when a condition happens on a model."""
 
@@ -107,9 +129,20 @@ def __init__(
         self.condition = condition if condition is not constants.UNSET else self.condition
         self.operation = operation or self.operation
         self.row = row or self.row
-        self.trigger_name = trigger_name or self.trigger_name or f"{self.label}_{self.operation}"
         self.level = level if level is not None else self.level
 
+        simplify = _simplify_trigger_names()
+
+        if trigger_name:
+            self.trigger_name = trigger_name
+        elif self.trigger_name:
+            self.trigger_name = self.trigger_name
+        else:
+            if simplify and self.label == self.operation:
+                self.trigger_name = str(self.operation)
+            else:
+                self.trigger_name = f"{self.label}_{self.operation}"
+
         if self.condition is constants.UNSET:
             self.condition = pgtrigger.AnyChange() if self.operation == pgtrigger.Update else None
 

pghistory/tests/test_core.py

@@ -8,6 +8,7 @@
 import pytest
 from django.apps import apps
 from django.db import DatabaseError, models
+from django.test.utils import override_settings
 from django.utils import timezone
 
 import pghistory
@@ -879,3 +880,38 @@ def test_conditional_statement_trigger():
     first = test_models.CondStatement.objects.order_by("id").first()
     test_models.CondStatement.objects.filter(id=first.id).update(id=first.id + 1000, int_field1=-1)
     assert test_models.CondStatementEvent.objects.all().count() == 15
+
+
+@pytest.mark.django_db
+def test_warning_when_simplifying_trigger_names_disabled():
+    import warnings
+
+    with override_settings(PGHISTORY_SIMPLIFY_TRIGGER_NAMES=False):
+        with warnings.catch_warnings(record=True) as caught:
+            warnings.simplefilter("always")
+            # Instantiating UpdateEvent triggers _simplify_trigger_names() internally
+            pghistory.core.UpdateEvent()
+
+        matching = [
+            w
+            for w in caught
+            if issubclass(w.category, DeprecationWarning) and "Trigger names" in str(w.message)
+        ]
+        assert matching, "Expected a DeprecationWarning about trigger names"
+
+
+@pytest.mark.django_db
+def test_no_warning_when_simplifying_trigger_names_enabled():
+    import warnings
+
+    with override_settings(PGHISTORY_SIMPLIFY_TRIGGER_NAMES=True):
+        with warnings.catch_warnings(record=True) as caught:
+            warnings.simplefilter("always")
+            pghistory.core.UpdateEvent()
+
+        matching = [
+            w
+            for w in caught
+            if issubclass(w.category, DeprecationWarning) and "Trigger names" in str(w.message)
+        ]
+        assert not matching, "Expected no DeprecationWarning when simplification is enabled"