BroadcastStatics new model and Broadcast update (#591)

* BroadcastStatics new model and Broadcast update

* Add trigger to save msg status update in BroadcastStatistics table

* Add template_id Broadcast model and update migrations

* Add cost, currency and template price in BroadcastStatistic view

* Update test

* Add service to get template cost

* Add test to cost_service

Author: lucaslinhares

temba/msgs/cost_service.py

@@ -0,0 +1,62 @@
+import logging
+
+import requests
+from weni.internal.clients.base import BaseInternalClient
+
+from django.conf import settings
+
+from temba.templates.models import Template
+
+logger = logging.getLogger(__name__)
+
+CATEGORY_TO_BILLING_FIELD = {
+    "MARKETING": "marketing",
+    "UTILITY": "utility",
+    "AUTHENTICATION": "authentication",
+    "SERVICE": "service",
+}
+
+
+class BillingInternalClient(BaseInternalClient):
+    def __init__(self, base_url=None, authenticator=None):
+        base_url = base_url or getattr(settings, "BILLING_BASE_URL", None)
+        super().__init__(base_url=base_url, authenticator=authenticator)
+
+    def get_pricing(self, project=None):
+        params = {}
+        if project:
+            params["project"] = project
+        response = requests.get(
+            self.get_url("/api/v1/meta-pricing/"), headers=self.authenticator.headers, params=params, timeout=10
+        )
+        response.raise_for_status()
+        return response.json()
+
+
+def get_template_price_and_currency_from_api(template_id=None):
+    """
+    Search for the template price and currency in the external pricing API.
+    Returns (template_price, currency). If it fails, returns (0, 'BRL').
+    If template_id is provided, uses its category to select the correct price field.
+    """
+    try:
+        client = BillingInternalClient()
+        template_price = 0
+        if template_id:
+            try:
+                template = Template.objects.get(pk=template_id)
+                project_uuid = template.org.proj_uuid
+                data = client.get_pricing(project=project_uuid)
+                currency = data.get("currency", "BRL")
+                category = template.category
+                if category not in CATEGORY_TO_BILLING_FIELD:
+                    logger.warning(f"Category {category} not mapped to billing. Using 'marketing' as fallback.")
+                billing_field = CATEGORY_TO_BILLING_FIELD.get(category, "marketing")
+                template_price = float(data.get("rates", {}).get(billing_field, 0))
+            except Template.DoesNotExist:
+                template_price = float(data.get("marketing", 0))
+        else:
+            template_price = float(data.get("marketing", 0))
+        return template_price, currency
+    except Exception:
+        return 0, "BRL"

temba/msgs/migrations/0167_auto_20250811_1748.py

@@ -0,0 +1,28 @@
+# Generated by Django 3.2.22 on 2025-08-11 17:48
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("msgs", "0166_auto_20241112_1456"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="broadcast",
+            name="is_bulk_send",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name="broadcast",
+            name="name",
+            field=models.CharField(blank=True, max_length=255, null=True),
+        ),
+        migrations.AddField(
+            model_name="broadcast",
+            name="template_id",
+            field=models.IntegerField(blank=True, null=True),
+        ),
+    ]

temba/msgs/migrations/0168_broadcaststatistics.py

@@ -0,0 +1,45 @@
+# Generated by Django 3.2.22 on 2025-08-20 14:11
+
+import django.db.models.deletion
+import django.utils.timezone
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("orgs", "0092_org_proj_uuid"),
+        ("msgs", "0167_auto_20250811_1748"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="BroadcastStatistics",
+            fields=[
+                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("processed", models.IntegerField(default=0)),
+                ("sent", models.IntegerField(default=0)),
+                ("delivered", models.IntegerField(default=0)),
+                ("failed", models.IntegerField(default=0)),
+                ("read", models.IntegerField(default=0)),
+                ("contact_count", models.IntegerField(default=0)),
+                ("cost", models.DecimalField(blank=True, decimal_places=2, max_digits=10, null=True)),
+                ("template_price", models.DecimalField(blank=True, decimal_places=4, max_digits=10, null=True)),
+                ("currency", models.CharField(blank=True, max_length=20, null=True)),
+                ("created_on", models.DateTimeField(db_index=True, default=django.utils.timezone.now)),
+                ("modified_on", models.DateTimeField(default=django.utils.timezone.now)),
+                (
+                    "broadcast",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT, related_name="statistics", to="msgs.broadcast"
+                    ),
+                ),
+                (
+                    "org",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT, related_name="broadcast_statistics", to="orgs.org"
+                    ),
+                ),
+            ],
+        ),
+    ]

temba/msgs/migrations/0169_broadcast_status_trigger.py

@@ -0,0 +1,82 @@
+from django.db import migrations
+
+TRIGGER_FUNCTION = """
+CREATE OR REPLACE FUNCTION update_broadcast_statistics_on_msg_status()
+RETURNS TRIGGER AS $$
+BEGIN
+    -- Only process if the broadcast_id or status changed
+    IF NEW.broadcast_id IS NULL OR NEW.status IS NOT DISTINCT FROM OLD.status THEN
+        RETURN NEW;
+    END IF;
+
+    -- Only process for bulk sends
+    IF NOT EXISTS (
+        SELECT 1 FROM msgs_broadcast b WHERE b.id = NEW.broadcast_id AND b.is_bulk_send
+    ) THEN
+        RETURN NEW;
+    END IF;
+
+    IF NEW.status = 'S' THEN
+        UPDATE msgs_broadcaststatistics
+        SET sent = sent + 1,
+            cost = COALESCE(cost, 0) + COALESCE(template_price, 0)
+        WHERE broadcast_id = NEW.broadcast_id;
+
+    ELSIF NEW.status = 'D' THEN
+        UPDATE msgs_broadcaststatistics
+        SET delivered = delivered + 1
+        WHERE broadcast_id = NEW.broadcast_id;
+
+    ELSIF NEW.status = 'F' THEN
+        UPDATE msgs_broadcaststatistics
+        SET failed = failed + 1
+        WHERE broadcast_id = NEW.broadcast_id;
+
+        -- If it failed directly from the queue, consider it as 'processed'
+        IF OLD.status = 'Q' THEN
+            UPDATE msgs_broadcaststatistics
+            SET processed = processed + 1,
+                modified_on = NOW()
+            WHERE broadcast_id = NEW.broadcast_id;
+        END IF;
+
+    ELSIF NEW.status = 'W' THEN
+        UPDATE msgs_broadcaststatistics
+        SET processed = processed + 1,
+            modified_on = NOW()
+        WHERE broadcast_id = NEW.broadcast_id;
+
+    ELSIF NEW.status = 'V' THEN
+        UPDATE msgs_broadcaststatistics
+        SET read = read + 1
+        WHERE broadcast_id = NEW.broadcast_id;
+    END IF;
+
+    RETURN NEW;
+END;
+$$ LANGUAGE plpgsql;
+"""
+
+TRIGGER = """
+CREATE TRIGGER trg_update_broadcast_statistics_on_msg_status
+AFTER UPDATE OF status ON msgs_msg
+FOR EACH ROW
+EXECUTE FUNCTION update_broadcast_statistics_on_msg_status();
+"""
+
+DROP_TRIGGER = """
+DROP TRIGGER IF EXISTS trg_update_broadcast_statistics_on_msg_status ON msgs_msg;
+DROP FUNCTION IF EXISTS update_broadcast_statistics_on_msg_status();
+"""
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("msgs", "0168_broadcaststatistics"),
+    ]
+
+    operations = [
+        migrations.RunSQL(TRIGGER_FUNCTION, DROP_TRIGGER),
+        migrations.RunSQL(TRIGGER, DROP_TRIGGER),
+    ]