Merge pull request #6603 from opsmill/pog-refactor-action-schema-IFC-1559

ogenstad · web-flow · commit a6f718ec2310 · 2025-06-03T19:48:40.000+02:00
Replace boolean options with more descriptive dropdowns
diff --git a/backend/infrahub/actions/constants.py b/backend/infrahub/actions/constants.py
@@ -46,6 +46,93 @@ def from_value(cls, value: str) -> BranchScope:
         raise NotImplementedError(f"The defined value {value} doesn't match a branch scope")
 
 
+class MemberAction(Enum):
+    ADD_MEMBER = DropdownChoice(
+        name="add_member",
+        label="Add member",
+        description="Add impacted member to the selected group",
+        color="#86efac",
+    )
+    REMOVE_MEMBER = DropdownChoice(
+        name="remove_member",
+        label="Remove member",
+        description="Remove impacted member from the selected group",
+        color="#fef08a",
+    )
+
+    @classmethod
+    def available_types(cls) -> list[DropdownChoice]:
+        return [cls.__members__[member].value for member in list(cls.__members__)]
+
+    @classmethod
+    def from_value(cls, value: str) -> MemberAction:
+        for member in cls.__members__:
+            if value == cls.__members__[member].value.name:
+                return cls.__members__[member]
+
+        raise NotImplementedError(f"The defined value {value} doesn't match a member action")
+
+
+class MemberUpdate(Enum):
+    ADDED = DropdownChoice(
+        name="added",
+        label="Added",
+        description="Trigger when members are added to this group",
+        color="#86efac",
+    )
+    REMOVED = DropdownChoice(
+        name="removed",
+        label="Removed",
+        description="Trigger when members are removed from this group",
+        color="#fef08a",
+    )
+
+    @classmethod
+    def available_types(cls) -> list[DropdownChoice]:
+        return [cls.__members__[member].value for member in list(cls.__members__)]
+
+    @classmethod
+    def from_value(cls, value: str) -> MemberUpdate:
+        for member in cls.__members__:
+            if value == cls.__members__[member].value.name:
+                return cls.__members__[member]
+
+        raise NotImplementedError(f"The defined value {value} doesn't match a MemberUpdate")
+
+
+class RelationshipMatch(Enum):
+    ADDED = DropdownChoice(
+        name="added",
+        label="Added",
+        description="Check if the selected relationship was added",
+        color="#86efac",
+    )
+    REMOVED = DropdownChoice(
+        name="removed",
+        label="Removed",
+        description="Check if the selected relationship was removed",
+        color="#fef08a",
+    )
+    UPDATED = DropdownChoice(
+        name="updated",
+        label="Updated",
+        description="Check if the selected relationship was updated, added or removed.",
+        color="#e5e7eb",
+    )
+
+    @classmethod
+    def available_types(cls) -> list[DropdownChoice]:
+        return [cls.__members__[member].value for member in list(cls.__members__)]
+
+    @classmethod
+    def from_value(cls, value: str) -> RelationshipMatch:
+        for member in cls.__members__:
+            if value == cls.__members__[member].value.name:
+                return cls.__members__[member]
+
+        raise NotImplementedError(f"The defined value {value} doesn't match a RelationshipMatch")
+
+
 class ValueMatch(Enum):
     VALUE = DropdownChoice(
         name="value",
diff --git a/backend/infrahub/actions/gather.py b/backend/infrahub/actions/gather.py
@@ -46,15 +46,15 @@ async def gather_trigger_action_rules(db: InfrahubDatabase) -> list[ActionTrigge
                                         },
                                         "... on CoreNodeTriggerRelationshipMatch": {
                                             "relationship_name": {"value": None},
-                                            "added": {"value": None},
+                                            "modification_type": {"value": None},
                                             "peer": {"value": None},
                                         },
                                     }
                                 }
                             },
                         },
                         "... on CoreGroupTriggerRule": {
-                            "members_added": {"value": None},
+                            "member_update": {"value": None},
                             "group": {
                                 "node": {
                                     "id": None,
@@ -68,7 +68,7 @@ async def gather_trigger_action_rules(db: InfrahubDatabase) -> list[ActionTrigge
                                 "id": None,
                                 "name": {"value": None},
                                 "... on CoreGroupAction": {
-                                    "add_members": {"value": None},
+                                    "member_action": {"value": None},
                                     "group": {
                                         "node": {
                                             "id": None,
diff --git a/backend/infrahub/actions/models.py b/backend/infrahub/actions/models.py
@@ -23,7 +23,7 @@
     REMOVE_ADD_NODE_FROM_GROUP,
 )
 
-from .constants import BranchScope, ValueMatch
+from .constants import BranchScope, MemberAction, MemberUpdate, RelationshipMatch, ValueMatch
 
 
 class EventGroupMember(BaseModel):
@@ -40,7 +40,7 @@ class CoreGeneratorAction(CoreAction):
 
 
 class CoreGroupAction(CoreAction):
-    add_members: bool
+    member_action: MemberAction
     group_id: str
 
 
@@ -52,7 +52,7 @@ class CoreTriggerRule(BaseModel):
 
 
 class CoreGroupTriggerRule(CoreTriggerRule):
-    members_added: bool
+    member_update: MemberUpdate
     group_id: str
     group_kind: str
 
@@ -70,7 +70,7 @@ class CoreNodeTriggerAttributeMatch(CoreNodeTriggerMatch):
 
 class CoreNodeTriggerRelationshipMatch(CoreNodeTriggerMatch):
     relationship_name: str
-    added: bool
+    modification_type: RelationshipMatch
     peer: str | None
 
 
@@ -135,14 +135,16 @@ def _from_node_trigger(
                         match_related["infrahub.attribute.value_previous"] = match.value_previous or ""
 
             elif isinstance(match, CoreNodeTriggerRelationshipMatch):
-                peer_status = "added" if match.added else "removed"
                 match_related = {
                     "prefect.resource.role": "infrahub.node.relationship_update",
                     "infrahub.field.name": match.relationship_name,
-                    "infrahub.relationship.peer_status": peer_status,
                 }
                 if isinstance(match.peer, str):
                     match_related["infrahub.relationship.peer_id"] = match.peer
+
+                if match.modification_type != RelationshipMatch.UPDATED:
+                    match_related["infrahub.relationship.peer_status"] = match.modification_type.value.name
+
             related_matches.append(match_related)
 
         event_trigger.match_related = related_matches or {}
@@ -164,7 +166,7 @@ def _from_node_trigger(
                 },
             )
         elif isinstance(trigger_rule.action, CoreGroupAction):
-            if trigger_rule.action.add_members:
+            if trigger_rule.action.member_action == MemberAction.ADD_MEMBER:
                 flow = ACTION_ADD_NODE_TO_GROUP
             else:
                 flow = REMOVE_ADD_NODE_FROM_GROUP
@@ -198,7 +200,7 @@ def _from_group_trigger(
     ) -> Self:
         event_trigger = EventTrigger()
 
-        if trigger_rule.members_added:
+        if trigger_rule.member_update == MemberUpdate.ADDED:
             event_trigger.events.add(GroupMemberAddedEvent.event_name)
         else:
             event_trigger.events.add(GroupMemberRemovedEvent.event_name)
diff --git a/backend/infrahub/actions/parsers.py b/backend/infrahub/actions/parsers.py
@@ -2,7 +2,7 @@
 
 from infrahub.core.constants import InfrahubKind
 
-from .constants import BranchScope, ValueMatch
+from .constants import BranchScope, MemberAction, MemberUpdate, RelationshipMatch, ValueMatch
 from .models import (
     CoreAction,
     CoreGeneratorAction,
@@ -35,14 +35,14 @@ def _parse_graphql_node(data: dict[str, Any]) -> CoreTriggerRule | None:
     action = _parse_graphql_action_response(data=data["action"]["node"])
     match typename:
         case "CoreGroupTriggerRule":
-            members_added = data["members_added"]["value"]
+            member_update = MemberUpdate.from_value(data["member_update"]["value"])
             group_id = data["group"]["node"]["id"]
             group_kind = data["group"]["node"]["__typename"]
             return CoreGroupTriggerRule(
                 name=name,
                 branch_scope=branch_scope,
                 action=action,
-                members_added=members_added,
+                member_update=member_update,
                 group_id=group_id,
                 group_kind=group_kind,
                 active=active,
@@ -70,9 +70,9 @@ def _parse_graphql_action_response(data: dict[str, Any]) -> CoreAction:
             generator_id = data["generator"]["node"]["id"]
             return CoreGeneratorAction(generator_id=generator_id)
         case "CoreGroupAction":
-            add_members = data["add_members"]["value"]
+            member_action = MemberAction.from_value(data["member_action"]["value"])
             group_id = data["group"]["node"]["id"]
-            return CoreGroupAction(add_members=add_members, group_id=group_id)
+            return CoreGroupAction(member_action=member_action, group_id=group_id)
 
     raise NotImplementedError(f"{typename} is not a valid CoreAction")
 
@@ -96,7 +96,7 @@ def _parse_node_trigger_matches(data: list[dict[str, Any]]) -> list[CoreNodeTrig
                 matches.append(
                     CoreNodeTriggerRelationshipMatch(
                         relationship_name=node["relationship_name"]["value"],
-                        added=node["added"]["value"],
+                        modification_type=RelationshipMatch.from_value(node["modification_type"]["value"]),
                         peer=node["peer"]["value"],
                     )
                 )
diff --git a/backend/infrahub/actions/schema.py b/backend/infrahub/actions/schema.py
@@ -1,4 +1,11 @@
-from infrahub.actions.constants import BranchScope, NodeAction, ValueMatch
+from infrahub.actions.constants import (
+    BranchScope,
+    MemberAction,
+    MemberUpdate,
+    NodeAction,
+    RelationshipMatch,
+    ValueMatch,
+)
 from infrahub.core.constants import AllowOverrideType, BranchSupportType, InfrahubKind
 from infrahub.core.constants import RelationshipCardinality as Cardinality
 from infrahub.core.constants import RelationshipKind as RelKind
@@ -182,12 +189,13 @@
     inherit_from=[InfrahubKind.ACTION],
     attributes=[
         Attr(
-            name="add_members",
-            kind="Boolean",
+            name="member_action",
+            kind="Dropdown",
             description="Defines if the action should add or remove members from a group when triggered",
+            choices=MemberAction.available_types(),
+            default_value=MemberAction.ADD_MEMBER.value.name,
             unique=False,
             optional=False,
-            default_value=True,
             order_weight=300,
         ),
     ],
@@ -321,13 +329,14 @@
             order_weight=100,
         ),
         Attr(
-            name="added",
-            kind="Boolean",
-            description="Indicates if the relationship was added or removed",
-            unique=False,
+            name="modification_type",
+            kind="Dropdown",
+            description="Indicates if the relationship was added or removed or just updated in any way",
+            choices=RelationshipMatch.available_types(),
+            default_value=RelationshipMatch.ADDED.value.name,
             optional=False,
-            default_value=True,
             order_weight=200,
+            allow_override=AllowOverrideType.NONE,
         ),
         Attr(
             name="peer",
@@ -358,12 +367,12 @@
     inherit_from=[InfrahubKind.TRIGGERRULE],
     attributes=[
         Attr(
-            name="members_added",
-            kind="Boolean",
+            name="member_update",
+            kind="Dropdown",
             description="Indicate if the match should be for when members are added or removed",
-            unique=False,
+            choices=MemberUpdate.available_types(),
+            default_value=MemberUpdate.ADDED.value.name,
             optional=False,
-            default_value=True,
             order_weight=300,
         ),
     ],
diff --git a/backend/infrahub/core/protocols.py b/backend/infrahub/core/protocols.py
@@ -403,12 +403,12 @@ class CoreGraphQLQueryGroup(CoreGroup):
 
 
 class CoreGroupAction(CoreAction):
-    add_members: Boolean
+    member_action: Dropdown
     group: RelationshipManager
 
 
 class CoreGroupTriggerRule(CoreTriggerRule):
-    members_added: Boolean
+    member_update: Dropdown
     group: RelationshipManager
 
 
@@ -440,7 +440,7 @@ class CoreNodeTriggerAttributeMatch(CoreNodeTriggerMatch):
 
 class CoreNodeTriggerRelationshipMatch(CoreNodeTriggerMatch):
     relationship_name: String
-    added: Boolean
+    modification_type: Dropdown
     peer: StringOptional
 
 
diff --git a/backend/tests/unit/actions/test_gather.py b/backend/tests/unit/actions/test_gather.py
@@ -250,7 +250,7 @@ async def test_gather_trigger_gather_trigger_action_rules_node_relationship(
         ],
     )
 
-    relationship_match.added.value = False
+    relationship_match.modification_type.value = "removed"
     await relationship_match.save(db=db)
 
     triggers = await gather_trigger_action_rules(db=db)
@@ -357,7 +357,7 @@ async def test_gather_trigger_gather_trigger_action_rules_group_generators(
     action = automation.actions[0]
     assert action.parameters["generator_definition_id"] == generator_definition.id
 
-    group_trigger.members_added.value = False
+    group_trigger.member_update.value = "removed"
     group_trigger.branch_scope.value = "other_branches"
     await group_trigger.save(db=db)
 
