Add proposed change event when multiple approvals are revoked (#7033)

Author: gmazoyer

backend/infrahub/core/constants/__init__.py

@@ -66,6 +66,7 @@ class EventType(InfrahubStringEnum):
     PROPOSED_CHANGE_APPROVED = f"{EVENT_NAMESPACE}.proposed_change.approved"
     PROPOSED_CHANGE_REJECTED = f"{EVENT_NAMESPACE}.proposed_change.rejected"
     PROPOSED_CHANGE_APPROVAL_REVOKED = f"{EVENT_NAMESPACE}.proposed_change.approval_revoked"
+    PROPOSED_CHANGE_APPROVALS_REVOKED = f"{EVENT_NAMESPACE}.proposed_change.approvals_revoked"
     PROPOSED_CHANGE_REJECTION_REVOKED = f"{EVENT_NAMESPACE}.proposed_change.rejection_revoked"
     PROPOSED_CHANGE_THREAD_CREATED = f"{EVENT_NAMESPACE}.proposed_change_thread.created"
     PROPOSED_CHANGE_THREAD_UPDATED = f"{EVENT_NAMESPACE}.proposed_change_thread.updated"

backend/infrahub/events/__init__.py

@@ -5,6 +5,7 @@
 from .node_action import NodeCreatedEvent, NodeDeletedEvent, NodeUpdatedEvent
 from .proposed_change_action import (
     ProposedChangeApprovalRevokedEvent,
+    ProposedChangeApprovalsRevokedEvent,
     ProposedChangeApprovedEvent,
     ProposedChangeMergedEvent,
     ProposedChangeRejectedEvent,
@@ -32,6 +33,7 @@
     "NodeDeletedEvent",
     "NodeUpdatedEvent",
     "ProposedChangeApprovalRevokedEvent",
+    "ProposedChangeApprovalsRevokedEvent",
     "ProposedChangeApprovedEvent",
     "ProposedChangeMergedEvent",
     "ProposedChangeRejectedEvent",

backend/infrahub/events/proposed_change_action.py

@@ -150,6 +150,28 @@ class ProposedChangeRejectionRevokedEvent(ProposedChangeReviewRevokedEvent):
     event_name: ClassVar[str] = f"{EVENT_NAMESPACE}.proposed_change.rejection_revoked"
 
 
+class ProposedChangeApprovalsRevokedEvent(ProposedChangeEvent):
+    reviewer_accounts: dict[str, str] = Field(
+        default_factory=dict, description="ID to name map of accounts whose approval was revoked"
+    )
+
+    event_name: ClassVar[str] = f"{EVENT_NAMESPACE}.proposed_change.approvals_revoked"
+
+    def get_related(self) -> list[dict[str, str]]:
+        related = super().get_related()
+        for account_id, account_name in self.reviewer_accounts.items():
+            related.append(
+                {
+                    "prefect.resource.id": account_id,
+                    "prefect.resource.role": "infrahub.related.node",
+                    "infrahub.node.kind": InfrahubKind.GENERICACCOUNT,
+                    "infrahub.node.id": account_id,
+                    "infrahub.reviewer.account.name": account_name,
+                }
+            )
+        return related
+
+
 class ProposedChangeThreadEvent(ProposedChangeEvent):
     thread_id: str = Field(..., description="The ID of the thread that was created or updated")
     thread_kind: str = Field(..., description="The name of the thread that was created or updated")

backend/infrahub/graphql/types/event.py

@@ -136,6 +136,13 @@ class Meta:
     payload = Field(GenericScalar, required=True)
 
 
+class ProposedChangeApprovalsRevokedEvent(ObjectType):
+    class Meta:
+        interfaces = (EventNodeInterface,)
+
+    payload = Field(GenericScalar, required=True)
+
+
 class ProposedChangeReviewRequestedEvent(ObjectType):
     class Meta:
         interfaces = (EventNodeInterface,)
@@ -220,6 +227,7 @@ class Meta:
     events.ProposedChangeRejectedEvent.event_name: ProposedChangeReviewEvent,
     events.ProposedChangeRejectionRevokedEvent.event_name: ProposedChangeReviewRevokedEvent,
     events.ProposedChangeReviewRequestedEvent.event_name: ProposedChangeReviewRequestedEvent,
+    events.ProposedChangeApprovalsRevokedEvent.event_name: ProposedChangeApprovalsRevokedEvent,
     events.ProposedChangeMergedEvent.event_name: ProposedChangeMergedEvent,
     events.ProposedChangeThreadCreatedEvent.event_name: ProposedChangeThreadEvent,
     events.ProposedChangeThreadUpdatedEvent.event_name: ProposedChangeThreadEvent,

backend/infrahub/task_manager/event.py

@@ -242,7 +242,11 @@ def _return_event_specifics(self) -> dict[str, Any]:
                     **self._return_proposed_change_event(),
                     **self._return_proposed_change_reviewer_former_decision(),
                 }
-            case "infrahub.proposed_change.review_requested" | "infrahub.proposed_change.merged":
+            case (
+                "infrahub.proposed_change.approvals_revoked"
+                | "infrahub.proposed_change.review_requested"
+                | "infrahub.proposed_change.merged"
+            ):
                 event_specifics = self._return_proposed_change_event()
 
         return event_specifics

docs/docs/reference/infrahub-events.mdx

@@ -369,6 +369,33 @@ For more detailed explanations on how these events are used within Infrahub, see
 | **reviewer_former_decision** | The former decision made by the reviewer |
 <!-- vale on -->
 <!-- vale off -->
+### Proposed Change Approvals Revoked Event
+<!-- vale on -->
+
+**Type**: infrahub.proposed_change.approvals_revoked
+<!-- 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 |
+| **proposed_change_id** | The ID of the proposed change |
+| **proposed_change_name** | The name of the proposed change |
+| **proposed_change_state** | The state of the proposed change |
+| **reviewer_accounts** | ID to name map of accounts whose approval was revoked |
+<!-- vale on -->
+<!-- vale off -->
 ### Proposed Change Approved Event
 <!-- vale on -->