feat: add a abstract layer for WorkflowNodeExcetion (#18026)

api/core/repository/__init__.py

@@ -0,0 +1,15 @@
+"""
+Repository interfaces for data access.
+
+This package contains repository interfaces that define the contract
+for accessing and manipulating data, regardless of the underlying
+storage mechanism.
+"""
+
+from core.repository.repository_factory import RepositoryFactory
+from core.repository.workflow_node_execution_repository import WorkflowNodeExecutionRepository
+
+__all__ = [
+    "RepositoryFactory",
+    "WorkflowNodeExecutionRepository",
+]

api/core/repository/repository_factory.py

@@ -0,0 +1,97 @@
+"""
+Repository factory for creating repository instances.
+
+This module provides a simple factory interface for creating repository instances.
+It does not contain any implementation details or dependencies on specific repositories.
+"""
+
+from collections.abc import Callable, Mapping
+from typing import Any, Literal, Optional, cast
+
+from core.repository.workflow_node_execution_repository import WorkflowNodeExecutionRepository
+
+# Type for factory functions - takes a dict of parameters and returns any repository type
+RepositoryFactoryFunc = Callable[[Mapping[str, Any]], Any]
+
+# Type for workflow node execution factory function
+WorkflowNodeExecutionFactoryFunc = Callable[[Mapping[str, Any]], WorkflowNodeExecutionRepository]
+
+# Repository type literals
+RepositoryType = Literal["workflow_node_execution"]
+
+
+class RepositoryFactory:
+    """
+    Factory class for creating repository instances.
+
+    This factory delegates the actual repository creation to implementation-specific
+    factory functions that are registered with the factory at runtime.
+    """
+
+    # Dictionary to store factory functions
+    _factory_functions: dict[str, RepositoryFactoryFunc] = {}
+
+    @classmethod
+    def _register_factory(cls, repository_type: RepositoryType, factory_func: RepositoryFactoryFunc) -> None:
+        """
+        Register a factory function for a specific repository type.
+        This is a private method and should not be called directly.
+
+        Args:
+            repository_type: The type of repository (e.g., 'workflow_node_execution')
+            factory_func: A function that takes parameters and returns a repository instance
+        """
+        cls._factory_functions[repository_type] = factory_func
+
+    @classmethod
+    def _create_repository(cls, repository_type: RepositoryType, params: Optional[Mapping[str, Any]] = None) -> Any:
+        """
+        Create a new repository instance with the provided parameters.
+        This is a private method and should not be called directly.
+
+        Args:
+            repository_type: The type of repository to create
+            params: A dictionary of parameters to pass to the factory function
+
+        Returns:
+            A new instance of the requested repository
+
+        Raises:
+            ValueError: If no factory function is registered for the repository type
+        """
+        if repository_type not in cls._factory_functions:
+            raise ValueError(f"No factory function registered for repository type '{repository_type}'")
+
+        # Use empty dict if params is None
+        params = params or {}
+
+        return cls._factory_functions[repository_type](params)
+
+    @classmethod
+    def register_workflow_node_execution_factory(cls, factory_func: WorkflowNodeExecutionFactoryFunc) -> None:
+        """
+        Register a factory function for the workflow node execution repository.
+
+        Args:
+            factory_func: A function that takes parameters and returns a WorkflowNodeExecutionRepository instance
+        """
+        cls._register_factory("workflow_node_execution", factory_func)
+
+    @classmethod
+    def create_workflow_node_execution_repository(
+        cls, params: Optional[Mapping[str, Any]] = None
+    ) -> WorkflowNodeExecutionRepository:
+        """
+        Create a new WorkflowNodeExecutionRepository instance with the provided parameters.
+
+        Args:
+            params: A dictionary of parameters to pass to the factory function
+
+        Returns:
+            A new instance of the WorkflowNodeExecutionRepository
+
+        Raises:
+            ValueError: If no factory function is registered for the workflow_node_execution repository type
+        """
+        # We can safely cast here because we've registered a WorkflowNodeExecutionFactoryFunc
+        return cast(WorkflowNodeExecutionRepository, cls._create_repository("workflow_node_execution", params))

api/core/repository/workflow_node_execution_repository.py

@@ -0,0 +1,88 @@
+from collections.abc import Sequence
+from dataclasses import dataclass
+from typing import Literal, Optional, Protocol
+
+from models.workflow import WorkflowNodeExecution
+
+
+@dataclass
+class OrderConfig:
+    """Configuration for ordering WorkflowNodeExecution instances."""
+
+    order_by: list[str]
+    order_direction: Optional[Literal["asc", "desc"]] = None
+
+
+class WorkflowNodeExecutionRepository(Protocol):
+    """
+    Repository interface for WorkflowNodeExecution.
+
+    This interface defines the contract for accessing and manipulating
+    WorkflowNodeExecution data, regardless of the underlying storage mechanism.
+
+    Note: Domain-specific concepts like multi-tenancy (tenant_id), application context (app_id),
+    and trigger sources (triggered_from) should be handled at the implementation level, not in
+    the core interface. This keeps the core domain model clean and independent of specific
+    application domains or deployment scenarios.
+    """
+
+    def save(self, execution: WorkflowNodeExecution) -> None:
+        """
+        Save a WorkflowNodeExecution instance.
+
+        Args:
+            execution: The WorkflowNodeExecution instance to save
+        """
+        ...
+
+    def get_by_node_execution_id(self, node_execution_id: str) -> Optional[WorkflowNodeExecution]:
+        """
+        Retrieve a WorkflowNodeExecution by its node_execution_id.
+
+        Args:
+            node_execution_id: The node execution ID
+
+        Returns:
+            The WorkflowNodeExecution instance if found, None otherwise
+        """
+        ...
+
+    def get_by_workflow_run(
+        self,
+        workflow_run_id: str,
+        order_config: Optional[OrderConfig] = None,
+    ) -> Sequence[WorkflowNodeExecution]:
+        """
+        Retrieve all WorkflowNodeExecution instances for a specific workflow run.
+
+        Args:
+            workflow_run_id: The workflow run ID
+            order_config: Optional configuration for ordering results
+                order_config.order_by: List of fields to order by (e.g., ["index", "created_at"])
+                order_config.order_direction: Direction to order ("asc" or "desc")
+
+        Returns:
+            A list of WorkflowNodeExecution instances
+        """
+        ...
+
+    def get_running_executions(self, workflow_run_id: str) -> Sequence[WorkflowNodeExecution]:
+        """
+        Retrieve all running WorkflowNodeExecution instances for a specific workflow run.
+
+        Args:
+            workflow_run_id: The workflow run ID
+
+        Returns:
+            A list of running WorkflowNodeExecution instances
+        """
+        ...
+
+    def update(self, execution: WorkflowNodeExecution) -> None:
+        """
+        Update an existing WorkflowNodeExecution instance.
+
+        Args:
+            execution: The WorkflowNodeExecution instance to update
+        """
+        ...