recce-nightly 1.10.0.20250625__py3-none-any.whl → 1.30.0.20251221__py3-none-any.whl

recce/apis/check_api.py

@@ -1,4 +1,3 @@
-from datetime import datetime, timezone
 from typing import Optional
 from uuid import UUID
 
@@ -153,22 +152,10 @@ class PatchCheckIn(BaseModel):
 
 @check_router.patch("/checks/{check_id}", status_code=200, response_model=CheckOut, response_model_exclude_none=True)
 async def update_check_handler(check_id: UUID, patch: PatchCheckIn, background_tasks: BackgroundTasks):
-    check = CheckDAO().find_check_by_id(check_id)
+    check = CheckDAO().update_check_by_id(check_id, patch)
     if check is None:
         raise HTTPException(status_code=404, detail="Not Found")
 
-    if patch.name is not None:
-        check.name = patch.name
-    if patch.description is not None:
-        check.description = patch.description
-    if patch.params is not None:
-        check.params = patch.params
-    if patch.view_options is not None:
-        check.view_options = patch.view_options
-    if patch.is_checked is not None:
-        check.is_checked = patch.is_checked
-    check.updated_at = datetime.now(timezone.utc).replace(microsecond=0)
-
     background_tasks.add_task(export_persistent_state)
     return CheckOut.from_check(check)
 
@@ -195,3 +182,22 @@ async def reorder_handler(order: ReorderChecksIn):
         CheckDAO().reorder(order.source, order.destination)
     except RecceException as e:
         raise HTTPException(status_code=400, detail=e.message)
+
+
+@check_router.post("/checks/{check_id}/mark-as-preset", status_code=204)
+async def mark_as_preset_check_handler(check_id: UUID, background_tasks: BackgroundTasks):
+    """
+    Mark an existing check as a preset check (cloud users only).
+
+    This creates a preset check from the specified check.
+    Only available for users with cloud mode enabled.
+
+    Returns:
+        204 No Content: Successfully marked check as preset
+        400 Bad Request: Error with detail message (e.g., not in cloud mode, check not found)
+    """
+    try:
+        CheckDAO().mark_as_preset_check(check_id)
+        background_tasks.add_task(export_persistent_state)
+    except RecceException as e:
+        raise HTTPException(status_code=400, detail=e.message)

recce/apis/check_events_api.py

@@ -0,0 +1,353 @@
+"""
+Check Events API endpoints.
+
+This module provides REST endpoints for check events (timeline/conversation),
+proxying requests to Recce Cloud. This feature is only available for cloud users.
+"""
+
+import logging
+from typing import List, Optional
+from uuid import UUID
+
+from fastapi import APIRouter, HTTPException
+from pydantic import BaseModel
+
+from recce.core import default_context
+from recce.event import get_recce_api_token
+from recce.exceptions import RecceException
+from recce.util.cloud.check_events import CheckEventsCloud
+from recce.util.recce_cloud import RecceCloud, RecceCloudException
+
+logger = logging.getLogger("uvicorn")
+
+check_events_router = APIRouter(tags=["check_events"])
+
+
+# ============================================================================
+# Helper Functions
+# ============================================================================
+
+
+def _is_cloud_user() -> bool:
+    """Check if the current user is connected to Recce Cloud."""
+    ctx = default_context()
+    if ctx is None or ctx.state_loader is None:
+        return False
+    return hasattr(ctx.state_loader, "session_id") and ctx.state_loader.session_id is not None
+
+
+def _get_session_info() -> tuple:
+    """
+    Get organization ID, project ID, and session ID from state loader.
+
+    Returns:
+        tuple: (org_id, project_id, session_id)
+
+    Raises:
+        HTTPException: If not in cloud mode or session info unavailable
+    """
+    if not _is_cloud_user():
+        raise HTTPException(
+            status_code=400,
+            detail="Check events are only available when connected to Recce Cloud.",
+        )
+
+    ctx = default_context()
+    state_loader = ctx.state_loader
+
+    session_id = state_loader.session_id
+
+    # Check if org_id and project_id are cached
+    if hasattr(state_loader, "org_id") and hasattr(state_loader, "project_id"):
+        return state_loader.org_id, state_loader.project_id, session_id
+
+    # Fetch from cloud API
+    api_token = get_recce_api_token() or state_loader.token
+    if not api_token:
+        raise HTTPException(
+            status_code=401,
+            detail="Cannot access Recce Cloud: no API token available.",
+        )
+
+    try:
+        recce_cloud = RecceCloud(api_token)
+        session = recce_cloud.get_session(session_id)
+
+        org_id = session.get("org_id")
+        project_id = session.get("project_id")
+
+        if not org_id or not project_id:
+            raise HTTPException(
+                status_code=400,
+                detail=f"Session {session_id} does not belong to a valid organization or project.",
+            )
+
+        # Cache for future use
+        state_loader.org_id = org_id
+        state_loader.project_id = project_id
+
+        return org_id, project_id, session_id
+
+    except RecceCloudException as e:
+        logger.error(f"Failed to get session info: {e}")
+        raise HTTPException(status_code=e.status_code, detail=str(e.reason))
+
+
+def _get_events_client() -> CheckEventsCloud:
+    """
+    Get the CheckEventsCloud client.
+
+    Returns:
+        CheckEventsCloud: Cloud client for event operations
+
+    Raises:
+        HTTPException: If client cannot be initialized
+    """
+    ctx = default_context()
+    api_token = get_recce_api_token() or ctx.state_loader.token
+
+    if not api_token:
+        raise HTTPException(
+            status_code=401,
+            detail="Cannot access Recce Cloud: no API token available.",
+        )
+
+    return CheckEventsCloud(api_token)
+
+
+# ============================================================================
+# Pydantic Models
+# ============================================================================
+
+
+class CheckEventActorOut(BaseModel):
+    """Actor who performed the event."""
+
+    type: str  # "user", "recce_ai", "preset_system"
+    user_id: Optional[int] = None
+    login: Optional[str] = None
+    fullname: Optional[str] = None
+
+
+class CheckEventOut(BaseModel):
+    """Check event response model."""
+
+    id: str
+    check_id: str
+    event_type: str
+    actor: CheckEventActorOut
+    content: Optional[str] = None
+    old_value: Optional[str] = None
+    new_value: Optional[str] = None
+    is_edited: bool = False
+    is_deleted: bool = False
+    created_at: str
+    updated_at: str
+
+
+class CreateCommentIn(BaseModel):
+    """Request body for creating a comment."""
+
+    content: str
+
+
+class UpdateCommentIn(BaseModel):
+    """Request body for updating a comment."""
+
+    content: str
+
+
+# ============================================================================
+# API Endpoints
+# ============================================================================
+
+
+@check_events_router.get(
+    "/checks/{check_id}/events",
+    status_code=200,
+    response_model=List[CheckEventOut],
+)
+async def list_check_events(check_id: UUID):
+    """
+    List all events for a check in chronological order.
+
+    This endpoint returns all events (comments, state changes, etc.) for the
+    specified check. Events are returned in chronological order (oldest first).
+
+    Args:
+        check_id: The check ID
+
+    Returns:
+        List of CheckEventOut objects
+
+    Raises:
+        400: Not connected to Recce Cloud
+        401: No API token available
+        404: Check not found
+    """
+    try:
+        org_id, project_id, session_id = _get_session_info()
+        client = _get_events_client()
+
+        events = client.list_events(org_id, project_id, session_id, str(check_id))
+        return events
+
+    except RecceCloudException as e:
+        logger.error(f"Failed to list check events: {e}")
+        raise HTTPException(status_code=e.status_code, detail=str(e.reason))
+    except RecceException as e:
+        logger.error(f"Failed to list check events: {e}")
+        raise HTTPException(status_code=400, detail=str(e))
+
+
+@check_events_router.get(
+    "/checks/{check_id}/events/{event_id}",
+    status_code=200,
+    response_model=CheckEventOut,
+)
+async def get_check_event(check_id: UUID, event_id: UUID):
+    """
+    Get a specific event by ID.
+
+    Args:
+        check_id: The check ID
+        event_id: The event ID
+
+    Returns:
+        CheckEventOut object
+
+    Raises:
+        400: Not connected to Recce Cloud
+        401: No API token available
+        404: Event not found
+    """
+    try:
+        org_id, project_id, session_id = _get_session_info()
+        client = _get_events_client()
+
+        event = client.get_event(org_id, project_id, session_id, str(check_id), str(event_id))
+        return event
+
+    except RecceCloudException as e:
+        logger.error(f"Failed to get check event: {e}")
+        raise HTTPException(status_code=e.status_code, detail=str(e.reason))
+    except RecceException as e:
+        logger.error(f"Failed to get check event: {e}")
+        raise HTTPException(status_code=400, detail=str(e))
+
+
+@check_events_router.post(
+    "/checks/{check_id}/events",
+    status_code=201,
+    response_model=CheckEventOut,
+)
+async def create_comment(check_id: UUID, body: CreateCommentIn):
+    """
+    Create a new comment on a check.
+
+    Args:
+        check_id: The check ID
+        body: Request body containing comment content
+
+    Returns:
+        Created CheckEventOut object
+
+    Raises:
+        400: Not connected to Recce Cloud or invalid content
+        401: No API token available
+        404: Check not found
+    """
+    if not body.content or not body.content.strip():
+        raise HTTPException(status_code=400, detail="Comment content cannot be empty.")
+
+    try:
+        org_id, project_id, session_id = _get_session_info()
+        client = _get_events_client()
+
+        event = client.create_comment(org_id, project_id, session_id, str(check_id), body.content)
+        return event
+
+    except RecceCloudException as e:
+        logger.error(f"Failed to create comment: {e}")
+        raise HTTPException(status_code=e.status_code, detail=str(e.reason))
+    except RecceException as e:
+        logger.error(f"Failed to create comment: {e}")
+        raise HTTPException(status_code=400, detail=str(e))
+
+
+@check_events_router.patch(
+    "/checks/{check_id}/events/{event_id}",
+    status_code=200,
+    response_model=CheckEventOut,
+)
+async def update_comment(check_id: UUID, event_id: UUID, body: UpdateCommentIn):
+    """
+    Update an existing comment.
+
+    Only the author or an admin can update a comment.
+
+    Args:
+        check_id: The check ID
+        event_id: The event ID of the comment to update
+        body: Request body containing new comment content
+
+    Returns:
+        Updated CheckEventOut object
+
+    Raises:
+        400: Not connected to Recce Cloud or invalid content
+        401: No API token available
+        403: Not authorized to update this comment
+        404: Comment not found
+    """
+    if not body.content or not body.content.strip():
+        raise HTTPException(status_code=400, detail="Comment content cannot be empty.")
+
+    try:
+        org_id, project_id, session_id = _get_session_info()
+        client = _get_events_client()
+
+        event = client.update_comment(org_id, project_id, session_id, str(check_id), str(event_id), body.content)
+        return event
+
+    except RecceCloudException as e:
+        logger.error(f"Failed to update comment: {e}")
+        raise HTTPException(status_code=e.status_code, detail=str(e.reason))
+    except RecceException as e:
+        logger.error(f"Failed to update comment: {e}")
+        raise HTTPException(status_code=400, detail=str(e))
+
+
+@check_events_router.delete(
+    "/checks/{check_id}/events/{event_id}",
+    status_code=204,
+)
+async def delete_comment(check_id: UUID, event_id: UUID):
+    """
+    Delete a comment (soft delete).
+
+    Only the author or an admin can delete a comment. The comment will be
+    marked as deleted but remain in the timeline with a "Comment deleted" indicator.
+
+    Args:
+        check_id: The check ID
+        event_id: The event ID of the comment to delete
+
+    Raises:
+        400: Not connected to Recce Cloud
+        401: No API token available
+        403: Not authorized to delete this comment
+        404: Comment not found
+    """
+    try:
+        org_id, project_id, session_id = _get_session_info()
+        client = _get_events_client()
+
+        client.delete_comment(org_id, project_id, session_id, str(check_id), str(event_id))
+
+    except RecceCloudException as e:
+        logger.error(f"Failed to delete comment: {e}")
+        raise HTTPException(status_code=e.status_code, detail=str(e.reason))
+    except RecceException as e:
+        logger.error(f"Failed to delete comment: {e}")
+        raise HTTPException(status_code=400, detail=str(e))

recce/apis/check_func.py

@@ -86,10 +86,10 @@ def create_check_from_run(
         is_preset=is_preset,
         is_checked=is_checked,
     )
-    CheckDAO().create(check)
-    run.check_id = check.check_id
+    new_check = CheckDAO().create(check)
+    run.check_id = new_check.check_id
 
-    return check
+    return new_check
 
 
 def create_check_without_run(
@@ -105,8 +105,8 @@ def create_check_without_run(
         is_preset=is_preset,
         is_checked=is_checked,
     )
-    CheckDAO().create(check)
-    return check
+    new_check = CheckDAO().create(check)
+    return new_check
 
 
 def purge_preset_checks():

recce/apis/run_func.py

@@ -122,12 +122,16 @@ def submit_run(type, params, check_id=None):
 
     task.progress_listener = progress_listener
 
-    async def update_run_result(run_id, result, error):
+    async def update_run_result(run, result, error, updated_params=None):
+        """Update run with result, error, and optionally updated params."""
         if run is None:
             return
         if result is not None:
             run.result = result
             run.status = RunStatus.FINISHED
+        if updated_params is not None:
+            # Merge updated params (preserves any fields not in updated_params)
+            run.params.update(updated_params)
         if error is not None:
             failed_reason = str(error) if str(error) != "None" else repr(error)
             run.error = failed_reason
@@ -138,10 +142,35 @@ def submit_run(type, params, check_id=None):
     def fn():
         try:
             result = task.execute()
-            asyncio.run_coroutine_threadsafe(update_run_result(run.run_id, result, None), loop)
+
+            # Extract updated params from task after execution
+            updated_params = None
+            if hasattr(task, "params") and task.params is not None:
+                # Serialization logic:
+                # - Most tasks use Pydantic models (v2: model_dump, v1: dict)
+                # - Some tasks may use plain dicts
+                # - If params is an unexpected type, log a warning for debugging
+                # - Handle the case where model_dump() or dict() raises an exception.
+                try:
+                    if hasattr(task.params, "model_dump"):
+                        updated_params = task.params.model_dump()
+                    elif hasattr(task.params, "dict"):
+                        updated_params = task.params.dict()
+                    elif isinstance(task.params, dict):
+                        updated_params = task.params
+                    else:
+                        logger.warning(
+                            f"Could not serialize task.params for run_id={run.run_id}: "
+                            f"unexpected type {type(task.params)} with value {repr(task.params)}"
+                        )
+                except Exception as e:
+                    logger.warning(f"Failed to serialize task.params: {e}")
+                    updated_params = None
+
+            asyncio.run_coroutine_threadsafe(update_run_result(run, result, None, updated_params), loop)
             return result
         except BaseException as e:
-            asyncio.run_coroutine_threadsafe(update_run_result(run.run_id, None, e), loop)
+            asyncio.run_coroutine_threadsafe(update_run_result(run, None, e, None), loop)
             if isinstance(e, RecceException) and e.is_raise is False:
                 return None
             import sentry_sdk

recce/artifact.py

@@ -40,7 +40,7 @@ def verify_artifacts_path(target_path: str) -> bool:
 
 
 def parse_dbt_version(file_path: str) -> str:
-    with open(file_path, "r") as f:
+    with open(file_path, "r", encoding="utf-8") as f:
         data = json.load(f)
 
     dbt_version = data.get("metadata", {}).get("dbt_version", None)
@@ -80,6 +80,64 @@ def archive_artifacts(target_path: str) -> (str, str):
     return artifacts_tar_gz_path, dbt_version
 
 
+def upload_artifacts_to_session(target_path: str, session_id: str, token: str, debug: bool = False):
+    """Upload dbt artifacts to a specific session ID in Recce Cloud."""
+    console = Console()
+    if verify_artifacts_path(target_path) is False:
+        console.print(f"[[red]Error[/red]] Invalid target path: {target_path}")
+        console.print("Please provide a valid target path containing manifest.json and catalog.json.")
+        return 1
+
+    manifest_path = os.path.join(target_path, "manifest.json")
+    catalog_path = os.path.join(target_path, "catalog.json")
+
+    # get the adapter type from the manifest file
+    with open(manifest_path, "r", encoding="utf-8") as f:
+        manifest_data = json.load(f)
+        adapter_type = manifest_data.get("metadata", {}).get("adapter_type")
+        if adapter_type is None:
+            raise Exception("Failed to parse adapter type from manifest.json")
+
+    recce_cloud = RecceCloud(token)
+
+    session = recce_cloud.get_session(session_id)
+
+    org_id = session.get("org_id")
+    if org_id is None:
+        raise Exception(f"Session ID {session_id} does not belong to any organization.")
+
+    project_id = session.get("project_id")
+    if project_id is None:
+        raise Exception(f"Session ID {session_id} does not belong to any project.")
+
+    # Get the presigned URL for uploading the artifacts using session ID
+    console.print(f'Uploading artifacts for session ID "{session_id}"')
+    presigned_urls = recce_cloud.get_upload_urls_by_session_id(org_id, project_id, session_id)
+    if debug:
+        console.rule("Debug information", style="blue")
+        console.print(f"Org ID: {org_id}")
+        console.print(f"Project ID: {project_id}")
+        console.print(f"Session ID: {session_id}")
+        console.print(f"Manifest path: {presigned_urls['manifest_url']}")
+        console.print(f"Catalog path: {presigned_urls['catalog_url']}")
+        console.print(f"Adapter type: {adapter_type}")
+
+    # Upload the compressed artifacts (no password needed for session uploads)
+    console.print(f'Uploading manifest from path "{manifest_path}"')
+    response = requests.put(presigned_urls["manifest_url"], data=open(manifest_path, "rb").read())
+    if response.status_code != 200 and response.status_code != 204:
+        raise Exception(response.text)
+    console.print(f'Uploading catalog from path "{catalog_path}"')
+    response = requests.put(presigned_urls["catalog_url"], data=open(catalog_path, "rb").read())
+    if response.status_code != 200 and response.status_code != 204:
+        raise Exception(response.text)
+
+    # Update the session metadata
+    recce_cloud.update_session(org_id, project_id, session_id, adapter_type)
+
+    return 0
+
+
 def upload_dbt_artifacts(target_path: str, branch: str, token: str, password: str, debug: bool = False):
     console = Console()
     if verify_artifacts_path(target_path) is False:
@@ -100,7 +158,7 @@ def upload_dbt_artifacts(target_path: str, branch: str, token: str, password: st
     metadata = {"commit": sha, "dbt_version": dbt_version}
 
     # Get the presigned URL for uploading the artifacts
-    presigned_url = RecceCloud(token).get_presigned_url(
+    presigned_url = RecceCloud(token).get_presigned_url_by_github_repo(
         method=PresignedUrlMethod.UPLOAD,
         repository=repo,
         artifact_name="dbt_artifacts.tar.gz",
@@ -145,7 +203,7 @@ def download_dbt_artifacts(
     sha = None
     dbt_version = None
 
-    presigned_url, tags = RecceCloud(token).get_download_presigned_url_with_tags(
+    presigned_url, tags = RecceCloud(token).get_download_presigned_url_by_github_repo_with_tags(
         repository=repo,
         artifact_name="dbt_artifacts.tar.gz",
         branch=branch,
@@ -191,3 +249,18 @@ def download_dbt_artifacts(
     except FileNotFoundError:
         pass
     return 0
+
+
+def delete_dbt_artifacts(branch: str, token: str, debug: bool = False):
+    """Delete dbt artifacts from a specific branch in Recce Cloud."""
+    console = Console()
+    repo = hosting_repo()
+
+    if debug:
+        console.rule("Debug information", style="blue")
+        console.print(f"Git Branch: {branch}")
+        console.print(f"GitHub repository: {repo}")
+
+    console.print(f'Deleting dbt artifacts from branch: "{branch}"')
+
+    RecceCloud(token).purge_artifacts(repo, branch=branch)