Refactor branch defined triggers

Author: ogenstad

backend/infrahub/trigger/models.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from datetime import timedelta
-from enum import Enum
+from enum import Enum, StrEnum
 from typing import TYPE_CHECKING, Any
 
 from prefect.events.actions import RunDeployment
@@ -19,6 +19,16 @@
     from uuid import UUID
 
 
+class TriggerComparison(StrEnum):
+    MATCH = "match"  # Expected trigger and actual trigger is identical
+    REFRESH = "refresh"  # The branch parameters doesn't match, the hash does, refresh in Prefect but don't run triggers
+    UPDATE = "update"  # Neither branch or other data points match, update in Prefect and run triggers
+
+    @property
+    def update_prefect(self) -> bool:
+        return self in {TriggerComparison.REFRESH, TriggerComparison.UPDATE}
+
+
 class TriggerSetupReport(BaseModel):
     created: list[TriggerDefinition] = Field(default_factory=list)
     updated: list[TriggerDefinition] = Field(default_factory=list)
@@ -29,6 +39,12 @@ class TriggerSetupReport(BaseModel):
     def in_use_count(self) -> int:
         return len(self.created + self.updated + self.unchanged)
 
+    def add_with_comparison(self, trigger: TriggerDefinition, comparison: TriggerComparison) -> None:
+        if comparison == TriggerComparison.MATCH:
+            self.unchanged.append(trigger)
+        elif comparison in {TriggerComparison.UPDATE, TriggerComparison.REFRESH}:
+            self.updated.append(trigger)
+
 
 class TriggerType(str, Enum):
     ACTION_TRIGGER_RULE = "action_trigger_rule"

backend/infrahub/trigger/setup.py

@@ -10,15 +10,17 @@
 
 from infrahub import lock
 from infrahub.database import InfrahubDatabase
-from infrahub.trigger.models import TriggerDefinition
+from infrahub.trigger.models import TriggerBranchDefinition, TriggerDefinition
 
-from .models import TriggerSetupReport, TriggerType
+from .models import TriggerComparison, TriggerSetupReport, TriggerType
 
 if TYPE_CHECKING:
     from uuid import UUID
 
 
-def compare_automations(target: AutomationCore, existing: Automation) -> bool:
+def compare_automations(
+    target: AutomationCore, existing: Automation, trigger_type: TriggerType | None
+) -> TriggerComparison:
     """Compare an AutomationCore with an existing Automation object to identify if they are identical or not
 
     Return True if the target is identical to the existing automation
@@ -27,6 +29,11 @@ def compare_automations(target: AutomationCore, existing: Automation) -> bool:
     target_dump = target.model_dump(exclude_defaults=True, exclude_none=True)
     existing_dump = existing.model_dump(exclude_defaults=True, exclude_none=True, exclude={"id"})
 
+    if not trigger_type or (trigger_type and not isinstance(trigger_type, TriggerBranchDefinition)):
+        if target_dump == existing_dump:
+            return TriggerComparison.MATCH
+        return TriggerComparison.UPDATE
+
     return target_dump == existing_dump
 
 
@@ -63,10 +70,8 @@ async def setup_triggers(
 
     report = TriggerSetupReport()
 
-    if trigger_type:
-        log.debug(f"Setting up triggers of type {trigger_type.value}")
-    else:
-        log.debug("Setting up all triggers")
+    trigger_log_message = f"triggers of type {trigger_type.value}" if trigger_type else "all triggers"
+    log.debug(f"Setting up {trigger_log_message}")
 
     # -------------------------------------------------------------
     # Retrieve existing Deployments and Automation from the server
@@ -80,16 +85,14 @@ async def setup_triggers(
     }
     deployments_mapping: dict[str, UUID] = {name: item.id for name, item in deployments.items()}
 
-    # If a trigger type is provided, narrow down the list of existing triggers to know which one to delete
-    existing_automations: dict[str, Automation] = {}
+    existing_automations = {item.name: item for item in await client.read_automations()}
     if trigger_type:
+        # If a trigger type is provided, narrow down the list of existing triggers to know which one to delete
         existing_automations = {
-            item.name: item
-            for item in await client.read_automations()
-            if item.name.startswith(f"{trigger_type.value}::")
+            automation_name: automation
+            for automation_name, automation in existing_automations.items()
+            if automation_name.startswith(f"{trigger_type.value}::")
         }
-    else:
-        existing_automations = {item.name: item for item in await client.read_automations()}
 
     trigger_names = [trigger.generate_name() for trigger in triggers]
     automation_names = list(existing_automations.keys())
@@ -115,12 +118,13 @@ async def setup_triggers(
         existing_automation = existing_automations.get(trigger.generate_name(), None)
 
         if existing_automation:
-            if force_update or not compare_automations(target=automation, existing=existing_automation):
+            trigger_comparison = compare_automations(
+                target=automation, existing=existing_automation, trigger_type=trigger_type
+            )
+            if force_update or trigger_comparison.update_prefect:
                 await client.update_automation(automation_id=existing_automation.id, automation=automation)
                 log.info(f"{trigger.generate_name()} Updated")
-                report.updated.append(trigger)
-            else:
-                report.unchanged.append(trigger)
+            report.add_with_comparison(trigger, trigger_comparison)
         else:
             await client.create_automation(automation=automation)
             log.info(f"{trigger.generate_name()} Created")
@@ -145,15 +149,9 @@ async def setup_triggers(
             else:
                 raise
 
-    if trigger_type:
-        log.info(
-            f"Processed triggers of type {trigger_type.value}: "
-            f"{len(report.created)} created, {len(report.updated)} updated, {len(report.unchanged)} unchanged, {len(report.deleted)} deleted"
-        )
-    else:
-        log.info(
-            f"Processed all triggers: "
-            f"{len(report.created)} created, {len(report.updated)} updated, {len(report.unchanged)} unchanged, {len(report.deleted)} deleted"
-        )
+    log.info(
+        f"Processed {trigger_log_message}: "
+        f"{len(report.created)} created, {len(report.updated)} updated, {len(report.unchanged)} unchanged, {len(report.deleted)} deleted"
+    )
 
     return report