add edit profile picture

- add coverage folder to dockerignore
- update backend services swagger yml for images api
- update user service readme to include firebase setup
- add edit profile picture functionality

Author: feliciagan

backend/question-service/.dockerignore

@@ -1,3 +1,4 @@
+coverage
 node_modules
 tests
 .env*

backend/question-service/src/controllers/questionController.ts

@@ -81,11 +81,11 @@ export const createImageLink = async (
       const uploadPromises = files.map((file) => uploadFileToFirebase(file));
       const imageUrls = await Promise.all(uploadPromises);
       console.log(imageUrls);
-      res
+      return res
         .status(200)
         .json({ message: "Images uploaded successfully", imageUrls });
     } catch (error) {
-      res.status(500).json({ message: "Server error", error });
+      return res.status(500).json({ message: "Server error", error });
     }
   });
 };

backend/question-service/swagger.yml

@@ -350,3 +350,46 @@ paths:
             application/json:
               schema:
                 $ref: "#/definitions/ServerError"
+  /api/questions/images:
+    post:
+      summary: Publish image to firebase storage
+      tags: 
+        - questions
+      security:
+        - bearerAuth: []
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                profilePic:
+                  type: string
+                  format: binary
+                  required: true
+      responses:
+        200:
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: Message
+                  imageUrl:
+                    type: string
+                    description: image url
+        400:
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        500:
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"

backend/user-service/.env.sample

@@ -11,5 +11,11 @@ ADMIN_USERNAME=administrator
 ADMIN_EMAIL=[email protected]
 ADMIN_PASSWORD=Admin@123
 
+# firebase
+FIREBASE_PROJECT_ID=FIREBASE_PROJECT_ID
+FIREBASE_PRIVATE_KEY=FIREBASE_PRIVATE_KEY
+FIREBASE_CLIENT_EMAIL=FIREBASE_CLIENT_EMAIL
+FIREBASE_STORAGE_BUCKET=FIREBASE_STORAGE_BUCKET
+
 # origins for cors
 ORIGINS=http://localhost:5173,http://127.0.0.1:5173

backend/user-service/README.md

@@ -28,6 +28,38 @@
 
 6. Update the `DB_CLOUD_URI` of the `.env` file, and paste the string we copied earlier in step 4.
 
+## Setting-up Firebase
+
+1. Go to https://console.firebase.google.com/u/0/.
+
+2. Create a project and choose a project name. Navigate to `Storage` and click on it to activate it.
+
+3. Select `Start in production mode` and your preferred cloud storage region.
+
+4. After Storage is created, go to `Rules` section and set rule to:
+
+   ```
+   rules_version = '2';
+   service firebase.storage {
+     match /b/{bucket}/o {
+       match /{allPaths=**} {
+         allow read: if true;
+         allow write: if request.auth != null;
+       }
+     }
+   }
+   ```
+
+   This rule ensures that only verified users can upload images while ensuring that URLs of images are public. Remember to click `Publish` to save changes.
+
+5. Go to `Settings`, `Project settings`, `Service accounts` and click `Generate new private key`. This will download a `.json` file, which will contain your credentials.
+
+6. In `.env` of user service, replace:
+   - `FIREBASE_PROJECT_ID` with `project_id` found in the downloaded json file.
+   - `FIREBASE_PRIVATE_KEY` with `private_key` found in the downloaded json file.
+   - `FIREBASE_CLIENT_EMAIL` with `client_email` found in the downloaded json file.
+   - `FIREBASE_STORAGE_BUCKET` with the folder path of the Storage. It should look something like `gs://<appname>.appspot.com`.
+
 ## Running User Service
 
 1. Follow the instructions [here](https://nodejs.org/en/download/package-manager) to set up Node v20.

backend/user-service/config/firebase.ts

@@ -0,0 +1,14 @@
+import admin from "firebase-admin";
+
+admin.initializeApp({
+  credential: admin.credential.cert({
+    projectId: process.env.FIREBASE_PROJECT_ID,
+    privateKey: process.env.FIREBASE_PRIVATE_KEY?.replace(/\\n/g, "\n"),
+    clientEmail: process.env.FIREBASE_CLIENT_EMAIL,
+  } as admin.ServiceAccount),
+  storageBucket: process.env.FIREBASE_STORAGE_BUCKET,
+});
+
+const bucket = admin.storage().bucket();
+
+export { bucket };

backend/user-service/config/multer.ts

@@ -0,0 +1,6 @@
+import multer from "multer";
+
+const storage = multer.memoryStorage();
+const upload = multer({ storage }).single("profilePic");
+
+export { upload };

backend/user-service/controller/user-controller.ts

@@ -20,6 +20,8 @@ import {
   validateBiography,
 } from "../utils/validators";
 import { IUser } from "../model/user-model";
+import { upload } from "../config/multer";
+import { uploadFileToFirebase } from "../utils/utils";
 
 export async function createUser(
   req: Request,
@@ -92,6 +94,34 @@ export async function createUser(
   }
 }
 
+export const createImageLink = async (
+  req: Request,
+  res: Response
+): Promise<void> => {
+  upload(req, res, async (err) => {
+    if (err) {
+      return res
+        .status(500)
+        .json({ message: "Failed to upload image", error: err.message });
+    }
+
+    if (!req.file) {
+      return res.status(400).json({ message: "No image uploaded" });
+    }
+
+    try {
+      const file = req.file as Express.Multer.File;
+      const imageUrl = await uploadFileToFirebase("profilePics/", file);
+
+      return res
+        .status(200)
+        .json({ message: "Image uploaded successfully", imageUrl: imageUrl });
+    } catch (error) {
+      return res.status(500).json({ message: "Server error", error });
+    }
+  });
+};
+
 export async function getUser(req: Request, res: Response): Promise<Response> {
   try {
     const userId = req.params.id;