Merge branch 'main' of https://github.com/devsoc-unsw/trainee-fool-24t3

backend/package.json

@@ -13,6 +13,8 @@
   "license": "ISC",
   "dependencies": {
     "@prisma/client": "^5.22.0",
+    "@supabase/storage-js": "^2.7.1",
+    "base64-arraybuffer": "^1.0.2",
     "bcrypt": "^5.1.1",
     "connect-redis": "^7.1.1",
     "cors": "^2.8.5",

backend/prisma/migrations/20241213143101_20241213074516/migration.sql

@@ -0,0 +1,8 @@
+/*
+  Warnings:
+
+  - A unique constraint covering the columns `[text]` on the table `Keyword` will be added. If there are existing duplicate values, this will fail.
+
+*/
+-- CreateIndex
+CREATE UNIQUE INDEX "Keyword_text_key" ON "Keyword"("text");

backend/src/config/storage.ts

@@ -0,0 +1,68 @@
+import { StorageClient } from '@supabase/storage-js';
+import { decode } from 'base64-arraybuffer';
+
+const STORAGE_URL = process.env['STORAGE_URL'];
+const SERVICE_KEY = process.env['SERVICE_ROLE'];
+
+if (process.env['NODE_ENV'] !== 'test' && !STORAGE_URL) {
+  throw new Error('Storage URL not found.');
+}
+if (process.env['NODE_ENV'] !== 'test' && !SERVICE_KEY) {
+  throw new Error('Service key not found.');
+}
+
+export let storageClient: StorageClient | null = null;
+if (STORAGE_URL && SERVICE_KEY) {
+  storageClient = new StorageClient(STORAGE_URL, {
+    apikey: SERVICE_KEY,
+    Authorization: `Bearer ${SERVICE_KEY}`,
+  });
+}
+
+export const uploadFile = async (
+  file: string,
+  fileType: string,
+  societyId: number,
+  eventName: string
+) => {
+  if (!storageClient) {
+    throw new Error('Storage client not initialised.');
+  }
+  const { data, error } = await storageClient
+    .from('images')
+    .upload(
+      `${societyId}/${eventName}/banner.${fileType.split('/')[1]}`,
+      decode(file),
+      {
+        contentType: fileType,
+        upsert: true,
+      }
+    );
+  if (error) {
+    throw new Error(error.message);
+  }
+  console.log(data);
+  return data.path;
+};
+
+export const getFile = async (path: string) => {
+  if (!storageClient) {
+    throw new Error('Storage client not initialised.');
+  }
+  const { data, error } = await storageClient.from('images').download(path);
+  if (error) {
+    throw new Error(error.message);
+  }
+
+  return data;
+};
+
+export const getFileUrl = async (path: string) => {
+  if (!storageClient) {
+    throw new Error('Storage client not initialised.');
+  }
+
+  const { data } = await storageClient.from('images').getPublicUrl(path);
+
+  return data;
+};

backend/src/index.ts

@@ -28,6 +28,12 @@ import {
   findUserFromId,
   updateUserPasswordFromEmail,
 } from './routes/User/user';
+import {
+  getFile,
+  getFileUrl,
+  storageClient,
+  uploadFile,
+} from './config/storage';
 
 declare module 'express-session' {
   interface SessionData {
@@ -78,7 +84,7 @@ app.use(
     credentials: true,
   })
 );
-app.use(express.json());
+app.use(express.json({ limit: '20mb' }));
 
 if (process.env['SESSION_SECRET'] === undefined) {
   console.error('Session secret not provided in .env file');
@@ -191,7 +197,7 @@ app.post('/auth/otp/generate', async (req: Request, res: Response) => {
       });
     }
 
-    if (process.env['CI']) {
+    if (process.env['NODE_ENV'] === 'test') {
       return res.status(200).json({ message: token });
     }
     return res.status(200).json({ message: 'ok' });
@@ -256,6 +262,8 @@ app.post('/auth/password/forgot', async (req: Request, res: Response) => {
 
     await updateUserPasswordFromEmail(email, password, SALT_ROUNDS);
 
+    await redisClient.del(email);
+
     return res.status(200).json({ message: 'ok' });
   } catch (error) {
     return res.status(400).json({
@@ -626,10 +634,33 @@ app.post(
       return res.status(400).json({ message: 'Invalid date' });
     }
 
+    //console.log(event);
+
+    // upload image to storage and get link
+    let imagePath = '';
+    try {
+      if (event.banner && storageClient) {
+        const metaData = event.banner.metaData;
+        const base64Data = event.banner.buffer.split(',')[1];
+        if (base64Data) {
+          imagePath = await uploadFile(
+            base64Data,
+            metaData.type,
+            event.societyId,
+            event.name
+          );
+        } else {
+          throw new Error('Invalid base64 string.');
+        }
+      }
+    } catch (error) {
+      return res.status(400).json({ message: `Unable to upload image.` });
+    }
+
     try {
       const eventRes = await prisma.event.create({
         data: {
-          banner: event.banner,
+          banner: imagePath,
           name: event.name,
           startDateTime: dayjs(event.startDateTime).toISOString(),
           endDateTime: dayjs(event.endDateTime).toISOString(),
@@ -644,6 +675,7 @@ app.post(
       });
       return res.status(200).json(eventRes);
     } catch (e) {
+      console.log(e);
       return res.status(400).json({ message: 'Invalid event input' });
     }
   }
@@ -675,21 +707,53 @@ app.put('/event', async (req: TypedRequest<UpdateEventBody>, res: Response) => {
     return res.status(400).json({ message: 'Invalid date' });
   }
 
+  // upload image to storage and get link
+  let imagePath;
+  try {
+    if (Object.keys(event.banner).length > 0) {
+      const base64Data = req.body.banner.buffer.split(',')[1];
+      if (base64Data) {
+        const metaData = req.body.banner.metaData;
+
+        imagePath = await uploadFile(
+          base64Data,
+          metaData.type,
+          event.societyId,
+          event.name
+        );
+      } else {
+        throw new Error('Invalid base64 string.');
+      }
+    } else {
+      throw new Error('No banner submitted.');
+    }
+  } catch (error) {
+    return res.status(400).json({ error: (error as Error).message });
+  }
+
   try {
     const eventRes = await prisma.event.update({
       where: {
         id: eventID,
       },
       data: {
-        banner: req.body.banner,
+        banner: imagePath,
         name: req.body.name,
         startDateTime: dayjs(req.body.startDateTime).toISOString(),
         endDateTime: dayjs(req.body.endDateTime).toISOString(),
         location: req.body.location,
         description: req.body.description,
       },
     });
-    return res.status(200).json(eventRes);
+    // we are choosing to send the image back as a url
+    let imageFile;
+    try {
+      imageFile = await getFileUrl(event.banner); // getFile(event.banner) if we wanted raw file
+    } catch (error) {
+      return res.status(400).json({ error: (error as Error).message });
+    }
+
+    return res.status(200).json({ ...event, banner: imageFile });
   } catch (e) {
     return res.status(400).json({ message: 'Invalid event input' });
   }
@@ -766,7 +830,7 @@ app.get('/events', async (req, res: Response) => {
     skip: page * 10,
     take: 10,
   });
-
+  
   if (!events || events.length === 0) {
     return res.status(404).json({ message: 'No events found.' });
   }
@@ -828,7 +892,7 @@ app.get('/user/events', async (req, res: Response) => {
       take: 10,
     }),
   });
-
+  
   if (!events || events.length === 0) {
     return res.status(404).json({ message: 'No events found.' });
   }
@@ -1175,16 +1239,16 @@ app.get('/user/keywords', async (req, res: Response) => {
 
   const userID = sessionFromDB.userId;
 
-    let userKeywords = await prisma.user.findFirst({
-      where: {
-        id: userID,
-      },
-      select: {
-        keywords: true,
-      }
-    });
-  
-    if (userKeywords === null) return res.status(404).json([]);
+  let userKeywords = await prisma.user.findFirst({
+    where: {
+      id: userID,
+    },
+    select: {
+      keywords: true,
+    },
+  });
+
+  if (userKeywords === null) return res.status(404).json([]);
 
   return res.status(200).json(userKeywords.keywords);
 });
@@ -1224,21 +1288,21 @@ app.post(
       });
       return res.status(200).json(newKeyword);
     } catch (e) {
-      return res.status(400).json({ message: "Invalid keyword input." });
+      return res.status(400).json({ message: 'Invalid keyword input.' });
     }
   }
 );
 
 // associates a user with a keyword
 app.post(
-  "/user/keyword", 
+  '/user/keyword',
   async (req: TypedRequest<keywordIdBody>, res: Response) => {
     //get userid from session
     const sessionFromDB = await validateSession(
       req.session ? req.session : null
     );
     if (!sessionFromDB) {
-      return res.status(401).json({ message: "Invalid session provided." });
+      return res.status(401).json({ message: 'Invalid session provided.' });
     }
     const userID = sessionFromDB.userId;
 
@@ -1253,7 +1317,7 @@ app.post(
     });
 
     if (!keywordExists) {
-      return res.status(404).json({ message: "Invalid keyword." });
+      return res.status(404).json({ message: 'Invalid keyword.' });
     }
 
     //Connect keyword and user
@@ -1283,19 +1347,20 @@ app.post(
       },
     });
 
-  return res.status(200).json({ message: "ok" });
-});
+    return res.status(200).json({ message: 'ok' });
+  }
+);
 
 // disassociates a user with a keyword
 app.delete(
-  "/user/keyword", 
+  '/user/keyword',
   async (req: TypedRequest<keywordIdBody>, res: Response) => {
     //get userid from session
     const sessionFromDB = await validateSession(
       req.session ? req.session : null
     );
     if (!sessionFromDB) {
-      return res.status(401).json({ message: "Invalid session provided." });
+      return res.status(401).json({ message: 'Invalid session provided.' });
     }
     const userID = sessionFromDB.userId;
 
@@ -1310,7 +1375,7 @@ app.delete(
     });
 
     if (!societyId) {
-      return res.status(400).json({ message: "Invalid keyword." });
+      return res.status(400).json({ message: 'Invalid keyword.' });
     }
 
     //Disconnect keyword and user
@@ -1340,8 +1405,9 @@ app.delete(
       },
     });
 
-  return res.status(200).json({ message: "ok" });
-});
+    return res.status(200).json({ message: 'ok' });
+  }
+);
 
 app.get('/hello', () => {
   console.log('Hello World!');

backend/src/requestTypes.ts

@@ -24,7 +24,7 @@ export interface UserIdBody {
 }
 
 export interface CreateEventBody {
-  banner: string;
+  banner: Base64Image;
   name: string;
   startDateTime: Date;
   endDateTime: Date;
@@ -33,6 +33,15 @@ export interface CreateEventBody {
   societyId: number;
 }
 
+interface Base64Image {
+  buffer: string,
+  metaData: {
+    name: string,
+    type: string,
+    size: number,
+  }
+}
+
 export interface UpdateEventBody extends CreateEventBody {
   id: number;
 }