Merge pull request #354 from OpenGeoscience/email-notifs

Email notifications upon task completion

Author: annehaley

uvdat/core/migrations/0023_task_subscribers.py

@@ -0,0 +1,22 @@
+# Generated by Django 5.2.9 on 2026-03-16 14:42
+from __future__ import annotations
+
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0022_view_states"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="taskresult",
+            name="subscribers",
+            field=models.ManyToManyField(
+                blank=True, related_name="task_subscriptions", to=settings.AUTH_USER_MODEL
+            ),
+        ),
+    ]

uvdat/core/models/task_result.py

@@ -4,9 +4,13 @@
 
 from asgiref.sync import async_to_sync
 from channels.layers import get_channel_layer
+from django.conf import settings
+from django.contrib.auth.models import User
+from django.core.mail import send_mail
 from django.db import models
 from django.db.models.signals import post_save
 from django.dispatch import receiver
+from django.template.loader import render_to_string
 from django.utils import timezone
 
 from .project import Project
@@ -25,6 +29,7 @@ class TaskResult(models.Model):
     error = models.TextField(blank=True, default="")
     created = models.DateTimeField(auto_now_add=True, editable=False)
     completed = models.DateTimeField(null=True)
+    subscribers = models.ManyToManyField(User, related_name="task_subscriptions", blank=True)
 
     project_filter_path = "project"
     project_filter_allow_null = True
@@ -53,6 +58,19 @@ def complete(self):
         self.status = f"Completed in {seconds:.2f} seconds."
         self.save()
 
+        for subscriber in self.subscribers.all():
+            subject = "GeoDatalytics Task Completed"
+            message = render_to_string(
+                "uvdat/email_task_complete.txt",
+                {"task_name": self.name, "link": settings.UVDAT_WEB_URL},
+            )
+            send_mail(
+                subject=subject,
+                message=message,
+                from_email=None,
+                recipient_list=[subscriber],
+            )
+
 
 @receiver(post_save, sender=TaskResult)
 def result_post_save(sender, instance, **kwargs):

uvdat/core/rest/analytics.py

@@ -3,6 +3,7 @@
 import inspect
 
 from django.db.models import QuerySet
+from django.shortcuts import get_object_or_404
 from rest_framework.decorators import action
 from rest_framework.response import Response
 from rest_framework.serializers import ModelSerializer
@@ -110,3 +111,18 @@ def run(self, request, project_id: int, task_type: str, **kwargs):
             uvdat_serializers.TaskResultSerializer(result).data,
             status=200,
         )
+
+    @action(
+        detail=False,
+        methods=["post"],
+        url_path=r"(?P<result_id>[\d*]+)/subscribe",
+    )
+    def subscribe(self, request, result_id, **kwargs):
+        task_result = get_object_or_404(TaskResult, id=result_id)
+        if task_result.completed:
+            return Response("Task already completed. Subscription not applied.", status=410)
+        task_result.subscribers.add(request.user)
+        return Response(
+            uvdat_serializers.TaskResultSerializer(task_result).data,
+            status=200,
+        )

uvdat/core/templates/uvdat/email_task_complete.txt

@@ -0,0 +1,7 @@
+You are receiving this email because you have requested a notification upon the completion of a task in GeoDatalytics.
+
+The following Analytics Task has been completed:
+
+{{ task_name }}
+
+View the results at {{ link }}.

uvdat/core/tests/test_analytics.py

@@ -4,7 +4,7 @@
 from django.core.management import call_command
 import pytest
 
-from uvdat.core.models import Chart, Dataset, Network
+from uvdat.core.models import Chart, Dataset, Network, TaskResult
 from uvdat.core.tasks.analytics import (
     FloodNetworkFailure,
     FloodSimulation,
@@ -56,6 +56,28 @@ def test_rest_run_analysis_task_no_inputs(authenticated_api_client, user, projec
     assert "not provided" in resp.json()
 
 
+@pytest.mark.django_db
+def test_rest_subscribe_to_running_task(authenticated_api_client, user, project, mailoutbox):
+    project.set_followers([user])
+    task_result = TaskResult.objects.create(name="Test Task", project=project)
+    resp = authenticated_api_client.post(f"/api/v1/analytics/{task_result.id}/subscribe/")
+    assert resp.status_code == 200
+    task_result.complete()
+    message = next(filter(lambda m: m.subject == "GeoDatalytics Task Completed", mailoutbox), None)
+    assert message is not None
+    assert task_result.name in message.body
+
+
+@pytest.mark.django_db
+def test_rest_subscribe_to_completed_task(authenticated_api_client, user, project):
+    project.set_followers([user])
+    task_result = TaskResult.objects.create(name="Test Task", project=project)
+    task_result.complete()
+    resp = authenticated_api_client.post(f"/api/v1/analytics/{task_result.id}/subscribe/")
+    assert resp.status_code == 410
+    assert resp.json() == "Task already completed. Subscription not applied."
+
+
 @pytest.mark.slow
 @pytest.mark.django_db
 def test_flood_analysis_chain(project):

web/src/api/rest.ts

@@ -226,6 +226,14 @@ export async function getTaskResult(resultId: number): Promise<TaskResult> {
   return (await apiClient.get(`analytics/${resultId}`)).data;
 }
 
+export async function subscribeToTaskResult(resultId: number): Promise<TaskResult> {
+  return (await apiClient.post(
+    `analytics/${resultId}/subscribe/`,
+    undefined,
+    {errorMsg: 'Failed to subscribe to task result. Task may already be completed.'}
+  )).data;
+}
+
 export async function getVectorDataBounds(vectorId: number): Promise<number[]> {
   return (await apiClient.get(`vectors/${vectorId}/bounds/`)).data;
 }

web/src/components/sidebars/AnalyticsPanel.vue

@@ -1,12 +1,12 @@
 <script setup lang="ts">
 import { ref, watch, computed } from "vue";
 import {
-  getTaskResults,
   runAnalysis,
   getDataset,
   getChart,
   getTaskResult,
   getNetwork,
+  subscribeToTaskResult,
 } from "@/api/rest";
 import NodeAnimation from "./NodeAnimation.vue";
 import SliderNumericInput from "../SliderNumericInput.vue";
@@ -17,13 +17,15 @@ import {
   usePanelStore,
   useAnalysisStore,
   useProjectStore,
+  useAppStore,
 } from "@/store";
 
 const panelStore = usePanelStore();
 const analysisStore = useAnalysisStore();
 const projectStore = useProjectStore();
 const networkStore = useNetworkStore();
 const layerStore = useLayerStore();
+const appStore = useAppStore();
 
 const searchText = ref<string | undefined>();
 const filteredAnalysisTypes = computed(() => {
@@ -187,6 +189,11 @@ async function fillInputsAndOutputs() {
   }
 }
 
+async function subscribe() {
+  if (analysisStore.currentResult){
+    analysisStore.currentResult.subscribers = (await subscribeToTaskResult(analysisStore.currentResult.id)).subscribers;
+  }
+}
 
 watch(() => analysisStore.currentAnalysisType, () => {
   fetchResults()
@@ -344,6 +351,26 @@ watch(
                       </tbody>
                     </v-table>
                   </div>
+                  <div v-else>
+                    <div
+                      v-if="appStore.currentUser && analysisStore.currentResult?.subscribers.includes(appStore.currentUser.id)"
+                      style="text-align: center;"
+                    >
+                      <v-icon icon="mdi-check" color="success" />
+                      Subscribed
+                      <v-icon
+                        icon="mdi-information-outline"
+                        v-tooltip="'An email will be sent to you when the task is completed.'"
+                      />
+                    </div>
+                    <v-btn
+                      v-else
+                      @click="subscribe"
+                      v-tooltip="'If subscribed, an email will be sent to you when the task is completed.'"
+                    >
+                      Notify Me Once Completed
+                    </v-btn>
+                  </div>
                 </v-expansion-panel-text>
               </v-expansion-panel>
             </v-expansion-panels>

web/src/types.ts

@@ -421,6 +421,7 @@ export interface TaskResult {
   error: string;
   created: string;
   completed: string;
+  subscribers: number[];
 }
 
 export interface FloatingPanelConfig {