Add cancel button to visits

Keep students in the queue but hidden until their visit has actually concluded. Cancelling destroys the in-progress visit and unhides them from the queue.

Author: jbcarras

api/database/idb_visits.py

@@ -32,6 +32,18 @@ def end_visit(self, visit_id, reason):
         """
         raise NotImplementedError()
 
+    @abstractmethod
+    def cancel_visit(self, visit_id):
+        """ Destroy this visit from the database if it's still in progress.
+        Un-dequeue this student from the queue if they have been dequeued.
+
+        :param visit_id:
+        :return:
+        """
+
+
+        raise NotImplementedError()
+
     @abstractmethod
     def get_in_progress_visits(self):
         """ Return all database entries for visits that have

api/database/relational_db/relational_db.py

@@ -39,7 +39,8 @@ def initialize(self):
                     user_id INTEGER UNIQUE,
                     joined TEXT DEFAULT (datetime('now', 'localtime')),
                     priority INTEGER,
-                    enqueue_reason TEXT
+                    enqueue_reason TEXT,
+                    dequeued BOOLEAN DEFAULT false
                 );
                 """
             )

api/database/relational_db/relational_db_queue.py

@@ -44,7 +44,7 @@ def dequeue_student(self):
                 ORDER BY priority DESC, joined
             """
             ).fetchone()
-            cursor.execute("DELETE FROM queue WHERE user_id = ?", (user[0],))
+            cursor.execute("UPDATE queue SET dequeued = true WHERE user_id = ?", (user[0],))
 
         return {
             "user_id": user[0],
@@ -68,7 +68,7 @@ def dequeue_specified_student(self, student_id):
             if user is None:
                 return None
 
-            cursor.execute("DELETE FROM queue WHERE user_id = ?", (user[0],))
+            cursor.execute("UPDATE queue SET dequeued = true WHERE user_id = ?", (user[0],))
 
         return {
             "user_id": user[0],
@@ -85,6 +85,7 @@ def get_queue(self):
                 """
                 SELECT users.user_id, preferred_name, ubit, person_num 
                 FROM queue INNER JOIN users ON queue.user_id = users.user_id 
+                WHERE dequeued = false
                 ORDER BY priority DESC, joined
                 """
             )
@@ -106,7 +107,7 @@ def get_queue(self):
     def clear_queue(self):
         with self.cursor() as cursor:
             cursor.execute(
-                "DELETE FROM queue"
+                "DELETE FROM queue WHERE dequeued = false"
             )
 
     def remove_student(self, student):
@@ -116,6 +117,8 @@ def remove_student(self, student):
             if queue_info is None:
                 return None
 
+        with self.cursor() as cursor:
+
             cursor.execute("DELETE FROM queue WHERE user_id = ?", (student, ))
 
             return {"user_id": queue_info[0], "joined": queue_info[1]}

api/database/relational_db/relational_db_visits.py

@@ -25,12 +25,36 @@ def end_visit(self, visit_id, reason):
         now = str(datetime.datetime.now().isoformat(' ', timespec="seconds"))
 
         with self.cursor() as cursor:
+
+            student = cursor.execute("SELECT (student_id) from visits WHERE visit_id = ?", (visit_id, )).fetchone()
+
+            if student is None:
+                return
+
+            student = student[0]
+
             cursor.execute("""
                 UPDATE visits
                 SET session_end = ?, session_end_reason = ?
                 WHERE visit_id = ? AND session_end is null
             """, (now, reason, visit_id))
 
+        self.remove_student(student)
+
+    def cancel_visit(self, visit_id):
+        with self.cursor() as cursor:
+
+            student = cursor.execute("SELECT (student_id) from visits WHERE visit_id = ?", (visit_id,)).fetchone()
+
+            if student is None:
+                return
+
+            student = student[0]
+
+            cursor.execute("DELETE from visits WHERE visit_id = ?", (visit_id,))
+
+            cursor.execute("UPDATE queue SET dequeued = false WHERE user_id = ?", (student, ))
+
 
     def get_in_progress_visits(self):
         with self.cursor() as cursor:

api/queue/routes.py

@@ -121,7 +121,27 @@ def restore_visit():
 
     user_id = user["user_id"]
 
-    return get_tas_visit(user_id)
+    visit = get_tas_visit(user_id)
+
+    if visit is None:
+        return {"message": "You do not have an in-progress visit."}, 404
+
+    return visit
+
+@blueprint.route("/cancel-visit", methods=["POST"])
+@min_level('ta')
+def cancel_visit():
+    body = request.get_json()
+
+    visit_id = body.get("visit_id")
+
+    if visit_id is None:
+        return {"message": "Malformed request"}, 400
+
+    db.cancel_visit(visit_id)
+
+    return {"message": "Canceled visit"}, 200
+
 
 @blueprint.route("/active-visits", methods=["GET"])
 @min_level('ta')

client/src/components/Visit.vue

@@ -3,7 +3,7 @@
 import {ref} from "vue";
 
 const props = defineProps(["visit_info"])
-const emit = defineEmits(["close"])
+const emit = defineEmits(["open", "close"])
 
 const dialogRef = ref<HTMLDialogElement>();
 const showing = ref<boolean>(false);
@@ -14,6 +14,7 @@ const taNotesText = ref("");
 const show = () => {
   dialogRef.value?.showModal();
   showing.value = true;
+  emit("open")
 }
 
 const hide = () => {
@@ -68,6 +69,20 @@ const sendToBack = () => {
   })
 }
 
+const cancelVisit = () => {
+  fetch("/api/cancel-visit", {
+    method: "POST",
+    body: JSON.stringify({"visit_id": props.visit_info["visitID"]}),
+    headers: {"Content-Type": "application/json"}
+  }).then(res => {
+    if (res.ok) {
+      hide();
+    }
+  })
+
+
+}
+
 
 </script>
 
@@ -88,8 +103,8 @@ const sendToBack = () => {
       <textarea ref="taNotesBox" v-model="taNotesText" id="ta-visit-notes" placeholder="How did the visit go?"
                 required></textarea>
       <button @click="() => submitVisit()" id="end-visit" class="important">End Visit</button>
-      <button @click="() => submitVisit(sendToFront)" id="end-visit-return-front">End and Return to Front</button>
-      <button @click="() => submitVisit(sendToBack)" id="end-visit-return-back">End and Return to Back</button>
+      <button @click="() => submitVisit(sendToBack)" id="end-visit-return-front">End and Return to Back</button>
+      <button @click="cancelVisit" id="end-visit-cancel">Cancel Visit</button>
     </div>
 
 

client/src/pages/InstructorQueue.vue

@@ -199,7 +199,7 @@ router.beforeEach((to, from, next) => {
 
 <template>
 
-  <Visit ref="visitDialog" :visit_info="visitInfo" @close="() => { getQueue(); getInProgressVisit(); } "/>
+  <Visit ref="visitDialog" :visit_info="visitInfo" @open="getQueue" @close="() => { getQueue(); getInProgressVisit(); } "/>
 
   <ConfirmationDialog @open="resetForceEnqueueDialog" ref="forceEnqueueDialog">
     <label for="force-enqueue">Student Identifier (UBITName or Person Number)</label><br/>