infrahub-server 1.5.0b0__py3-none-any.whl → 1.5.0b2__py3-none-any.whl

infrahub/core/validators/determiner.py

@@ -10,6 +10,7 @@ from infrahub.core.schema.attribute_parameters import AttributeParameters
 from infrahub.core.schema.relationship_schema import RelationshipSchema
 from infrahub.core.schema.schema_branch import SchemaBranch
 from infrahub.core.validators import CONSTRAINT_VALIDATOR_MAP
+from infrahub.exceptions import SchemaNotFoundError
 from infrahub.log import get_logger
 
 if TYPE_CHECKING:
@@ -81,7 +82,17 @@ class ConstraintValidatorDeterminer:
 
     async def _get_all_property_constraints(self) -> list[SchemaUpdateConstraintInfo]:
         constraints: list[SchemaUpdateConstraintInfo] = []
-        for schema in self.schema_branch.get_all().values():
+        schemas = list(self.schema_branch.get_all(duplicate=False).values())
+        # added here to check their uniqueness constraints
+        try:
+            schemas.append(self.schema_branch.get_node(name="SchemaAttribute", duplicate=False))
+        except SchemaNotFoundError:
+            pass
+        try:
+            schemas.append(self.schema_branch.get_node(name="SchemaRelationship", duplicate=False))
+        except SchemaNotFoundError:
+            pass
+        for schema in schemas:
             constraints.extend(await self._get_property_constraints_for_one_schema(schema=schema))
         return constraints
 

infrahub/core/validators/relationship/peer.py

@@ -22,7 +22,7 @@ class RelationshipPeerUpdateValidatorQuery(RelationshipSchemaValidatorQuery):
     name = "relationship_constraints_peer_validator"
 
     async def query_init(self, db: InfrahubDatabase, **kwargs: dict[str, Any]) -> None:  # noqa: ARG002
-        peer_schema = db.schema.get(name=self.relationship_schema.peer, branch=self.branch)
+        peer_schema = db.schema.get(name=self.relationship_schema.peer, branch=self.branch, duplicate=False)
         allowed_peer_kinds = [peer_schema.kind]
         if isinstance(peer_schema, GenericSchema):
             allowed_peer_kinds += peer_schema.used_by

infrahub/core/validators/tasks.py

@@ -36,7 +36,7 @@ async def schema_validate_migrations(message: SchemaValidateMigrationData) -> li
     log.info(f"{len(message.constraints)} constraint(s) to validate")
     # NOTE this task is a good candidate to add a progress bar
     for constraint in message.constraints:
-        schema = message.schema_branch.get(name=constraint.path.schema_kind)
+        schema = message.schema_branch.get(name=constraint.path.schema_kind, duplicate=False)
         if not isinstance(schema, GenericSchema | NodeSchema):
             continue
         batch.add(

infrahub/database/graph.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from infrahub.core.graph import GRAPH_VERSION
+from infrahub.core.initialization import get_root_node
+from infrahub.log import get_logger
+
+if TYPE_CHECKING:
+    from infrahub.database import InfrahubDatabase
+
+
+log = get_logger()
+
+
+async def validate_graph_version(db: InfrahubDatabase) -> None:
+    root = await get_root_node(db=db)
+    if root.graph_version != GRAPH_VERSION:
+        log.warning(
+            f"Expected database graph version {GRAPH_VERSION} but got {root.graph_version}, possibly 'infrahub upgrade' has not been executed"
+        )

infrahub/display_labels/gather.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from prefect import task
+from prefect.cache_policies import NONE
+from prefect.logging import get_run_logger
+
+from infrahub.core.registry import registry
+from infrahub.database import InfrahubDatabase  # noqa: TC001  needed for prefect flow
+
+from .models import DisplayLabelTriggerDefinition
+
+
+@dataclass
+class BranchScope:
+    name: str
+    out_of_scope: list[str] = field(default_factory=list)
+
+
+@task(
+    name="gather-trigger-display-labels-jinja2",
+    cache_policy=NONE,
+)
+async def gather_trigger_display_labels_jinja2(
+    db: InfrahubDatabase | None = None,  # noqa: ARG001 Needed to have a common function signature for gathering functions
+) -> list[DisplayLabelTriggerDefinition]:
+    log = get_run_logger()
+
+    # Build a list of all branches to process based on which branch is different from main
+    branches_with_diff_from_main = registry.get_altered_schema_branches()
+    branches_to_process: list[BranchScope] = [BranchScope(name=branch) for branch in branches_with_diff_from_main]
+    branches_to_process.append(BranchScope(name=registry.default_branch, out_of_scope=branches_with_diff_from_main))
+
+    triggers: list[DisplayLabelTriggerDefinition] = []
+
+    for branch in branches_to_process:
+        schema_branch = registry.schema.get_schema_branch(name=branch.name)
+        branch_triggers = DisplayLabelTriggerDefinition.from_schema_display_labels(
+            branch=branch.name,
+            display_labels=schema_branch.display_labels,
+            branches_out_of_scope=branch.out_of_scope,
+        )
+        log.info(f"Generating {len(branch_triggers)} Jinja2 trigger for {branch.name} (except {branch.out_of_scope})")
+
+        triggers.extend(branch_triggers)
+
+    return triggers

infrahub/display_labels/models.py

@@ -0,0 +1,240 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Any, Self
+
+from infrahub_sdk.graphql import Query
+from pydantic import BaseModel, Field
+
+from infrahub.core.constants import RelationshipCardinality
+from infrahub.core.registry import registry
+from infrahub.core.schema import NodeSchema  # noqa: TC001
+from infrahub.events import NodeUpdatedEvent
+from infrahub.trigger.constants import NAME_SEPARATOR
+from infrahub.trigger.models import (
+    EventTrigger,
+    ExecuteWorkflow,
+    TriggerBranchDefinition,
+    TriggerType,
+)
+from infrahub.workflows.catalogue import DISPLAY_LABELS_PROCESS_JINJA2
+
+if TYPE_CHECKING:
+    from infrahub.core.schema.schema_branch_display import DisplayLabels, RelationshipTriggers
+
+
+@dataclass
+class AttributeTarget:
+    hash: str
+    fields: set[str]
+
+
+class DisplayLabelTriggerDefinition(TriggerBranchDefinition):
+    type: TriggerType = TriggerType.DISPLAY_LABEL_JINJA2
+    template_hash: str
+    target_kind: str | None = Field(default=None)
+
+    def get_description(self) -> str:
+        return f"{super().get_description()} | hash:{self.template_hash}"
+
+    @classmethod
+    def from_schema_display_labels(
+        cls,
+        branch: str,
+        display_labels: DisplayLabels,
+        branches_out_of_scope: list[str] | None = None,
+    ) -> list[DisplayLabelTriggerDefinition]:
+        """
+        This function is used to create a trigger definition for a display labels of type Jinja2.
+        """
+
+        definitions: list[DisplayLabelTriggerDefinition] = []
+
+        for node_kind, template_label in display_labels.get_template_nodes().items():
+            definitions.append(
+                cls.new(
+                    branch=branch,
+                    node_kind=node_kind,
+                    target_kind=node_kind,
+                    fields=[
+                        "_trigger_placeholder"
+                    ],  # Triggers for the nodes themselves are only used to determine if all nodes should be regenerated
+                    template_hash=template_label.get_hash(),
+                    branches_out_of_scope=branches_out_of_scope,
+                )
+            )
+
+        for related_kind, relationship_trigger in display_labels.get_related_trigger_nodes().items():
+            definitions.extend(
+                cls.from_related_node(
+                    branch=branch,
+                    related_kind=related_kind,
+                    relationship_trigger=relationship_trigger,
+                    display_labels=display_labels,
+                    branches_out_of_scope=branches_out_of_scope,
+                )
+            )
+
+        return definitions
+
+    @classmethod
+    def from_related_node(
+        cls,
+        branch: str,
+        related_kind: str,
+        relationship_trigger: RelationshipTriggers,
+        display_labels: DisplayLabels,
+        branches_out_of_scope: list[str] | None = None,
+    ) -> list[DisplayLabelTriggerDefinition]:
+        targets_by_attribute: dict[str, AttributeTarget] = {}
+        definitions: list[DisplayLabelTriggerDefinition] = []
+        for attribute, relationship_identifiers in relationship_trigger.attributes.items():
+            for relationship_identifier in relationship_identifiers:
+                actual_node = display_labels.get_template_node(kind=relationship_identifier.kind)
+                if relationship_identifier.kind not in targets_by_attribute:
+                    targets_by_attribute[relationship_identifier.kind] = AttributeTarget(
+                        actual_node.get_hash(), fields=set()
+                    )
+                targets_by_attribute[relationship_identifier.kind].fields.add(attribute)
+
+        for target_kind, attribute_target in targets_by_attribute.items():
+            definitions.append(
+                cls.new(
+                    branch=branch,
+                    node_kind=related_kind,
+                    target_kind=target_kind,
+                    fields=sorted(attribute_target.fields),
+                    template_hash=attribute_target.hash,
+                    branches_out_of_scope=branches_out_of_scope,
+                )
+            )
+
+        return definitions
+
+    @classmethod
+    def new(
+        cls,
+        branch: str,
+        node_kind: str,
+        target_kind: str,
+        template_hash: str,
+        fields: list[str],
+        branches_out_of_scope: list[str] | None = None,
+    ) -> Self:
+        event_trigger = EventTrigger()
+        event_trigger.events.add(NodeUpdatedEvent.event_name)
+        event_trigger.match = {"infrahub.node.kind": node_kind}
+        if branches_out_of_scope:
+            event_trigger.match["infrahub.branch.name"] = [f"!{branch}" for branch in branches_out_of_scope]
+        elif not branches_out_of_scope and branch != registry.default_branch:
+            event_trigger.match["infrahub.branch.name"] = branch
+
+        event_trigger.match_related = {
+            "prefect.resource.role": ["infrahub.node.attribute_update", "infrahub.node.relationship_update"],
+            "infrahub.field.name": fields,
+        }
+
+        workflow = ExecuteWorkflow(
+            workflow=DISPLAY_LABELS_PROCESS_JINJA2,
+            parameters={
+                "branch_name": "{{ event.resource['infrahub.branch.name'] }}",
+                "node_kind": node_kind,
+                "object_id": "{{ event.resource['infrahub.node.id'] }}",
+                "target_kind": target_kind,
+                "context": {
+                    "__prefect_kind": "json",
+                    "value": {
+                        "__prefect_kind": "jinja",
+                        "template": "{{ event.payload['context'] | tojson }}",
+                    },
+                },
+            },
+        )
+
+        trigger_definition_target_kind = target_kind if target_kind == node_kind else None
+
+        return cls(
+            name=f"{target_kind}{NAME_SEPARATOR}by{NAME_SEPARATOR}{node_kind}",
+            template_hash=template_hash,
+            branch=branch,
+            trigger=event_trigger,
+            actions=[workflow],
+            target_kind=trigger_definition_target_kind,
+        )
+
+
+class DisplayLabelJinja2GraphQLResponse(BaseModel):
+    node_id: str
+    display_label_value: str | None
+    variables: dict[str, Any] = Field(default_factory=dict)
+
+
+class DisplayLabelJinja2GraphQL(BaseModel):
+    filter_key: str
+    node_schema: NodeSchema = Field(..., description="The node kind where the computed attribute is defined")
+    variables: list[str] = Field(..., description="The list of variable names used within the computed attribute")
+
+    def render_graphql_query(self, filter_id: str) -> str:
+        query_fields = self.query_fields
+        query_fields["id"] = None
+        query_fields["display_label"] = None
+        query = Query(
+            name="DisplayLabelFilter",
+            query={
+                self.node_schema.kind: {
+                    "@filters": {self.filter_key: filter_id},
+                    "edges": {"node": query_fields},
+                }
+            },
+        )
+
+        return query.render()
+
+    @property
+    def query_fields(self) -> dict[str, Any]:
+        output: dict[str, Any] = {}
+        for variable in self.variables:
+            field_name, remainder = variable.split("__", maxsplit=1)
+            if field_name in self.node_schema.attribute_names:
+                output[field_name] = {remainder: None}
+            elif field_name in self.node_schema.relationship_names:
+                related_attribute, related_value = remainder.split("__", maxsplit=1)
+                relationship = self.node_schema.get_relationship(name=field_name)
+                if relationship.cardinality == RelationshipCardinality.ONE:
+                    if field_name not in output:
+                        output[field_name] = {"node": {}}
+                    output[field_name]["node"][related_attribute] = {related_value: None}
+        return output
+
+    def parse_response(self, response: dict[str, Any]) -> list[DisplayLabelJinja2GraphQLResponse]:
+        rendered_response: list[DisplayLabelJinja2GraphQLResponse] = []
+        if kind_payload := response.get(self.node_schema.kind):
+            edges = kind_payload.get("edges", [])
+            for node in edges:
+                if node_response := self.to_node_response(node_dict=node):
+                    rendered_response.append(node_response)
+        return rendered_response
+
+    def to_node_response(self, node_dict: dict[str, Any]) -> DisplayLabelJinja2GraphQLResponse | None:
+        if node := node_dict.get("node"):
+            node_id = node.get("id")
+        else:
+            return None
+
+        display_label = node.get("display_label")
+        response = DisplayLabelJinja2GraphQLResponse(node_id=node_id, display_label_value=display_label)
+        for variable in self.variables:
+            field_name, remainder = variable.split("__", maxsplit=1)
+            response.variables[variable] = None
+            if field_content := node.get(field_name):
+                if field_name in self.node_schema.attribute_names:
+                    response.variables[variable] = field_content.get(remainder)
+                elif field_name in self.node_schema.relationship_names:
+                    relationship = self.node_schema.get_relationship(name=field_name)
+                    if relationship.cardinality == RelationshipCardinality.ONE:
+                        related_attribute, related_value = remainder.split("__", maxsplit=1)
+                        node_content = field_content.get("node") or {}
+                        related_attribute_content = node_content.get(related_attribute) or {}
+                        response.variables[variable] = related_attribute_content.get(related_value)
+
+        return response

infrahub/display_labels/tasks.py

@@ -0,0 +1,192 @@
+from __future__ import annotations
+
+from typing import cast
+
+from infrahub_sdk.exceptions import URLNotFoundError
+from infrahub_sdk.template import Jinja2Template
+from prefect import flow
+from prefect.logging import get_run_logger
+
+from infrahub.context import InfrahubContext  # noqa: TC001  needed for prefect flow
+from infrahub.core.registry import registry
+from infrahub.events import BranchDeletedEvent
+from infrahub.trigger.models import TriggerSetupReport, TriggerType
+from infrahub.trigger.setup import setup_triggers_specific
+from infrahub.workers.dependencies import get_client, get_component, get_database, get_workflow
+from infrahub.workflows.catalogue import DISPLAY_LABELS_PROCESS_JINJA2, TRIGGER_UPDATE_DISPLAY_LABELS
+from infrahub.workflows.utils import add_tags, wait_for_schema_to_converge
+
+from .gather import gather_trigger_display_labels_jinja2
+from .models import DisplayLabelJinja2GraphQL, DisplayLabelJinja2GraphQLResponse, DisplayLabelTriggerDefinition
+
+UPDATE_DISPLAY_LABEL = """
+mutation UpdateDisplayLabel(
+    $id: String!,
+    $kind: String!,
+    $value: String!
+  ) {
+  InfrahubUpdateDisplayLabel(
+    data: {id: $id, value: $value, kind: $kind}
+  ) {
+    ok
+  }
+}
+"""
+
+
+@flow(
+    name="display-label-jinja2-update-value",
+    flow_run_name="Update value for display_label on {node_kind}",
+)
+async def display_label_jinja2_update_value(
+    branch_name: str,
+    obj: DisplayLabelJinja2GraphQLResponse,
+    node_kind: str,
+    template: Jinja2Template,
+) -> None:
+    log = get_run_logger()
+    client = get_client()
+
+    await add_tags(branches=[branch_name], nodes=[obj.node_id], db_change=True)
+
+    value = await template.render(variables=obj.variables)
+    if value == obj.display_label_value:
+        log.debug(f"Ignoring to update {obj} with existing value on display_label={value}")
+        return
+
+    try:
+        await client.execute_graphql(
+            query=UPDATE_DISPLAY_LABEL,
+            variables={"id": obj.node_id, "kind": node_kind, "value": value},
+            branch_name=branch_name,
+        )
+        log.info(f"Updating {node_kind}.display_label='{value}' ({obj.node_id})")
+    except URLNotFoundError:
+        log.warning(
+            f"Updating {node_kind}.display_label='{value}' ({obj.node_id}) failed for branch {branch_name} (branch not found)"
+        )
+
+
+@flow(
+    name="display-label-process-jinja2",
+    flow_run_name="Process display_labels for {target_kind}",
+)
+async def process_display_label(
+    branch_name: str,
+    node_kind: str,
+    object_id: str,
+    target_kind: str,
+    context: InfrahubContext,  # noqa: ARG001
+) -> None:
+    log = get_run_logger()
+    client = get_client()
+
+    await add_tags(branches=[branch_name])
+
+    target_schema = branch_name if branch_name in registry.get_altered_schema_branches() else registry.default_branch
+    schema_branch = registry.schema.get_schema_branch(name=target_schema)
+    node_schema = schema_branch.get_node(name=target_kind, duplicate=False)
+
+    if node_kind == target_kind:
+        display_label_template = schema_branch.display_labels.get_template_node(kind=node_kind)
+    else:
+        display_label_template = schema_branch.display_labels.get_related_template(
+            related_kind=node_kind, target_kind=target_kind
+        )
+
+    jinja_template = Jinja2Template(template=display_label_template.template)
+    variables = jinja_template.get_variables()
+    display_label_graphql = DisplayLabelJinja2GraphQL(
+        node_schema=node_schema, variables=variables, filter_key=display_label_template.filter_key
+    )
+
+    query = display_label_graphql.render_graphql_query(filter_id=object_id)
+    response = await client.execute_graphql(query=query, branch_name=branch_name)
+    update_candidates = display_label_graphql.parse_response(response=response)
+
+    if not update_candidates:
+        log.debug("No nodes found that requires updates")
+        return
+
+    batch = await client.create_batch()
+    for node in update_candidates:
+        batch.add(
+            task=display_label_jinja2_update_value,
+            branch_name=branch_name,
+            obj=node,
+            node_kind=node_schema.kind,
+            template=jinja_template,
+        )
+
+    _ = [response async for _, response in batch.execute()]
+
+
+@flow(name="display-labels-setup-jinja2", flow_run_name="Setup display labels in task-manager")
+async def display_labels_setup_jinja2(
+    context: InfrahubContext, branch_name: str | None = None, event_name: str | None = None
+) -> None:
+    database = await get_database()
+    async with database.start_session() as db:
+        log = get_run_logger()
+
+        if branch_name:
+            await add_tags(branches=[branch_name])
+            component = await get_component()
+            await wait_for_schema_to_converge(branch_name=branch_name, component=component, db=db, log=log)
+
+        report: TriggerSetupReport = await setup_triggers_specific(
+            gatherer=gather_trigger_display_labels_jinja2, trigger_type=TriggerType.DISPLAY_LABEL_JINJA2
+        )  # type: ignore[misc]
+
+        # Configure all DisplayLabelTriggerDefinitions in Prefect
+        display_reports = [cast(DisplayLabelTriggerDefinition, entry) for entry in report.updated + report.created]
+        direct_target_triggers = [display_report for display_report in display_reports if display_report.target_kind]
+
+        for display_report in direct_target_triggers:
+            if event_name != BranchDeletedEvent.event_name and display_report.branch == branch_name:
+                await get_workflow().submit_workflow(
+                    workflow=TRIGGER_UPDATE_DISPLAY_LABELS,
+                    context=context,
+                    parameters={
+                        "branch_name": display_report.branch,
+                        "kind": display_report.target_kind,
+                    },
+                )
+
+        log.info(f"{report.in_use_count} Display labels for Jinja2 automation configuration completed")
+
+
+@flow(
+    name="trigger-update-display-labels",
+    flow_run_name="Trigger updates for display labels for {kind}",
+)
+async def trigger_update_display_labels(
+    branch_name: str,
+    kind: str,
+    context: InfrahubContext,
+) -> None:
+    await add_tags(branches=[branch_name])
+
+    client = get_client()
+
+    # NOTE we only need the id of the nodes, this query will still query for the HFID
+    node_schema = registry.schema.get_node_schema(name=kind, branch=branch_name)
+    nodes = await client.all(
+        kind=kind,
+        branch=branch_name,
+        exclude=node_schema.attribute_names + node_schema.relationship_names,
+        populate_store=False,
+    )
+
+    for node in nodes:
+        await get_workflow().submit_workflow(
+            workflow=DISPLAY_LABELS_PROCESS_JINJA2,
+            context=context,
+            parameters={
+                "branch_name": branch_name,
+                "node_kind": kind,
+                "target_kind": kind,
+                "object_id": node.id,
+                "context": context,
+            },
+        )

infrahub/display_labels/triggers.py

@@ -0,0 +1,22 @@
+from infrahub.events.branch_action import BranchDeletedEvent
+from infrahub.events.schema_action import SchemaUpdatedEvent
+from infrahub.trigger.models import BuiltinTriggerDefinition, EventTrigger, ExecuteWorkflow
+from infrahub.workflows.catalogue import DISPLAY_LABELS_SETUP_JINJA2
+
+TRIGGER_DISPLAY_LABELS_ALL_SCHEMA = BuiltinTriggerDefinition(
+    name="display-labels-setup-all",
+    trigger=EventTrigger(events={SchemaUpdatedEvent.event_name, BranchDeletedEvent.event_name}),
+    actions=[
+        ExecuteWorkflow(
+            workflow=DISPLAY_LABELS_SETUP_JINJA2,
+            parameters={
+                "branch_name": "{{ event.resource['infrahub.branch.name'] }}",
+                "event_name": "{{ event.event }}",
+                "context": {
+                    "__prefect_kind": "json",
+                    "value": {"__prefect_kind": "jinja", "template": "{{ event.payload['context'] | tojson }}"},
+                },
+            },
+        ),
+    ],
+)

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 @@ class BranchRebasedEvent(InfrahubEvent):
             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

infrahub/events/group_action.py

@@ -22,7 +22,7 @@ class GroupMutatedEvent(InfrahubEvent):
     def get_related(self) -> list[dict[str, str]]:
         related = super().get_related()
 
-        if self.kind in [InfrahubKind.GENERATORGROUP, InfrahubKind.GRAPHQLQUERYGROUP]:
+        if self.kind in [InfrahubKind.GENERATORGROUP, InfrahubKind.GENERATORAWAREGROUP, InfrahubKind.GRAPHQLQUERYGROUP]:
             # Temporary workaround to avoid too large payloads for the related field
             return related
 

infrahub/events/node_action.py

@@ -24,7 +24,7 @@ class NodeMutatedEvent(InfrahubEvent):
 
     def get_related(self) -> list[dict[str, str]]:
         related = super().get_related()
-        if self.kind in [InfrahubKind.GENERATORGROUP, InfrahubKind.GRAPHQLQUERYGROUP]:
+        if self.kind in [InfrahubKind.GENERATORGROUP, InfrahubKind.GENERATORAWAREGROUP, InfrahubKind.GRAPHQLQUERYGROUP]:
             # Temporary workaround to avoid too large payloads for the related field
             return related
 

infrahub/generators/constants.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+
+class GeneratorDefinitionRunSource(Enum):
+    PROPOSED_CHANGE = "proposed_change"
+    MERGE = "merge"
+    UNKNOWN = "unknown"

infrahub/generators/models.py

@@ -44,6 +44,11 @@ class GeneratorDefinitionModel(BaseModel):
     group_id: str = Field(..., description="The group to target when running this generator")
     parameters: dict = Field(..., description="The input parameters required to run this check")
 
+    execute_in_proposed_change: bool = Field(
+        ..., description="Indicates if the generator should execute in a proposed change."
+    )
+    execute_after_merge: bool = Field(..., description="Indicates if the generator should execute after a merge.")
+
     @classmethod
     def from_pc_generator_definition(cls, model: ProposedChangeGeneratorDefinition) -> GeneratorDefinitionModel:
         return GeneratorDefinitionModel(
@@ -55,6 +60,8 @@ class GeneratorDefinitionModel(BaseModel):
             file_path=model.file_path,
             group_id=model.group_id,
             parameters=model.parameters,
+            execute_in_proposed_change=model.execute_in_proposed_change,
+            execute_after_merge=model.execute_after_merge,
         )