Enhanced Logging System with Winston Integration

[Sweetdevil144]

Fixes #21
Description:

This pull request introduces significant improvements to our application's logging system, leveraging the winston library for a more structured and effective logging approach:

1. Logger Utility Introduction:

   • New Logger.js File: Implemented in the util directory, this file features a custom Logger class using winston, standardizing logging across our codebase.
   • Logger Class Capabilities: Offers four logging levels - debug, info, warn, and error - with log verbosity adapting to the environment (development or production).

2. Refactoring in app.js:

   • Replaced Console Logging: Transitioned from console.log and console.error to the Logger class methods for consistent logging.
   • Enhanced Logging Details: Logs, particularly for errors, now include comprehensive information like stack traces and context for better debugging.

3. Adaptive Log Level Management:

   • Environment-Based Log Levels: The Logger sets log levels dynamically based on NODE_ENV, ensuring appropriate verbosity in development and production modes.

4. Log Formatting and Management:

   • Improved Readability: Logs are now colorized and formatted for clarity, thanks to winston's features.
   • Versatile Log Storage: Configured with multiple transports, our logger ensures effective log data capture and storage in both console and files.

[ChakshuGautam]

@Sweetdevil144 is this ready to review?

[Sweetdevil144]

Yes, go ahead!!

[dhruv-1001]

Hey, @Sweetdevil144. As the project grows, there will be more files/classes. And we'll need to know which class is throwing out those logs. Can you also add that logger functionality to this PR as well?

[Sweetdevil144]

@dhruv-1001 I think I already did it by adding server/utils/logger.js class. If more files are added, one can simply import the class and add logger functionalities to the same!!
Hope that helps !! (:

[Sweetdevil144]

I will add the class function as you requested for it to be thrown too!!

[dhruv-1001]

@Sweetdevil144, any update on this?

[Sweetdevil144]

Hey @dhruv-1001 , I already added class logging property to the Logger. Just a simple guide. User will add two comments in Logging. For example

Logger.error('app.js',`Error reading folder: ${err}`);

It is already available for review. Any changes are welcome.

[Sweetdevil144]

I think the code is ready to be merged. Views @dhruv-1001 and @ChakshuGautam ??

[dhruv-1001]

@Sweetdevil144, can you make the changes i've mentioned in review?
Which says that, file name should be passed in constructor to function. So that we don't have to pass that in every time we log anything.

[Sweetdevil144]

Can you check the changes now @dhruv-1001 ? I've added the filename to logger class so that it's passed only once when using the Logger file. For example, If you want to log in app.js, we do :

import Logger from './util/logger';
const logger = new Logger('app.js');

[dhruv-1001]

@Sweetdevil144, that's great. Just update the logs everywhere according to this change, and test it out on your local. I'll then merge this PR

[Sweetdevil144]

Hey @dhruv-1001 and @ChakshuGautam . Can you checkout this PR?

[dhruv-1001]

@Sweetdevil144, that's great. Just update the logs everywhere according to this change, and test it out on your local. I'll then merge this PR

Can you push these changes?

[Sweetdevil144]

@Sweetdevil144, that's great. Just update the logs everywhere according to this change, and test it out on your local. I'll then merge this PR

Can you push these changes?

Pushed

[Sweetdevil144]

I guess we should remove combined.log and all other log files by adding them in .gitignore

[Sweetdevil144]

@dhruv-1001 ready for review

One more doubt : Why don't we have jest configured for our codebase? We can prepare our jest.config.js as follow :

   module.exports = {
     transform: {
       '^.+\\.js$': 'babel-jest',
     },
   };

It is because I have been facing the following issue while running our test cases :
SyntaxError: Cannot use import statement outside a module, which indicates that Jest is trying to run our tests in a CommonJS environment, which does not support ES6 module syntax (import/export). To resolve this issue, we'll need to configure Jest to use Babel for transforming our code, which will allow it to understand ES6 modules.

[dhruv-1001]

Hey @Sweetdevil144, will be reviewing this today evening.
Edit: Will try today.

[dhruv-1001]

This LGTM. Merging this now. Moving forward we are migrating to nestjs. So, will be using logging class by nestjs.