Add branch migrated evemt

Author: gmazoyer

backend/infrahub/core/branch/tasks.py

@@ -33,7 +33,13 @@
 from infrahub.core.validators.models.validate_migration import SchemaValidateMigrationData
 from infrahub.core.validators.tasks import schema_validate_migrations
 from infrahub.dependencies.registry import get_component_registry
-from infrahub.events.branch_action import BranchCreatedEvent, BranchDeletedEvent, BranchMergedEvent, BranchRebasedEvent
+from infrahub.events.branch_action import (
+    BranchCreatedEvent,
+    BranchDeletedEvent,
+    BranchMergedEvent,
+    BranchMigratedEvent,
+    BranchRebasedEvent,
+)
 from infrahub.events.models import EventMeta, InfrahubEvent
 from infrahub.events.node_action import get_node_event
 from infrahub.exceptions import BranchNotFoundError, ValidationError
@@ -236,6 +242,14 @@ async def migrate_branch(branch: str, context: InfrahubContext, send_events: boo
     obj.graph_version = GRAPH_VERSION
     await obj.save(db=db)
 
+    if send_events:
+        event_service = await get_event_service()
+        await event_service.send(
+            BranchMigratedEvent(
+                branch_name=obj.name, branch_id=str(obj.uuid), meta=EventMeta(branch=obj, context=context)
+            )
+        )
+
 
 @flow(name="branch-merge", flow_run_name="Merge branch {branch} into main")
 async def merge_branch(branch: str, context: InfrahubContext, proposed_change_id: str | None = None) -> None:

backend/infrahub/core/constants/__init__.py

@@ -50,6 +50,7 @@ class EventType(InfrahubStringEnum):
     BRANCH_CREATED = f"{EVENT_NAMESPACE}.branch.created"
     BRANCH_DELETED = f"{EVENT_NAMESPACE}.branch.deleted"
     BRANCH_MERGED = f"{EVENT_NAMESPACE}.branch.merged"
+    BRANCH_MIGRATED = f"{EVENT_NAMESPACE}.branch.migrated"
     BRANCH_REBASED = f"{EVENT_NAMESPACE}.branch.rebased"
 
     SCHEMA_UPDATED = f"{EVENT_NAMESPACE}.schema.updated"

backend/infrahub/events/branch_action.py

@@ -109,7 +109,7 @@ class BranchRebasedEvent(InfrahubEvent):
 
     event_name: ClassVar[str] = f"{EVENT_NAMESPACE}.branch.rebased"
 
-    branch_id: str = Field(..., description="The ID of the mutated node")
+    branch_id: str = Field(..., description="The ID of the branch")
     branch_name: str = Field(..., description="The name of the branch")
 
     def get_resource(self) -> dict[str, str]:
@@ -128,3 +128,29 @@ def get_messages(self) -> list[InfrahubMessage]:
             RefreshRegistryRebasedBranch(branch=self.branch_name),
         ]
         return events
+
+
+class BranchMigratedEvent(InfrahubEvent):
+    """Event generated when a branch has been migrated"""
+
+    event_name: ClassVar[str] = f"{EVENT_NAMESPACE}.branch.migrated"
+
+    branch_id: str = Field(..., description="The ID of the branch")
+    branch_name: str = Field(..., description="The name of the branch")
+
+    def get_resource(self) -> dict[str, str]:
+        return {
+            "prefect.resource.id": f"infrahub.branch.{self.branch_name}",
+            "infrahub.branch.id": self.branch_id,
+            "infrahub.branch.name": self.branch_name,
+        }
+
+    def get_messages(self) -> list[InfrahubMessage]:
+        events: list[InfrahubMessage] = [
+            # EventBranchMigrated(
+            #     branch=self.branch,
+            #     meta=self.get_message_meta(),
+            # ),
+            RefreshRegistryRebasedBranch(branch=self.branch_name),
+        ]
+        return events

backend/infrahub/task_manager/event.py

@@ -160,6 +160,9 @@ def _return_branch_merged(self) -> dict[str, Any]:
     def _return_branch_rebased(self) -> dict[str, Any]:
         return {"rebased_branch": self._get_branch_name_from_resource()}
 
+    def _return_branch_migrated(self) -> dict[str, Any]:
+        return {"migrated_branch": self._get_branch_name_from_resource()}
+
     def _return_group_event(self) -> dict[str, Any]:
         members = []
         ancestors = []
@@ -228,6 +231,8 @@ def _return_event_specifics(self) -> dict[str, Any]:
                 event_specifics = self._return_branch_deleted()
             case "infrahub.branch.merged":
                 event_specifics = self._return_branch_merged()
+            case "infrahub.branch.migrated":
+                event_specifics = self._return_branch_migrated()
             case "infrahub.branch.rebased":
                 event_specifics = self._return_branch_rebased()
             case "infrahub.group.member_added" | "infrahub.group.member_removed":

backend/infrahub/task_manager/models.py

@@ -141,6 +141,13 @@ def add_event_type_filter(
             if branches:
                 self.resource = EventResourceFilter(labels=ResourceSpecification({"infrahub.branch.name": branches}))
 
+        if branch_migrated := event_type_filter.get("branch_migrated"):
+            branches = branch_migrated.get("branches") or []
+            if "infrahub.branch.created" not in event_type:
+                event_type.append("infrahub.branch.migrated")
+            if branches:
+                self.resource = EventResourceFilter(labels=ResourceSpecification({"infrahub.branch.name": branches}))
+
         if branch_rebased := event_type_filter.get("branch_rebased"):
             branches = branch_rebased.get("branches") or []
             if "infrahub.branch.created" not in event_type:

docs/docs/reference/infrahub-events.mdx

@@ -164,6 +164,32 @@ For more detailed explanations on how these events are used within Infrahub, see
 | **proposed_change_id** | The ID of the proposed change that merged this branch if applicable |
 <!-- vale on -->
 <!-- vale off -->
+### Branch Migrated Event
+<!-- vale on -->
+
+**Type**: infrahub.branch.migrated
+**Description**: Event generated when a branch has been migrated
+<!-- vale off -->
+**Uses node_kind filter for webhooks**: `false`
+<!-- vale on -->
+
+<!-- vale off -->
+| Key | Description |
+|-----|-------------|
+| **meta.branch** | The branch on which originate this event |
+| **meta.request_id** | N/A |
+| **meta.account_id** | The ID of the account triggering this event |
+| **meta.initiator_id** | The worker identity of the initial sender of this message |
+| **meta.context** | The context used when originating this event |
+| **meta.level** | N/A |
+| **meta.has_children** | Indicates if this event might potentially have child events under it. |
+| **meta.id** | UUID of the event |
+| **meta.parent** | The UUID of the parent event if applicable |
+| **meta.ancestors** | Any event used to trigger this event |
+| **branch_id** | The ID of the branch |
+| **branch_name** | The name of the branch |
+<!-- vale on -->
+<!-- vale off -->
 ### Branch Rebased Event
 <!-- vale on -->
 
@@ -186,7 +212,7 @@ For more detailed explanations on how these events are used within Infrahub, see
 | **meta.id** | UUID of the event |
 | **meta.parent** | The UUID of the parent event if applicable |
 | **meta.ancestors** | Any event used to trigger this event |
-| **branch_id** | The ID of the mutated node |
+| **branch_id** | The ID of the branch |
 | **branch_name** | The name of the branch |
 <!-- vale on -->
 ## Group events