Rename, simplify, separate managed and unmanaged reports, add link to sidebar and homepage

This commit is contained in:
Rachid Mrad 2024-03-01 18:23:35 -05:00
parent 4b1b1386a8
commit 32207be68a
No known key found for this signature in database
8 changed files with 163 additions and 99 deletions

View file

@ -27,7 +27,6 @@ from django_fsm import TransitionNotAllowed # type: ignore
from django.utils.safestring import mark_safe
from django.utils.html import escape
from django.contrib.auth.forms import UserChangeForm, UsernameField
from registrar.views.admin_views import ExportDataDomainGrowth, ExportDataFederal, ExportDataFull, ExportDataManagedVsUnmanaged, ExportDataRequests, ExportDataType
from django.utils.translation import gettext_lazy as _
@ -364,16 +363,18 @@ class UserContactInline(admin.StackedInline):
model = models.Contact
def user_analytics(request):
def analytics(request):
end_date = datetime.datetime.today()
start_date = datetime.datetime.today() - datetime.timedelta(days=30)
thirty_days_ago = datetime.datetime.today() - datetime.timedelta(days=30)
last_30_days_applications = models.DomainApplication.objects.filter(
created_at__gt=start_date
created_at__gt=thirty_days_ago
)
avg_approval_time = last_30_days_applications.annotate(
approval_time=F("approved_domain__created_at") - F("created_at")
last_30_days_approved_applications = models.DomainApplication.objects.filter(
created_at__gt=thirty_days_ago, status=DomainApplication.ApplicationStatus.APPROVED
)
avg_approval_time = last_30_days_approved_applications.annotate(
approval_time=F("approved_domain__created_at") - F("submission_date")
).aggregate(Avg("approval_time"))["approval_time__avg"]
# format the timedelta?
avg_approval_time = str(avg_approval_time)
@ -416,7 +417,7 @@ def user_analytics(request):
filter_deleted_domains_start_date = {
"domain__state__in": [Domain.State.DELETED],
"domain__first_ready__lte": start_date_formatted,
"domain__deleted__lte": start_date_formatted,
}
deleted_domains_sliced_at_start_date = csv_export.get_sliced_domains(filter_deleted_domains_start_date)
@ -428,7 +429,7 @@ def user_analytics(request):
filter_deleted_domains_end_date = {
"domain__state__in": [Domain.State.DELETED],
"domain__first_ready__lte": end_date_formatted,
"domain__deleted__lte": end_date_formatted,
}
deleted_domains_sliced_at_end_date = csv_export.get_sliced_domains(filter_deleted_domains_end_date)
@ -436,7 +437,7 @@ def user_analytics(request):
# Created and Submitted requests
filter_requests_start_date = {
"submission_date__lte": start_date_formatted,
"created_at__lte": start_date_formatted,
}
requests_sliced_at_start_date = csv_export.get_sliced_requests(filter_requests_start_date)
@ -447,7 +448,7 @@ def user_analytics(request):
submitted_requests_sliced_at_start_date = csv_export.get_sliced_requests(filter_submitted_requests_start_date)
filter_requests_end_date = {
"submission_date__lte": end_date_formatted,
"created_at__lte": end_date_formatted,
}
requests_sliced_at_end_date = csv_export.get_sliced_requests(filter_requests_end_date)
@ -455,14 +456,15 @@ def user_analytics(request):
"status": DomainApplication.ApplicationStatus.SUBMITTED,
"submission_date__lte": end_date_formatted,
}
submitted_requests_at_end_date = csv_export.get_sliced_requests(filter_submitted_requests_end_date)
submitted_requests_sliced_at_end_date = csv_export.get_sliced_requests(filter_submitted_requests_end_date)
context = dict(
**admin.site.each_context(request),
data=dict(
user_count=models.User.objects.all().count(),
domain_count=models.Domain.objects.all().count(),
applications_last_30_days=last_30_days_applications.count(),
last_30_days_applications=last_30_days_applications.count(),
last_30_days_approved_applications=last_30_days_approved_applications.count(),
average_application_approval_time_last_30_days=avg_approval_time,
managed_domains_sliced_at_start_date=managed_domains_sliced_at_start_date,
@ -478,7 +480,7 @@ def user_analytics(request):
requests_sliced_at_start_date=requests_sliced_at_start_date,
submitted_requests_sliced_at_start_date=submitted_requests_sliced_at_start_date,
requests_sliced_at_end_date=requests_sliced_at_end_date,
submitted_requests_at_end_date=submitted_requests_at_end_date,
submitted_requests_sliced_at_end_date=submitted_requests_sliced_at_end_date,
),
)

View file

@ -320,3 +320,10 @@ input.admin-confirm-button {
top: 2px;
}
}
.module--custom {
a {
font-size: 13px;
font-weight: 600;
}
}

View file

@ -9,8 +9,8 @@ from django.urls import include, path
from django.views.generic import RedirectView
from registrar import views
from registrar.admin import user_analytics
from registrar.views.admin_views import ExportDataDomainGrowth, ExportDataFederal, ExportDataFull, ExportDataManagedVsUnmanaged, ExportDataRequests, ExportDataType
from registrar.admin import analytics
from registrar.views.admin_views import ExportDataDomainsGrowth, ExportDataFederal, ExportDataFull, ExportDataManagedDomains, ExportDataRequestsGrowth, ExportDataType, ExportDataUnmanagedDomains
from registrar.views.application import Step
from registrar.views.utility import always_404
@ -67,24 +67,29 @@ urlpatterns = [
name="export_data_federal",
),
path(
"admin/analytics/export_domain_growth/",
ExportDataDomainGrowth.as_view(),
name="export_domain_growth",
"admin/analytics/export_domains_growth/",
ExportDataDomainsGrowth.as_view(),
name="export_domains_growth",
),
path(
"admin/analytics/export_managed_unmanaged/",
ExportDataManagedVsUnmanaged.as_view(),
name="export_managed_unmanaged",
"admin/analytics/export_requests_growth/",
ExportDataRequestsGrowth.as_view(),
name="export_requests_growth",
),
path(
"admin/analytics/export_requests/",
ExportDataRequests.as_view(),
name="export_requests",
"admin/analytics/export_managed_domains/",
ExportDataManagedDomains.as_view(),
name="export_managed_domains",
),
path(
"admin/analytics/export_unmanaged_domains/",
ExportDataUnmanagedDomains.as_view(),
name="export_unmanaged_domains",
),
path(
"admin/analytics/",
admin.site.admin_view(user_analytics),
name="user_analytics",
admin.site.admin_view(analytics),
name="analytics",
),
path("admin/", admin.site.urls),

View file

@ -16,7 +16,8 @@
<ul>
<li>User Count: {{ data.user_count }}</li>
<li>Domain Count: {{ data.domain_count }}</li>
<li>Domain applications (last 30 days): {{ data.applications_last_30_days }}</li>
<li>Domain applications (last 30 days): {{ data.last_30_days_applications }}</li>
<li>Approved applications (last 30 days): {{ data.last_30_days_approved_applications }}</li>
<li>Average approval time for applications (last 30 days): {{ data.average_application_approval_time_last_30_days }}</li>
</ul>
</div>
@ -80,28 +81,35 @@
<ul class="usa-button-group">
<li class="usa-button-group__item">
<button class="button exportLink" data-export-url="{% url 'export_domain_growth' %}" type="button">
<button class="button exportLink" data-export-url="{% url 'export_domains_growth' %}" type="button">
<svg class="usa-icon" aria-hidden="true" focusable="false" role="img" width="24" height="24">
<use xlink:href="{%static 'img/sprite.svg'%}#file_download"></use>
</svg><span class="margin-left-05">Domain growth</span>
</button>
</li>
<li class="usa-button-group__item">
<button class="button exportLink" data-export-url="{% url 'export_requests' %}" type="button">
<button class="button exportLink" data-export-url="{% url 'export_requests_growth' %}" type="button">
<svg class="usa-icon" aria-hidden="true" focusable="false" role="img" width="24" height="24">
<use xlink:href="{%static 'img/sprite.svg'%}#file_download"></use>
</svg><span class="margin-left-05">Request Growth</span>
</button>
</li>
<li class="usa-button-group__item">
<button class="button exportLink" data-export-url="{% url 'export_managed_unmanaged' %}" type="button">
<button class="button exportLink" data-export-url="{% url 'export_managed_domains' %}" type="button">
<svg class="usa-icon" aria-hidden="true" focusable="false" role="img" width="24" height="24">
<use xlink:href="{%static 'img/sprite.svg'%}#file_download"></use>
</svg><span class="margin-left-05">Managed vs unmanaged domain</span>
</svg><span class="margin-left-05">Managed domains</span>
</button>
</li>
<li class="usa-button-group__item">
<button class="button exportLink" data-export-url="{% url 'user_analytics' %}" type="button">
<button class="button exportLink" data-export-url="{% url 'export_unmanaged_domains' %}" type="button">
<svg class="usa-icon" aria-hidden="true" focusable="false" role="img" width="24" height="24">
<use xlink:href="{%static 'img/sprite.svg'%}#file_download"></use>
</svg><span class="margin-left-05">Unmanaged domains</span>
</button>
</li>
<li class="usa-button-group__item">
<button class="button exportLink" data-export-url="{% url 'analytics' %}" type="button">
<svg class="usa-icon" aria-hidden="true" focusable="false" role="img" width="24" height="24">
<use xlink:href="{%static 'img/sprite.svg'%}#assessment"></use>
</svg><span class="margin-left-05">Update charts</span>
@ -128,12 +136,12 @@
<div class="grid-col">
<canvas id="myChart3" width="400" height="200"
data-list-one="{{data.deleted_domains_sliced_at_start_date}}"
data-list-two="{{data.requests_sliced_at_start_date}}"
data-list-two="{{data.deleted_domains_sliced_at_end_date}}"
></canvas>
</div>
<div class="grid-col">
<canvas id="myChart4" width="400" height="200"
data-list-one="{{data.deleted_domains_sliced_at_start_date}}"
data-list-one="{{data.ready_domains_sliced_at_start_date}}"
data-list-two="{{data.ready_domains_sliced_at_end_date}}"
></canvas>
</div>
@ -143,7 +151,7 @@
<div class="grid-col">
<canvas id="myChart5" width="400" height="200"
data-list-one="{{data.submitted_requests_sliced_at_start_date}}"
data-list-two="{{data.submitted_requests_at_end_date}}"
data-list-two="{{data.submitted_requests_sliced_at_end_date}}"
></canvas>
</div>
<div class="grid-col">

View file

@ -67,3 +67,9 @@
{% else %}
<p>{% translate 'You dont have permission to view or edit anything.' %}</p>
{% endif %}
<div class="module module--custom">
<h2>Analytics</h2>
<a class="display-block padding-1" href="{% url 'analytics' %}">Dashboard</a>
</div>

View file

@ -0,0 +1,11 @@
{% extends "admin/index.html" %}
{% block content %}
<div id="content-main">
{% include "admin/app_list.html" with app_list=app_list show_changelinks=True %}
<div class="module module--custom">
<h2>Analytics</h2>
<a class="display-block padding-1" href="{% url 'analytics' %}">Dashboard</a>
</div>
</div>
{% endblock %}

View file

@ -180,14 +180,14 @@ def write_csv(
writer.writerows(rows)
def get_domain_requests(filter_condition, sort_fields):
domain_requests = (
def get_requests(filter_condition, sort_fields):
requests = (
DomainApplication.objects.all()
.filter(**filter_condition)
.order_by(*sort_fields)
)
return domain_requests
return requests
def parse_request_row(columns, request: DomainApplication):
"""Given a set of columns, generate a new row from cleaned column data"""
@ -234,7 +234,7 @@ def write_requests_csv(
"""
"""
all_requetsts = get_domain_requests(filter_condition, sort_fields)
all_requetsts = get_requests(filter_condition, sort_fields)
# Reduce the memory overhead when performing the write operation
paginator = Paginator(all_requetsts, 1000)
@ -426,10 +426,11 @@ def export_data_domain_growth_to_csv(csv_file, start_date, end_date):
)
def get_sliced_domains(filter_condition):
"""
"""Get fitered domains counts sliced by org type and election office.
"""
domains = DomainInformation.objects.all().filter(**filter_condition)
domains_count = domains.count()
federal = domains.filter(organization_type=DomainApplication.OrganizationChoices.FEDERAL).count()
interstate = domains.filter(organization_type=DomainApplication.OrganizationChoices.INTERSTATE).count()
state_or_territory = domains.filter(organization_type=DomainApplication.OrganizationChoices.STATE_OR_TERRITORY).count()
@ -440,7 +441,8 @@ def get_sliced_domains(filter_condition):
school_district = domains.filter(organization_type=DomainApplication.OrganizationChoices.SCHOOL_DISTRICT).count()
election_board = domains.filter(is_election_board=True).count()
return [federal,
return [domains_count,
federal,
interstate,
state_or_territory,
tribal,
@ -451,21 +453,23 @@ def get_sliced_domains(filter_condition):
election_board]
def get_sliced_requests(filter_condition):
"""
"""Get fitered requests counts sliced by org type and election office.
"""
domain_requests = DomainApplication.objects.all().filter(**filter_condition)
federal = domain_requests.filter(organization_type=DomainApplication.OrganizationChoices.FEDERAL).count()
interstate = domain_requests.filter(organization_type=DomainApplication.OrganizationChoices.INTERSTATE).count()
state_or_territory = domain_requests.filter(organization_type=DomainApplication.OrganizationChoices.STATE_OR_TERRITORY).count()
tribal = domain_requests.filter(organization_type=DomainApplication.OrganizationChoices.TRIBAL).count()
county = domain_requests.filter(organization_type=DomainApplication.OrganizationChoices.COUNTY).count()
city = domain_requests.filter(organization_type=DomainApplication.OrganizationChoices.CITY).count()
special_district = domain_requests.filter(organization_type=DomainApplication.OrganizationChoices.SPECIAL_DISTRICT).count()
school_district = domain_requests.filter(organization_type=DomainApplication.OrganizationChoices.SCHOOL_DISTRICT).count()
election_board = domain_requests.filter(is_election_board=True).count()
requests = DomainApplication.objects.all().filter(**filter_condition)
requests_count = requests.count()
federal = requests.filter(organization_type=DomainApplication.OrganizationChoices.FEDERAL).count()
interstate = requests.filter(organization_type=DomainApplication.OrganizationChoices.INTERSTATE).count()
state_or_territory = requests.filter(organization_type=DomainApplication.OrganizationChoices.STATE_OR_TERRITORY).count()
tribal = requests.filter(organization_type=DomainApplication.OrganizationChoices.TRIBAL).count()
county = requests.filter(organization_type=DomainApplication.OrganizationChoices.COUNTY).count()
city = requests.filter(organization_type=DomainApplication.OrganizationChoices.CITY).count()
special_district = requests.filter(organization_type=DomainApplication.OrganizationChoices.SPECIAL_DISTRICT).count()
school_district = requests.filter(organization_type=DomainApplication.OrganizationChoices.SCHOOL_DISTRICT).count()
election_board = requests.filter(is_election_board=True).count()
return [federal,
return [requests_count,
federal,
interstate,
state_or_territory,
tribal,
@ -475,8 +479,8 @@ def get_sliced_requests(filter_condition):
school_district,
election_board]
def export_data_managed_vs_unamanaged_domains(csv_file, start_date, end_date):
"""
def export_data_managed_domains_to_csv(csv_file, start_date, end_date):
"""Get domains have domain managers for two different dates.
"""
start_date_formatted = format_start_date(start_date)
@ -490,51 +494,60 @@ def export_data_managed_vs_unamanaged_domains(csv_file, start_date, end_date):
"domain__name",
]
writer.writerow(["START DATE"])
writer.writerow([])
filter_managed_domains_start_date = {
"domain__permissions__isnull": False,
"domain__first_ready__lte": start_date_formatted,
}
managed_domains_sliced_at_start_date = get_sliced_domains(filter_managed_domains_start_date)
writer.writerow(["MANAGED DOMAINS COUNTS"])
writer.writerow(["FEDERAL", "INTERSTATE", "STATE_OR_TERRITORY", "TRIBAL", "COUNTY", "CITY", "SPECIAL_DISTRICT", "SCHOOL_DISTRICT", "ELECTION OFFICE"])
writer.writerow(["MANAGED DOMAINS COUNTS AT SRAT DATE"])
writer.writerow(["Total", "Federal", "Interstate", "State or territory", "Tribal", "County", "City", "Special district", "School district", "Election office"])
writer.writerow(managed_domains_sliced_at_start_date)
writer.writerow([])
write_csv(writer, columns, sort_fields, filter_managed_domains_start_date, get_domain_managers=True, should_write_header=True)
writer.writerow([])
filter_unmanaged_domains_start_date = {
"domain__permissions__isnull": True,
"domain__first_ready__lte": start_date_formatted,
}
unmanaged_domains_sliced_at_start_date = get_sliced_domains(filter_unmanaged_domains_start_date)
writer.writerow(["UNMANAGED DOMAINS COUNTS"])
writer.writerow(["FEDERAL", "INTERSTATE", "STATE_OR_TERRITORY", "TRIBAL", "COUNTY", "CITY", "SPECIAL_DISTRICT", "SCHOOL_DISTRICT", "ELECTION OFFICE"])
writer.writerow(unmanaged_domains_sliced_at_start_date)
writer.writerow([])
write_csv(writer, columns, sort_fields, filter_unmanaged_domains_start_date, get_domain_managers=True, should_write_header=True)
writer.writerow([])
writer.writerow(["END DATE"])
writer.writerow([])
filter_managed_domains_end_date = {
"domain__permissions__isnull": False,
"domain__first_ready__lte": end_date_formatted,
}
managed_domains_sliced_at_end_date = get_sliced_domains(filter_managed_domains_end_date)
writer.writerow(["MANAGED DOMAINS COUNTS"])
writer.writerow(["FEDERAL", "INTERSTATE", "STATE_OR_TERRITORY", "TRIBAL", "COUNTY", "CITY", "SPECIAL_DISTRICT", "SCHOOL_DISTRICT", "ELECTION OFFICE"])
writer.writerow(["MANAGED DOMAINS COUNTS AT END DATE"])
writer.writerow(["Total", "Federal", "Interstate", "State or territory", "Tribal", "County", "City", "Special district", "School district", "Election office"])
writer.writerow(managed_domains_sliced_at_end_date)
writer.writerow([])
write_csv(writer, columns, sort_fields, filter_managed_domains_end_date, get_domain_managers=True, should_write_header=True)
def export_data_unmanaged_domains_to_csv(csv_file, start_date, end_date):
""" Get domains that do not have domain managers for two different dates.
"""
start_date_formatted = format_start_date(start_date)
end_date_formatted = format_end_date(end_date)
writer = csv.writer(csv_file)
columns = [
"Domain name",
"Domain type",
]
sort_fields = [
"domain__name",
]
filter_unmanaged_domains_start_date = {
"domain__permissions__isnull": True,
"domain__first_ready__lte": start_date_formatted,
}
unmanaged_domains_sliced_at_start_date = get_sliced_domains(filter_unmanaged_domains_start_date)
writer.writerow(["UNMANAGED DOMAINS AT START DATE"])
writer.writerow(["Total", "Federal", "Interstate", "State or territory", "Tribal", "County", "City", "Special district", "School district", "Election office"])
writer.writerow(unmanaged_domains_sliced_at_start_date)
writer.writerow([])
write_csv(writer, columns, sort_fields, filter_unmanaged_domains_start_date, get_domain_managers=True, should_write_header=True)
writer.writerow([])
filter_unmanaged_domains_end_date = {
@ -543,14 +556,14 @@ def export_data_managed_vs_unamanaged_domains(csv_file, start_date, end_date):
}
unmanaged_domains_sliced_at_end_date = get_sliced_domains(filter_unmanaged_domains_end_date)
writer.writerow(["UNMANAGED DOMAINS COUNTS"])
writer.writerow(["FEDERAL", "INTERSTATE", "STATE_OR_TERRITORY", "TRIBAL", "COUNTY", "CITY", "SPECIAL_DISTRICT", "SCHOOL_DISTRICT", "ELECTION OFFICE"])
writer.writerow(["UNMANAGED DOMAINS AT END DATE"])
writer.writerow(["Total", "Federal", "Interstate", "State or territory", "Tribal", "County", "City", "Special district", "School district", "Election office"])
writer.writerow(unmanaged_domains_sliced_at_end_date)
writer.writerow([])
write_csv(writer, columns, sort_fields, filter_unmanaged_domains_end_date, get_domain_managers=True, should_write_header=True)
def export_data_requests_to_csv(csv_file, start_date, end_date):
def export_data_requests_growth_to_csv(csv_file, start_date, end_date):
"""
"""

View file

@ -33,7 +33,7 @@ class ExportDataFederal(View):
csv_export.export_data_federal_to_csv(response)
return response
class ExportDataDomainGrowth(View):
class ExportDataDomainsGrowth(View):
def get(self, request, *args, **kwargs):
# Get start_date and end_date from the request's GET parameters
# #999: not needed if we switch to django forms
@ -48,19 +48,7 @@ class ExportDataDomainGrowth(View):
return response
class ExportDataManagedVsUnmanaged(View):
def get(self, request, *args, **kwargs):
# Get start_date and end_date from the request's GET parameters
# #999: not needed if we switch to django forms
start_date = request.GET.get("start_date", "")
end_date = request.GET.get("end_date", "")
response = HttpResponse(content_type="text/csv")
response["Content-Disposition"] = f'attachment; filename="managed-vs-unamanaged-domains-{start_date}-to-{end_date}.csv"'
csv_export.export_data_managed_vs_unamanaged_domains(response, start_date, end_date)
return response
class ExportDataRequests(View):
class ExportDataRequestsGrowth(View):
def get(self, request, *args, **kwargs):
# Get start_date and end_date from the request's GET parameters
# #999: not needed if we switch to django forms
@ -71,6 +59,30 @@ class ExportDataRequests(View):
response["Content-Disposition"] = f'attachment; filename="requests-{start_date}-to-{end_date}.csv"'
# For #999: set export_data_domain_growth_to_csv to return the resulting queryset, which we can then use
# in context to display this data in the template.
csv_export.export_data_requests_to_csv(response, start_date, end_date)
csv_export.export_data_requests_growth_to_csv(response, start_date, end_date)
return response
class ExportDataManagedDomains(View):
def get(self, request, *args, **kwargs):
# Get start_date and end_date from the request's GET parameters
# #999: not needed if we switch to django forms
start_date = request.GET.get("start_date", "")
end_date = request.GET.get("end_date", "")
response = HttpResponse(content_type="text/csv")
response["Content-Disposition"] = f'attachment; filename="managed-vs-unamanaged-domains-{start_date}-to-{end_date}.csv"'
csv_export.export_data_managed_domains_to_csv(response, start_date, end_date)
return response
class ExportDataUnmanagedDomains(View):
def get(self, request, *args, **kwargs):
# Get start_date and end_date from the request's GET parameters
# #999: not needed if we switch to django forms
start_date = request.GET.get("start_date", "")
end_date = request.GET.get("end_date", "")
response = HttpResponse(content_type="text/csv")
response["Content-Disposition"] = f'attachment; filename="managed-vs-unamanaged-domains-{start_date}-to-{end_date}.csv"'
csv_export.export_data_unmanaged_domains_to_csv(response, start_date, end_date)
return response