Feat/7 following unfollowing homepage (#19)

* Create an unfollow write, refactor

* Implement following and unfollowing users

* Render posts on home page

* Add tests, add minor tweaks

* Refactor tests to work with new homepage

* Create a followers/following view

Author: lyncasterc

backend/requests/put-requests.rest

@@ -0,0 +1,45 @@
+# creating a user
+POST http://localhost:3001/api/users
+Content-Type: application/json
+
+{
+  "fullName": "Bob Dob",
+  "email": "[email protected]",
+  "username": "bobbydob",
+  "password": "secret"
+}
+
+###
+# creating a second user
+POST http://localhost:3001/api/users
+Content-Type: application/json
+
+{
+  "fullName": "Bob Dob",
+  "email": "[email protected]",
+  "username": "bobbydob2",
+  "password": "secret"
+}
+
+###
+#log in first user
+@token = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwiaWQiOiI2NWU0ZjZhZTNjMjg4Y2EzODVkYzJhNGEiLCJpYXQiOjE3MDk2MTEzMTAsImV4cCI6MTcwOTYxNDkxMH0.gmUZvHrjxO8ceZVOm0kTh3fYboJldmsCdxMPMyUmbH4
+POST http://localhost:3001/api/login
+Content-Type: application/json
+
+{
+  "username": "admin",
+  "password": "admin"
+}
+
+###
+# request to follow second user
+@id = 65e64e6a0fa35c92f120667b
+PUT http://localhost:3001/api/users/{{id}}/follow
+Authorization: bearer {{token}}
+
+###
+# request to unfollow second user
+@id = 65e64e6a0fa35c92f120667b
+PUT http://localhost:3001/api/users/{{id}}/unfollow
+Authorization: bearer {{token}}

backend/src/routes/users.ts

@@ -87,11 +87,13 @@ router.delete('/:id/image', authenticator(), async (req, res, next) => {
 });
 
 router.put('/:id/follow', authenticator(), async (req, res, next) => {
-  if (req.params.id === req.userToken!.id) return res.status(400).send({ error: 'You can\'t follow yourself!' });
+  if (req.params.id === req.userToken!.id) {
+    return res.status(400).send({ error: 'You can\'t follow yourself!' });
+  }
 
   try {
-    const followedUser = await userService.followUserById(req.userToken!.id, req.params.id);
-    return res.status(200).send(followedUser);
+    await userService.followUserById(req.userToken!.id, req.params.id);
+    return res.status(200).end();
   } catch (error) {
     const errorMessage = logger.getErrorMessage(error);
     logger.error(errorMessage);
@@ -103,7 +105,20 @@ router.put('/:id/follow', authenticator(), async (req, res, next) => {
     return next(error);
   }
 });
+
+router.put('/:id/unfollow', authenticator(), async (req, res, next) => {
+  if (req.params.id === req.userToken!.id) {
+    return res.status(400).send({ error: 'You can\'t unfollow yourself!' });
+  }
+
+  try {
+    await userService.unfollowUserById(req.userToken!.id, req.params.id);
+    return res.status(200).end();
+  } catch (error) {
+    return next(error);
+  }
+});
+
 // TODO: write a delete route
-// TODO: write unfollow route?
 
 export default router;

backend/src/services/user-service.ts

@@ -5,17 +5,29 @@ import { NewUser, UpdatedUserFields } from '../types';
 import cloudinary from '../utils/cloudinary';
 
 const getUsers = async () => {
-  // TODO: decide which are and populate the fields that should be populated.
-  // TODO: omit passwordHash from results.
   const users = await User.find({})
-    .populate('posts', { image: 1 });
+    .select('-passwordHash')
+    .populate({
+      path: 'posts',
+      select: 'image createdAt updatedAt creator caption',
+      populate: {
+        path: 'creator',
+        select: 'username id image',
+      },
+    })
+    .populate('followers', { username: 1 })
+    .populate('following', { username: 1 });
 
   return users;
 };
 
 const getUserById = async (id: string) => {
   const user = await User.findById(id)
-    .populate('posts', { image: 1 });
+    .select('-passwordHash')
+    .populate('posts', { image: 1 })
+    .populate('followers', { username: 1 })
+    .populate('following', { username: 1 });
+
   return user;
 };
 
@@ -57,18 +69,20 @@ const followUserById = async (followerId: string, followedUserId: string) => {
   const followedUser = await User.findById(followedUserId);
   const follower = await User.findById(followerId);
 
-  if (!followedUser) throw new Error('User not found.');
+  if (!followedUser) {
+    throw new Error('User not found.');
+  }
 
   // checking if user already follows the user they are requesting to follow
-  if (follower.following.map((ids: ObjectId) => ids?.toString()).includes(followedUser.id)) throw new Error('You already follow that user!');
+  if (follower.following.map((ids: ObjectId) => ids?.toString()).includes(followedUser.id)) {
+    throw new Error('You already follow that user!');
+  }
 
   followedUser.followers = [...followedUser.followers, follower];
   follower.following = [...follower.following, followedUser.id];
 
   await followedUser.save();
   await follower.save();
-
-  return followedUser;
 };
 
 const deleteUserImage = async (id: string) => {
@@ -80,11 +94,31 @@ const deleteUserImage = async (id: string) => {
   return user;
 };
 
+const unfollowUserById = async (followerId: string, followedUserId: string) => {
+  const followedUser = await User.findById(followedUserId);
+  const follower = await User.findById(followerId);
+
+  if (!followedUser) {
+    throw new Error('User not found.');
+  }
+
+  follower.following = follower.following.filter(
+    (id: ObjectId) => id.toString() !== followedUser.id,
+  );
+  followedUser.followers = followedUser.followers.filter(
+    (id: ObjectId) => id.toString() !== follower.id,
+  );
+
+  await follower.save();
+  await followedUser.save();
+};
+
 export default {
   getUsers,
   getUserById,
   addUser,
   updateUserById,
   followUserById,
   deleteUserImage,
+  unfollowUserById,
 };

backend/src/types.ts

@@ -34,8 +34,8 @@ export interface User {
   passwordHash: string,
   image?: Image,
   posts?: string[], // ref
-  followers?: string[], // ref -> User
-  following?: string[], //  ref -> User
+  followers?: { id: string, username: string }[], //  ref -> User
+  following?: { id: string, username: string }[], //  ref -> User
 }
 
 export interface NewUser {

backend/test/helpers/test-helpers.ts

@@ -3,7 +3,7 @@ import { User, Post } from '../../src/mongo';
 import { NewUser } from '../../src/types';
 
 const usersInDB = async () => {
-  const users = await User.find({});
+  const users = await User.find({}).select('-passwordHash');
   return users.map((user) => user.toJSON());
 };
 

backend/test/user-api.test.ts

@@ -55,7 +55,7 @@ describe('When there are multiple users in the database', () => {
   });
 
   describe('When getting a single user by id', () => {
-    test('Correct user is retured', async () => {
+    test('Correct user is returned', async () => {
       const targetUser = (await testHelpers.usersInDB())[0];
       const response = await api
         .get(`/api/users/${targetUser.id}`)
@@ -277,15 +277,17 @@ describe('When there are multiple users in the database', () => {
       const users = (await testHelpers.usersInDB());
       const differentUser = users.find((user) => user.id !== targetUser.id);
 
-      const response = await api
+      await api
         .put(`/api/users/${differentUser.id}/follow`)
         .set('Authorization', `bearer ${token}`)
         .expect(200);
 
-      const returnedUser = response.body;
+      const followedUser = (await testHelpers.usersInDB()).find(
+        (user) => user.id === differentUser.id,
+      );
 
-      expect(returnedUser.followers).toHaveLength(1);
-      expect(returnedUser.followers[0].id).toBe(targetUser.id);
+      expect(followedUser.followers).toHaveLength(1);
+      expect(followedUser.followers[0].toString()).toBe(targetUser.id.toString());
     });
 
     test('following a user adds that user to the requesting user following list', async () => {
@@ -303,6 +305,44 @@ describe('When there are multiple users in the database', () => {
       expect(updatedTargetUser.following).toHaveLength(1);
       expect(updatedTargetUser.following[0].toString()).toBe(differentUser.id.toString());
     });
+
+    test('user can be unfollowed', async () => {
+      const users = (await testHelpers.usersInDB());
+      const differentUser = users.find((user) => user.id !== targetUser.id);
+      const differentUserId = differentUser.id;
+
+      await api
+        .put(`/api/users/${differentUserId}/follow`)
+        .set('Authorization', `bearer ${token}`)
+        .expect(200);
+
+      let updatedTargetUser = (await testHelpers.usersInDB()).find(
+        (user) => user.id === targetUser.id,
+      );
+      let updatedDifferentUser = (await testHelpers.usersInDB()).find(
+        (user) => user.id === differentUserId,
+      );
+
+      expect(updatedTargetUser.following).toHaveLength(1);
+      expect(updatedTargetUser.following[0].toString()).toBe(differentUserId.toString());
+      expect(updatedDifferentUser.followers).toHaveLength(1);
+      expect(updatedDifferentUser.followers[0].toString()).toBe(targetUser.id.toString());
+
+      await api
+        .put(`/api/users/${differentUserId}/unfollow`)
+        .set('Authorization', `bearer ${token}`)
+        .expect(200);
+
+      updatedTargetUser = (await testHelpers.usersInDB()).find(
+        (user) => user.id === targetUser.id,
+      );
+      updatedDifferentUser = (await testHelpers.usersInDB()).find(
+        (user) => user.id === differentUserId,
+      );
+
+      expect(updatedTargetUser.following).toHaveLength(0);
+      expect(updatedDifferentUser.followers).toHaveLength(0);
+    });
   });
 
   // TODO: Write tests to check if comment fields are populated when fetching user/users.

frontend/cypress.json

@@ -8,6 +8,12 @@
       "username": "admin",
       "password": "secret",
       "email": "[email protected]"
+    },
+    "user2": {
+      "fullName": "Superuser2",
+      "username": "admin2",
+      "password": "secret",
+      "email": "[email protected]"
     }
   }
 }

frontend/cypress/integration/deleting-posts.spec.ts

@@ -25,11 +25,9 @@ it('user can delete their post in the post view', () => {
 
   cy.contains(/post deleted/i).should('be.visible');
 
-  cy.reload();
-
-  cy.contains(/post/i).should('not.exist');
-
   cy.contains(/posts/i)
     .prev()
     .should('contain.text', '0');
+
+  cy.get('[data-cy="user-profile-image-grid"] img').should('not.exist');
 });