feat: Render usage report in sales dashboard usage directly, without sending email (#5407)

Author: rolodato

api/sales_dashboard/forms.py

@@ -1,12 +1,5 @@
-import inspect
-from datetime import date
-
 from django import forms
-from django.conf import settings
-from django.core.mail import send_mail
 
-from environments.models import Environment
-from features.models import Feature
 from organisations.models import (
     Organisation,
     OrganisationSubscriptionInformationCache,
@@ -17,8 +10,6 @@
     MAX_SEATS_IN_FREE_PLAN,
     TRIAL_SUBSCRIPTION_ID,
 )
-from projects.models import Project
-from users.models import FFAdminUser
 
 
 class MaxSeatsForm(forms.Form):
@@ -86,28 +77,3 @@ def save(self, organisation: Organisation, commit: bool = True) -> Organisation:
             osic.save()
 
         return organisation
-
-
-class EmailUsageForm(forms.Form):
-    email_address = forms.EmailField()
-
-    def save(self, commit=True):  # type: ignore[no-untyped-def]
-        message = inspect.cleandoc(
-            f"""
-            Current Flagsmith Stats on {date.today()}:
-
-            Total Organisations = {Organisation.objects.all().count()}
-            Total Projects = {Project.objects.all().count()}
-            Total Environments = {Environment.objects.all().count()}
-            Total Features = {Feature.objects.all().count()}
-            Total Seats = {FFAdminUser.objects.all().count()}
-            """
-        )
-
-        send_mail(
-            subject="Flagsmith Usage Report",
-            message=message,
-            from_email=settings.DEFAULT_FROM_EMAIL,
-            recipient_list=[self.cleaned_data["email_address"]],
-            fail_silently=True,
-        )

api/sales_dashboard/templates/sales_dashboard/base.html

@@ -27,8 +27,10 @@
         </li>
       </ul>
     </nav>
+    <div class="py-3">
     {% block content %}
     {% endblock %}
+    </div>
     <!-- Optional JavaScript -->
     <!-- jQuery first, then Popper.js, then Bootstrap JS -->
     <script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>

api/sales_dashboard/templates/sales_dashboard/email-usage.html

@@ -8,7 +8,7 @@
 
     <main role="main" class="col-md-9 ml-sm-auto col-lg-10 px-md-4">
       <div
-        class="d-flex justify-content-between flex-wrap flex-md-nowrap align-items-center pt-3 pb-2 mb-3 border-bottom">
+        class="d-flex justify-content-between flex-wrap flex-md-nowrap align-items-center border-bottom">
         <h1 class="h2">Organisations</h1>
         <div class="float-right">
           <div class='float-left'>

api/sales_dashboard/templates/sales_dashboard/home.html

@@ -9,11 +9,11 @@
                         </a>
                     </li>
                     <li class="nav-item">
-                        <a class="nav-link active" href="/sales-dashboard/email-usage/">
+                        <a class="nav-link active" href="/sales-dashboard/usage/">
                           <span data-feather="home"></span>
-                          Email Usage
+                          Usage report
                         </a>
                     </li>
                 </ul>
             </div>
-        </nav>
+        </nav>

api/sales_dashboard/templates/sales_dashboard/nav.html

@@ -0,0 +1,25 @@
+{% extends "sales_dashboard/base.html" %}
+
+{% block title %}
+Usage Report
+{% endblock %}
+
+{% block content %}
+<div class="container-fluid">
+    <div class="row">
+        {% include "sales_dashboard/nav.html" %}
+        <main role="main" class="col-md-9 ml-sm-auto col-lg-10 px-md-4">
+            <h1 class="title">Flagsmith Usage Report</h1>
+            <p>{{ stats.site_url }}</p>
+            <p>{{ stats.report_date }} UTC</p>
+            <ul>
+                <li>Total Organisations: {{ stats.total_organisations }}</li>
+                <li>Total Projects: {{ stats.total_projects }}</li>
+                <li>Total Environments: {{ stats.total_environments }}</li>
+                <li>Total Features: {{ stats.total_features }}</li>
+                <li>Total User Seats: {{ stats.total_seats }}</li>
+            </ul>
+        </main>
+    </div>
+</div>
+{% endblock %}

api/sales_dashboard/templates/sales_dashboard/usage.html

@@ -38,9 +38,9 @@
         name="update_max_api_calls",
     ),
     path(
-        "email-usage/",
-        views.EmailUsage.as_view(),
-        name="email-usage",
+        "usage/",
+        views.UsageReport.as_view(),
+        name="usage",
     ),
     path(
         "organisations/<int:organisation_id>/download_org_data",

api/sales_dashboard/urls.py

@@ -1,6 +1,7 @@
 import json
 from datetime import timedelta
 
+import pytz
 import re2 as re  # type: ignore[import-untyped]
 from django.conf import settings
 from django.contrib.admin.views.decorators import staff_member_required
@@ -15,19 +16,21 @@
 )
 from django.shortcuts import get_object_or_404
 from django.template import loader
-from django.urls import reverse, reverse_lazy
+from django.urls import reverse
 from django.utils import timezone
 from django.utils.decorators import method_decorator
 from django.utils.safestring import mark_safe
-from django.views.generic import ListView
-from django.views.generic.edit import FormView
+from django.views.generic import ListView, TemplateView
 
 from app_analytics.influxdb_wrapper import (
     get_event_list_for_organisation,
     get_events_for_organisation,
 )
+from core.helpers import get_current_site_url
 from environments.dynamodb.migrator import IdentityMigrator
 from environments.identities.models import Identity
+from environments.models import Environment
+from features.models import Feature
 from import_export.export import full_export
 from organisations.chargebee.tasks import update_chargebee_cache
 from organisations.models import (
@@ -39,10 +42,10 @@
     update_organisation_subscription_information_cache,
     update_organisation_subscription_information_influx_cache,
 )
+from projects.models import Project
 from users.models import FFAdminUser
 
 from .forms import (
-    EmailUsageForm,
     EndTrialForm,
     MaxAPICallsForm,
     MaxSeatsForm,
@@ -295,18 +298,21 @@ def migrate_identities_to_edge(request, project_id):  # type: ignore[no-untyped-
     name="get",
     decorator=staff_member_required(),
 )
-@method_decorator(
-    name="post",
-    decorator=staff_member_required(),
-)
-class EmailUsage(FormView):  # type: ignore[type-arg]
-    form_class = EmailUsageForm
-    template_name = "sales_dashboard/email-usage.html"
-    success_url = reverse_lazy("sales_dashboard:index")
-
-    def form_valid(self, form):  # type: ignore[no-untyped-def]
-        form.save()
-        return super().form_valid(form)
+class UsageReport(TemplateView):  # pragma: no cover
+    template_name = "sales_dashboard/usage.html"
+
+    def get_context_data(self, **kwargs):  # type: ignore[no-untyped-def]
+        context = super().get_context_data(**kwargs)
+        context["stats"] = {
+            "site_url": get_current_site_url(),
+            "total_organisations": Organisation.objects.all().count(),
+            "total_projects": Project.objects.all().count(),
+            "total_environments": Environment.objects.all().count(),
+            "total_features": Feature.objects.all().count(),
+            "total_seats": FFAdminUser.objects.all().count(),
+            "report_date": timezone.now().astimezone(pytz.UTC),
+        }
+        return context
 
 
 @staff_member_required()  # type: ignore[misc]

api/sales_dashboard/views.py

@@ -219,32 +219,14 @@ def test_get_email_usage_fails_if_not_staff(
     user = FFAdminUser.objects.create(email="notastaffuser@example.com")
     client.force_login(user)
 
-    url = reverse("sales_dashboard:email-usage")
+    url = reverse("sales_dashboard:usage")
 
     # When
     response = client.get(url)
 
     # Then
     assert response.status_code == 302
-    assert response.url == "/admin/login/?next=/sales-dashboard/email-usage/"  # type: ignore[attr-defined]
-
-
-def test_post_email_usage_fails_if_not_staff(
-    organisation: Organisation,
-    client: Client,
-) -> None:
-    # Given
-    user = FFAdminUser.objects.create(email="notastaffuser@example.com")
-    client.force_login(user)
-
-    url = reverse("sales_dashboard:email-usage")
-
-    # When
-    response = client.post(url)
-
-    # Then
-    assert response.status_code == 302
-    assert response.url == "/admin/login/?next=/sales-dashboard/email-usage/"  # type: ignore[attr-defined]
+    assert response.url == "/admin/login/?next=/sales-dashboard/usage/"  # type: ignore[attr-defined]
 
 
 def test_start_trial(