Feat/5 add post features (#14)

Add the ability to upload, view, and delete posts

Author: lyncasterc

backend/package.json

@@ -9,9 +9,9 @@
     "test": "cross-env NODE_ENV=test jest --verbose --detectOpenHandles",
     "start": "cross-env NODE_ENV=production node src/index.ts",
     "dev": "cross-env NODE_ENV=development nodemon --files src/index.ts",
-    "start:test": "cross-env NODE_ENV=test node src/index.ts",
+    "start:test": "cross-env NODE_ENV=test ts-node --files src/index.ts",
     "start:dev": "cross-env NODE_ENV=development ts-node --files src/index.ts",
-    "docker:mongo": "docker-compose -f docker-compose.dev.yml up",
+    "docker:mongo": "docker-compose -f docker-compose.dev.yml up -d",
     "lint": "eslint .",
     "build:ui": "rm -rf build && cd ../frontend && npm run build && mv build ../backend"
   },

backend/requests/post-requests.rest

@@ -20,13 +20,57 @@ Content-Type: application/json
 }
 
 ###
-#creating post
-@token = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImJvYmJ5ZG9iIiwiaWQiOiI2MjYxZTE1OTcxYmFhMzFkOWU3YjA5NjMiLCJpYXQiOjE2NTA1ODIwMjMsImV4cCI6MTY1MDU4NTYyM30.Y2FKPx7u1b_nKiDrN8IJjXkfRWQEMWX6UjHahM6Lgrc
+#creating post with caption and image
+# replace {{token}} with the token from the login response
+@token = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImJvYmJ5ZG9iIiwiaWQiOiI2NWRhODA5YmQ5ZmVkMGNiYjI1YWY5YTYiLCJpYXQiOjE3MDkzNTI3MjUsImV4cCI6MTcwOTM1NjMyNX0.NkY1Lx7Mlb72qTtE4Y9eu4rNmObxVkhsvqiKr1NO-Ew
 POST http://localhost:3001/api/posts
 Content-Type: application/json
 Authorization: bearer {{token}}
 
 {
   "caption": "a blue square",
-  "image": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMDAiIGhlaWdodD0iMTAwIj48cmVjdCBmaWxsPSIjMDBCMUZGIiB3aWR0aD0iMTAwIiBoZWlnaHQ9IjEwMCIvPjwvc3ZnPg=="
+  "imageDataUrl": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMDAiIGhlaWdodD0iMTAwIj48cmVjdCBmaWxsPSIjMDBCMUZGIiB3aWR0aD0iMTAwIiBoZWlnaHQ9IjEwMCIvPjwvc3ZnPg=="
 }
+
+###
+#creating post with image and no caption (should pass)
+# replace {{token}} with the token from the login response
+@token = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImJvYmJ5ZG9iIiwiaWQiOiI2NWRhODA5YmQ5ZmVkMGNiYjI1YWY5YTYiLCJpYXQiOjE3MDkzNTI3MjUsImV4cCI6MTcwOTM1NjMyNX0.NkY1Lx7Mlb72qTtE4Y9eu4rNmObxVkhsvqiKr1NO-Ew
+POST http://localhost:3001/api/posts
+Content-Type: application/json
+Authorization: bearer {{token}}
+
+{
+  "imageDataUrl": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMDAiIGhlaWdodD0iMTAwIj48cmVjdCBmaWxsPSIjMDBCMUZGIiB3aWR0aD0iMTAwIiBoZWlnaHQ9IjEwMCIvPjwvc3ZnPg=="
+}
+
+###
+#creating post with no image (should fail)
+# replace {{token}} with the token from the login response
+@token = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImJvYmJ5ZG9iIiwiaWQiOiI2NWRhODA5YmQ5ZmVkMGNiYjI1YWY5YTYiLCJpYXQiOjE3MDkzNTI3MjUsImV4cCI6MTcwOTM1NjMyNX0.NkY1Lx7Mlb72qTtE4Y9eu4rNmObxVkhsvqiKr1NO-Ew
+POST http://localhost:3001/api/posts
+Content-Type: application/json
+Authorization: bearer {{token}}
+
+{
+  "caption": "a blue square"
+}
+
+###
+# deleting a post (use the id from the one of the responses above)
+# replace {{token}} with the token from the login response
+# should return 204
+@token = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImJvYmJ5ZG9iIiwiaWQiOiI2NWRhODA5YmQ5ZmVkMGNiYjI1YWY5YTYiLCJpYXQiOjE3MDkzNTI3MjUsImV4cCI6MTcwOTM1NjMyNX0.NkY1Lx7Mlb72qTtE4Y9eu4rNmObxVkhsvqiKr1NO-Ew
+DELETE http://localhost:3001/api/posts/65e2a7dc58bb1d3eaacc4f89
+Content-Type: application/json
+Authorization: bearer {{token}}
+
+
+### deleting non-existing post
+# replace {{token}} with the token from the login response
+# delete an existing post use its id in the url
+# should return 404
+@token = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImJvYmJ5ZG9iIiwiaWQiOiI2NWRhODA5YmQ5ZmVkMGNiYjI1YWY5YTYiLCJpYXQiOjE3MDkzNTI3MjUsImV4cCI6MTcwOTM1NjMyNX0.NkY1Lx7Mlb72qTtE4Y9eu4rNmObxVkhsvqiKr1NO-Ew
+DELETE http://localhost:3001/api/posts/65e2a7dc58bb1d3eaacc4f89
+Content-Type: application/json
+Authorization: bearer {{token}}

backend/src/routes/posts.ts

@@ -10,7 +10,7 @@ import { NewPostFields, Image } from '../types';
 const router = express.Router();
 
 // TODO: remove authenticator from this. instagram allows this.
-router.get('/:id', authenticator(), async (req, res) => {
+router.get('/:id', async (req, res) => {
   const post = await postService.getPost(req.params.id);
   if (!post) return res.status(404).end();
   return res.send(post);
@@ -20,7 +20,7 @@ router.post('/', authenticator(), async (req, res, next) => {
   let newPostFields: NewPostFields;
   let image: Image | undefined;
   // TODO: check if the user exists before proceeding?
-  // or should that happen in the autheticator middleware?
+  // or should that happen in the authenticator middleware?
   const user = await User.findById(req.userToken!.id);
 
   try {
@@ -80,6 +80,26 @@ router.put('/:id', authenticator(), async (req, res, next) => {
   }
 });
 
+router.delete('/:id', authenticator(), async (req, res, next) => {
+  try {
+    await postService.deletePostById(req.params.id, req.userToken!.id);
+    return res.status(204).end();
+  } catch (error) {
+    const errorMessage = logger.getErrorMessage(error);
+    logger.error(errorMessage);
+
+    if (/unauthorized/i.test(errorMessage)) {
+      return res.status(401).send({ error: errorMessage });
+    }
+
+    if (/post not found/i.test(errorMessage)) {
+      return res.status(404).send({ error: errorMessage });
+    }
+
+    return next(error);
+  }
+});
+
 // TODO: write a delete route
 
 export default router;

backend/src/services/post-service.ts

@@ -1,5 +1,7 @@
 import { Post } from '../mongo';
 import { NewPost, ProofedUpdatedPost } from '../types';
+import cloudinary from '../utils/cloudinary';
+
 // TODO: figure out what exactly needs to be populated.
 const getPost = async (id: string) => {
   const post = await Post.findById(id)
@@ -49,8 +51,24 @@ const updatePostById = async (
   return updatedPost;
 };
 
+const deletePostById = async (id: string, requester: string) => {
+  const deletedPost = await Post.findById(id);
+
+  if (!deletedPost) {
+    throw new Error('Post not found');
+  }
+
+  if (requester !== deletedPost.creator.toString()) {
+    throw new Error('Unauthorized');
+  }
+
+  await cloudinary.destroy(deletedPost.image.publicId);
+  await deletedPost.remove();
+};
+
 export default {
   getPost,
   addPost,
   updatePostById,
+  deletePostById,
 };

backend/src/types.ts

@@ -16,11 +16,13 @@ export interface Comment {
 
 export interface Post {
   id: string,
-  creator: string, // ref -> User
+  creator: User, // ref -> User
   caption?: string,
   image: Image,
   comments?: string[], // ref
   likes?: string[], // ref -> User
+  createdAt: string, // Date
+  updatedAt: string, // Date
 }
 
 export interface User {
@@ -44,13 +46,13 @@ export interface NewUser {
 }
 
 export interface NewPostFields {
-  caption: string,
+  caption?: string,
   imageDataUrl: string,
 }
 
 export interface NewPost {
-  caption: string,
-  image?: Image,
+  caption?: string,
+  image: Image,
 }
 
 export interface ProofedUpdatedUserFields {

backend/src/utils/cloudinary.ts

@@ -21,7 +21,18 @@ const destroy = async (publicId: string) => {
   await cloudinary.uploader.destroy(publicId);
 };
 
+const checkIfImageExists = async (publicId: string) => {
+  try {
+    await cloudinary.api.resource(publicId);
+    return true;
+  } catch (error) {
+    console.error(error);
+    return false;
+  }
+};
+
 export default {
   upload,
   destroy,
+  checkIfImageExists,
 };

backend/src/utils/field-parsers.ts

@@ -13,7 +13,7 @@ export const parseStringField = (param: unknown, fieldKey: string) => {
 
 const parseDataURIField = (param: unknown) => {
   if (!param || !isString(param) || !validDataUrl(param)) {
-    throw new Error('Malformatted or missing image');
+    throw new Error('Malformed or missing image');
   }
 
   return param;
@@ -84,8 +84,10 @@ interface UnknownPostFields {
 }
 
 const proofPostFields = ({ caption, imageDataUrl }: UnknownPostFields) => {
+  const optionalCaption = caption ? parseStringField(caption, 'caption') : '';
+
   const postFields = {
-    caption: parseStringField(caption, 'caption'),
+    caption: optionalCaption,
     imageDataUrl: parseDataURIField(imageDataUrl),
   };