Add loggers, refactor, add JWT_SECRET to github actions

Author: lyncasterc

.github/workflows/pipeline.yml

@@ -28,12 +28,13 @@ jobs:
           echo CLOUDINARY_NAME=${{ secrets.CLOUDINARY_NAME }} >> .env
           echo CLOUDINARY_API_KEY=${{ secrets.CLOUDINARY_API_KEY }} >> .env
           echo CLOUDINARY_API_SECRET=${{ secrets.CLOUDINARY_API_SECRET }} >> .env
+          echo JWT_SECRET=${{ secrets.JWT_SECRET }} >> .env
       - name: npm install
         run: npm install
       - name: lint
         run: npm run lint
       - name: test
-        run: npm test -- auth
+        run: npm test
   test_lint_frontend:
     runs-on: ubuntu-20.04
     defaults:
@@ -57,7 +58,8 @@ jobs:
           echo DEV_MONGODB_URI=${{ secrets.DEV_MONGODB_URI }} >> .env
           echo CLOUDINARY_NAME=${{ secrets.CLOUDINARY_NAME }} >> .env
           echo CLOUDINARY_API_KEY=${{ secrets.CLOUDINARY_API_KEY }} >> .env
-          echo CLOUDINARY_API_SECRET=${{ secrets.CLOUDINARY_API_SECRET }} >> .env
+          echo CLOUDINARY_API_SECRET=${{ secrets.CLOUDINARY_API_SECRET }} >> .env'
+          echo JWT_SECRET=${{ secrets.JWT_SECRET }} >> .env
           npm install
       - name: cypress tests
         uses: cypress-io/github-action@v2

backend/src/app.ts

@@ -9,7 +9,7 @@ import userRouter from './routes/users';
 import authRouter from './routes/auth';
 import testRouter from './routes/tests';
 import likeRouter from './routes/likes';
-import { errorHandler } from './utils/middleware';
+import { errorHandler, logErrorCodes } from './utils/middleware';
 
 const { NODE_ENV } = process.env;
 const app = express();
@@ -22,6 +22,8 @@ if (NODE_ENV === 'development') {
   })();
 }
 
+app.use(logErrorCodes);
+
 app.get('/health', (_req, res) => {
   res.send('ok');
 });

backend/src/routes/comments.ts

@@ -31,7 +31,6 @@ router.get('/', async (req, res, next) => {
     return res.send(comments);
   } catch (error) {
     const errorMessage = logger.getErrorMessage(error);
-    logger.error(errorMessage);
 
     if (/not found/i.test(errorMessage)) {
       return res.status(404).send({ error: errorMessage });
@@ -51,7 +50,6 @@ router.get('/:parentCommentId', async (req, res, next) => {
     return res.send(replies);
   } catch (error) {
     const errorMessage = logger.getErrorMessage(error);
-    logger.error(errorMessage);
 
     if (/not found/i.test(errorMessage)) {
       return res.status(404).send({ error: errorMessage });
@@ -77,7 +75,6 @@ router.post('/', authenticator(), async (req, res, next) => {
     return res.status(201).end();
   } catch (error) {
     const errorMessage = logger.getErrorMessage(error);
-    logger.error(errorMessage);
 
     if (/not found/i.test(errorMessage)) {
       return res.status(404).send({ error: errorMessage });
@@ -100,7 +97,6 @@ router.delete('/:commentId', authenticator(), async (req, res, next) => {
     return res.status(204).end();
   } catch (error) {
     const errorMessage = logger.getErrorMessage(error);
-    logger.error(errorMessage);
 
     if (/not found/i.test(errorMessage)) {
       return res.status(404).send({ error: errorMessage });

backend/src/routes/likes.ts

@@ -18,7 +18,6 @@ router.post('/', authenticator(), async (req, res, next) => {
     return res.status(201).end();
   } catch (error) {
     const errorMessage = logger.getErrorMessage(error);
-    logger.error(errorMessage);
 
     if (/not found/i.test(errorMessage)) {
       return res.status(404).send({ error: errorMessage });
@@ -44,9 +43,6 @@ router.delete('/:entityId', authenticator(), async (req, res, next) => {
 
     return res.status(204).end();
   } catch (error) {
-    const errorMessage = logger.getErrorMessage(error);
-    logger.error(errorMessage);
-
     return next(error);
   }
 });
@@ -59,9 +55,6 @@ router.get('/:entityId/likeCount', async (req, res, next) => {
 
     return res.status(200).send({ likeCount });
   } catch (error) {
-    const errorMessage = logger.getErrorMessage(error);
-    logger.error(errorMessage);
-
     return next(error);
   }
 });
@@ -74,9 +67,6 @@ router.get('/:entityId/likes', async (req, res, next) => {
 
     return res.status(200).send({ likes });
   } catch (error) {
-    const errorMessage = logger.getErrorMessage(error);
-    logger.error(errorMessage);
-
     return next(error);
   }
 });
@@ -90,9 +80,6 @@ router.get('/:entityId/hasLiked', authenticator(), async (req, res, next) => {
 
     return res.status(200).send({ hasLiked });
   } catch (error) {
-    const errorMessage = logger.getErrorMessage(error);
-    logger.error(errorMessage);
-
     return next(error);
   }
 });

backend/src/routes/posts.ts

@@ -26,14 +26,12 @@ router.post('/', authenticator(), async (req, res, next) => {
   try {
     newPostFields = fieldParsers.proofPostFields(req.body);
   } catch (error) {
-    logger.error(logger.getErrorMessage(error));
     return res.status(400).send({ error: logger.getErrorMessage(error) });
   }
 
   try {
     image = await cloudinary.upload(newPostFields.imageDataUrl);
   } catch (error) {
-    logger.error(logger.getErrorMessage(error));
     return res.status(500).send({ error: 'Something went wrong uploading the photo!' });
   }
 
@@ -46,7 +44,6 @@ router.post('/', authenticator(), async (req, res, next) => {
     await user.save();
     return res.status(201).send(savedPost);
   } catch (error) {
-    logger.error(logger.getErrorMessage(error));
     return next(error);
   }
 });
@@ -57,7 +54,6 @@ router.put('/:id', authenticator(), async (req, res, next) => {
   try {
     if (updatedPostFields.caption) updatedPostFields.caption = parseStringField(updatedPostFields.caption, 'caption');
   } catch (error) {
-    logger.error(logger.getErrorMessage(error));
     return res.status(400).send({ error: logger.getErrorMessage(error) });
   }
 
@@ -70,7 +66,7 @@ router.put('/:id', authenticator(), async (req, res, next) => {
     return res.status(200).send(updatedPost);
   } catch (error) {
     const errorMessage = logger.getErrorMessage(error);
-    logger.error(errorMessage);
+
     if (errorMessage === 'Unauthorized') return res.status(401).send({ error: errorMessage });
 
     return next(error);
@@ -83,7 +79,6 @@ router.delete('/:id', authenticator(), async (req, res, next) => {
     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 });

backend/src/routes/users.ts

@@ -96,7 +96,6 @@ router.put('/:id/follow', authenticator(), async (req, res, next) => {
     return res.status(200).end();
   } catch (error) {
     const errorMessage = logger.getErrorMessage(error);
-    logger.error(errorMessage);
     const errorResponseObj = { error: errorMessage };
 
     if (/user not found/i.test(errorMessage)) return res.status(404).send(errorResponseObj);

backend/src/utils/middleware.ts

@@ -43,9 +43,12 @@ export const authenticator = () => (
 export const errorHandler = (error: Error, _req: Request, res: Response, next: NextFunction) => {
   const errorMessage = logger.getErrorMessage(error);
 
-  if (process.env.NODE_ENV !== 'test') {
-    logger.error(errorMessage);
-  }
+  logger.error({
+    errorMessage,
+    name: error.name,
+    message: error.message,
+    stack: error.stack,
+  });
 
   if (error.name === 'CastError') {
     return res.status(400).send({ error: 'malformatted id' });
@@ -65,3 +68,22 @@ export const errorHandler = (error: Error, _req: Request, res: Response, next: N
 
   return next(error);
 };
+
+export function logErrorCodes(req: Request, res:Response, next: NextFunction) {
+  const originalSend = res.send.bind(res);
+
+  res.send = function logIfError(data) {
+    if (res.statusCode >= 400) {
+      logger.error({
+        method: req.method,
+        url: req.originalUrl,
+        statusCode: res.statusCode,
+        errorMessage: data,
+      });
+    }
+
+    return originalSend(data);
+  };
+
+  next();
+}

backend/test/auth-api.test.ts

@@ -27,7 +27,7 @@ describe('successful login', () => {
     });
   });
 
-  test.only('responds with 200 code and returns JSON', async () => {
+  test('responds with 200 code and returns JSON', async () => {
     await api
       .post(LOGIN_URL)
       .send({ username: testUser.username, password: 'secret' })