django-webhook-subscriber 1.0.0__py3-none-any.whl → 2.0.0__py3-none-any.whl

django_webhook_subscriber/managers.py

@@ -1,9 +1,13 @@
 """Managers for Django Webhook Subscriber."""
 
+import logging
+
 from django.db import models
 from django.utils import timezone
 
-from django_webhook_subscriber.conf import rest_webhook_settings
+from .conf import rest_webhook_settings
+
+logger = logging.getLogger(__name__)
 
 
 class WebhookDeliveryLogManager(models.Manager):
@@ -13,41 +17,59 @@ class WebhookDeliveryLogManager(models.Manager):
     age, and to clean up old logs based on retention settings.
     """
 
-    def cleanup_old_logs(self, webhook=None):
+    def cleanup_old_logs(self, subscription=None):
         """This method will cleanup old logs based on retention settings."""
 
         # Get retention period from settings
-        days = getattr(rest_webhook_settings, 'LOG_RETENTION_DAYS')
+        days = getattr(rest_webhook_settings, "LOG_RETENTION_DAYS")
 
         # Calculate cutoff date
         cutoff_date = timezone.now() - timezone.timedelta(days=days)
 
         # Build query
         query = self.filter(created_at__lt=cutoff_date)
-        if webhook:
-            # If a webhook is provided, filter by it
-            query = query.filter(webhook=webhook)
+
+        logger.debug("Cleaning up logs older than: %s...", cutoff_date)
+
+        if subscription:
+            # If a subscription is provided, filter by it
+            query = query.filter(subscription=subscription)
+
+        logger.debug("Found a total of %d old logs.", query.count())
 
         # Delete old logs
-        query.delete()
+        deleted, _ = query.delete()
+
+        logger.info("Deleted a total of %d old logs.", deleted)
 
     def create(self, **kwargs):
-        """This method will create a new log entry, and proceed to cleanup
-        old logs if necessary."""
+        """
+        This method will create a new log entry, and proceed to cleanup old
+        logs if necessary.
+        """
 
         # create the log entry
         log = super().create(**kwargs)
 
         # Checking if AUTO_CLEANUP is set to True
-        auto_cleanup = getattr(rest_webhook_settings, 'AUTO_CLEANUP')
+        auto_cleanup = getattr(rest_webhook_settings, "AUTO_CLEANUP")
 
         # cleanup old logs if necessary
-        if auto_cleanup and kwargs['webhook']:
+        if (
+            auto_cleanup
+            and "subscription" in kwargs
+            and kwargs["subscription"]
+        ):
             # Using a try/except block to prevent any errors during cleanup
             # from affecting the log creation process
             try:
-                self.cleanup_old_logs(webhook=kwargs['webhook'])
-            except Exception:
-                pass
+                logger.debug(
+                    "Cleaning up old logs for subscription: %s...",
+                    kwargs["subscription"],
+                )
+
+                self.cleanup_old_logs(subscription=kwargs["subscription"])
+            except Exception as e:
+                logger.error("Error cleaning up old logs: %s", str(e))
 
         return log

django_webhook_subscriber/migrations/0002_remove_webhookregistry_content_type_and_more.py

@@ -0,0 +1,192 @@
+# Generated by Django 5.2.6 on 2025-09-29 10:38
+
+import django.db.models.deletion
+import django_webhook_subscriber.utils
+import django_webhook_subscriber.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('contenttypes', '0002_remove_content_type_name'),
+        ('django_webhook_subscriber', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='webhookregistry',
+            name='content_type',
+        ),
+        migrations.RemoveField(
+            model_name='webhookdeliverylog',
+            name='webhook',
+        ),
+        migrations.RemoveField(
+            model_name='webhookdeliverylog',
+            name='event_signal',
+        ),
+        migrations.AddField(
+            model_name='webhookdeliverylog',
+            name='attempt_number',
+            field=models.PositiveSmallIntegerField(default=1),
+        ),
+        migrations.AddField(
+            model_name='webhookdeliverylog',
+            name='delivery_duration_ms',
+            field=models.PositiveIntegerField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='webhookdeliverylog',
+            name='delivery_url',
+            field=models.CharField(default='', max_length=500),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name='webhookdeliverylog',
+            name='is_retry',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name='webhookdeliverylog',
+            name='response_headers',
+            field=models.JSONField(blank=True, default=dict),
+        ),
+        migrations.AlterField(
+            model_name='webhookdeliverylog',
+            name='error_message',
+            field=models.TextField(blank=True, default=''),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name='webhookdeliverylog',
+            name='payload',
+            field=models.JSONField(default=dict),
+        ),
+        migrations.AlterField(
+            model_name='webhookdeliverylog',
+            name='response_body',
+            field=models.TextField(blank=True, default=None),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name='webhookdeliverylog',
+            name='response_status',
+            field=models.PositiveIntegerField(blank=True, null=True),
+        ),
+        migrations.CreateModel(
+            name='WebhookSubscriber',
+            fields=[
+                ('id', models.AutoField(primary_key=True, serialize=False)),
+                ('name', models.CharField(help_text='Name of this subscriber', max_length=255)),
+                ('description', models.TextField(blank=True)),
+                ('target_url', models.CharField(help_text='The base URL for webhook delivery', max_length=500)),
+                ('secret', models.CharField(default=django_webhook_subscriber.utils.generate_secret, help_text='Secret key for webhook authentication via X-Secret header', max_length=64)),
+                ('serializer_class', models.CharField(blank=True, help_text="Dot path to DRF serializer class (e.g., 'myapp.serializers.MySerializer')", max_length=512, validators=[django_webhook_subscriber.validators.validate_class_path])),
+                ('headers', models.JSONField(blank=True, default=dict, help_text='Additional headers to send (JSON format)', validators=[django_webhook_subscriber.validators.validate_headers])),
+                ('max_retries', models.PositiveIntegerField(default=3, help_text='Max delivery attempts')),
+                ('retry_delay', models.PositiveIntegerField(default=60, help_text='Seconds between retries')),
+                ('timeout', models.PositiveIntegerField(default=30, help_text='Request timeout in seconds')),
+                ('auto_disable_after_failures', models.PositiveIntegerField(default=10, help_text='Auto-disable after N consecutive failures (0 = never)')),
+                ('is_active', models.BooleanField(default=True)),
+                ('consecutive_failures', models.PositiveIntegerField(default=0)),
+                ('last_success', models.DateTimeField(blank=True, null=True)),
+                ('last_failure', models.DateTimeField(blank=True, null=True)),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('content_type', models.ForeignKey(help_text='The model this subscriber watches', on_delete=django.db.models.deletion.CASCADE, to='contenttypes.contenttype')),
+            ],
+            options={
+                'verbose_name': 'Webhook Subscriber',
+                'verbose_name_plural': 'Webhook Subscribers',
+                'db_table': 'django_webhook_subscriber_webhook_subscriber',
+                'ordering': ['-created_at'],
+            },
+        ),
+        migrations.CreateModel(
+            name='WebhookSubscription',
+            fields=[
+                ('id', models.AutoField(primary_key=True, serialize=False)),
+                ('event_name', models.CharField(help_text="Event name (e.g., 'created', 'published', 'archived')", max_length=100)),
+                ('custom_endpoint', models.CharField(blank=True, help_text='Optional custom endpoint path or full URL', max_length=512)),
+                ('is_active', models.BooleanField(default=True)),
+                ('keep_last_response', models.BooleanField(default=True, help_text='Whether to store the last response received')),
+                ('last_response', models.TextField(blank=True, help_text='Last response received (truncated if too long)')),
+                ('last_success', models.DateTimeField(blank=True, null=True)),
+                ('last_failure', models.DateTimeField(blank=True, null=True)),
+                ('consecutive_failures', models.PositiveIntegerField(default=0)),
+                ('total_deliveries', models.PositiveIntegerField(default=0)),
+                ('successful_deliveries', models.PositiveIntegerField(default=0)),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('subscriber', models.ForeignKey(limit_choices_to=models.Q(('is_active', True)), on_delete=django.db.models.deletion.CASCADE, related_name='subscriptions', to='django_webhook_subscriber.webhooksubscriber')),
+            ],
+            options={
+                'verbose_name': 'Webhook Subscription',
+                'verbose_name_plural': 'Webhook Subscriptions',
+                'db_table': 'django_webhook_subscriber_subscription',
+                'ordering': ('subscriber__name', 'event_name'),
+            },
+        ),
+        migrations.AddField(
+            model_name='webhookdeliverylog',
+            name='subscription',
+            field=models.ForeignKey(default=None, on_delete=django.db.models.deletion.CASCADE, related_name='delivery_logs', to='django_webhook_subscriber.webhooksubscription'),
+            preserve_default=False,
+        ),
+        migrations.AddIndex(
+            model_name='webhookdeliverylog',
+            index=models.Index(fields=['subscription', '-created_at'], name='django_webh_subscri_af8f0d_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='webhookdeliverylog',
+            index=models.Index(fields=['response_status'], name='django_webh_respons_52f5e1_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='webhookdeliverylog',
+            index=models.Index(fields=['created_at'], name='django_webh_created_bc530f_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='webhookdeliverylog',
+            index=models.Index(fields=['attempt_number'], name='django_webh_attempt_e33fed_idx'),
+        ),
+        migrations.DeleteModel(
+            name='WebhookRegistry',
+        ),
+        migrations.AddIndex(
+            model_name='webhooksubscriber',
+            index=models.Index(fields=['content_type', 'is_active'], name='django_webh_content_784d7f_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='webhooksubscriber',
+            index=models.Index(fields=['is_active'], name='django_webh_is_acti_0cbbec_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='webhooksubscriber',
+            index=models.Index(fields=['content_type'], name='django_webh_content_6d305b_idx'),
+        ),
+        migrations.AlterUniqueTogether(
+            name='webhooksubscriber',
+            unique_together={('target_url', 'content_type')},
+        ),
+        migrations.AddIndex(
+            model_name='webhooksubscription',
+            index=models.Index(fields=['subscriber', 'event_name'], name='django_webh_subscri_ae1285_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='webhooksubscription',
+            index=models.Index(fields=['is_active'], name='django_webh_is_acti_f01243_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='webhooksubscription',
+            index=models.Index(fields=['subscriber', 'is_active'], name='django_webh_subscri_0376a3_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='webhooksubscription',
+            index=models.Index(fields=['event_name', 'is_active'], name='django_webh_event_n_8184a3_idx'),
+        ),
+        migrations.AlterUniqueTogether(
+            name='webhooksubscription',
+            unique_together={('subscriber', 'event_name')},
+        ),
+    ]