Display information about prepub sync status on the Admin dashboard

The styles here are very rudimentary, and will probably need some
fixing up before we'd want this to go live.

Author: chigby

dashboard/templates/dashboard/shortcuts_panel.html

@@ -27,3 +27,24 @@
 		{% endwith %}
 	</ul>
 </section>
+{% if prepub_sync_completed_at %}
+	<section class="panel nice-padding" style="font-size: 1.5em; line-height: 1.6">
+		<p><strong>Prepublication Incidents Sync</strong>
+			<br>
+			Completed at: {{ prepub_sync_completed_at|date:"SHORT_DATETIME_FORMAT" }}
+			{% if not prepub_sync_extended_message %}
+				<br>
+				{{ prepub_sync_message }}
+			{% endif %}
+		</p>
+		{% if prepub_sync_extended_message %}
+			<p>
+				Sync did not succeed.
+			</p>
+			<details>
+				<summary>Details</summary>
+				{{ prepub_sync_message }}
+			</details>
+		{% endif %}
+	</section>
+{% endif %}

dashboard/tests/test_dashboard.py

@@ -1,16 +1,17 @@
-from wagtail import hooks
-
 from django.urls import reverse
-from wagtail.test.utils import WagtailPageTestCase
+
+from wagtail import hooks
 from wagtail.models import Page, Site
+from wagtail.test.utils import WagtailPageTestCase
 
 from common.models.settings import (
     SearchSettings,
 )
+from dashboard.wagtail_hooks import add_shortcuts_panel
+from incident.models import PrepublicationIncidentSync
 from incident.tests.factories import (
     IncidentIndexPageFactory,
 )
-from dashboard.wagtail_hooks import add_shortcuts_panel
 
 
 class ShortcutsPanelTest(WagtailPageTestCase):
@@ -37,3 +38,21 @@ def test_image_shortcut(self):
     def test_incident_shortcut(self):
         response = self.client.get(reverse('wagtailadmin_home'))
         self.assertContains(response, 'Add a new incident')
+
+    @hooks.register_temporarily('construct_homepage_panels', add_shortcuts_panel)
+    def test_prepublication_status(self):
+        prepub_sync = PrepublicationIncidentSync.objects.create(
+            status=PrepublicationIncidentSync.Status.SUCCESS,
+            message='3 incidents retrieved.',
+        )
+        response = self.client.get(reverse('wagtailadmin_home'))
+        self.assertContains(response, '3 incidents retrieved.')
+
+    @hooks.register_temporarily('construct_homepage_panels', add_shortcuts_panel)
+    def test_prepublication_sync_failed_message(self):
+        prepub_sync = PrepublicationIncidentSync.objects.create(
+            status=PrepublicationIncidentSync.Status.INVALID_DATA,
+            message='Row 3: Invalid date Jan 13, 2010',
+        )
+        response = self.client.get(reverse('wagtailadmin_home'))
+        self.assertContains(response, 'Sync did not succeed')

dashboard/wagtail_hooks.py

@@ -1,13 +1,27 @@
 from wagtail import hooks
 from wagtail.admin.ui.components import Component
 
+from incident.models import PrepublicationIncidentSync
+
 
 class ShortcutsPanel(Component):
     # This is an ordering number that is the minimum multiple of 10 to place
     # this panel underneath the built-in Wagtail panels.
     order = 100
     template_name = 'dashboard/shortcuts_panel.html'
 
+    def get_context_data(self, parent_context):
+        context = super().get_context_data(parent_context)
+        prepub_sync = PrepublicationIncidentSync.objects.first()
+        if prepub_sync:
+            context['prepub_sync_completed_at'] = prepub_sync.completed_at
+            context['prepub_sync_message'] = prepub_sync.message
+            if prepub_sync.status == PrepublicationIncidentSync.Status.SUCCESS:
+                context['prepub_sync_extended_message'] = False
+            else:
+                context['prepub_sync_extended_message'] = True
+        return context
+
 
 @hooks.register('construct_homepage_panels')
 def add_shortcuts_panel(request, panels):