#795 Edit endpoint names and change to POST request

Author: alaneng-neu

.github/workflows/task-deadline-notifications.yml

@@ -10,5 +10,5 @@ jobs:
     steps:
       - name: Send notifications
         run: |
-          curl -X GET https://api.finishlinebyner.com/deadline-notifications/sendTaskDeadlineSlackNotifications \
+          curl -X POST https://api.finishlinebyner.com/notifications/task-deadlines \
           -H 'Authorization: ${{ secrets.NOTIFICATION_ENDPOINT_SECRET }}'

src/backend/index.ts

@@ -12,7 +12,7 @@ import descriptionBulletsRouter from './src/routes/description-bullets.routes';
 import tasksRouter from './src/routes/tasks.routes';
 import reimbursementRequestsRouter from './src/routes/reimbursement-requests.routes';
 import designReviewRouter from './src/routes/design-review.routes';
-import deadlineNotificationsRouter from './src/routes/deadline-notifications.routes';
+import notificationsRouter from './src/routes/notifications.routes';
 
 const app = express();
 const port = process.env.PORT || 3001;
@@ -55,7 +55,7 @@ app.use('/description-bullets', descriptionBulletsRouter);
 app.use('/tasks', tasksRouter);
 app.use('/reimbursement-requests', reimbursementRequestsRouter);
 app.use('/design-reviews', designReviewRouter);
-app.use('/deadline-notifications', deadlineNotificationsRouter);
+app.use('/notifications', notificationsRouter);
 app.use('/', (_req, res) => {
   res.json('Welcome to FinishLine');
 });

…rs/deadline-notifications.controllers.ts …controllers/notifications.controllers.tssrc/backend/src/controllers/deadline-notifications.controllers.ts renamed to src/backend/src/controllers/notifications.controllers.ts src/backend/src/controllers/deadline-notifications.controllers.ts renamed to src/backend/src/controllers/notifications.controllers.ts

@@ -1,11 +1,10 @@
 import { NextFunction, Request, Response } from 'express';
-import DeadlineNotificationsService from '../services/deadline-notifications.services';
+import NotificationsService from '../services/notifications.services';
 
-export default class DeadlineNotificationsController {
+export default class NotificationsController {
   static async sendTaskDeadlineSlackNotifications(_req: Request, res: Response, next: NextFunction) {
     try {
-      const tomorrow = new Date(new Date().setHours(24, 0, 0, 0));
-      await DeadlineNotificationsService.sendTaskDeadlineSlackNotifications(tomorrow);
+      await NotificationsService.sendTaskDeadlineSlackNotifications();
 
       res.status(200).json({ message: 'Successfully sent task deadline notifications!' });
     } catch (error: unknown) {

src/backend/src/routes/deadline-notifications.routes.ts

@@ -0,0 +1,8 @@
+import express from 'express';
+import NotificationsController from '../controllers/notifications.controllers';
+
+const notificationsRouter = express.Router();
+
+notificationsRouter.post('/task-deadlines', NotificationsController.sendTaskDeadlineSlackNotifications);
+
+export default notificationsRouter;

src/backend/src/routes/notifications.routes.ts

@@ -1,16 +1,20 @@
 import prisma from '../prisma/prisma';
-import { TaskWithAssignees, getTeamFromTaskAssignees, usersToSlackPings } from '../utils/deadline-notifications.utils';
+import {
+  TaskWithAssignees,
+  endOfDayTomorrow,
+  getTeamFromTaskAssignees,
+  startOfDayTomorrow,
+  usersToSlackPings
+} from '../utils/notifications.utils';
 import { sendMessage } from '../integrations/slack';
 
-export default class DeadlineNotificationsService {
+export default class NotificationsService {
   /**
-   * Sends the task deadline slack notifications for all tasks with a deadline of the given date
-   * @param deadline the beginning of the deadline date (at 12am)
+   * Sends the task deadline slack notifications for all tasks with a deadline of tomorrow
    */
-  static async sendTaskDeadlineSlackNotifications(deadline: Date) {
-    const startOfDay = deadline;
-    const endOfDay = new Date(startOfDay);
-    endOfDay.setDate(startOfDay.getDate() + 1);
+  static async sendTaskDeadlineSlackNotifications() {
+    const startOfDay = startOfDayTomorrow();
+    const endOfDay = endOfDayTomorrow();
 
     const tasks = await prisma.task.findMany({
       where: {
@@ -43,7 +47,7 @@ export default class DeadlineNotificationsService {
 
     // group tasks due by team in a map
     tasks.forEach((task) => {
-      const teamSlackId = getTeamFromTaskAssignees(task.assignees);
+      const teamSlackId = getTeamFromTaskAssignees(task.assignees).slackId;
 
       const currentTasks = teamTaskMap.get(teamSlackId);
       if (currentTasks) {
@@ -57,6 +61,8 @@ export default class DeadlineNotificationsService {
     // send the notifications to each team for their respective tasks
     teamTaskMap.forEach((tasks, slackId) => {
       const messageBlock = tasks
+        // ensures that the task has assignees to send a reminder for
+        .filter((task) => task.assignees)
         .map(
           (task) =>
             `${usersToSlackPings(task.assignees ?? [])} Reminder: ${task.title} due tomorrow in project ${

…vices/deadline-notifications.services.ts …d/src/services/notifications.services.tssrc/backend/src/services/deadline-notifications.services.ts renamed to src/backend/src/services/notifications.services.ts src/backend/src/services/deadline-notifications.services.ts renamed to src/backend/src/services/notifications.services.ts

@@ -22,9 +22,9 @@ export const usersToSlackPings = (users: UserWithSettings[]) => {
  * Gets the team of a task's assignees.
  * Assumes all assigness share a team
  * @param users the users of the task
- * @returns the slack id of the team assigned to the task
+ * @returns the team assigned to the task
  */
-export const getTeamFromTaskAssignees = (users: UserWithTeams[]): string => {
+export const getTeamFromTaskAssignees = (users: UserWithTeams[]): Team => {
   const allTeams = users.map((user) => {
     const teams = [];
     if (user.teamAsHead) teams.push(user.teamAsHead);
@@ -43,8 +43,27 @@ export const getTeamFromTaskAssignees = (users: UserWithTeams[]): string => {
 
   // Assuming we return the Slack ID of the first common team if there are any
   if (commonTeams.length > 0) {
-    return commonTeams[0].slackId; // Return the slackId of the first common team
+    return commonTeams[0]; // Return the first common team
   }
 
   throw new HttpException(400, 'All of the users do not share a team!');
 };
+
+/**
+ * Gets the beginning of the day tomorrow
+ * @returns the beginning of the day tomorrow (at 12am)
+ */
+export const startOfDayTomorrow = () => {
+  return new Date(new Date().setHours(24, 0, 0, 0));
+};
+
+/**
+ * Gets the end of the day tomorrow
+ * @returns the end of the day tomorrow (i.e. 12am of the following day)
+ */
+export const endOfDayTomorrow = () => {
+  const startOfDay = startOfDayTomorrow();
+  const endOfDay = new Date(startOfDay);
+  endOfDay.setDate(startOfDay.getDate() + 1);
+  return endOfDay;
+};