Merge pull request #1743 from GSA/1677-user-story-view-table-of-all-jobs-sent-with-my-service

new activity page

app/assets/sass/uswds/_uswds-theme-custom-styles.scss

@@ -452,27 +452,43 @@ td.table-empty-message {
       width: 25%;
       overflow-wrap: anywhere;
    }
+   td.jobid {
+      width: 5%;
+   }
    td.template {
-      width: 20%;
+      width: 25%;
    }
    td.time-sent {
-      width: 20%;
+      width: 30%;
    }
    td.sender {
-      width: 15%;
+      width: 20%;
+      overflow-wrap: break-word;
    }
    td.count-of-recipients {
       width: 5%;
    }
    td.report {
       width: 5%;
+      text-align: center;
    }
+   td.report img {
+      padding-top: 5px;
+    }
    th {
       padding: 0.5rem 1rem
    }
-   td {
-      padding: 0.5rem 1rem
-  }
+}
+
+@media (max-width: 768px) {
+   .usa-table-container--scrollable-mobile {
+      margin: 0;
+      overflow-y:hidden;
+   }
+}
+
+.usa-table th[data-sortable][aria-sort=ascending], .usa-table th[data-sortable][aria-sort=descending] {
+   background-color: #a1d3ff;
 }
 
 #template-list {

app/formatters.py

@@ -231,6 +231,11 @@ def naturaltime_without_indefinite_article(date):
     )
 
 
+def convert_time_unixtimestamp(date_string):
+    dt = datetime.fromisoformat(date_string)
+    return int(dt.timestamp())
+
+
 def format_delta(date):
     # This method assumes that date is in UTC
     date = parse_naive_dt(date)

app/main/__init__.py

@@ -3,6 +3,7 @@ from flask import Blueprint
 main = Blueprint("main", __name__)
 
 from app.main.views import (  # noqa isort:skip
+    activity,
     add_service,
     api_keys,
     choose_account,

app/main/views/activity.py

@@ -0,0 +1,80 @@
+from flask import abort, render_template, request, url_for
+
+from app import current_service, job_api_client
+from app.formatters import convert_time_unixtimestamp, get_time_left
+from app.main import main
+from app.utils.pagination import (
+    generate_next_dict,
+    generate_pagination_pages,
+    generate_previous_dict,
+    get_page_from_request,
+)
+from app.utils.user import user_has_permissions
+
+
+@main.route("/activity/services/<uuid:service_id>")
+@user_has_permissions()
+def all_jobs_activity(service_id):
+    service_data_retention_days = 7
+    page = get_page_from_request()
+    jobs = job_api_client.get_page_of_jobs(service_id, page=page)
+    all_jobs_dict = generate_job_dict(jobs)
+    prev_page, next_page, pagination = handle_pagination(jobs, service_id, page)
+
+    return render_template(
+        "views/activity/all-activity.html",
+        all_jobs_dict=all_jobs_dict,
+        service_data_retention_days=service_data_retention_days,
+        next_page=next_page,
+        prev_page=prev_page,
+        pagination=pagination,
+    )
+
+
+def handle_pagination(jobs, service_id, page):
+    if page is None:
+        abort(404, "Invalid page argument ({}).".format(request.args.get("page")))
+    prev_page = (
+        generate_previous_dict("main.all_jobs_activity", service_id, page)
+        if page > 1
+        else None
+    )
+    next_page = (
+        generate_next_dict("main.all_jobs_activity", service_id, page)
+        if jobs.get("links", {}).get("next")
+        else None
+    )
+    pagination = generate_pagination_pages(
+        jobs.get("total", {}), jobs.get("page_size", {}), page
+    )
+    return prev_page, next_page, pagination
+
+
+def generate_job_dict(jobs):
+    return [
+        {
+            "job_id": job["id"],
+            "time_left": get_time_left(job["created_at"]),
+            "download_link": url_for(
+                ".view_job_csv", service_id=current_service.id, job_id=job["id"]
+            ),
+            "view_job_link": url_for(
+                ".view_job", service_id=current_service.id, job_id=job["id"]
+            ),
+            "created_at": job["created_at"],
+            "time_sent_data_value": convert_time_unixtimestamp(
+                job["processing_finished"]
+                if job["processing_finished"]
+                else (
+                    job["processing_started"]
+                    if job["processing_started"]
+                    else job["created_at"]
+                )
+            ),
+            "processing_finished": job["processing_finished"],
+            "processing_started": job["processing_started"],
+            "created_by": job["created_by"],
+            "template_name": job["template_name"],
+        }
+        for job in jobs["data"]
+    ]

app/navigation.py

@@ -153,6 +153,9 @@ class HeaderNavigation(Navigation):
 
 class MainNavigation(Navigation):
     mapping = {
+        "activity": {
+            "all_jobs_activity",
+        },
         "dashboard": {
             "conversation",
             "inbox",

app/templates/new/components/main_nav.html

@@ -8,6 +8,7 @@
   {% if current_user.has_permissions() %}
     {% if current_user.has_permissions('view_activity') %}
       <li class="usa-sidenav__item"><a class="{{ main_navigation.is_selected('dashboard') }}" href="{{ url_for('.service_dashboard', service_id=current_service.id) }}">Dashboard</a></li>
+      <li class="usa-sidenav__item"><a class="{{ main_navigation.is_selected('activity') }}" href="{{ url_for('.all_jobs_activity', service_id=current_service.id) }}">Activity</a></li>
     {% endif %}
     {% if not current_user.has_permissions('view_activity') %}
       <li class="usa-sidenav__item"><a class="{{ casework_navigation.is_selected('sent-messages') }}" href="{{ url_for('.view_notifications', service_id=current_service.id, status='sending,delivered,failed') }}">Sent messages</a></li>

app/templates/views/activity/all-activity.html

@@ -0,0 +1,126 @@
+{% extends "withnav_template.html" %}
+
+{% block service_page_title %}
+  All activity
+{% endblock %}
+
+{% set show_pagination %}
+  {% if prev_page or next_page %}
+  <nav aria-label="Pagination" class="usa-pagination">
+    <ul class="usa-pagination__list">
+      {% if prev_page %}
+      <li class="usa-pagination__item usa-pagination__arrow">
+        <a
+          href="{{prev_page['url']}}"
+          class="usa-pagination__link usa-pagination__previous-page"
+          aria-label="Previous page"
+          >
+          <img src="{{ url_for('static', filename='/img/usa-icons/navigate_before.svg') }}" alt="arrow">
+          <span class="usa-pagination__link-text">Previous</span></a
+        >
+      </li>
+      {% endif %}
+      {% if pagination %}
+        {% for page in pagination.pages %}
+          {% if page == pagination.current %}
+          <li class="usa-pagination__item usa-pagination__page-no">
+            <span class="usa-pagination__button usa-current" aria-label="Page {{ page }}" aria-current="true">
+              {{ page }}
+            </span>
+          </li>
+          {% else %}
+            <li class="usa-pagination__item">
+              <a class="usa-pagination__button" href="?page={{ page }}">
+                {{ page }}
+              </a>
+            </li>
+          {% endif %}
+          {% if page == 3 and pagination.last > 4 %}
+            <li class="usa-pagination__item usa-pagination__overflow" aria-label="ellipsis indicating non-visible pages">
+              <span>…</span>
+            </li>
+          {% endif %}
+        {% endfor %}
+      {% endif %}
+      {% if next_page %}
+      <li class="usa-pagination__item usa-pagination__arrow">
+        <a
+          href="{{ next_page['url'] }}"
+          class="usa-pagination__link usa-pagination__next-page"
+          aria-label="Next page"
+        >
+          <span class="usa-pagination__link-text">Next </span>
+          <img src="{{ url_for('static', filename='/img/usa-icons/navigate_next.svg') }}" alt="arrow">
+        </a>
+      </li>
+      {% endif %}
+    </ul>
+  </nav>
+  {% endif %}
+{% endset %}
+
+{% block maincolumn_content %}
+  <div class="margin-bottom-8">
+    <h1 class="usa-sr-only">All activity</h1>
+    <h2 class="font-body-2xl line-height-sans-2 margin-0">All activity</h2>
+    <h2 class="margin-top-4 margin-bottom-1">Sent jobs</h2>
+    <div class="usa-table-container--scrollable-mobile">
+      <table class="usa-table usa-table--compact job-table">
+        <caption></caption>
+        <thead class="table-field-headings">
+          <tr>
+            <th scope="col" role="columnheader" class="table-field-heading-first" id="jobId">
+              <span>Job ID#</span>
+            </th>
+            <th data-sortable scope="col" role="columnheader" class="table-field-heading">
+              <span>Template</span>
+            </th>
+            <th data-sortable scope="col" role="columnheader" class="table-field-heading">
+              <span>Time sent</span>
+            </th>
+            <th data-sortable scope="col" role="columnheader" class="table-field-heading">
+              <span>Sender</span>
+            </th>
+            <th data-sortable scope="col" role="columnheader" class="table-field-heading">
+              <span>Report</span>
+            </th>
+          </tr>
+        </thead>
+        <tbody>
+          {% if all_jobs_dict %}
+            {% for job in all_jobs_dict %}
+              <tr class="table-row">
+                <td class="table-field jobid" scope="row" role="rowheader">
+                  <a class="usa-link" href="{{ job.view_job_link }}">
+                    {{ job.job_id[:8] if job.job_id else 'Manually entered number' }}
+                  </a>
+                </td>
+                <td class="table-field template">{{ job.template_name }}</td>
+                <td data-sort-value="{{job.time_sent_data_value}}" class="table-field time-sent">
+                  {{ (job.processing_finished if job.processing_finished else job.processing_started
+                    if job.processing_started else job.created_at)|format_datetime_table }}
+                </td>
+                <td class="table-field sender">{{ job.created_by.name }}</td>
+                <td class="table-field report">
+                  {% if job.time_left != "Data no longer available" %}
+                    <a href="{{ job.download_link }}"><img src="{{ url_for('static', filename='img/material-icons/file_download.svg') }}" alt="File Download Icon"></a>
+                  {% elif job %}
+                    <span>N/A</span>
+                  {% endif %}
+                </td>
+              </tr>
+            {% endfor %}
+          {% else %}
+            <tr class="table-row">
+              <td class="table-empty-message" colspan="10">No batched job messages found (messages are kept for {{ service_data_retention_days }} days).</td>
+            </tr>
+        {% endif %}
+        </tbody>
+      </table>
+      <div class="usa-sr-only usa-table__announcement-region" aria-live="polite"></div>
+      <p><b>Note: </b>Report data is only available for 7 days after your message has been sent</p>
+    </div>
+    {{show_pagination}}
+  </div>
+
+{% endblock %}

app/utils/pagination.py

@@ -29,3 +29,15 @@ def generate_previous_next_dict(view, service_id, page, title, url_args):
         "title": title,
         "label": "page {}".format(page),
     }
+
+
+def generate_pagination_pages(total_items, page_size, current_page):
+    total_pages = (total_items + page_size - 1) // page_size
+    pagination = {"current": current_page, "pages": [], "last": total_pages}
+    if total_pages <= 9:
+        pagination["pages"] = list(range(1, total_pages + 1))
+    else:
+        start_page = max(1, min(current_page - 4, total_pages - 8))
+        end_page = min(start_page + 8, total_pages)
+        pagination["pages"] = list(range(start_page, end_page + 1))
+    return pagination