Merge pull request #3 from rschand-dev/development

Add User Connections

Author: Reginald Chand

PROJECT_STRUCTURE

@@ -7,12 +7,12 @@ bms-backend-mongodb
 │       └── eslint.yml
 ├── .gitignore
 ├── CODE_OF_CONDUCT.md
-├── eslint.config.mjs
 ├── LICENSE
-├── package.json
-├── pnpm-lock.yaml
 ├── PROJECT_STRUCTURE
 ├── README.md
+├── eslint.config.mjs
+├── package.json
+├── pnpm-lock.yaml
 ├── server.mjs
 └── src
     ├── config
@@ -37,7 +37,8 @@ bms-backend-mongodb
     │   ├── user.password.reset.email.controller.mjs
     │   ├── user.password.update.controller.mjs
     │   ├── user.profile.update.controller.mjs
-    │   └── user.profile.view.controller.mjs
+    │   ├── user.profile.view.controller.mjs
+    │   └── user.social.controller.mjs
     ├── database
     │   └── mongodb.database.mjs
     ├── middleware
@@ -56,8 +57,10 @@ bms-backend-mongodb
     │   ├── blog.data.schema.mjs
     │   ├── refresh.token.schema.mjs
     │   ├── signup.schema.mjs
+    │   ├── user.connection.schema.mjs
     │   ├── user.logout.blacklist.token.schema.mjs
-    │   └── user.password.reset.blacklist.token.schema.mjs
+    │   ├── user.password.reset.blacklist.token.schema.mjs
+    │   └── user.social.schema.mjs
     ├── store
     │   └── redis.client.store.mjs
     ├── template
@@ -67,7 +70,8 @@ bms-backend-mongodb
     │   ├── catch.error.utility.mjs
     │   ├── email.sender.utility.mjs
     │   ├── jwt.regeneration.utility.mjs
-    │   └── redis.keys.retrieval.utility.mjs
+    │   ├── redis.keys.retrieval.utility.mjs
+    │   └── update.user.connection.utility.mjs
     └── validator
         ├── blog.data.update.validator.mjs
         ├── blog.data.validator.mjs
@@ -79,4 +83,5 @@ bms-backend-mongodb
         ├── token.validator.mjs
         ├── user.password.reset.validator.mjs
         ├── user.password.update.validator.mjs
-        └── user.profile.update.validator.mjs
+        ├── user.profile.update.validator.mjs
+        └── user.social.validator.mjs

README.md

@@ -22,6 +22,7 @@ This project is a fully-featured Blog Management System (BMS) backend built with
 - Profile view and update
 - Blog creation, update, deletion, and view
 - Feed view for blogs
+- User Connections (Follow/Unfollow)
 - CSRF protection
 - Redis caching for blog data
 - Rate limiting and file upload middleware
@@ -34,9 +35,8 @@ This project is a fully-featured Blog Management System (BMS) backend built with
 ## Upcoming Features
 
 1. Frontend Development (Website). Using **Next.JS & Tailwind CSS**
-2. Followers and following functionality
-3. Likes, comments, and shares for blogs
-4. Enhanced blog search functionality
+2. Likes, comments, and shares for blogs
+3. Enhanced blog search functionality
 
 ## Installation
 
@@ -184,6 +184,10 @@ Alternatively you can find the `PROJECT_STRUCTURE` file in the root directory of
 - **GET** /user/profile - View user profile (requires JWT)
 - **PUT** /user/profile-update - Update user profile (requires JWT)
 
+### User Connection
+
+- **PUT** /user/social/operation - Create and or Update User Connections (Follow/Unfollow) (requires JWT)
+
 ### Blog
 
 - **GET** /blog/feeds - View blog feeds (requires JWT)

src/controller/signin.controller.mjs

@@ -28,6 +28,7 @@ export const signInController = async (request, response) => {
     }
 
     const userData = {
+      _id: existingUser._id,
       firstName: existingUser.firstName,
       lastName: existingUser.lastName,
       userName: existingUser.userName,

src/controller/user.social.controller.mjs

@@ -0,0 +1,50 @@
+import { SocialModel, UserModel } from "../model/model.mjs";
+import { catchErrorUtility } from "../utility/catch.error.utility.mjs";
+import { updateUserConnectionUtility } from "../utility/update.user.connection.utility.mjs";
+import { userSocialValidator } from "../validator/user.social.validator.mjs";
+
+export const userSocialController = async (request, response) => {
+  const { error, value } = userSocialValidator.validate(request.body);
+
+  if (error) {
+    return response.status(400).json({ responseData: error.message });
+  }
+
+  const { email, userId, userData } = value;
+
+  try {
+    const [existingUser, existingUserToFollowOrUnfollow] = await Promise.all([
+      UserModel.findOne({
+        email: { $eq: userData.email },
+      }),
+
+      UserModel.findOne({
+        $and: [{ email: { $eq: email } }, { _id: { $eq: userId } }],
+      }),
+    ]);
+
+    if (!existingUser || !existingUserToFollowOrUnfollow) {
+      return response.status(404).json({
+        responseData:
+          "OOPS! Something happened on our end. Please wait for a while and try again!",
+      });
+    }
+
+    await SocialModel.findOneAndUpdate(
+      { _id: existingUser._id },
+      { _id: existingUser._id },
+      { upsert: true }
+    );
+
+    await updateUserConnectionUtility(
+      SocialModel,
+      email,
+      userId,
+      existingUser,
+      existingUserToFollowOrUnfollow,
+      response
+    );
+  } catch (error) {
+    catchErrorUtility(error, response);
+  }
+};

src/model/model.mjs

@@ -1,6 +1,8 @@
 import { blogDataSchema } from "../schema/blog.data.schema.mjs";
 import mongoose from "mongoose";
 import { signUpSchema } from "../schema/signup.schema.mjs";
+import { userSocialSchema } from "../schema/user.social.schema.mjs";
 
 export const UserModel = mongoose.model("User", signUpSchema);
 export const BlogModel = mongoose.model("Blog", blogDataSchema);
+export const SocialModel = mongoose.model("Social", userSocialSchema);

src/router/router.mjs

@@ -18,6 +18,7 @@ import { userPasswordResetEmailController } from "../controller/user.password.re
 import { userPasswordUpdateController } from "../controller/user.password.update.controller.mjs";
 import { userProfileUpdateController } from "../controller/user.profile.update.controller.mjs";
 import { userProfileViewController } from "../controller/user.profile.view.controller.mjs";
+import { userSocialController } from "../controller/user.social.controller.mjs";
 import { verifyJwtMiddleware } from "../middleware/verify.jwt.middleware.mjs";
 
 export const router = express.Router();
@@ -55,6 +56,7 @@ router.put(
   verifyJwtMiddleware,
   userProfileUpdateController
 );
+router.put("/user/social/operation", verifyJwtMiddleware, userSocialController);
 
 router.get("/blog/feeds", verifyJwtMiddleware, feedViewController);
 router.get("/blog/:blogSlug", verifyJwtMiddleware, blogViewController);

src/schema/user.connection.schema.mjs

@@ -0,0 +1,8 @@
+import mongoose from "mongoose";
+
+export const userConnectionSchema = new mongoose.Schema(
+  {
+    email: { type: String, required: true, unique: true, ref: "User" },
+  },
+  { timestamps: true }
+);

src/schema/user.social.schema.mjs

@@ -0,0 +1,13 @@
+import mongoose from "mongoose";
+import { userConnectionSchema } from "./user.connection.schema.mjs";
+
+export const userSocialSchema = new mongoose.Schema(
+  {
+    _id: { type: mongoose.Types.ObjectId, ref: "User" },
+    followers: [userConnectionSchema],
+    followings: [userConnectionSchema],
+    followerCount: { type: Number, default: 0 },
+    followingCount: { type: Number, default: 0 },
+  },
+  { timestamps: true }
+);

src/utility/update.user.connection.utility.mjs

@@ -0,0 +1,76 @@
+/**
+ * @description Function to add or remove user (Follow/Unfollow) (Concurrent updates to users connecting with each other).
+ * @param {mongoose.Model} SocialModel The social model.
+ * @param {string} email The email of the user to follow.
+ * @param {string} userId The id of the user to follow.
+ * @param {mongoose.Document} existingUser The existing user aka currently logged in users required MongoDB documents.
+ * @param {mongoose.Document} existingUserToFollowOrUnfollow The user to follow required MongoDB documents.
+ * @param {Expression.Response} response Express response message.
+ * @returns Express response message.
+ */
+export const updateUserConnectionUtility = async (
+  SocialModel,
+  email,
+  userId,
+  existingUser,
+  existingUserToFollowOrUnfollow,
+  response
+) => {
+  const userIsAConnection = await SocialModel.exists({
+    "followers.email": { $eq: email },
+  });
+
+  if (!userIsAConnection) {
+    // Follow User.
+    await SocialModel.bulkWrite([
+      {
+        updateOne: {
+          filter: { _id: { $eq: existingUser._id } },
+          update: {
+            $push: { followers: { email } },
+            $inc: { followerCount: 1 },
+          },
+        },
+      },
+      {
+        updateOne: {
+          filter: { _id: { $eq: userId } },
+          update: {
+            $push: { followings: { email: existingUser.email } },
+            $inc: { followingCount: 1 },
+          },
+        },
+      },
+    ]);
+
+    return response.status(201).json({
+      responseData: `Successfully followed ${existingUserToFollowOrUnfollow.firstName} ${existingUserToFollowOrUnfollow.lastName}`,
+    });
+  }
+
+  // Unfollow User.
+  await SocialModel.bulkWrite([
+    {
+      updateOne: {
+        filter: { _id: { $eq: existingUser._id } },
+        update: {
+          $pull: { followers: { email } },
+          $inc: { followerCount: -1 },
+        },
+      },
+    },
+    {
+      updateOne: {
+        filter: { _id: { $eq: userId } },
+        update: {
+          $pull: { followings: { email: existingUser.email } },
+          $inc: { followingCount: -1 },
+        },
+      },
+    },
+  ]);
+
+  return response.status(200).json({
+    responseData: `Successfully unfollowed ${existingUserToFollowOrUnfollow.firstName} ${existingUserToFollowOrUnfollow.lastName}`,
+  });
+};

src/validator/user.social.validator.mjs

@@ -0,0 +1,7 @@
+import Joi from "joi";
+
+export const userSocialValidator = Joi.object({
+  email: Joi.string().email().required(),
+  userId: Joi.string().required(),
+  userData: Joi.object().required(),
+}).unknown();