django-cfg 1.4.120__py3-none-any.whl → 1.5.2__py3-none-any.whl

django_cfg/apps/rq/serializers/health.py

@@ -0,0 +1,60 @@
+"""
+Health check and configuration serializers for Django-RQ.
+"""
+
+from rest_framework import serializers
+
+
+class HealthCheckSerializer(serializers.Serializer):
+    """
+    Health check response serializer.
+
+    Provides overall RQ cluster health status.
+    """
+
+    status = serializers.CharField(help_text="Health status (healthy/degraded/unhealthy)")
+    worker_count = serializers.IntegerField(help_text="Total number of active workers")
+    queue_count = serializers.IntegerField(help_text="Number of configured queues")
+    total_jobs = serializers.IntegerField(help_text="Total jobs across all queues")
+    timestamp = serializers.DateTimeField(help_text="Health check timestamp")
+    enabled = serializers.BooleanField(help_text="RQ enabled status")
+    redis_connected = serializers.BooleanField(help_text="Redis connection status")
+    wrapper_url = serializers.CharField(
+        required=False,
+        allow_blank=True,
+        default="",
+        help_text="Wrapper URL (optional)"
+    )
+    has_api_key = serializers.BooleanField(
+        required=False,
+        default=False,
+        help_text="API key configured status"
+    )
+
+
+class RQConfigSerializer(serializers.Serializer):
+    """
+    RQ configuration serializer.
+
+    Returns current RQ configuration from django-cfg.
+    """
+
+    enabled = serializers.BooleanField(help_text="RQ enabled status")
+    queues = serializers.DictField(help_text="Configured queues")
+    async_mode = serializers.BooleanField(
+        default=True, help_text="Async mode enabled"
+    )
+    show_admin_link = serializers.BooleanField(
+        default=True, help_text="Show admin link"
+    )
+    prometheus_enabled = serializers.BooleanField(
+        default=True, help_text="Prometheus metrics enabled"
+    )
+    api_token_configured = serializers.BooleanField(
+        default=False, help_text="API token is configured"
+    )
+    schedules = serializers.ListField(
+        required=False,
+        default=list,
+        help_text="Scheduled tasks from django-cfg config"
+    )

django_cfg/apps/rq/serializers/job.py

@@ -0,0 +1,100 @@
+"""
+Job information serializers for Django-RQ.
+"""
+
+from rest_framework import serializers
+
+
+class JobListSerializer(serializers.Serializer):
+    """
+    Job list item serializer.
+
+    Provides basic job information for list views.
+    """
+
+    id = serializers.CharField(help_text="Job ID")
+    func_name = serializers.CharField(help_text="Function name")
+    created_at = serializers.DateTimeField(help_text="Job creation time")
+    status = serializers.CharField(
+        help_text="Job status (queued/started/finished/failed)"
+    )
+    queue = serializers.CharField(help_text="Queue name")
+    timeout = serializers.IntegerField(
+        allow_null=True, required=False, help_text="Job timeout in seconds"
+    )
+
+
+class JobDetailSerializer(serializers.Serializer):
+    """
+    Detailed job information serializer.
+
+    Provides comprehensive job details including result and metadata.
+    """
+
+    id = serializers.CharField(help_text="Job ID")
+    func_name = serializers.CharField(help_text="Function name")
+    args = serializers.ListField(default=list, help_text="Function arguments")
+    kwargs = serializers.DictField(default=dict, help_text="Function keyword arguments")
+
+    # Status and timing
+    created_at = serializers.DateTimeField(help_text="Job creation time")
+    enqueued_at = serializers.DateTimeField(
+        allow_null=True, required=False, help_text="Job enqueue time"
+    )
+    started_at = serializers.DateTimeField(
+        allow_null=True, required=False, help_text="Job start time"
+    )
+    ended_at = serializers.DateTimeField(
+        allow_null=True, required=False, help_text="Job end time"
+    )
+    status = serializers.CharField(
+        help_text="Job status (queued/started/finished/failed)"
+    )
+
+    # Queue and worker
+    queue = serializers.CharField(help_text="Queue name")
+    worker_name = serializers.CharField(
+        allow_null=True, required=False, help_text="Worker name if started"
+    )
+
+    # Configuration
+    timeout = serializers.IntegerField(
+        allow_null=True, required=False, help_text="Job timeout in seconds"
+    )
+    result_ttl = serializers.IntegerField(
+        allow_null=True, required=False, help_text="Result TTL in seconds"
+    )
+    failure_ttl = serializers.IntegerField(
+        allow_null=True, required=False, help_text="Failure TTL in seconds"
+    )
+
+    # Result and error
+    result = serializers.JSONField(
+        allow_null=True, required=False, help_text="Job result if finished"
+    )
+    exc_info = serializers.CharField(
+        allow_null=True, required=False, help_text="Exception info if failed"
+    )
+
+    # Metadata
+    meta = serializers.DictField(default=dict, help_text="Job metadata")
+    dependency_ids = serializers.ListField(
+        child=serializers.CharField(),
+        default=list,
+        help_text="List of dependency job IDs",
+    )
+
+
+class JobActionResponseSerializer(serializers.Serializer):
+    """
+    Job action response serializer.
+
+    Used for job management actions (requeue, delete, etc.).
+    """
+
+    success = serializers.BooleanField(help_text="Action success status")
+    message = serializers.CharField(help_text="Action result message")
+    job_id = serializers.CharField(help_text="Job ID")
+    action = serializers.CharField(
+        help_text="Action performed (requeue/delete/cancel)"
+    )

django_cfg/apps/rq/serializers/queue.py

@@ -0,0 +1,80 @@
+"""
+Queue statistics serializers for Django-RQ.
+"""
+
+from rest_framework import serializers
+
+
+class QueueStatsSerializer(serializers.Serializer):
+    """
+    Queue statistics serializer.
+
+    Provides basic queue statistics.
+    """
+
+    name = serializers.CharField(help_text="Queue name")
+    count = serializers.IntegerField(help_text="Total jobs in queue")
+    queued_jobs = serializers.IntegerField(
+        default=0, help_text="Jobs waiting to be processed"
+    )
+    started_jobs = serializers.IntegerField(
+        default=0, help_text="Jobs currently being processed"
+    )
+    finished_jobs = serializers.IntegerField(default=0, help_text="Completed jobs")
+    failed_jobs = serializers.IntegerField(default=0, help_text="Failed jobs")
+    deferred_jobs = serializers.IntegerField(default=0, help_text="Deferred jobs")
+    scheduled_jobs = serializers.IntegerField(default=0, help_text="Scheduled jobs")
+    workers = serializers.IntegerField(
+        default=0, help_text="Number of workers for this queue"
+    )
+
+
+class QueueDetailSerializer(serializers.Serializer):
+    """
+    Detailed queue information serializer.
+
+    Provides comprehensive queue statistics and metadata.
+    """
+
+    name = serializers.CharField(help_text="Queue name")
+    count = serializers.IntegerField(help_text="Total jobs in queue")
+
+    # Job counts by status
+    queued_jobs = serializers.IntegerField(
+        default=0, help_text="Jobs waiting to be processed"
+    )
+    started_jobs = serializers.IntegerField(
+        default=0, help_text="Jobs currently being processed"
+    )
+    finished_jobs = serializers.IntegerField(default=0, help_text="Completed jobs")
+    failed_jobs = serializers.IntegerField(default=0, help_text="Failed jobs")
+    deferred_jobs = serializers.IntegerField(default=0, help_text="Deferred jobs")
+    scheduled_jobs = serializers.IntegerField(default=0, help_text="Scheduled jobs")
+
+    # Worker information
+    workers = serializers.IntegerField(
+        default=0, help_text="Number of workers for this queue"
+    )
+
+    # Metadata
+    oldest_job_timestamp = serializers.DateTimeField(
+        allow_null=True,
+        required=False,
+        help_text="Timestamp of oldest job in queue",
+    )
+    connection_kwargs = serializers.DictField(
+        default=dict, help_text="Redis connection parameters"
+    )
+    is_async = serializers.BooleanField(default=True, help_text="Queue is in async mode")
+
+
+class QueueJobListSerializer(serializers.Serializer):
+    """
+    List of jobs in queue (simple view).
+    """
+
+    queue_name = serializers.CharField(help_text="Queue name")
+    total_jobs = serializers.IntegerField(help_text="Total number of jobs")
+    jobs = serializers.ListField(
+        child=serializers.CharField(), default=list, help_text="List of job IDs"
+    )

django_cfg/apps/rq/serializers/schedule.py

@@ -0,0 +1,178 @@
+"""
+Schedule management serializers for Django-RQ.
+"""
+
+from rest_framework import serializers
+
+
+class ScheduleCreateSerializer(serializers.Serializer):
+    """
+    Serializer for creating a scheduled job.
+
+    Supports three scheduling methods:
+    1. scheduled_time: Schedule job at specific time
+    2. interval: Schedule job to repeat at intervals
+    3. cron: Schedule job with cron expression
+    """
+
+    # Job configuration
+    func = serializers.CharField(
+        help_text="Function path (e.g., 'myapp.tasks.my_task')"
+    )
+    args = serializers.ListField(
+        default=list,
+        required=False,
+        help_text="Function arguments"
+    )
+    kwargs = serializers.DictField(
+        default=dict,
+        required=False,
+        help_text="Function keyword arguments"
+    )
+
+    # Queue configuration
+    queue_name = serializers.CharField(
+        default="default",
+        help_text="Queue name to schedule job in"
+    )
+
+    # Scheduling options (choose one)
+    scheduled_time = serializers.DateTimeField(
+        required=False,
+        allow_null=True,
+        help_text="Schedule job at specific time (ISO 8601)"
+    )
+    interval = serializers.IntegerField(
+        required=False,
+        allow_null=True,
+        min_value=1,
+        help_text="Schedule job to repeat every N seconds"
+    )
+    cron = serializers.CharField(
+        required=False,
+        allow_null=True,
+        help_text="Cron expression (e.g., '0 0 * * *' for daily at midnight)"
+    )
+
+    # Job options
+    timeout = serializers.IntegerField(
+        required=False,
+        allow_null=True,
+        help_text="Job timeout in seconds"
+    )
+    result_ttl = serializers.IntegerField(
+        required=False,
+        allow_null=True,
+        help_text="Result TTL in seconds"
+    )
+    repeat = serializers.IntegerField(
+        required=False,
+        allow_null=True,
+        help_text="Number of times to repeat (None = infinite)"
+    )
+    description = serializers.CharField(
+        required=False,
+        allow_null=True,
+        max_length=255,
+        help_text="Job description"
+    )
+
+    def validate(self, attrs):
+        """Validate that exactly one scheduling method is provided."""
+        scheduling_methods = [
+            attrs.get('scheduled_time'),
+            attrs.get('interval'),
+            attrs.get('cron'),
+        ]
+        provided_methods = [m for m in scheduling_methods if m is not None]
+
+        if len(provided_methods) == 0:
+            raise serializers.ValidationError(
+                "Must provide one of: scheduled_time, interval, or cron"
+            )
+
+        if len(provided_methods) > 1:
+            raise serializers.ValidationError(
+                "Can only provide one scheduling method: scheduled_time, interval, or cron"
+            )
+
+        return attrs
+
+
+class ScheduledJobSerializer(serializers.Serializer):
+    """
+    Serializer for scheduled job information.
+    """
+
+    id = serializers.CharField(help_text="Job ID")
+    func = serializers.CharField(help_text="Function path")
+    args = serializers.ListField(default=list, help_text="Function arguments")
+    kwargs = serializers.DictField(default=dict, help_text="Function keyword arguments")
+
+    # Schedule info
+    queue_name = serializers.CharField(help_text="Queue name")
+    scheduled_time = serializers.DateTimeField(
+        allow_null=True,
+        required=False,
+        help_text="Next scheduled time"
+    )
+    interval = serializers.IntegerField(
+        allow_null=True,
+        required=False,
+        help_text="Repeat interval in seconds"
+    )
+    cron = serializers.CharField(
+        allow_null=True,
+        required=False,
+        help_text="Cron expression"
+    )
+
+    # Job options
+    timeout = serializers.IntegerField(
+        allow_null=True,
+        required=False,
+        help_text="Job timeout in seconds"
+    )
+    result_ttl = serializers.IntegerField(
+        allow_null=True,
+        required=False,
+        help_text="Result TTL in seconds"
+    )
+    repeat = serializers.IntegerField(
+        allow_null=True,
+        required=False,
+        help_text="Times to repeat (None = infinite)"
+    )
+    description = serializers.CharField(
+        allow_null=True,
+        required=False,
+        help_text="Job description"
+    )
+
+    # Metadata
+    created_at = serializers.DateTimeField(
+        allow_null=True,
+        required=False,
+        help_text="Job creation time"
+    )
+    meta = serializers.DictField(
+        default=dict,
+        help_text="Job metadata"
+    )
+
+
+class ScheduleActionResponseSerializer(serializers.Serializer):
+    """
+    Response serializer for schedule actions (create/delete).
+    """
+
+    success = serializers.BooleanField(help_text="Action success status")
+    message = serializers.CharField(help_text="Action result message")
+    job_id = serializers.CharField(
+        required=False,
+        allow_null=True,
+        help_text="Job ID (for create action)"
+    )
+    action = serializers.CharField(
+        help_text="Action performed (create/delete/cancel)"
+    )

django_cfg/apps/rq/serializers/testing.py

@@ -0,0 +1,139 @@
+"""
+DRF serializers for RQ testing and simulation endpoints.
+"""
+
+from rest_framework import serializers
+
+
+class TestScenarioSerializer(serializers.Serializer):
+    """Serializer for available test scenarios."""
+
+    id = serializers.CharField(help_text="Scenario ID")
+    name = serializers.CharField(help_text="Scenario name")
+    description = serializers.CharField(help_text="Scenario description")
+    task_func = serializers.CharField(help_text="Task function path")
+    default_args = serializers.ListField(
+        child=serializers.JSONField(),
+        required=False,
+        default=list,
+        help_text="Default arguments"
+    )
+    default_kwargs = serializers.DictField(
+        required=False,
+        default=dict,
+        help_text="Default keyword arguments"
+    )
+    estimated_duration = serializers.IntegerField(
+        required=False,
+        allow_null=True,
+        help_text="Estimated duration in seconds"
+    )
+
+
+class RunDemoRequestSerializer(serializers.Serializer):
+    """Serializer for running demo tasks."""
+
+    scenario = serializers.ChoiceField(
+        choices=[
+            'success',
+            'failure',
+            'slow',
+            'progress',
+            'retry',
+            'random',
+            'memory',
+            'cpu',
+        ],
+        help_text="Demo scenario to run"
+    )
+    queue = serializers.CharField(
+        default='default',
+        help_text="Queue name"
+    )
+    args = serializers.ListField(
+        child=serializers.JSONField(),
+        required=False,
+        default=list,
+        help_text="Task arguments"
+    )
+    kwargs = serializers.DictField(
+        required=False,
+        default=dict,
+        help_text="Task keyword arguments"
+    )
+    timeout = serializers.IntegerField(
+        required=False,
+        allow_null=True,
+        help_text="Job timeout in seconds"
+    )
+
+
+class StressTestRequestSerializer(serializers.Serializer):
+    """Serializer for stress testing."""
+
+    num_jobs = serializers.IntegerField(
+        min_value=1,
+        max_value=1000,
+        default=10,
+        help_text="Number of jobs to create"
+    )
+    queue = serializers.CharField(
+        default='default',
+        help_text="Queue name"
+    )
+    scenario = serializers.ChoiceField(
+        choices=['success', 'failure', 'slow', 'random'],
+        default='success',
+        help_text="Task scenario"
+    )
+    duration = serializers.IntegerField(
+        min_value=1,
+        max_value=60,
+        default=2,
+        help_text="Task duration in seconds"
+    )
+
+
+class TestingActionResponseSerializer(serializers.Serializer):
+    """Serializer for testing action responses."""
+
+    success = serializers.BooleanField(help_text="Action success status")
+    message = serializers.CharField(help_text="Action message")
+    job_ids = serializers.ListField(
+        child=serializers.CharField(),
+        required=False,
+        default=list,
+        help_text="Created job IDs"
+    )
+    count = serializers.IntegerField(
+        required=False,
+        allow_null=True,
+        help_text="Number of items affected"
+    )
+    metadata = serializers.DictField(
+        required=False,
+        default=dict,
+        help_text="Additional metadata"
+    )
+
+
+class CleanupRequestSerializer(serializers.Serializer):
+    """Serializer for cleanup operations."""
+
+    queue = serializers.CharField(
+        required=False,
+        allow_blank=True,
+        help_text="Queue name (empty for all queues)"
+    )
+    registries = serializers.ListField(
+        child=serializers.ChoiceField(
+            choices=['failed', 'finished', 'deferred', 'scheduled']
+        ),
+        required=False,
+        default=list,
+        help_text="Registries to clean"
+    )
+    delete_demo_jobs_only = serializers.BooleanField(
+        default=True,
+        help_text="Only delete demo jobs (func starts with 'demo_')"
+    )

django_cfg/apps/rq/serializers/worker.py

@@ -0,0 +1,58 @@
+"""
+Worker information serializers for Django-RQ.
+"""
+
+from rest_framework import serializers
+
+
+class WorkerSerializer(serializers.Serializer):
+    """
+    Worker information serializer.
+
+    Provides detailed information about an RQ worker.
+    """
+
+    name = serializers.CharField(help_text="Worker name/ID")
+    queues = serializers.ListField(
+        child=serializers.CharField(), default=list, help_text="List of queue names"
+    )
+    state = serializers.CharField(help_text="Worker state (idle/busy/suspended)")
+    current_job = serializers.CharField(
+        allow_null=True, required=False, help_text="Current job ID if busy"
+    )
+    birth = serializers.DateTimeField(help_text="Worker start time")
+    last_heartbeat = serializers.DateTimeField(help_text="Last heartbeat timestamp")
+    successful_job_count = serializers.IntegerField(
+        default=0, help_text="Total successful jobs"
+    )
+    failed_job_count = serializers.IntegerField(default=0, help_text="Total failed jobs")
+    total_working_time = serializers.FloatField(
+        default=0.0, help_text="Total working time in seconds"
+    )
+
+
+class WorkerStatsSerializer(serializers.Serializer):
+    """
+    Aggregated worker statistics serializer.
+
+    Provides overview of all workers across all queues.
+    """
+
+    total_workers = serializers.IntegerField(help_text="Total number of workers")
+    busy_workers = serializers.IntegerField(default=0, help_text="Number of busy workers")
+    idle_workers = serializers.IntegerField(default=0, help_text="Number of idle workers")
+    suspended_workers = serializers.IntegerField(
+        default=0, help_text="Number of suspended workers"
+    )
+    total_successful_jobs = serializers.IntegerField(
+        default=0, help_text="Total successful jobs (all workers)"
+    )
+    total_failed_jobs = serializers.IntegerField(
+        default=0, help_text="Total failed jobs (all workers)"
+    )
+    total_working_time = serializers.FloatField(
+        default=0.0, help_text="Total working time across all workers (seconds)"
+    )
+    workers = serializers.ListField(
+        child=WorkerSerializer(), default=list, help_text="List of individual workers"
+    )

django_cfg/apps/rq/services/__init__.py

@@ -0,0 +1,25 @@
+"""
+Services for Django-RQ monitoring.
+"""
+
+from .config_helper import (
+    get_redis_url,
+    get_rq_config,
+    is_prometheus_enabled,
+    is_rq_enabled,
+    register_schedules_from_config,
+)
+from .rq_converters import job_to_model, queue_to_model, worker_to_model
+
+__all__ = [
+    # Converters
+    'job_to_model',
+    'queue_to_model',
+    'worker_to_model',
+    # Config helpers
+    'get_redis_url',
+    'get_rq_config',
+    'is_rq_enabled',
+    'is_prometheus_enabled',
+    'register_schedules_from_config',
+]