django-cfg 1.4.116__py3-none-any.whl → 1.5.14__py3-none-any.whl

django_cfg/apps/tasks/models/task_log.py

@@ -1,246 +0,0 @@
-"""
-Task execution log model.
-
-Stores history of task executions for monitoring and debugging.
-"""
-from django.conf import settings
-from django.db import models
-from django.utils import timezone
-
-
-class TaskLog(models.Model):
-    """
-    Log of task executions.
-
-    Stores execution history from ReArq task queue.
-    Status values match ReArq's JobStatus enum.
-    """
-
-    class StatusChoices(models.TextChoices):
-        """Task status matching ReArq JobStatus enum."""
-        DEFERRED = "deferred", "Deferred"
-        QUEUED = "queued", "Queued"
-        IN_PROGRESS = "in_progress", "In Progress"
-        SUCCESS = "success", "Success"
-        FAILED = "failed", "Failed"
-        EXPIRED = "expired", "Expired"
-        CANCELED = "canceled", "Canceled"
-
-    # Task identification
-    job_id = models.CharField(
-        max_length=100,
-        unique=True,
-        db_index=True,
-        help_text="Unique job identifier from ReArq"
-    )
-    task_name = models.CharField(
-        max_length=200,
-        db_index=True,
-        help_text="Name of the task function"
-    )
-    queue_name = models.CharField(
-        max_length=100,
-        db_index=True,
-        help_text="Queue where task was executed"
-    )
-
-    # Arguments
-    args = models.JSONField(
-        default=list,
-        help_text="Positional arguments passed to task"
-    )
-    kwargs = models.JSONField(
-        default=dict,
-        help_text="Keyword arguments passed to task"
-    )
-
-    # Status tracking
-    status = models.CharField(
-        max_length=20,
-        choices=StatusChoices.choices,
-        default=StatusChoices.QUEUED,
-        db_index=True,
-        help_text="Current task status"
-    )
-
-    # Performance metrics
-    duration_ms = models.IntegerField(
-        null=True,
-        blank=True,
-        help_text="Task execution duration in milliseconds"
-    )
-
-    # Retry configuration (from ReArq Job)
-    job_retry = models.IntegerField(
-        default=0,
-        help_text="Maximum number of retries allowed (from task definition)"
-    )
-    job_retries = models.IntegerField(
-        default=0,
-        help_text="Number of retries performed so far"
-    )
-    job_retry_after = models.IntegerField(
-        default=60,
-        help_text="Seconds to wait before retry"
-    )
-
-    # Result tracking
-    success = models.BooleanField(
-        null=True,
-        blank=True,
-        help_text="Whether task completed successfully (null = not finished)"
-    )
-    result = models.TextField(
-        null=True,
-        blank=True,
-        help_text="Task result (JSON string)"
-    )
-    error_message = models.TextField(
-        null=True,
-        blank=True,
-        help_text="Error message if task failed"
-    )
-
-    # Worker information
-    worker_id = models.CharField(
-        max_length=100,
-        null=True,
-        blank=True,
-        help_text="ID of worker that processed the task"
-    )
-
-    # Timestamps (matching ReArq Job fields)
-    enqueue_time = models.DateTimeField(
-        db_index=True,
-        help_text="When job was enqueued to ReArq (from Job.enqueue_time)"
-    )
-    expire_time = models.DateTimeField(
-        null=True,
-        blank=True,
-        help_text="When job will expire (from Job.expire_time)"
-    )
-    start_time = models.DateTimeField(
-        null=True,
-        blank=True,
-        help_text="When task execution started (from JobResult.start_time)"
-    )
-    finish_time = models.DateTimeField(
-        null=True,
-        blank=True,
-        help_text="When task execution finished (from JobResult.finish_time)"
-    )
-
-    # Django-specific timestamps
-    created_at = models.DateTimeField(
-        auto_now_add=True,
-        help_text="When TaskLog record was created in Django DB"
-    )
-    updated_at = models.DateTimeField(
-        auto_now=True,
-        help_text="When TaskLog record was last updated"
-    )
-
-    # User tracking (optional)
-    user = models.ForeignKey(
-        settings.AUTH_USER_MODEL,
-        on_delete=models.SET_NULL,
-        null=True,
-        blank=True,
-        help_text="User who triggered the task (if applicable)"
-    )
-
-    class Meta:
-        # app_label is derived from apps.py: django_cfg.apps.tasks -> last segment = "tasks"
-        # To get "django_cfg_tasks" for consistent admin URLs, we explicitly set it:
-        app_label = "django_cfg_tasks"
-        db_table = "django_cfg_task_log"
-        ordering = ["-enqueue_time"]
-        indexes = [
-            models.Index(fields=["task_name", "-enqueue_time"]),
-            models.Index(fields=["status", "-enqueue_time"]),
-            models.Index(fields=["queue_name", "status"]),
-            models.Index(fields=["success", "-enqueue_time"]),
-            models.Index(fields=["-created_at"]),  # For Django admin
-        ]
-        verbose_name = "Task Log"
-        verbose_name_plural = "Task Logs"
-
-    def __str__(self) -> str:
-        return f"{self.task_name} ({self.status})"
-
-    @property
-    def is_completed(self) -> bool:
-        """Check if task is in a terminal state."""
-        return self.status in [
-            self.StatusChoices.SUCCESS,
-            self.StatusChoices.FAILED,
-            self.StatusChoices.EXPIRED,
-            self.StatusChoices.CANCELED,
-        ]
-
-    @property
-    def is_successful(self) -> bool:
-        """Check if task completed successfully."""
-        return self.status == self.StatusChoices.SUCCESS and self.success is True
-
-    @property
-    def is_failed(self) -> bool:
-        """Check if task failed."""
-        return self.status in [
-            self.StatusChoices.FAILED,
-            self.StatusChoices.EXPIRED,
-        ] or self.success is False
-
-    def mark_started(self, worker_id: str = None, start_time=None):
-        """Mark task as started (from ReArq JobResult)."""
-        self.status = self.StatusChoices.IN_PROGRESS
-        self.start_time = start_time or timezone.now()
-        if worker_id:
-            self.worker_id = worker_id
-        self.save(update_fields=["status", "start_time", "worker_id", "updated_at"])
-
-    def mark_completed(self, result: str = None, finish_time=None):
-        """Mark task as completed successfully (from ReArq JobResult)."""
-        self.status = self.StatusChoices.SUCCESS
-        self.success = True
-        self.finish_time = finish_time or timezone.now()
-        if result is not None:
-            self.result = result
-
-        # Calculate duration
-        if self.start_time and self.finish_time:
-            delta = self.finish_time - self.start_time
-            self.duration_ms = int(delta.total_seconds() * 1000)
-
-        self.save(update_fields=["status", "success", "finish_time", "result", "duration_ms", "updated_at"])
-
-    def mark_failed(self, error_message: str, finish_time=None):
-        """Mark task as failed with error message (from ReArq JobResult)."""
-        self.status = self.StatusChoices.FAILED
-        self.success = False
-        self.error_message = error_message
-        self.finish_time = finish_time or timezone.now()
-
-        # Calculate duration
-        if self.start_time and self.finish_time:
-            delta = self.finish_time - self.start_time
-            self.duration_ms = int(delta.total_seconds() * 1000)
-
-        self.save(update_fields=["status", "success", "error_message", "finish_time", "duration_ms", "updated_at"])
-
-    def mark_expired(self):
-        """Mark task as expired (from ReArq Job.status)."""
-        self.status = self.StatusChoices.EXPIRED
-        self.success = False
-        self.save(update_fields=["status", "success", "updated_at"])
-
-    def mark_canceled(self):
-        """Mark task as canceled (from ReArq Job.status)."""
-        self.status = self.StatusChoices.CANCELED
-        self.success = False
-        self.save(update_fields=["status", "success", "updated_at"])
-
-    def increment_retry(self):
-        """Increment retry counter (from ReArq Job.job_retries)."""
-        self.job_retries += 1
-        self.save(update_fields=["job_retries", "updated_at"])

django_cfg/apps/tasks/serializers/__init__.py

@@ -1,28 +0,0 @@
-"""
-ReArq Tasks API Serializers.
-
-DRF serializers for TaskLog model and ReArq operations.
-"""
-from .task_log import (
-    TaskLogSerializer,
-    TaskLogListSerializer,
-    TaskLogDetailSerializer,
-    TaskLogStatsSerializer,
-    TasksByQueueSerializer,
-    TasksByStatusSerializer,
-    TaskLogOverviewSerializer,
-    TaskLogTimelineItemSerializer,
-    TaskLogTimelineSerializer,
-)
-
-__all__ = [
-    "TaskLogSerializer",
-    "TaskLogListSerializer",
-    "TaskLogDetailSerializer",
-    "TaskLogStatsSerializer",
-    "TasksByQueueSerializer",
-    "TasksByStatusSerializer",
-    "TaskLogOverviewSerializer",
-    "TaskLogTimelineItemSerializer",
-    "TaskLogTimelineSerializer",
-]

django_cfg/apps/tasks/serializers/task_log.py

@@ -1,249 +0,0 @@
-"""
-TaskLog DRF Serializers.
-
-Serializers for TaskLog model with filtering and statistics.
-"""
-from rest_framework import serializers
-from ..models import TaskLog
-
-
-class TaskLogSerializer(serializers.ModelSerializer):
-    """
-    Basic TaskLog serializer.
-
-    Used for list views with essential fields only.
-    Includes computed properties matching ReArq response format.
-    """
-
-    duration_seconds = serializers.SerializerMethodField()
-    is_completed = serializers.BooleanField(read_only=True)
-    is_successful = serializers.BooleanField(read_only=True)
-    is_failed = serializers.BooleanField(read_only=True)
-
-    class Meta:
-        model = TaskLog
-        fields = [
-            'id',
-            'job_id',
-            'task_name',
-            'queue_name',
-            'status',
-            'success',
-            'duration_ms',
-            'duration_seconds',
-            'job_retry',
-            'job_retries',
-            'enqueue_time',
-            'expire_time',
-            'start_time',
-            'finish_time',
-            'is_completed',
-            'is_successful',
-            'is_failed',
-        ]
-        read_only_fields = fields
-
-    def get_duration_seconds(self, obj) -> float:
-        """Convert duration from ms to seconds."""
-        if obj.duration_ms is not None:
-            return round(obj.duration_ms / 1000, 2)
-        return None
-
-
-class TaskLogListSerializer(serializers.ModelSerializer):
-    """
-    Compact serializer for list views.
-
-    Minimal fields for performance, matching ReArq Job list format.
-    """
-
-    status_display = serializers.CharField(source='get_status_display', read_only=True)
-
-    class Meta:
-        model = TaskLog
-        fields = [
-            'id',
-            'job_id',
-            'task_name',
-            'queue_name',
-            'status',
-            'status_display',
-            'success',
-            'job_retries',
-            'duration_ms',
-            'enqueue_time',
-            'start_time',
-            'finish_time',
-        ]
-        read_only_fields = fields
-
-
-class TaskLogDetailSerializer(serializers.ModelSerializer):
-    """
-    Detailed TaskLog serializer.
-
-    Includes all fields including args, kwargs, result, error messages.
-    Combines ReArq Job + JobResult data.
-    """
-
-    status_display = serializers.CharField(source='get_status_display', read_only=True)
-    duration_seconds = serializers.SerializerMethodField()
-    user_display = serializers.SerializerMethodField()
-
-    class Meta:
-        model = TaskLog
-        fields = [
-            # Job identification
-            'id',
-            'job_id',
-            'task_name',
-            'queue_name',
-            # Status
-            'status',
-            'status_display',
-            'success',
-            # Arguments
-            'args',
-            'kwargs',
-            # Result
-            'result',
-            'error_message',
-            # Performance
-            'duration_ms',
-            'duration_seconds',
-            # Retry info (from ReArq Job)
-            'job_retry',
-            'job_retries',
-            'job_retry_after',
-            # Worker
-            'worker_id',
-            # Timestamps (from ReArq)
-            'enqueue_time',
-            'expire_time',
-            'start_time',
-            'finish_time',
-            # Django timestamps
-            'created_at',
-            'updated_at',
-            # User
-            'user',
-            'user_display',
-        ]
-        read_only_fields = fields
-
-    def get_duration_seconds(self, obj) -> float:
-        """Convert duration from ms to seconds."""
-        if obj.duration_ms is not None:
-            return round(obj.duration_ms / 1000, 2)
-        return None
-
-    def get_user_display(self, obj) -> str:
-        """Get user display name."""
-        if obj.user:
-            return f"{obj.user.username} ({obj.user.email})"
-        return None
-
-
-class TaskLogStatsSerializer(serializers.Serializer):
-    """
-    Statistics serializer for task metrics.
-
-    Not tied to a model - used for aggregated data.
-    """
-
-    total = serializers.IntegerField(help_text="Total number of task executions")
-    successful = serializers.IntegerField(help_text="Number of successful executions")
-    failed = serializers.IntegerField(help_text="Number of failed executions")
-    in_progress = serializers.IntegerField(help_text="Number of tasks currently running")
-    success_rate = serializers.FloatField(help_text="Success rate percentage")
-    avg_duration_ms = serializers.IntegerField(help_text="Average duration in milliseconds")
-    avg_duration_seconds = serializers.FloatField(help_text="Average duration in seconds")
-    period_hours = serializers.IntegerField(help_text="Statistics period in hours", required=False)
-
-
-class TasksByQueueSerializer(serializers.Serializer):
-    """
-    Tasks count by queue.
-
-    Used in overview endpoint for tasks_by_queue list.
-    """
-    queue_name = serializers.CharField(help_text="Queue name")
-    count = serializers.IntegerField(help_text="Number of tasks in this queue")
-
-
-class TasksByStatusSerializer(serializers.Serializer):
-    """
-    Tasks count by status.
-
-    Used in overview endpoint for tasks_by_status list.
-    """
-    status = serializers.CharField(help_text="Task status")
-    count = serializers.IntegerField(help_text="Number of tasks with this status")
-
-
-class TaskLogOverviewSerializer(serializers.Serializer):
-    """
-    Overview of task system with proper structure.
-
-    Provides high-level statistics about the entire task system:
-    - Total tasks count (all-time)
-    - Active queues list
-    - Recent failures (last 24h)
-    - Tasks distribution by queue (as array)
-    - Tasks distribution by status (as array)
-
-    Used by /cfg/tasks/logs/overview/ endpoint.
-    """
-    total_tasks = serializers.IntegerField(help_text="Total number of tasks all-time")
-    active_queues = serializers.ListField(
-        child=serializers.CharField(),
-        help_text="List of active queue names"
-    )
-    recent_failures = serializers.IntegerField(help_text="Failed tasks in last 24 hours")
-    tasks_by_queue = TasksByQueueSerializer(
-        many=True,
-        help_text="Tasks grouped by queue name"
-    )
-    tasks_by_status = TasksByStatusSerializer(
-        many=True,
-        help_text="Tasks grouped by status"
-    )
-
-
-class TaskLogTimelineItemSerializer(serializers.Serializer):
-    """
-    Single timeline data point.
-
-    Represents aggregated task statistics for a specific time period.
-    """
-    timestamp = serializers.DateTimeField(help_text="Time bucket start")
-    total = serializers.IntegerField(help_text="Total tasks in this period")
-    successful = serializers.IntegerField(help_text="Successful tasks")
-    failed = serializers.IntegerField(help_text="Failed tasks")
-    in_progress = serializers.IntegerField(help_text="Tasks currently in progress", required=False)
-    avg_duration_ms = serializers.FloatField(help_text="Average duration in milliseconds", required=False)
-
-
-class TaskLogTimelineSerializer(serializers.Serializer):
-    """
-    Timeline response wrapper.
-
-    Returns timeline data as array of time-bucketed statistics.
-    Used by /cfg/tasks/logs/timeline/ endpoint.
-    """
-    period_hours = serializers.IntegerField(help_text="Time period covered in hours")
-    interval = serializers.CharField(help_text="Time bucket interval (hour/day)")
-    data = TaskLogTimelineItemSerializer(many=True, help_text="Timeline data points")
-
-
-__all__ = [
-    "TaskLogSerializer",
-    "TaskLogListSerializer",
-    "TaskLogDetailSerializer",
-    "TaskLogStatsSerializer",
-    "TasksByQueueSerializer",
-    "TasksByStatusSerializer",
-    "TaskLogOverviewSerializer",
-    "TaskLogTimelineItemSerializer",
-    "TaskLogTimelineSerializer",
-]

django_cfg/apps/tasks/services/__init__.py

@@ -1,10 +0,0 @@
-"""Task services module."""
-from .client import ReArqClient, get_rearq_client
-from .config_helper import get_tasks_config, get_tasks_config_or_default
-
-__all__ = [
-    "ReArqClient",
-    "get_rearq_client",
-    "get_tasks_config",
-    "get_tasks_config_or_default",
-]

django_cfg/apps/tasks/services/client/__init__.py

@@ -1,7 +0,0 @@
-"""ReArq client module."""
-from .client import ReArqClient, get_rearq_client
-
-__all__ = [
-    "ReArqClient",
-    "get_rearq_client",
-]