Merge pull request #2975 from GSA/2966-create-organization-dashboard-pageroutetemplate-page

Set up org dashboard template
2026-08-03 13:18:57 -04:00 · 2025-10-16 12:42:39 -07:00
parent b9884ed635 6cde0675d2
commit 7c9ed23ba1
14 changed files with 176 additions and 119 deletions
--- a/.ds.baseline
+++ b/.ds.baseline
@@ -161,7 +161,7 @@
        "filename": "app/config.py",
        "hashed_secret": "577a4c667e4af8682ca431857214b3a920883efc",
        "is_verified": false,
-        "line_number": 118,
+        "line_number": 127,
        "is_secret": false
      }
    ],
@@ -634,5 +634,5 @@
      }
    ]
  },
-  "generated_at": "2025-10-07T17:43:26Z"
+  "generated_at": "2025-10-14T19:59:45Z"
 }
--- a/app/config.py
+++ b/app/config.py
@@ -78,6 +78,10 @@ class Config(object):
    # TODO: reassign this
    NOTIFY_SERVICE_ID = "d6aa2c68-a2d9-4437-ab19-3ae8eb202553"

+    ORGANIZATION_DASHBOARD_ENABLED = (
+        getenv("ORGANIZATION_DASHBOARD_ENABLED", "False") == "True"
+    )
+
    NOTIFY_BILLING_DETAILS = json.loads(getenv("NOTIFY_BILLING_DETAILS") or "null") or {
        "account_number": "98765432",
        "sort_code": "01-23-45",
@@ -109,6 +113,11 @@ class Development(Config):
    ASSET_PATH = "/static/"
    NOTIFY_LOG_LEVEL = "DEBUG"

+    # Feature Flags
+    ORGANIZATION_DASHBOARD_ENABLED = (
+        getenv("ORGANIZATION_DASHBOARD_ENABLED", "True") == "True"
+    )
+
    # Buckets
    CSV_UPLOAD_BUCKET = _s3_credentials_from_env("CSV")
    LOGO_UPLOAD_BUCKET = _s3_credentials_from_env("LOGO")
--- a/app/main/views/organizations.py
+++ b/app/main/views/organizations.py
@@ -2,7 +2,7 @@ from collections import OrderedDict
 from datetime import datetime
 from functools import partial

-from flask import flash, redirect, render_template, request, url_for
+from flask import current_app, flash, redirect, render_template, request, url_for
 from flask_login import current_user

 from app import current_organization, org_invite_api_client, organizations_client
@@ -65,13 +65,29 @@ def add_organization():
@main.route("/organizations/<uuid:org_id>", methods=["GET"])
@user_has_permissions()
 def organization_dashboard(org_id):
-    year, current_financial_year = requested_and_current_financial_year(request)
-    services = current_organization.services_and_usage(financial_year=year)["services"]
+    if not current_app.config.get("ORGANIZATION_DASHBOARD_ENABLED", False):
+        return redirect(url_for(".organization_usage", org_id=org_id))
+
+    year = requested_and_current_financial_year(request)[0]
+
+    # TODO: total message allowance
    return render_template(
        "views/organizations/organization/index.html",
+        selected_year=year,
+    )
+
+
+@main.route("/organizations/<uuid:org_id>/usage", methods=["GET"])
+@user_has_permissions()
+def organization_usage(org_id):
+    year, current_financial_year = requested_and_current_financial_year(request)
+    services = current_organization.services_and_usage(financial_year=year)["services"]
+
+    return render_template(
+        "views/organizations/organization/usage.html",
        services=services,
        years=get_tuples_of_financial_years(
-            partial(url_for, ".organization_dashboard", org_id=current_organization.id),
+            partial(url_for, ".organization_usage", org_id=current_organization.id),
            start=current_financial_year - 2,
            end=current_financial_year,
        ),
@@ -90,14 +106,10 @@ def organization_dashboard(org_id):
@main.route("/organizations/<uuid:org_id>/download-usage-report.csv", methods=["GET"])
@user_has_permissions()
 def download_organization_usage_report(org_id):
-    selected_year_input = request.args.get("selected_year")
-    # Validate selected_year to prevent header injection
-    if (
-        selected_year_input
-        and selected_year_input.isdigit()
-        and len(selected_year_input) == 4
-    ):
-        selected_year = selected_year_input
+    # Validate and sanitize selected_year to prevent header injection
+    selected_year_input = request.args.get("selected_year", "")
+    if selected_year_input.isdigit() and len(selected_year_input) == 4:
+        selected_year = str(int(selected_year_input))
    else:
        selected_year = str(datetime.now().year)
    services_usage = current_organization.services_and_usage(
@@ -142,13 +154,8 @@ def download_organization_usage_report(org_id):
        {
            "Content-Type": "text/csv; charset=utf-8",
            "Content-Disposition": (
-                "inline;"
-                'filename="{} organization usage report for year {}'
-                ' - generated on {}.csv"'.format(
-                    safe_org_name,
-                    selected_year,
-                    datetime.now().strftime("%Y-%m-%dT%H:%M:%S.%fZ"),
-                )
+                f'inline;filename="{safe_org_name} organization usage report for year {selected_year}'
+                f' - generated on {datetime.now().strftime("%Y-%m-%dT%H:%M:%S.%fZ")}.csv"'
            ),
        },
    )
--- a/app/navigation.py
+++ b/app/navigation.py
@@ -333,6 +333,9 @@ class OrgNavigation(Navigation):
        "dashboard": {
            "organization_dashboard",
        },
+        "usage": {
+            "organization_usage",
+        },
        "settings": {
            "edit_organization_billing_details",
            "edit_organization_domains",
--- a/app/templates/components/org_nav.html
+++ b/app/templates/components/org_nav.html
@@ -1,6 +1,9 @@
 <nav id="nav-org-nav" aria-label="Organization navigation" class="nav margin-bottom-4">
  <ul class="usa-sidenav">
-    <li class="usa-sidenav__item"><a class="usa-link{{ org_navigation.is_selected('dashboard') }}" href="{{ url_for('.organization_dashboard', org_id=current_org.id) }}">Usage</a></li>
+    {% if config.ORGANIZATION_DASHBOARD_ENABLED %}
+    <li class="usa-sidenav__item"><a class="usa-link{{ org_navigation.is_selected('dashboard') }}" href="{{ url_for('.organization_dashboard', org_id=current_org.id) }}">Dashboard</a></li>
+    {% endif %}
+    <li class="usa-sidenav__item"><a class="usa-link{{ org_navigation.is_selected('usage') }}" href="{{ url_for('.organization_usage', org_id=current_org.id) }}">Usage</a></li>
    <li class="usa-sidenav__item"><a class="usa-link{{ org_navigation.is_selected('team-members') }}" href="{{ url_for('.manage_org_users', org_id=current_org.id) }}">Team members</a></li>
    {% if current_user.platform_admin %}
    <li class="usa-sidenav__item"><a class="usa-link{{ org_navigation.is_selected('settings') }}" href="{{ url_for('.organization_settings', org_id=current_org.id) }}">Settings</a></li>
--- a/app/templates/views/organizations/organization/index.html
+++ b/app/templates/views/organizations/organization/index.html
@@ -1,102 +1,27 @@
 {% from "components/page-header.html" import page_header %}
-{% from "components/big-number.html" import big_number %}
-{% from "components/live-search.html" import live_search %}
-{% from "components/pill.html" import pill %}
 {% extends "withnav_template.html" %}

 {% block org_page_title %}
-  Usage
+  Organization Dashboard
 {% endblock %}

 {% block maincolumn_content %}

-  {{ page_header('Usage', size='medium') }}
+  {{ page_header('Organization Dashboard', size='large') }}

-  <div class="margin-bottom-3">
-    {{ pill(years, selected_year, big_number_args={'smallest': True}) }}
-  </div>
-
-  <div class="grid-row margin-bottom-3">
-    <div class="grid-col-6">
-      <h2 class="font-heading-md">Emails</h2>
-      <div class="keyline-block">
-        {{ big_number(
-          total_emails_sent,
-          label='sent',
-          smaller=True
-        ) }}
-      </div>
-    </div>
-    <div class="grid-col-6">
-      <h2 class="font-heading-md">Text messages</h2>
-      <div class="keyline-block">
-        {{ big_number(
-          total_sms_cost,
-          'spent',
-          currency="$",
-          smaller=True
-        ) }}
-      </div>
-    </div>
-  </div>
-
-  {% if search_form %}
-    <div>
-      {{ live_search(
-        target_selector='.organization-service',
-        show=True,
-        form=search_form,
-        label='Search by service'
-      ) }}
-    </div>
-  {% endif %}
-
-  <h2 class="font-heading-md {% if search_form %}visually-hidden{% endif %}">By service</h2>
-
-  {% for service in services %}
-    <div class="keyline-block organization-service">
-      <h3 class="live-search-relevant">
-        <a href="{{ url_for('main.usage', service_id=service.service_id) }}" class="usa-link browse-list-link">{{ service.service_name  }}</a>
-      </h3>
-      <div class="grid-row">
-        <div class="grid-col-6">
-          {{ big_number(
-            service.emails_sent,
-            label=service.emails_sent|message_count_label('email'),
-            smallest=True
-          ) }}
-        </div>
-        <div class="grid-col-6">
-          {% if service.sms_cost %}
-            {{ big_number(
-              service.sms_cost,
-              'spent on text messages',
-              currency="$",
-              smallest=True
-            ) }}
-          {% else %}
-            {{ big_number(
-              service.sms_billable_units,
-              'free {}'.format(service.sms_billable_units|message_count_label('sms')),
-              smallest=True
-            ) }}
-          {% endif %}
-        </div>
-      </div>
-    </div>
-  {% endfor %}
-  <div class="keyline-block"></div>
-  {% if not services %}
-    <p class="usa-body usa-hint">
-      {{ current_org.name }} has no live services on Notify.gov
+  <div class="margin-top-5 margin-bottom-5">
+    <h2 class="font-heading-lg">What is a service?</h2>
+    <p class="usa-body">
+      When you join Notify, you're added to a service. This is your organization's workspace for sending text messages and emails. Within your service, you can:
    </p>
-    <div class="keyline-block"></div>
-  {% else %}
-    <div class="js-stick-at-bottom-when-scrolling">
-      <p>
-        <a href="{{ download_link }}" download="download" class="usa-link">Download this report (<abbr title="Comma separated values">CSV</abbr>)</a>
-      </p>
-    </div>
-  {% endif %}
+    <ol class="usa-list">
+      <li>Create and edit message templates</li>
+      <li>Send messages to recipients</li>
+      <li>View message status and history</li>
+      <li>Manage team members and permissions</li>
+      <li>Track usage and delivery statistics</li>
+      <li>If you work for multiple organizations, you may belong to multiple services and can switch between them.</li>
+    </ol>
+  </div>

 {% endblock %}
--- a/app/templates/views/organizations/organization/usage.html
+++ b/app/templates/views/organizations/organization/usage.html
@@ -0,0 +1,103 @@
+{% from "components/page-header.html" import page_header %}
+{% from "components/big-number.html" import big_number %}
+{% from "components/live-search.html" import live_search %}
+{% from "components/pill.html" import pill %}
+{% from "components/table.html" import list_table, field, row_heading %}
+{% extends "withnav_template.html" %}
+
+{% block org_page_title %}
+  Usage
+{% endblock %}
+
+{% block maincolumn_content %}
+
+  {{ page_header('Usage', size='medium') }}
+
+  <div class="margin-bottom-3">
+    {{ pill(years, selected_year, big_number_args={'smallest': True}) }}
+  </div>
+
+  <div class="grid-row margin-bottom-3">
+    <div class="grid-col-6">
+      <h2 class="font-heading-md">Emails</h2>
+      <div class="keyline-block">
+        {{ big_number(
+          total_emails_sent,
+          label='sent',
+          smaller=True
+        ) }}
+      </div>
+    </div>
+    <div class="grid-col-6">
+      <h2 class="font-heading-md">Text messages</h2>
+      <div class="keyline-block">
+        {{ big_number(
+          total_sms_cost,
+          'spent',
+          currency="$",
+          smaller=True
+        ) }}
+      </div>
+    </div>
+  </div>
+
+  {% if search_form %}
+    <div>
+      {{ live_search(
+        target_selector='.organization-service',
+        show=True,
+        form=search_form,
+        label='Search by service'
+      ) }}
+    </div>
+  {% endif %}
+
+  <h2 class="font-heading-md {% if search_form %}visually-hidden{% endif %}">By service</h2>
+
+  {% for service in services %}
+    <div class="keyline-block organization-service">
+      <h3 class="live-search-relevant">
+        <a href="{{ url_for('main.usage', service_id=service.service_id) }}" class="usa-link browse-list-link">{{ service.service_name  }}</a>
+      </h3>
+      <div class="grid-row">
+        <div class="grid-col-6">
+          {{ big_number(
+            service.emails_sent,
+            label=service.emails_sent|message_count_label('email'),
+            smallest=True
+          ) }}
+        </div>
+        <div class="grid-col-6">
+          {% if service.sms_cost %}
+            {{ big_number(
+              service.sms_cost,
+              'spent on text messages',
+              currency="$",
+              smallest=True
+            ) }}
+          {% else %}
+            {{ big_number(
+              service.sms_billable_units,
+              'free {}'.format(service.sms_billable_units|message_count_label('sms')),
+              smallest=True
+            ) }}
+          {% endif %}
+        </div>
+      </div>
+    </div>
+  {% endfor %}
+  <div class="keyline-block"></div>
+  {% if not services %}
+    <p class="usa-body usa-hint">
+      {{ current_org.name }} has no live services on Notify.gov
+    </p>
+    <div class="keyline-block"></div>
+  {% else %}
+    <div class="js-stick-at-bottom-when-scrolling">
+      <p>
+        <a href="{{ download_link }}" download="download" class="usa-link">Download this report (<abbr title="Comma separated values">CSV</abbr>)</a>
+      </p>
+    </div>
+  {% endif %}
+
+{% endblock %}
--- a/deploy-config/demo.yml
+++ b/deploy-config/demo.yml
@@ -8,3 +8,4 @@ redis_enabled: 1
 nr_agent_id: '1134302465'
 nr_app_id: '1083160688'
 API_PUBLIC_URL: https://notify-api-demo.app.cloud.gov
+ORGANIZATION_DASHBOARD_ENABLED: False
--- a/deploy-config/production.yml
+++ b/deploy-config/production.yml
@@ -8,3 +8,4 @@ redis_enabled: 1
 nr_agent_id: '1050708682'
 nr_app_id: '1050708682'
 API_PUBLIC_URL: https://notify-api-production.app.cloud.gov
+ORGANIZATION_DASHBOARD_ENABLED: False
--- a/deploy-config/sandbox.yml
+++ b/deploy-config/sandbox.yml
@@ -12,3 +12,4 @@ SECRET_KEY: sandbox-notify-secret-key
 nr_agent_id: ''
 nr_app_id: ''
 NR_BROWSER_KEY: ''
+ORGANIZATION_DASHBOARD_ENABLED: False
--- a/deploy-config/staging.yml
+++ b/deploy-config/staging.yml
@@ -8,3 +8,4 @@ redis_enabled: 1
 nr_agent_id: '1134291385'
 nr_app_id: '1031640326'
 API_PUBLIC_URL: https://notify-api-staging.app.cloud.gov
+ORGANIZATION_DASHBOARD_ENABLED: True
--- a/manifest.yml
+++ b/manifest.yml
@@ -63,3 +63,5 @@ applications:
      LOGIN_DOT_GOV_CERTS_URL: ((LOGIN_DOT_GOV_CERTS_URL))

      API_PUBLIC_URL: ((API_PUBLIC_URL))
+
+      ORGANIZATION_DASHBOARD_ENABLED: ((ORGANIZATION_DASHBOARD_ENABLED))
--- a/tests/app/main/views/organizations/test_organizations.py
+++ b/tests/app/main/views/organizations/test_organizations.py
@@ -44,7 +44,7 @@ def test_view_organization_shows_the_correct_organization(client_request, mocker
    )

    page = client_request.get(
-        ".organization_dashboard",
+        ".organization_usage",
        org_id=ORGANISATION_ID,
    )

@@ -353,7 +353,7 @@ def test_organization_services_shows_live_services_and_usage(
    )

    client_request.login(active_user_with_permissions)
-    page = client_request.get(".organization_dashboard", org_id=ORGANISATION_ID)
+    page = client_request.get(".organization_usage", org_id=ORGANISATION_ID)
    mock.assert_called_once_with(ORGANISATION_ID, 2020)

    services = page.select("main h3")
@@ -409,7 +409,7 @@ def test_organization_services_shows_live_services_and_usage_with_count_of_1(
    )

    client_request.login(active_user_with_permissions)
-    page = client_request.get(".organization_dashboard", org_id=ORGANISATION_ID)
+    page = client_request.get(".organization_usage", org_id=ORGANISATION_ID)

    usage_rows = page.select("main .grid-col-6")

@@ -443,7 +443,7 @@ def test_organization_services_filters_by_financial_year(
        "app.organizations_client.get_services_and_usage", return_value={"services": []}
    )
    page = client_request.get(
-        ".organization_dashboard",
+        ".organization_usage",
        org_id=ORGANISATION_ID,
        year=financial_year,
    )
@@ -486,7 +486,7 @@ def test_organization_services_shows_search_bar(
    )

    client_request.login(active_user_with_permissions)
-    page = client_request.get(".organization_dashboard", org_id=ORGANISATION_ID)
+    page = client_request.get(".organization_usage", org_id=ORGANISATION_ID)

    services = page.select(".organization-service")
    assert len(services) == 8
@@ -535,7 +535,7 @@ def test_organization_services_hides_search_bar_for_7_or_fewer_services(
    )

    client_request.login(active_user_with_permissions)
-    page = client_request.get(".organization_dashboard", org_id=ORGANISATION_ID)
+    page = client_request.get(".organization_usage", org_id=ORGANISATION_ID)

    services = page.select(".organization-service")
    assert len(services) == 7
@@ -569,7 +569,7 @@ def test_organization_services_links_to_downloadable_report(
        },
    )
    client_request.login(active_user_with_permissions)
-    page = client_request.get(".organization_dashboard", org_id=ORGANISATION_ID)
+    page = client_request.get(".organization_usage", org_id=ORGANISATION_ID)

    link_to_report = page.select_one("a[download]")
    assert normalize_spaces(link_to_report.text) == "Download this report (CSV)"
--- a/tests/app/test_navigation.py
+++ b/tests/app/test_navigation.py
@@ -138,6 +138,7 @@ EXCLUDED_ENDPOINTS = tuple(
            "organization_dashboard",
            "organization_settings",
            "organization_trial_mode_services",
+            "organization_usage",
            "organizations",
            "performance",
            "platform_admin",