gobby 0.2.6__py3-none-any.whl → 0.2.8__py3-none-any.whl

gobby/workflows/enforcement/commit_policy.py

@@ -0,0 +1,283 @@
+"""Commit policy enforcement for workflow engine.
+
+Provides actions that enforce commit requirements before stopping or closing tasks.
+"""
+
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any
+
+from gobby.workflows.git_utils import get_dirty_files
+
+if TYPE_CHECKING:
+    from gobby.storage.tasks import LocalTaskManager
+    from gobby.workflows.definitions import WorkflowState
+
+logger = logging.getLogger(__name__)
+
+
+async def capture_baseline_dirty_files(
+    workflow_state: WorkflowState | None,
+    project_path: str | None = None,
+) -> dict[str, Any] | None:
+    """
+    Capture current dirty files as baseline for session-aware detection.
+
+    Called on session_start to record pre-existing dirty files. The
+    require_commit_before_stop action will compare against this baseline
+    to detect only NEW dirty files made during the session.
+
+    Args:
+        workflow_state: Workflow state to store baseline in
+        project_path: Path to the project directory for git status check
+
+    Returns:
+        Dict with captured baseline info, or None if no workflow_state
+    """
+    if not workflow_state:
+        logger.debug("capture_baseline_dirty_files: No workflow_state, skipping")
+        return None
+
+    dirty_files = get_dirty_files(project_path)
+
+    # Store as a list in workflow state (sets aren't JSON serializable)
+    workflow_state.variables["baseline_dirty_files"] = list(dirty_files)
+
+    # Log for debugging baseline capture issues
+    files_preview = list(dirty_files)[:5]
+    logger.info(
+        f"capture_baseline_dirty_files: project_path={project_path}, "
+        f"captured {len(dirty_files)} files: {files_preview}"
+    )
+
+    return {
+        "baseline_captured": True,
+        "file_count": len(dirty_files),
+        "files": list(dirty_files),
+    }
+
+
+async def require_commit_before_stop(
+    workflow_state: WorkflowState | None,
+    project_path: str | None = None,
+    task_manager: LocalTaskManager | None = None,
+) -> dict[str, Any] | None:
+    """
+    Block stop if there's an in_progress task with uncommitted changes.
+
+    This action is designed for on_stop triggers to enforce that agents
+    commit their work and close tasks before stopping.
+
+    Args:
+        workflow_state: Workflow state with variables (claimed_task_id, etc.)
+        project_path: Path to the project directory for git status check
+        task_manager: LocalTaskManager to verify task status
+
+    Returns:
+        Dict with decision="block" and reason if task has uncommitted changes,
+        or None to allow the stop.
+    """
+    if not workflow_state:
+        logger.debug("require_commit_before_stop: No workflow_state, allowing")
+        return None
+
+    claimed_task_id = workflow_state.variables.get("claimed_task_id")
+    if not claimed_task_id:
+        logger.debug("require_commit_before_stop: No claimed task, allowing")
+        return None
+
+    # Verify the task is actually still in_progress (not just cached in workflow state)
+    if task_manager:
+        task = task_manager.get_task(claimed_task_id)
+        if not task or task.status != "in_progress":
+            # Task was changed - clear the stale workflow state
+            logger.debug(
+                f"require_commit_before_stop: Task '{claimed_task_id}' is no longer "
+                f"in_progress (status={task.status if task else 'not found'}), clearing state"
+            )
+            workflow_state.variables["claimed_task_id"] = None
+            workflow_state.variables["task_claimed"] = False
+            return None
+
+    # Check for uncommitted changes using baseline-aware comparison
+    current_dirty = get_dirty_files(project_path)
+
+    if not current_dirty:
+        logger.debug("require_commit_before_stop: No uncommitted changes, allowing")
+        return None
+
+    # Get baseline dirty files captured at session start
+    baseline_dirty = set(workflow_state.variables.get("baseline_dirty_files", []))
+
+    # Calculate NEW dirty files (not in baseline)
+    new_dirty = current_dirty - baseline_dirty
+
+    if not new_dirty:
+        logger.debug(
+            f"require_commit_before_stop: All {len(current_dirty)} dirty files were pre-existing "
+            f"(in baseline), allowing"
+        )
+        return None
+
+    logger.debug(
+        f"require_commit_before_stop: Found {len(new_dirty)} new dirty files "
+        f"(baseline had {len(baseline_dirty)}, current has {len(current_dirty)})"
+    )
+
+    # Track how many times we've blocked to prevent infinite loops
+    block_count = workflow_state.variables.get("_commit_block_count", 0)
+    if block_count >= 3:
+        logger.warning(
+            f"require_commit_before_stop: Reached max block count ({block_count}), allowing"
+        )
+        return None
+
+    workflow_state.variables["_commit_block_count"] = block_count + 1
+
+    # Block - agent needs to commit and close
+    logger.info(
+        f"require_commit_before_stop: Blocking stop - task '{claimed_task_id}' "
+        f"has {len(new_dirty)} uncommitted changes"
+    )
+
+    # Build list of new dirty files for the message (limit to 10 for readability)
+    new_dirty_list = sorted(new_dirty)[:10]
+    files_display = "\n".join(f"  - {f}" for f in new_dirty_list)
+    if len(new_dirty) > 10:
+        files_display += f"\n  ... and {len(new_dirty) - 10} more files"
+
+    return {
+        "decision": "block",
+        "reason": (
+            f"Task '{claimed_task_id}' is in_progress with {len(new_dirty)} uncommitted "
+            f"changes made during this session:\n{files_display}\n\n"
+            f"Before stopping, commit your changes and close the task:\n"
+            f"1. Commit with [{claimed_task_id}] in the message\n"
+            f'2. Close the task: close_task(task_id="{claimed_task_id}", commit_sha="...")'
+        ),
+    }
+
+
+async def require_task_review_or_close_before_stop(
+    workflow_state: WorkflowState | None,
+    task_manager: LocalTaskManager | None = None,
+    project_id: str | None = None,
+    **kwargs: Any,
+) -> dict[str, Any] | None:
+    """Block stop if session has an in_progress task.
+
+    Agents must close their task (or send to review) before stopping.
+    The close_task() validation already requires a commit, so we don't
+    need to check for uncommitted changes here - that's handled by
+    require_commit_before_stop if needed.
+
+    Checks both:
+    1. claimed_task_id - task explicitly claimed via update_task(status="in_progress")
+    2. session_task - task(s) assigned via set_variable (fallback if no claimed_task_id)
+
+    Args:
+        workflow_state: Workflow state with variables (claimed_task_id, etc.)
+        task_manager: LocalTaskManager to verify task status
+        project_id: Project ID for resolving task references (#N, N formats)
+        **kwargs: Accepts additional kwargs for compatibility
+
+    Returns:
+        Dict with decision="block" and reason if task is still in_progress,
+        or None to allow the stop.
+    """
+    if not workflow_state:
+        logger.debug("require_task_review_or_close_before_stop: No workflow_state, allowing")
+        return None
+
+    # 1. Check claimed_task_id first (existing behavior)
+    claimed_task_id = workflow_state.variables.get("claimed_task_id")
+
+    # 2. If no claimed task, fall back to session_task
+    if not claimed_task_id and task_manager:
+        session_task = workflow_state.variables.get("session_task")
+        if session_task and session_task != "*":
+            # Normalize to list
+            task_ids = [session_task] if isinstance(session_task, str) else session_task
+
+            if isinstance(task_ids, list):
+                for task_id in task_ids:
+                    try:
+                        task = task_manager.get_task(task_id, project_id=project_id)
+                    except ValueError:
+                        continue
+                    if task and task.status == "in_progress":
+                        claimed_task_id = task_id
+                        logger.debug(
+                            f"require_task_review_or_close_before_stop: Found in_progress "
+                            f"session_task '{task_id}'"
+                        )
+                        break
+                    # Also check subtasks
+                    if task:
+                        subtasks = task_manager.list_tasks(parent_task_id=task.id)
+                        for subtask in subtasks:
+                            if subtask.status == "in_progress":
+                                claimed_task_id = subtask.id
+                                logger.debug(
+                                    f"require_task_review_or_close_before_stop: Found in_progress "
+                                    f"subtask '{subtask.id}' under session_task '{task_id}'"
+                                )
+                                break
+                    if claimed_task_id:
+                        break
+
+    if not claimed_task_id:
+        logger.debug("require_task_review_or_close_before_stop: No claimed task, allowing")
+        return None
+
+    if not task_manager:
+        logger.debug("require_task_review_or_close_before_stop: No task_manager, allowing")
+        return None
+
+    try:
+        task = task_manager.get_task(claimed_task_id, project_id=project_id)
+        if not task:
+            # Task not found - clear stale workflow state and allow
+            logger.debug(
+                f"require_task_review_or_close_before_stop: Task '{claimed_task_id}' not found, "
+                f"clearing state"
+            )
+            workflow_state.variables["claimed_task_id"] = None
+            workflow_state.variables["task_claimed"] = False
+            return None
+
+        if task.status != "in_progress":
+            # Task is closed or in review - allow stop
+            logger.debug(
+                f"require_task_review_or_close_before_stop: Task '{claimed_task_id}' "
+                f"status={task.status}, allowing"
+            )
+            # Clear stale workflow state
+            workflow_state.variables["claimed_task_id"] = None
+            workflow_state.variables["task_claimed"] = False
+            return None
+
+        # Task is still in_progress - block the stop
+        task_ref = f"#{task.seq_num}" if task.seq_num else task.id[:8]
+        logger.info(
+            f"require_task_review_or_close_before_stop: Blocking stop - task "
+            f"{task_ref} is still in_progress"
+        )
+
+        return {
+            "decision": "block",
+            "reason": (
+                f"\nTask {task_ref} is still in_progress. "
+                f"Close it with close_task() before stopping."
+            ),
+            "task_id": claimed_task_id,
+            "task_status": task.status,
+        }
+
+    except Exception as e:
+        logger.warning(
+            f"require_task_review_or_close_before_stop: Failed to check task status: {e}"
+        )
+        # Allow stop if we can't check - don't block on errors
+        return None

gobby/workflows/enforcement/handlers.py

@@ -0,0 +1,269 @@
+"""ActionHandler wrappers for enforcement actions.
+
+These handlers match the ActionHandler protocol: (context: ActionContext, **kwargs) -> dict | None
+They bridge the workflow engine to the core enforcement functions.
+"""
+
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any
+
+from gobby.workflows.enforcement.blocking import block_tools
+from gobby.workflows.enforcement.commit_policy import (
+    capture_baseline_dirty_files,
+    require_commit_before_stop,
+    require_task_review_or_close_before_stop,
+)
+from gobby.workflows.enforcement.task_policy import (
+    require_active_task,
+    require_task_complete,
+    validate_session_task_scope,
+)
+
+if TYPE_CHECKING:
+    from gobby.storage.tasks import LocalTaskManager
+
+logger = logging.getLogger(__name__)
+
+__all__ = [
+    "handle_block_tools",
+    "handle_capture_baseline_dirty_files",
+    "handle_require_active_task",
+    "handle_require_commit_before_stop",
+    "handle_require_task_complete",
+    "handle_require_task_review_or_close_before_stop",
+    "handle_validate_session_task_scope",
+]
+
+
+async def handle_capture_baseline_dirty_files(
+    context: Any,
+    task_manager: LocalTaskManager | None = None,
+    **kwargs: Any,
+) -> dict[str, Any] | None:
+    """ActionHandler wrapper for capture_baseline_dirty_files.
+
+    Note: project_path comes from session's project lookup or event_data.cwd.
+    """
+    from gobby.storage.projects import LocalProjectManager
+
+    # Get project path - prioritize session lookup over hook payload
+    project_path = None
+
+    # 1. Get from session's project (most reliable - session exists by now)
+    if context.session_id and context.session_manager:
+        session = context.session_manager.get(context.session_id)
+        if session and session.project_id:
+            project_mgr = LocalProjectManager(context.db)
+            project = project_mgr.get(session.project_id)
+            if project and project.repo_path:
+                project_path = project.repo_path
+
+    # 2. Fallback to event_data.cwd (from hook payload)
+    if not project_path and context.event_data:
+        project_path = context.event_data.get("cwd")
+
+    return await capture_baseline_dirty_files(
+        workflow_state=context.state,
+        project_path=project_path,
+    )
+
+
+async def handle_require_commit_before_stop(
+    context: Any,
+    task_manager: LocalTaskManager | None = None,
+    **kwargs: Any,
+) -> dict[str, Any] | None:
+    """ActionHandler wrapper for require_commit_before_stop.
+
+    Note: task_manager must be passed via closure from executor.
+    """
+    from gobby.storage.projects import LocalProjectManager
+
+    # Get project path
+    project_path = None
+
+    if context.session_id and context.session_manager:
+        session = context.session_manager.get(context.session_id)
+        if session and session.project_id:
+            project_mgr = LocalProjectManager(context.db)
+            project = project_mgr.get(session.project_id)
+            if project and project.repo_path:
+                project_path = project.repo_path
+
+    if not project_path and context.event_data:
+        project_path = context.event_data.get("cwd")
+
+    return await require_commit_before_stop(
+        workflow_state=context.state,
+        project_path=project_path,
+        task_manager=task_manager,
+    )
+
+
+async def handle_require_task_review_or_close_before_stop(
+    context: Any,
+    task_manager: LocalTaskManager | None = None,
+    **kwargs: Any,
+) -> dict[str, Any] | None:
+    """ActionHandler wrapper for require_task_review_or_close_before_stop."""
+    project_id = None
+    if context.session_manager:
+        session = context.session_manager.get(context.session_id)
+        if session:
+            project_id = session.project_id
+
+    return await require_task_review_or_close_before_stop(
+        workflow_state=context.state,
+        task_manager=task_manager,
+        project_id=project_id,
+    )
+
+
+async def handle_validate_session_task_scope(
+    context: Any,
+    task_manager: LocalTaskManager | None = None,
+    **kwargs: Any,
+) -> dict[str, Any] | None:
+    """ActionHandler wrapper for validate_session_task_scope."""
+    return await validate_session_task_scope(
+        task_manager=task_manager,
+        workflow_state=context.state,
+        event_data=context.event_data,
+    )
+
+
+async def handle_block_tools(
+    context: Any,
+    task_manager: LocalTaskManager | None = None,
+    **kwargs: Any,
+) -> dict[str, Any] | None:
+    """ActionHandler wrapper for block_tools.
+
+    Passes task_manager via closure from register_defaults.
+    """
+    from gobby.storage.projects import LocalProjectManager
+
+    # Get project_path for git dirty file checks
+    project_path = kwargs.get("project_path")
+    if not project_path and context.event_data:
+        project_path = context.event_data.get("cwd")
+
+    # Get source from session for is_plan_file checks
+    source = None
+    current_session = None
+    if context.session_manager:
+        current_session = context.session_manager.get(context.session_id)
+        if current_session:
+            source = current_session.source
+
+    # Fallback to session's project path
+    if not project_path and current_session and context.db:
+        project_mgr = LocalProjectManager(context.db)
+        project = project_mgr.get(current_session.project_id)
+        if project and project.repo_path:
+            project_path = project.repo_path
+
+    return await block_tools(
+        rules=kwargs.get("rules"),
+        event_data=context.event_data,
+        workflow_state=context.state,
+        project_path=project_path,
+        task_manager=task_manager,
+        source=source,
+    )
+
+
+async def handle_require_active_task(
+    context: Any,
+    task_manager: LocalTaskManager | None = None,
+    **kwargs: Any,
+) -> dict[str, Any] | None:
+    """ActionHandler wrapper for require_active_task.
+
+    DEPRECATED: Use block_tools action with rules instead.
+    Kept for backward compatibility with existing workflows.
+    """
+    # Get project_id from session for project-scoped task filtering
+    current_session = None
+    project_id = None
+    if context.session_manager:
+        current_session = context.session_manager.get(context.session_id)
+        if current_session:
+            project_id = current_session.project_id
+
+    return await require_active_task(
+        task_manager=task_manager,
+        session_id=context.session_id,
+        config=context.config,
+        event_data=context.event_data,
+        project_id=project_id,
+        workflow_state=context.state,
+        session_manager=context.session_manager,
+        session_task_manager=context.session_task_manager,
+    )
+
+
+async def handle_require_task_complete(
+    context: Any,
+    task_manager: LocalTaskManager | None = None,
+    template_engine: Any | None = None,
+    **kwargs: Any,
+) -> dict[str, Any] | None:
+    """ActionHandler wrapper for require_task_complete.
+
+    Supports:
+    - Single task ID: "#47"
+    - List of task IDs: ["#47", "#48"]
+    - Wildcard: "*" - work until no ready tasks remain
+    """
+    project_id = None
+    if context.session_manager and context.session_id:
+        session = context.session_manager.get(context.session_id)
+        if session:
+            project_id = session.project_id
+
+    # Get task_id from kwargs - may be a template that needs resolving
+    task_spec = kwargs.get("task_id")
+
+    # If it's a template reference like "{{ variables.session_task }}", resolve it
+    if task_spec and "{{" in str(task_spec) and template_engine:
+        task_spec = template_engine.render(
+            str(task_spec),
+            {"variables": context.state.variables if context.state else {}},
+        )
+
+    # Handle different task_spec types:
+    # - None/empty: no enforcement
+    # - "*": wildcard - fetch ready tasks
+    # - list: multiple specific tasks
+    # - string: single task ID
+    task_ids: list[str] | None = None
+
+    if not task_spec:
+        return None
+    elif task_spec == "*":
+        # Wildcard: get all ready tasks for this project
+        if task_manager:
+            ready_tasks = task_manager.list_ready_tasks(
+                project_id=project_id,
+                limit=100,
+            )
+            task_ids = [t.id for t in ready_tasks]
+            if not task_ids:
+                # No ready tasks - allow stop
+                return None
+    elif isinstance(task_spec, list):
+        task_ids = task_spec
+    else:
+        task_ids = [str(task_spec)]
+
+    return await require_task_complete(
+        task_manager=task_manager,
+        session_id=context.session_id,
+        task_ids=task_ids,
+        event_data=context.event_data,
+        project_id=project_id,
+        workflow_state=context.state,
+    )