upnext-shared 0.0.1__tar.gz

upnext_shared-0.0.1/.gitignore

@@ -0,0 +1,111 @@
+# =============================================================================
+# Python
+# =============================================================================
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+*.manifest
+pip-log.txt
+pip-delete-this-directory.txt
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+*.mo
+*.pot
+.venv/
+venv/
+ENV/
+env/
+.pdm.toml
+.pdm-python
+.pdm-build/
+__pypackages__/
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+.pytype/
+cython_debug/
+.ruff_cache/
+.pypirc
+
+# =============================================================================
+# Node / Next.js
+# =============================================================================
+node_modules/
+.pnp
+.pnp.js
+.next/
+out/
+next-env.d.ts
+.source/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+*.tsbuildinfo
+.vercel
+
+# =============================================================================
+# Database
+# =============================================================================
+*.sqlite
+*.sqlite3
+*.sqlite3-journal
+db.sqlite
+db.sqlite3
+
+# =============================================================================
+# Environment & Secrets
+# =============================================================================
+.env
+.env*.local
+.env.prod
+
+# =============================================================================
+# IDE & OS
+# =============================================================================
+.DS_Store
+*.pem
+.idea/
+*.swp
+*.swo
+*~
+
+# =============================================================================
+# Testing & Coverage
+# =============================================================================
+coverage/
+coverage_html/
+test-results/
+playwright-report/
+blob-report/
+.vitest/
+
+# =============================================================================
+# tanstack start
+# =============================================================================
+.output/
+.tanstack/

upnext_shared-0.0.1/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: upnext-shared
+Version: 0.0.1
+Summary: Shared models for UpNext packages
+Requires-Python: >=3.12
+Requires-Dist: pydantic>=2.10.0

upnext_shared-0.0.1/pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "upnext-shared"
+dynamic = ["version"]
+description = "Shared models for UpNext packages"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "pydantic>=2.10.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/shared"]
+
+[tool.hatch.version]
+path = "src/shared/_version.py"

upnext_shared-0.0.1/src/shared/__init__.py

@@ -0,0 +1,139 @@
+"""Shared models for UpNext packages."""
+
+from shared._version import __version__
+from shared.api import API_PREFIX, HOURLY_BUCKET_TTL, MINUTE_BUCKET_TTL, REGISTRY_TTL
+from shared.artifacts import ArtifactType
+from shared.events import (
+    BatchEventItem,
+    BatchEventRequest,
+    EventRequest,
+    EventType,
+    HealthResponse,
+    JobCheckpointEvent,
+    JobCompletedEvent,
+    JobFailedEvent,
+    JobProgressEvent,
+    JobRetryingEvent,
+    JobStartedEvent,
+)
+from shared.models import Job, JobStatus, StateTransition
+from shared.patterns import get_matching_patterns, matches_event_pattern
+from shared.schemas import (
+    ApiDetailResponse,
+    ApiEndpoint,
+    ApiInfo,
+    ApiInstance,
+    ApiOverview,
+    ApiPageResponse,
+    ApiRequestEvent,
+    ApiRequestEventsResponse,
+    ApiRequestSnapshotEvent,
+    ApisListResponse,
+    ApiSnapshotEvent,
+    ApisSnapshotEvent,
+    ApiStats,
+    ApiTrendHour,
+    ApiTrendsResponse,
+    ApiTrendsSnapshotEvent,
+    ArtifactCreateResponse,
+    ArtifactListResponse,
+    ArtifactQueuedResponse,
+    ArtifactResponse,
+    ArtifactStreamEvent,
+    CreateArtifactRequest,
+    DashboardStats,
+    EndpointsListResponse,
+    ErrorResponse,
+    FunctionDetailResponse,
+    FunctionInfo,
+    FunctionsListResponse,
+    FunctionType,
+    JobHistoryResponse,
+    JobListResponse,
+    JobStatsResponse,
+    JobTrendHour,
+    JobTrendsResponse,
+    JobTrendsSnapshotEvent,
+    Run,
+    RunStats,
+    WorkerInfo,
+    WorkerInstance,
+    WorkersListResponse,
+    WorkersSnapshotEvent,
+    WorkerStats,
+)
+
+__all__ = [
+    "__version__",
+    # API tracking constants
+    "API_PREFIX",
+    "MINUTE_BUCKET_TTL",
+    "HOURLY_BUCKET_TTL",
+    "REGISTRY_TTL",
+    # Core models
+    "Job",
+    "JobStatus",
+    "StateTransition",
+    # Events
+    "EventType",
+    "EventRequest",
+    "BatchEventItem",
+    "BatchEventRequest",
+    "JobStartedEvent",
+    "JobCompletedEvent",
+    "JobFailedEvent",
+    "JobRetryingEvent",
+    "JobProgressEvent",
+    "JobCheckpointEvent",
+    # Artifacts
+    "ArtifactType",
+    "ArtifactCreateResponse",
+    "ArtifactQueuedResponse",
+    "ArtifactResponse",
+    "ArtifactListResponse",
+    "ArtifactStreamEvent",
+    "CreateArtifactRequest",
+    "ErrorResponse",
+    # Health
+    "HealthResponse",
+    # Pattern matching
+    "matches_event_pattern",
+    "get_matching_patterns",
+    # API Schemas
+    "ApiInstance",
+    "ApiEndpoint",
+    "ApiInfo",
+    "ApiOverview",
+    "ApiPageResponse",
+    "ApiRequestEvent",
+    "ApiRequestEventsResponse",
+    "ApiRequestSnapshotEvent",
+    "ApisSnapshotEvent",
+    "ApisListResponse",
+    "ApiSnapshotEvent",
+    "EndpointsListResponse",
+    "ApiDetailResponse",
+    "ApiTrendHour",
+    "ApiTrendsSnapshotEvent",
+    "ApiTrendsResponse",
+    "FunctionType",
+    "Run",
+    "WorkerInstance",
+    "WorkerInfo",
+    "WorkersListResponse",
+    "WorkersSnapshotEvent",
+    "WorkerStats",
+    "FunctionInfo",
+    "FunctionsListResponse",
+    "FunctionDetailResponse",
+    "RunStats",
+    "ApiStats",
+    "DashboardStats",
+    # Job History
+    "JobHistoryResponse",
+    "JobListResponse",
+    "JobStatsResponse",
+    "JobTrendHour",
+    "JobTrendsSnapshotEvent",
+    "JobTrendsResponse",
+]

upnext_shared-0.0.1/src/shared/_version.py

@@ -0,0 +1,3 @@
+"""Canonical package version for the UpNext workspace."""
+
+__version__ = "0.0.1"

upnext_shared-0.0.1/src/shared/api.py

@@ -0,0 +1,26 @@
+"""API tracking constants shared between SDK middleware and server reader.
+
+Redis key structure:
+    upnext:api:registry                                    -> SET of api names
+    upnext:api:{api}:endpoints                             -> SET of "METHOD:path"
+    upnext:api:{api}:{method}:{path}:m:{YYYY-MM-DDTHH:MM} -> HASH (minute bucket)
+    upnext:api:{api}:{method}:{path}:h:{YYYY-MM-DDTHH}    -> HASH (hourly bucket)
+
+Each hash contains:
+    requests, errors, total_latency_ms, status_2xx, status_4xx, status_5xx
+"""
+
+# Key prefix for all API tracking keys
+API_PREFIX = "upnext:apis"
+
+# Key prefix for API instance heartbeats
+API_INSTANCE_PREFIX = "upnext:apis:instances"
+
+# TTLs (seconds)
+MINUTE_BUCKET_TTL = 600  # 10 minutes
+HOURLY_BUCKET_TTL = 2_592_000  # 30 days
+REGISTRY_TTL = 2_592_000  # 30 days
+
+# API instance TTL - must heartbeat within this time
+# With 10s heartbeat interval, this gives 3 missed heartbeats before expiry
+API_INSTANCE_TTL = 30

upnext_shared-0.0.1/src/shared/artifacts.py

@@ -0,0 +1,20 @@
+"""Artifact types for job outputs."""
+
+from enum import StrEnum
+
+
+class ArtifactType(StrEnum):
+    """Artifact types for job outputs."""
+
+    TEXT = "text"
+    JSON = "json"
+    PNG = "image/png"
+    JPEG = "image/jpeg"
+    WEBP = "image/webp"
+    GIF = "image/gif"
+    SVG = "image/svg"
+    PDF = "file/pdf"
+    CSV = "file/csv"
+    XML = "file/xml"
+    HTML = "file/html"
+    BINARY = "file/binary"

upnext_shared-0.0.1/src/shared/events.py

@@ -0,0 +1,189 @@
+"""Event schemas for job tracking between workers and API."""
+
+from datetime import datetime
+from enum import StrEnum
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict, Field
+
+EVENTS_STREAM = "upnext:events"
+API_REQUESTS_STREAM = "upnext:events:api:requests"
+ARTIFACT_EVENTS_STREAM = "upnext:events:artifacts"
+EVENTS_PUBSUB_CHANNEL = "upnext:events:pubsub"
+
+
+class EventType(StrEnum):
+    """Event types sent from workers to API."""
+
+    JOB_STARTED = "job.started"
+    JOB_COMPLETED = "job.completed"
+    JOB_FAILED = "job.failed"
+    JOB_RETRYING = "job.retrying"
+    JOB_PROGRESS = "job.progress"
+    JOB_CHECKPOINT = "job.checkpoint"
+
+
+class JobStartedEvent(BaseModel):
+    """Event data for job.started."""
+
+    job_id: str
+    function: str
+    function_name: str
+    parent_id: str | None = None
+    root_id: str
+    kwargs: dict[str, Any] = Field(default_factory=dict)
+    metadata: dict[str, Any] = Field(default_factory=dict)
+    attempt: int = 1
+    max_retries: int = 0
+    worker_id: str | None = None
+    started_at: datetime
+
+
+class JobCompletedEvent(BaseModel):
+    """Event data for job.completed."""
+
+    job_id: str
+    function: str
+    function_name: str
+    parent_id: str | None = None
+    root_id: str
+    result: Any = None
+    duration_ms: float | None = None
+    attempt: int = 1
+    completed_at: datetime
+
+
+class JobFailedEvent(BaseModel):
+    """Event data for job.failed."""
+
+    job_id: str
+    function: str
+    function_name: str
+    parent_id: str | None = None
+    root_id: str
+    error: str
+    traceback: str | None = None
+    attempt: int = 1
+    max_retries: int = 0
+    will_retry: bool = False
+    failed_at: datetime
+
+
+class JobRetryingEvent(BaseModel):
+    """Event data for job.retrying."""
+
+    job_id: str
+    function: str
+    function_name: str
+    parent_id: str | None = None
+    root_id: str
+    error: str
+    delay_seconds: float
+    current_attempt: int
+    next_attempt: int
+    retry_at: datetime
+
+
+class JobProgressEvent(BaseModel):
+    """Event data for job.progress."""
+
+    job_id: str
+    parent_id: str | None = None
+    root_id: str
+    progress: float
+    message: str | None = None
+    updated_at: datetime
+
+
+class JobCheckpointEvent(BaseModel):
+    """Event data for job.checkpoint."""
+
+    job_id: str
+    parent_id: str | None = None
+    root_id: str
+    state: dict[str, Any]
+    checkpointed_at: datetime
+
+
+class SSEJobEvent(BaseModel):
+    """Event payload streamed to browser clients via SSE.
+
+    Only includes fields the dashboard needs — sensitive data like
+    kwargs, result, traceback, and checkpoint state are excluded.
+    Extra fields from the source event are silently dropped.
+    """
+
+    model_config = ConfigDict(extra="ignore")
+
+    type: str
+    job_id: str = ""
+    worker_id: str = ""
+    function: str | None = None
+    function_name: str | None = None
+    parent_id: str | None = None
+    root_id: str
+    # job.started / job.completed / job.failed
+    attempt: int | None = None
+    max_retries: int | None = None
+    started_at: datetime | None = None
+    # job.completed
+    duration_ms: float | None = None
+    completed_at: datetime | None = None
+    # job.failed
+    error: str | None = None
+    failed_at: datetime | None = None
+    # job.retrying
+    current_attempt: int | None = None
+    next_attempt: int | None = None
+    # job.progress
+    progress: float | None = None
+    message: str | None = None
+
+
+class EventRequest(BaseModel):
+    """Generic event request from workers."""
+
+    type: str
+    data: dict[str, Any]
+    worker_id: str | None = None
+
+
+class BatchEventItem(BaseModel):
+    """Single event in a batch."""
+
+    type: str
+    job_id: str
+    worker_id: str
+    timestamp: float
+    data: dict[str, Any] = Field(default_factory=dict)
+
+
+class BatchEventRequest(BaseModel):
+    """Batch of events from workers."""
+
+    events: list[BatchEventItem]
+    worker_id: str | None = None
+
+
+class HealthResponse(BaseModel):
+    """Health check response."""
+
+    status: str = "ok"
+    version: str
+    tier: str = "free"
+    features: list[str] = Field(default_factory=list)
+
+
+class EventResponse(BaseModel):
+    """Event response."""
+
+    status: str = "ok"
+    event_type: str
+
+
+class BatchEventResponse(BaseModel):
+    """Batch event response."""
+
+    status: str = "ok"
+    processed: int
+    errors: int = 0