Add cooldown timer (#140)

Author: MeshanKhosla

prisma/schema.prisma

@@ -220,4 +220,5 @@ enum SiteSettingsValues {
 
 enum VariableSiteSettings {
   EMAIL_DOMAIN
+  COOLDOWN_TIME // In minutes
 }

src/components/admin/AdminView.tsx

@@ -9,6 +9,7 @@ import { useEffect, useState } from "react";
 import useSiteSettings from "../../utils/hooks/useSiteSettings";
 import { trpc } from "../../utils/trpc";
 import AdminList from "./AdminList";
+import CoolDownTimer from "./CooldownTimer";
 import ImportUsersMethod from "./ImportUsersMethod";
 
 /**
@@ -107,7 +108,9 @@ const AdminView = () => {
         </Flex>
       </Flex>
 
-      <Divider />
+      <CoolDownTimer />
+
+      <Divider mt={2} />
 
       <ImportUsersMethod />
     </Flex>

src/components/admin/CooldownTimer.tsx

@@ -0,0 +1,73 @@
+import {
+  Button,
+  Flex,
+  NumberDecrementStepper,
+  NumberIncrementStepper,
+  NumberInput,
+  NumberInputField,
+  NumberInputStepper,
+  Text,
+  useToast,
+} from "@chakra-ui/react";
+import { useState } from "react";
+import { trpc } from "../../utils/trpc";
+
+/** Handles how long a student should wait before they can make another ticket */
+const CoolDownTimer = () => {
+  const [cooldownTime, setCooldownTime] = useState<number>(0);
+  const setCooldownTimeMutation = trpc.admin.setCooldownTime.useMutation();
+  const toast = useToast();
+
+  trpc.admin.getCoolDownTime.useQuery(undefined, {
+    refetchOnWindowFocus: false,
+    onSuccess: (time) => {
+      setCooldownTime(time);
+    },
+  });
+
+  const handleSetCooldownTime = async () => {
+    console.log(cooldownTime);
+    await setCooldownTimeMutation.mutateAsync({
+      cooldownTime,
+    });
+
+    toast({
+      title: "Success",
+      description: "Cooldown time updated",
+      status: "success",
+      duration: 5000,
+      position: "top-right",
+      isClosable: true,
+    });
+  };
+
+  return (
+    <Flex direction="column">
+      <Text fontSize="xl">Cooldown</Text>
+      <Text fontSize="md">
+        Students must wait this many minutes since their last ticket was
+        resolved to make another ticket
+      </Text>
+      <Flex flexDir="row">
+        <NumberInput
+          value={cooldownTime}
+          min={0}
+          max={180}
+          width="100%"
+          onChange={(val) => setCooldownTime(parseInt(val))}
+        >
+          <NumberInputField />
+          <NumberInputStepper>
+            <NumberIncrementStepper />
+            <NumberDecrementStepper />
+          </NumberInputStepper>
+        </NumberInput>
+        <Button colorScheme="telegram" onClick={handleSetCooldownTime}>
+          Confirm
+        </Button>
+      </Flex>
+    </Flex>
+  );
+};
+
+export default CoolDownTimer;

src/components/queue/CreateTicketForm.tsx

@@ -151,6 +151,10 @@ const CreateTicketForm = (props: CreateTicketFormProps) => {
     },
   });
 
+  const cooldownPeriod = trpc.admin.getCoolDownTime.useQuery(undefined, {
+    refetchOnWindowFocus: false,
+  }).data;
+
   const handleTicketTypeChange = (newVal: TicketType) => {
     setTicketType(newVal);
     if (newVal === TicketType.DEBUGGING) {
@@ -223,13 +227,15 @@ const CreateTicketForm = (props: CreateTicketFormProps) => {
       })
       .then((ticket) => {
         if (!ticket) {
+          const coolDownText = cooldownPeriod
+            ? `You must wait ${cooldownPeriod} minutes since your last ticket was resolved.`
+            : "";
           toast({
             title: "Error",
-            description:
-              "Could not create ticket. You may already have a ticket open. If not, refresh and try again.",
+            description: `Could not create ticket. You may already have a ticket open. If not, refresh and try again. ${coolDownText}`,
             status: "error",
             position: "top-right",
-            duration: 5000,
+            duration: 10000,
             isClosable: true,
           });
           return;
@@ -328,8 +334,8 @@ const CreateTicketForm = (props: CreateTicketFormProps) => {
               Public
               <Tooltip
                 hasArrow
-                label="Public tickets can be joined by other students. This is great for group work 
-               or conceptual questions! If your ticket is public, we are more likely to 
+                label="Public tickets can be joined by other students. This is great for group work 
+               or conceptual questions! If your ticket is public, we are more likely to 
                help you for a longer time."
                 bg="gray.300"
                 color="black"

src/server/trpc/router/admin.ts

@@ -246,6 +246,45 @@ export const adminRouter = router({
       });
     }),
 
+  setCooldownTime: protectedStaffProcedure
+    .input(
+      z.object({
+        cooldownTime: z.number(),
+      }),
+    )
+    .mutation(async ({ input, ctx }) => {
+      if (input.cooldownTime < 0) {
+        throw new TRPCClientError("Cooldown time cannot be negative");
+      }
+
+      await ctx.prisma.variableSettings.upsert({
+        where: {
+          setting: VariableSiteSettings.COOLDOWN_TIME,
+        },
+        update: {
+          value: input.cooldownTime.toString(),
+        },
+        create: {
+          setting: VariableSiteSettings.COOLDOWN_TIME,
+          value: input.cooldownTime.toString(),
+        },
+      });
+    }),
+
+  getCoolDownTime: protectedProcedure.query(async ({ ctx }) => {
+    const setting = await ctx.prisma.variableSettings.upsert({
+      where: {
+        setting: VariableSiteSettings.COOLDOWN_TIME,
+      },
+      update: {},
+      create: {
+        setting: VariableSiteSettings.COOLDOWN_TIME,
+        value: "0",
+      },
+    });
+    return parseInt(setting.value);
+  }),
+
   getEmailDomain: protectedStaffProcedure.query(async ({ ctx }) => {
     const setting = await ctx.prisma.variableSettings.upsert({
       where: {

src/server/trpc/router/ticket.ts

@@ -9,6 +9,7 @@ import {
   TicketType,
   User,
   UserRole,
+  VariableSiteSettings,
 } from "@prisma/client";
 import { TRPCClientError } from "@trpc/client";
 import Ably from "ably/promises";
@@ -120,6 +121,27 @@ export const ticketRouter = router({
       // If a ticket is made with a priority assigment, it's a priority ticket
       const isPriority = assignment?.isPriority;
 
+      // Check if the user has made a ticket within the cooldown period
+      const cooldownTimeResult = await ctx.prisma.variableSettings.findUnique({
+        where: { setting: VariableSiteSettings.COOLDOWN_TIME },
+      });
+
+      // in minutes
+      const cooldownTime = parseInt(cooldownTimeResult?.value ?? "0");
+
+      const lastTicket = await ctx.prisma.ticket.findFirst({
+        where: {
+          createdByUserId: ctx.session.user.id,
+          resolvedAt: {
+            gte: new Date(Date.now() - cooldownTime * 60 * 1000),
+          },
+        },
+      });
+
+      if (lastTicket && ctx.session.user.role !== UserRole.STAFF) {
+        return;
+      }
+
       const ticket = await ctx.prisma.ticket.create({
         data: {
           description: input.description,