feat: add logging (#21)

.eslintrc

@@ -19,15 +19,7 @@
         ],
         "import/prefer-default-export": "off",
         "no-console": [
-            "error",
-            {
-                "allow": [
-                    "info",
-                    "warn",
-                    "trace",
-                    "error"
-                ]
-            }
+            "error"
         ]
     }
 }

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+### Logger usage
+
+The project uses `pino` logger. This logger should be used over `console` calls.
+
+For usual in-file logging one should import the logger from the corresponding `logger.ts` module
+and use it in accordance with [documentation](https://github.com/pinojs/pino/tree/master/docs).
+
+In case of logging the processes that happen during http request handling it is also
+possible to use the dedicated logger that is accessible via the `express` request object.
+
+Here's a couple of examples:
+
+1. Http logging
+
+```typescript
+  // some resolver code above
+  resolve: (_parent, _args, ctx) => {
+      ctx.apolloLogger.debug('resolver called');
+    });
+  },
+
+```
+
+2. Usual logger
+
+In order to maintain the logging structure and be able to filter logs by file they have been produced at the following approach has to be taken:
+
+```typescript
+import { getModuleBinding, getChildLogger } from './logger';
+
+const logger = getChildLogger({ msgPrefix: 'PREFIX' }, { myCustomBinding: 'Funny guy' });
+```
+
+If this approach is used - then it will be possible to filter the logs via providing the corresponding environment variable values. For more on this read the root [README](./README.md)

README.md

@@ -22,6 +22,9 @@ npm i
 # Run application in development mode
 npm run dev
 
+# Run application with extensive logging enabled (full ORM logging + app's logger has `debug` level on)
+npm run debug
+
 # Typechecking (via TypeScript / tsc)
 npm run typecheck
 
@@ -32,6 +35,10 @@ npm run lint
 npm run test
 ```
 
+### Logging configuration
+
+The configuration is received from the `logger.config.ts` file at the root of the project. Adjust the file parameters to control the logger behaviour.
+
 ### Coding Setup
 
 To install the correct node version, we recommend that you use [nvm](https://github.com/nvm-sh/nvm). If you have `nvm` installed you can run:
@@ -56,6 +63,7 @@ cp developer.env .env
 - `PORT` (optional, default: 3000): port on which the server will run.
 - `AUTH_SIGNUP_ENABLED` (optional, default: `false`): if signing up mutation is allowed (i.e. user creation via endpoint is enabled)
 - `JWT_EXPIRATION_PERIOD` (optional, default: `'7d'`): how soon the signed jwt token will expire.
+- `DEBUG` (optional): if set, enables the different more explicit logging mode where debug levels are set to `debug` for the app's logger and `query` for db logger
 
 ### Project-Requirements
 

logger.config.ts

@@ -0,0 +1,35 @@
+import { LoggerConfig } from './src/types';
+
+export const defaultLoggerConfig: LoggerConfig = {
+  // Filter by module name
+  moduleFilter: [],
+  // Filter by log prefix, e.g. adding
+  // `pref` to filter is going to correspond to showing `[PREF] ` logs
+  prefixFilter: [],
+  // Lowest printed log level of default logger
+  logLevel: 'info',
+  // Log levels of prisma logger that are enabled
+  dbLogLevel: ['info'],
+  // Lowest printed log level of express logger
+  httpLogLevel: 'info',
+};
+
+export const debugLogConfig: LoggerConfig = {
+  // Filter by module name
+  moduleFilter: [],
+  // Filter by log prefix, e.g. adding
+  // `pref` to filter is going to correspond to showing `[PERF]` logs
+  prefixFilter: [],
+  // Lowest printed log level of default logger
+  logLevel: 'debug',
+  // Log levels of prisma logger that are enabled
+  dbLogLevel: ['query'],
+  // Lowest printed log level of express logger
+  httpLogLevel: 'debug',
+};
+
+function getLoggerConfig(debug: boolean): LoggerConfig {
+  return (debug ? debugLogConfig : defaultLoggerConfig);
+}
+
+export const loggerConfig = getLoggerConfig(!!process.env.DEBUG);