Add more examples of logger usage

Author: santiq

src/api/middlewares/attachCurrentUser.ts

@@ -22,8 +22,7 @@ const attachCurrentUser = async (req, res, next) => {
     req.currentUser = currentUser;
     return next();
   } catch (e) {
-    Logger.warn('🔥 Error attaching user to req');
-    Logger.warn(e);
+    Logger.error('🔥 Error attaching user to req: %o', e);
     return next(e);
   }
 };

src/api/routes/auth.ts

@@ -21,12 +21,13 @@ export default (app: Router) => {
     }),
     async (req: Request, res: Response, next: NextFunction) => {
       const logger = Container.get('logger');
+      logger.debug('Calling Sign-Up endpoint with body: %o', req.body )
       try {
         const authServiceInstance = Container.get(AuthService);
         const { user, token } = await authServiceInstance.SignUp(req.body as IUserInputDTO);
         return res.json({ user, token }).status(201);
       } catch (e) {
-        logger.warn('🔥 error ', e);
+        logger.error('🔥 error: %o', e);
         return next(e);
       }
     },
@@ -41,14 +42,15 @@ export default (app: Router) => {
       }),
     }),
     async (req: Request, res: Response, next: NextFunction) => {
-      const Logger = Container.get('logger');
+      const logger = Container.get('logger');
+      logger.debug('Calling Sign-In endpoint with body: %o', req.body)
       try {
         const { email, password } = req.body;
         const authServiceInstance = Container.get(AuthService);
         const { user, token } = await authServiceInstance.SignIn(email, password);
         return res.json({ user, token }).status(200);
       } catch (e) {
-        Logger.warn('🔥 error ', e);
+        logger.error('🔥 error: %o',  e );
         return next(e);
       }
     },
@@ -64,12 +66,13 @@ export default (app: Router) => {
    * It's really annoying to develop that but if you had to, please use Redis as your data store
    */
   route.post('/logout', middlewares.isAuth, (req: Request, res: Response, next: NextFunction) => {
-    const Logger = Container.get('logger');
+    const logger = Container.get('logger');
+    logger.debug('Calling Sign-Out endpoint with body: %o', req.body)
     try {
       //@TODO AuthService.Logout(req.user) do some clever stuff
       return res.status(200).end();
     } catch (e) {
-      Logger.warn('🔥 error ', e);
+      logger.error('🔥 error %o', e);
       return next(e);
     }
   });

src/app.ts

@@ -19,11 +19,11 @@ async function startServer() {
 
   app.listen(config.port, err => {
     if (err) {
-      Logger.warn(err);
+      Logger.error(err);
       process.exit(1);
       return;
     }
-    Logger.debug(`
+    Logger.info(`
       ################################################
       🛡️  Server listening on port: ${config.port} 🛡️ 
       ################################################

src/config/index.ts

@@ -30,7 +30,7 @@ export default {
    * Used by winston logger
    */
   logs: {
-    level: process.env.LOG_LEVEL || 'debug',
+    level: process.env.LOG_LEVEL || 'silly',
   },
 
   /**

src/jobs/emailSequence.ts

@@ -11,8 +11,7 @@ export default class EmailSequenceJob {
       await mailerServiceInstance.StartEmailSequence('WelcomeSequence', { email, name });
       done();
     } catch (e) {
-      Logger.warn('🔥 Error with Email Sequence Job');
-      Logger.warn(e);
+      Logger.error('🔥 Error with Email Sequence Job: %o', e);
       done(e);
     }
   }

src/loaders/dependencyInjector.ts

@@ -13,11 +13,11 @@ export default ({ mongoConnection, models }: { mongoConnection; models: { name:
     Container.set('agendaInstance', agendaInstance);
     Container.set('logger', LoggerInstance)
 
-    LoggerInstance.debug('✌️ Agenda injected into container');
+    LoggerInstance.info('✌️ Agenda injected into container');
 
     return { agenda: agendaInstance };
   } catch (e) {
-    LoggerInstance.debug('🔥 Error on dependency injector loader %o', e);
+    LoggerInstance.error('🔥 Error on dependency injector loader: %o', e);
     throw e;
   }
 };

src/loaders/index.ts

@@ -5,7 +5,7 @@ import jobsLoader from './jobs';
 import Logger from './logger';
 export default async ({ expressApp }) => {
   const mongoConnection = await mongooseLoader();
-  Logger.debug('✌️ DB loaded and connected!');
+  Logger.info('✌️ DB loaded and connected!');
 
   /**
    * WTF is going on here?
@@ -30,11 +30,11 @@ export default async ({ expressApp }) => {
       // whateverModel
     ],
   });
-  Logger.debug('✌️ Dependency Injector loaded');
+  Logger.info('✌️ Dependency Injector loaded');
 
   await jobsLoader({ agenda });
-  Logger.debug('✌️ Jobs loaded');
+  Logger.info('✌️ Jobs loaded');
 
   await expressLoader({ app: expressApp });
-  Logger.debug('✌️ Express loaded');
+  Logger.info('✌️ Express loaded');
 };

src/services/auth.ts

@@ -34,19 +34,21 @@ export default class AuthService {
        * watches every API call and if it spots a 'password' and 'email' property then
        * it decides to steal them!? Would you even notice that? I wouldn't :/
        */
+      this.logger.silly('Hashing password');
       const hashedPassword = await argon2.hash(userInputDTO.password, { salt });
+      this.logger.silly('Creating user db record');
       const userRecord = await this.userModel.create({
         ...userInputDTO,
         salt: salt.toString('hex'),
         password: hashedPassword,
       });
-
+      this.logger.silly('Generating JWT');
       const token = this.generateToken(userRecord);
 
       if (!userRecord) {
         throw new Error('User cannot be created');
       }
-
+      this.logger.silly('Sending welcome email');
       await this.mailer.SendWelcomeEmail(userRecord);
 
       /**
@@ -60,7 +62,7 @@ export default class AuthService {
       Reflect.deleteProperty(user, 'salt');
       return { user, token };
     } catch (e) {
-      this.logger.warn(e);
+      this.logger.error(e);
       throw e;
     }
   }
@@ -73,8 +75,11 @@ export default class AuthService {
     /**
      * We use verify from argon2 to prevent 'timing based' attacks
      */
+    this.logger.silly('Checking password');
     const validPassword = await argon2.verify(userRecord.password, password);
     if (validPassword) {
+      this.logger.silly('Password is valid!');
+      this.logger.silly('Generating JWT');
       const token = this.generateToken(userRecord);
 
       const user = userRecord.toObject();
@@ -103,7 +108,7 @@ export default class AuthService {
      * because it doesn't have _the secret_ to sign it
      * more information here: https://softwareontheroad.com/you-dont-need-passport
      */
-
+    this.logger.silly(`Sign JWT for userId: ${user._id}`);
     return jwt.sign(
       {
         _id: user._id, // We are gonna use this in the middleware 'isAuth'

src/subscribers/user.ts

@@ -25,8 +25,7 @@ export default class UserSubscriber {
 
       UserModel.update({ _id }, { $set: { lastLogin: new Date() } });
     } catch (e) {
-      Logger.warn(`🔥 Error on event ${events.user.signIn}`);
-      Logger.warn(e);
+      Logger.error(`🔥 Error on event ${events.user.signIn}: %o`, e);
 
       // Throw the error so the process die (check src/app.ts)
       throw e;
@@ -46,8 +45,7 @@ export default class UserSubscriber {
       // Start your email sequence or whatever
       // MailService.startSequence('user.welcome', { email, name })
     } catch (e) {
-      Logger.warn(`🔥 Error on event ${events.user.signUp}`);
-      Logger.warn(e);
+      Logger.error(`🔥 Error on event ${events.user.signUp}: %o`, e);
 
       // Throw the error so the process dies (check src/app.ts)
       throw e;