add tests for invoice webhooks and fix condition check on invoice paid webhook (#639)

diego-escobedo · web-flow · commit 110ed4ef7620 · 2023-03-07T00:12:24.000-08:00
diff --git a/.github/workflows/cypress.yml b/.github/workflows/cypress.yml
@@ -1,11 +1,5 @@
 name: Cypress Tests
 
-on:
-  push:
-    branches: ["main"]
-  pull_request:
-    branches: ["main"]
-
 jobs:
   cypress-tests:
     runs-on: ubuntu-latest
@@ -90,11 +84,6 @@ jobs:
         run: |
           cd ./backend && pipenv run python manage.py runserver 0.0.0.0:8000 &
 
-      - name: Wait for backend to start
-        run: |
-          curl -IsS http://localhost:8000/api/healthcheck/ >/dev/null
-          echo "Backend is available"
-
       - name: Cypress run
         uses: cypress-io/github-action@v5
         with:
diff --git a/backend/metering_billing/models.py b/backend/metering_billing/models.py
@@ -25,6 +25,15 @@
 from django.db.models.constraints import CheckConstraint, UniqueConstraint
 from django.db.models.functions import Cast, Coalesce
 from django.utils.translation import gettext_lazy as _
+from rest_framework_api_key.models import AbstractAPIKey
+from simple_history.models import HistoricalRecords
+from svix.api import ApplicationIn, EndpointIn, EndpointSecretRotateIn, EndpointUpdate
+from svix.internal.openapi_client.models.http_error import HttpError
+from svix.internal.openapi_client.models.http_validation_error import (
+    HTTPValidationError,
+)
+from timezone_field import TimeZoneField
+
 from metering_billing.exceptions.exceptions import (
     ExternalConnectionFailure,
     NotEditable,
@@ -77,14 +86,6 @@
     WEBHOOK_TRIGGER_EVENTS,
 )
 from metering_billing.webhooks import invoice_paid_webhook, usage_alert_webhook
-from rest_framework_api_key.models import AbstractAPIKey
-from simple_history.models import HistoricalRecords
-from svix.api import ApplicationIn, EndpointIn, EndpointSecretRotateIn, EndpointUpdate
-from svix.internal.openapi_client.models.http_error import HttpError
-from svix.internal.openapi_client.models.http_validation_error import (
-    HTTPValidationError,
-)
-from timezone_field import TimeZoneField
 
 logger = logging.getLogger("django.server")
 META = settings.META
@@ -1665,6 +1666,11 @@ class PaymentStatus(models.IntegerChoices):
     )
     invoice_past_due_webhook_sent = models.BooleanField(default=False)
     history = HistoricalRecords()
+    __original_payment_status = None
+
+    def __init__(self, *args, **kwargs):
+        super(Invoice, self).__init__(*args, **kwargs)
+        self.__original_payment_status = self.payment_status
 
     class Meta:
         indexes = [
@@ -1701,13 +1707,14 @@ def save(self, *args, **kwargs):
                 next_invoice_number = "{0:06d}".format(last_invoice_number + 1)
 
             self.invoice_number = issue_date_string + "-" + next_invoice_number
-            # if not self.due_date:
-            #     self.due_date = self.issue_date + datetime.timedelta(days=1)
-        paid_before = self.payment_status == Invoice.PaymentStatus.PAID
         super().save(*args, **kwargs)
-        paid_after = self.payment_status == Invoice.PaymentStatus.PAID
-        if not paid_before and paid_after and self.cost_due > 0:
+        if (
+            self.__original_payment_status != self.payment_status
+            and self.payment_status == Invoice.PaymentStatus.PAID
+            and self.cost_due > 0
+        ):
             invoice_paid_webhook(self, self.organization)
+        self.__original_payment_status = self.payment_status
 
 
 class InvoiceLineItem(models.Model):
diff --git a/backend/metering_billing/tests/test_subscription.py b/backend/metering_billing/tests/test_subscription.py
@@ -2,6 +2,7 @@
 import json
 import urllib.parse
 from datetime import timedelta
+from unittest.mock import patch
 
 import pytest
 from django.urls import reverse
@@ -14,9 +15,11 @@
     PlanComponent,
     PlanVersion,
     PriceTier,
+    RecurringCharge,
     SubscriptionRecord,
 )
 from metering_billing.serializers.serializer_utils import DjangoJSONEncoder
+from metering_billing.tasks import check_past_due_invoices_inner
 from metering_billing.utils import now_utc
 from metering_billing.utils.enums import (
     CHARGEABLE_ITEM_TYPE,
@@ -43,7 +46,11 @@ def subscription_test_common_setup(
     add_plan_to_product,
 ):
     def do_subscription_test_common_setup(
-        *, num_subscriptions, auth_method, user_org_and_api_key_org_different=False
+        *,
+        num_subscriptions,
+        auth_method,
+        user_org_and_api_key_org_different=False,
+        setup_grace_period_setting=False
     ):
         # set up organizations and api keys
         org, key = generate_org_and_api_key()
@@ -121,6 +128,14 @@ def do_subscription_test_common_setup(
                 cost_per_batch=cpb,
                 metric_units_per_batch=mupb,
             )
+        RecurringCharge.objects.create(
+            organization=plan.organization,
+            plan_version=billing_plan,
+            charge_timing=RecurringCharge.ChargeTimingType.IN_ADVANCE,
+            charge_behavior=RecurringCharge.ChargeBehaviorType.PRORATE,
+            amount=10,
+            pricing_unit=billing_plan.pricing_unit,
+        )
         setup_dict["billing_plan"] = billing_plan
 
         (customer,) = add_customers_to_org(org, n=1)
@@ -137,6 +152,19 @@ def do_subscription_test_common_setup(
         setup_dict["payload"] = payload
         setup_dict["customer"] = customer
 
+        if setup_grace_period_setting:
+            payload = {
+                "payment_grace_period": 0,
+            }
+            response = setup_dict["client"].patch(
+                reverse(
+                    "organization-detail",
+                    kwargs={"organization_id": setup_dict["org"].organization_id},
+                ),
+                data=json.dumps(payload, cls=DjangoJSONEncoder),
+                content_type="application/json",
+            )
+            assert response.status_code == status.HTTP_200_OK
         return setup_dict
 
     return do_subscription_test_common_setup
@@ -749,3 +777,115 @@ def test_refresh_rate_metric_doesnt_fail(self, subscription_test_common_setup):
             setup_dict["org"].update_subscription_filter_settings(["email"])
         except Exception as e:
             assert False, e
+
+
+@pytest.mark.django_db(transaction=True)
+class TestInvoiceWebhooks:
+    def test_invoice_paid_webhook(
+        self,
+        subscription_test_common_setup,
+    ):
+        setup_dict = subscription_test_common_setup(
+            num_subscriptions=1, auth_method="session_auth"
+        )
+
+        prev_invoices_len = Invoice.objects.all().count()
+
+        params = {
+            "customer_id": setup_dict["customer"].customer_id,
+        }
+        payload = {
+            "flat_fee_behavior": FLAT_FEE_BEHAVIOR.CHARGE_FULL,
+            "bill_usage": True,
+        }
+        response = setup_dict["client"].post(
+            reverse("subscription-cancel") + "?" + urllib.parse.urlencode(params),
+            data=json.dumps(payload, cls=DjangoJSONEncoder),
+            content_type="application/json",
+        )
+
+        new_invoices_len = Invoice.objects.all().count()
+        assert response.status_code == status.HTTP_200_OK
+        assert new_invoices_len == prev_invoices_len + 1
+
+        payload = {
+            "payment_status": "paid",
+        }
+        invoice = Invoice.objects.last()
+        with patch("metering_billing.models.invoice_paid_webhook") as mock_webhook:
+            response = setup_dict["client"].patch(
+                reverse(
+                    "invoice-detail",
+                    kwargs={"invoice_id": invoice.invoice_id},
+                ),
+                data=json.dumps(payload, cls=DjangoJSONEncoder),
+                content_type="application/json",
+            )
+            mock_webhook.assert_called_once_with(invoice, invoice.organization)
+        assert response.status_code == status.HTTP_200_OK
+
+    def test_invoice_past_due_webhook_org_setting_not_set(
+        self,
+        subscription_test_common_setup,
+    ):
+        setup_dict = subscription_test_common_setup(
+            num_subscriptions=1,
+            auth_method="session_auth",
+        )
+
+        prev_invoices_len = Invoice.objects.all().count()
+
+        params = {
+            "customer_id": setup_dict["customer"].customer_id,
+        }
+        payload = {
+            "flat_fee_behavior": FLAT_FEE_BEHAVIOR.CHARGE_FULL,
+            "bill_usage": True,
+        }
+        response = setup_dict["client"].post(
+            reverse("subscription-cancel") + "?" + urllib.parse.urlencode(params),
+            data=json.dumps(payload, cls=DjangoJSONEncoder),
+            content_type="application/json",
+        )
+
+        new_invoices_len = Invoice.objects.all().count()
+        assert response.status_code == status.HTTP_200_OK
+        assert new_invoices_len == prev_invoices_len + 1
+
+        with patch("metering_billing.tasks.invoice_past_due_webhook") as mock_webhook:
+            check_past_due_invoices_inner()
+            mock_webhook.assert_not_called()
+
+    def test_invoice_past_due_webhook_org_setting_set(
+        self,
+        subscription_test_common_setup,
+    ):
+        setup_dict = subscription_test_common_setup(
+            num_subscriptions=1,
+            auth_method="session_auth",
+            setup_grace_period_setting=True,
+        )
+
+        prev_invoices_len = Invoice.objects.all().count()
+
+        params = {
+            "customer_id": setup_dict["customer"].customer_id,
+        }
+        payload = {
+            "flat_fee_behavior": FLAT_FEE_BEHAVIOR.CHARGE_FULL,
+            "bill_usage": True,
+        }
+        response = setup_dict["client"].post(
+            reverse("subscription-cancel") + "?" + urllib.parse.urlencode(params),
+            data=json.dumps(payload, cls=DjangoJSONEncoder),
+            content_type="application/json",
+        )
+
+        new_invoices_len = Invoice.objects.all().count()
+        assert response.status_code == status.HTTP_200_OK
+        assert new_invoices_len == prev_invoices_len + 1
+        invoice = Invoice.objects.last()
+
+        with patch("metering_billing.tasks.invoice_past_due_webhook") as mock_webhook:
+            check_past_due_invoices_inner()
+            mock_webhook.assert_called_once_with(invoice, invoice.organization)
