feat(tasks): improved ux

composables/task.ts

@@ -2,45 +2,74 @@ import type { TaskMessage } from "~/server/internal/tasks";
 import { WebSocketHandler } from "./ws";
 
 const websocketHandler = new WebSocketHandler("/api/v1/task");
+const taskStates: { [key: string]: Ref<TaskMessage | undefined> } = {};
+
+function handleUpdateMessage(msg: TaskMessage) {
+  const taskStates = useTaskStates();
+  const state = taskStates[msg.id];
+  if (!state) return;
+  if (!state.value || msg.reset) {
+    state.value = msg;
+    return;
+  }
+  state.value.log.push(...msg.log);
+
+  Object.assign(state.value, { ...msg, log: state.value.log });
+}
 
 websocketHandler.listen((message) => {
-  const msg = JSON.parse(message) as TaskMessage;
-  const taskStates = useTaskStates();
-  const state = taskStates.value[msg.id];
-  if (!state) return;
-  state.value = msg;
+  try {
+    // If it's an object, it's an update message
+    const msg = JSON.parse(message) as TaskMessage;
+    handleUpdateMessage(msg);
+  } catch {
+    // Otherwise it's control message
+    const taskStates = useTaskStates();
+
+    const [action, ...data] = message.split("/");
+
+    switch (action) {
+      case "connect":
+        const taskReady = useTaskReady();
+        taskReady.value = true;
+        break;
+      case "disconnect":
+        const disconnectTaskId = data[0];
+        delete taskStates[disconnectTaskId];
+        console.log(`disconnected from ${disconnectTaskId}`);
+        break;
+      case "error":
+        const [taskId, title, description] = data;
+        taskStates[taskId].value ??= {
+          id: taskId,
+          name: "Unknown task",
+          success: false,
+          progress: 0,
+          error: undefined,
+          log: [],
+        };
+        taskStates[taskId].value.error = { title, description };
+        break;
+    }
+  }
 });
 
-const useTaskStates = () =>
-  useState<{ [key: string]: Ref<TaskMessage> }>("task-states", () => ({
-    connect: useState<TaskMessage>("task-connect", () => ({
-      id: "connect",
-      name: "Connect",
-      success: false,
-      progress: 0,
-      log: [],
-      error: undefined,
-    })),
-  }));
+const useTaskStates = () => taskStates;
 
-export const useTaskReady = () => {
+export const useTaskReady = () => useState("taskready", () => false);
+
+export const useTask = (taskId: string): Ref<TaskMessage | undefined> => {
+  if (import.meta.server) return ref(undefined);
   const taskStates = useTaskStates();
-  return taskStates.value["connect"];
-};
+  if (
+    taskStates[taskId] &&
+    taskStates[taskId].value &&
+    !taskStates[taskId].value.error
+  )
+    return taskStates[taskId];
 
-export const useTask = (taskId: string): Ref<TaskMessage> => {
-  if (import.meta.server) return {} as unknown as Ref<TaskMessage>;
-  const taskStates = useTaskStates();
-  if (taskStates.value[taskId]) return taskStates.value[taskId];
-
-  taskStates.value[taskId] = useState(`task-${taskId}`, () => ({
-    id: taskId,
-    name: "loading...",
-    success: false,
-    progress: 0,
-    error: undefined,
-    log: [],
-  }));
+  taskStates[taskId] = ref(undefined);
+  console.log("connecting to " + taskId);
   websocketHandler.send(`connect/${taskId}`);
-  return taskStates.value[taskId];
+  return taskStates[taskId];
 };

pages/admin/task/[id]/index.vue

@@ -1,7 +1,7 @@
 <template>
   <div
     class="grow w-full flex items-center justify-center"
-    v-if="taskValue && taskValue.success"
+    v-if="task && task.success"
   >
     <div class="flex flex-col items-center">
       <CheckCircleIcon class="h-12 w-12 text-green-600" aria-hidden="true" />
@@ -11,37 +11,78 @@
         </h1>
         <div class="mt-4">
           <p class="text-sm text-zinc-400 max-w-md">
-            "{{ taskValue.name }}" completed successfully.
+            "{{ task.name }}" completed successfully.
           </p>
         </div>
       </div>
     </div>
   </div>
-  <div v-else-if="taskValue" class="flex flex-col w-full gap-y-4">
+  <div
+    class="grow w-full flex items-center justify-center"
+    v-else-if="task && task.error"
+  >
+    <div class="flex flex-col items-center">
+      <ExclamationCircleIcon
+        class="h-12 w-12 text-red-600"
+        aria-hidden="true"
+      />
+      <div class="mt-3 text-center sm:mt-5">
+        <h1 class="text-3xl font-semibold font-display leading-6 text-zinc-100">
+          {{ task.error.title }}
+        </h1>
+        <div class="mt-4">
+          <p class="text-sm text-zinc-400 max-w-md">
+            {{ task.error.description }}
+          </p>
+        </div>
+      </div>
+    </div>
+  </div>
+  <div v-else-if="task" class="flex flex-col w-full gap-y-4">
     <h1 class="text-3xl text-zinc-100 font-bold font-display">
-      {{ taskValue.name }}
+      {{ task.name }}
     </h1>
     <div class="h-3 rounded-full bg-zinc-950 overflow-hidden">
       <div
-        :style="{ width: `${taskValue.progress}%` }"
+        :style="{ width: `${task.progress}%` }"
         class="transition-all bg-blue-600 h-full"
       />
     </div>
 
     <div class="bg-zinc-950/50 rounded-md p-2 text-zinc-100">
-      <pre v-for="line in taskValue.log">{{ line }}</pre>
+      <pre v-for="line in task.log">{{ line }}</pre>
     </div>
   </div>
+  <div v-else role="status" class="w-full h-screen flex items-center justify-center">
+      <svg
+        aria-hidden="true"
+        class="size-8 text-transparent animate-spin fill-white"
+        viewBox="0 0 100 101"
+        fill="none"
+        xmlns="http://www.w3.org/2000/svg"
+      >
+        <path
+          d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z"
+          fill="currentColor"
+        />
+        <path
+          d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z"
+          fill="currentFill"
+        />
+      </svg>
+      <span class="sr-only">Loading...</span>
+    </div>
+
 </template>
 
 <script setup lang="ts">
 import { CheckCircleIcon } from "@heroicons/vue/16/solid";
+import { ExclamationCircleIcon, XMarkIcon } from "@heroicons/vue/24/solid";
 
 const route = useRoute();
 const taskId = route.params.id.toString();
 
 const task = useTask(taskId);
-const taskValue = computed(() => task.value);
 
 definePageMeta({
   layout: "admin",

server/api/v1/task/index.get.ts

@@ -25,16 +25,7 @@ export default defineWebSocketHandler({
 
     const admin = session.getAdminUser(token);
     adminSocketSessions[peer.id] = admin !== undefined;
-
-    const rtMsg: TaskMessage = {
-      id: "connect",
-      name: "Connect",
-      success: true,
-      progress: 0,
-      error: undefined,
-      log: [],
-    };
-    peer.send(JSON.stringify(rtMsg));
+    peer.send(`connect`);
   },
   message(peer, message) {
     if (!peer.id) return;

server/internal/tasks/index.ts

@@ -10,7 +10,7 @@ type TaskRegistryEntry = {
   success: boolean;
   progress: number;
   log: string[];
-  error: string | undefined;
+  error: { title: string; description: string } | undefined;
   clients: { [key: string]: boolean };
   name: string;
   requireAdmin: boolean;
@@ -25,27 +25,43 @@ class TaskHandler {
 
   create(task: Task) {
     let updateCollectTimeout: NodeJS.Timeout | undefined;
+    let updateCollectResolves: Array<(value: unknown) => void> = [];
+    let logOffset: number = 0;
 
-    const updateAllClients = () => {
-      if (updateCollectTimeout) return;
-      updateCollectTimeout = setTimeout(() => {
-        const taskEntry = this.taskRegistry[task.id];
-        if (!taskEntry) return;
-        const taskMessage: TaskMessage = {
-          id: task.id,
-          name: task.name,
-          success: taskEntry.success,
-          progress: taskEntry.progress,
-          error: taskEntry.error,
-          log: taskEntry.log.reverse().slice(0, 50),
-        };
-        for (const client of Object.keys(taskEntry.clients)) {
-          if (!this.clientRegistry[client]) continue;
-          this.clientRegistry[client].send(JSON.stringify(taskMessage));
+    const updateAllClients = (reset = false) =>
+      new Promise((r) => {
+        if (updateCollectTimeout) {
+          updateCollectResolves.push(r);
+          return;
         }
-        updateCollectTimeout = undefined;
-      }, 100);
-    };
+        updateCollectTimeout = setTimeout(() => {
+          const taskEntry = this.taskRegistry[task.id];
+          if (!taskEntry) return;
+
+          const taskMessage: TaskMessage = {
+            id: task.id,
+            name: task.name,
+            success: taskEntry.success,
+            progress: taskEntry.progress,
+            error: taskEntry.error,
+            log: taskEntry.log.slice(logOffset),
+            reset,
+          };
+          logOffset = taskEntry.log.length;
+
+          for (const client of Object.keys(taskEntry.clients)) {
+            if (!this.clientRegistry[client]) continue;
+            this.clientRegistry[client].send(JSON.stringify(taskMessage));
+          }
+          updateCollectTimeout = undefined;
+
+          for (const resolve of updateCollectResolves) {
+            resolve(undefined);
+          }
+          r(undefined);
+          updateCollectResolves = [];
+        }, 100);
+      });
 
     const progress = (progress: number) => {
       const taskEntry = this.taskRegistry[task.id];
@@ -71,29 +87,48 @@ class TaskHandler {
       requireAdmin: task.requireAdmin ?? false,
     };
 
+    updateAllClients(true);
+
     droplet.callAltThreadFunc(async () => {
-      const promiseRun = task.run({ progress, log });
-      promiseRun.then(() => {
-        const taskEntry = this.taskRegistry[task.id];
-        if (!taskEntry) return;
+      const taskEntry = this.taskRegistry[task.id];
+      if (!taskEntry) throw new Error("No task entry");
+
+      try {
+        await task.run({ progress, log });
         this.taskRegistry[task.id].success = true;
-        updateAllClients();
-      });
-      promiseRun.catch((error) => {
-        const taskEntry = this.taskRegistry[task.id];
-        if (!taskEntry) return;
+      } catch (error: unknown) {
         this.taskRegistry[task.id].success = false;
-        this.taskRegistry[task.id].error = error;
-        updateAllClients();
-      });
+        this.taskRegistry[task.id].error = {
+          title: "An error occurred",
+          description: (error as string).toString(),
+        };
+      }
+      await updateAllClients();
+
+      for (const client of Object.keys(taskEntry.clients)) {
+        if (!this.clientRegistry[client]) continue;
+        this.disconnect(client, task.id);
+      }
+      delete this.taskRegistry[task.id];
     });
   }
 
   connect(id: string, taskId: string, peer: PeerImpl, isAdmin = false) {
     const task = this.taskRegistry[taskId];
-    if (!task) return "Invalid task";
+    if (!task) {
+      peer.send(
+        `error/${taskId}/Unknown task/Drop couldn't find the task you're looking for.`
+      );
+      return;
+    }
 
-    if (task.requireAdmin && !isAdmin) return "Requires admin";
+    if (task.requireAdmin && !isAdmin) {
+      console.warn("user is not an admin, so cannot view this task");
+      peer.send(
+        `error/${taskId}/Unknown task/Drop couldn't find the task you're looking for.`
+      );
+      return;
+    }
 
     this.clientRegistry[id] = peer;
     this.taskRegistry[taskId].clients[id] = true; // Uniquely insert client to avoid sending duplicate traffic
@@ -107,15 +142,20 @@ class TaskHandler {
       progress: task.progress,
     };
     peer.send(JSON.stringify(catchupMessage));
+  }
 
-    return true;
+  sendDisconnectEvent(id: string, taskId: string) {
+    const client = this.clientRegistry[id];
+    if (!client) return;
+    client.send(`disconnect/${taskId}`);
   }
 
   disconnectAll(id: string) {
     for (const taskId of Object.keys(this.taskRegistry)) {
       delete this.taskRegistry[taskId].clients[id];
+      this.sendDisconnectEvent(id, taskId);
     }
-    
+
     delete this.clientRegistry[id];
   }
 
@@ -123,6 +163,7 @@ class TaskHandler {
     if (!this.taskRegistry[taskId]) return false;
 
     delete this.taskRegistry[taskId].clients[id];
+    this.sendDisconnectEvent(id, taskId);
 
     const allClientIds = Object.values(this.taskRegistry)
       .map((_) => Object.keys(_.clients))
@@ -153,8 +194,9 @@ export type TaskMessage = {
   name: string;
   success: boolean;
   progress: number;
-  error: undefined | string;
+  error: undefined | { title: string; description: string };
   log: string[];
+  reset?: boolean;
 };
 
 export type PeerImpl = {