chore(app): create the logger package

.eslintignore

@@ -1,10 +1,10 @@
 build
 .eslintrc.js
 jest.config.js
-app/graphql/types
 module.d.ts
 dist
 .next
 .turbo
 coverage
 env.d.ts
+**/*.d.ts

.eslintrc.js

@@ -23,6 +23,9 @@ module.exports = {
  'prefer-const': 'warn',
  'no-use-before-define': 'warn',
  'max-len': ['warn', 120],
+ '@typescript-eslint/ban-types': 'off',
+ '@typescript-eslint/camelcase': 'off',
+ '@typescript-eslint/class-name-casing': 'off',
  '@typescript-eslint/ban-ts-comment': [
  'warn',
  {
@@ -52,5 +55,17 @@ module.exports = {
  'newline-after-var': ['warn', 'always'],
  curly: 'warn',
  'sort-keys-fix/sort-keys-fix': 'warn',
+ '@typescript-eslint/prefer-ts-expect-error': 'error',
+ 'new-cap': 'off',
+ 'no-console': 'off',
+ 'no-else-return': 'error',
+ 'no-eval': 'error',
+ 'no-undef': 'error',
+ 'no-mixed-operators': 'off',
+ 'no-nested-ternary': 'error',
+ 'no-param-reassign': 'error',
+ 'no-underscore-dangle': 'off',
+ 'no-unused-vars': 'off',
+ 'ods-use-this': 'off',
  },
 };

apps/core/package.json

@@ -14,6 +14,7 @@
  },
  "dependencies": {
  "@sharingan/utils": "1.0.0",
+ "@sharingan/logger": "1.0.0",
  "apollo-server": "^3.6.6",
  "dotenv": "^16.0.0",
  "express": "^4.17.3",

apps/core/src/configs/logger.ts

@@ -0,0 +1,10 @@
+import path from 'path';
+import { fileLogger } from '@sharingan/logger';
+
+fileLogger.init({
+ appName: 'core',
+ logFileDirectory: path.resolve(__dirname, '../../logs'),
+ logToSentry: false,
+});
+
+export { fileLogger as logger };

apps/core/src/index.ts

@@ -3,6 +3,7 @@ import typeDefs from './resources/newsletter/schema';
 import { resolvers } from './resources/newsletter/resolvers';
 import { sortNumbers } from '@sharingan/utils';
 import { env } from './configs/env';
+import { logger } from './configs/logger';
 
 const server = new ApolloServer({
  healthCheckPath: '/health',
@@ -14,5 +15,5 @@ const server = new ApolloServer({
 console.log(sortNumbers([67, 80, 4, 11, 90, 54, 22]));
 
 void server.listen({ port: env.PORT }).then(({ url }) => {
- console.log(`🚀 Server ready at ${url}graphql`);
+ logger.info(`🚀 Server ready at ${url}graphql`);
 });

package.json

@@ -12,6 +12,7 @@
  },
  "private": true,
  "workspaces": [
+ "packages/logger",
  "packages/utils",
  "apps/core",
  "apps/web",

packages/logger/.eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+ "rules": {},
+ ignorePatterns: ["jest.config.js", "dist"]
+}

packages/logger/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+dist

packages/logger/index.ts

@@ -0,0 +1,7 @@
+import BaseLogger from './src/base-logger';
+import FileLogger from './src/file-logger';
+
+const baseLogger = new BaseLogger();
+const fileLogger = new FileLogger();
+
+export { baseLogger, fileLogger };

packages/logger/jest.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+ roots: ['.'],
+ preset: 'ts-jest',
+ testMatch: ['**/?(*.)+(spec|test).[jt]s'],
+ testEnvironment: 'node',
+ clearMocks: true,
+ maxWorkers: 1,
+ snapshotFormat: {
+ "printBasicPrototype": false
+ }
+};

packages/logger/package.json

@@ -0,0 +1,27 @@
+{
+ "name": "@sharingan/logger",
+ "version": "1.0.0",
+ "description": "Sharingan logger",
+ "main": "dist/index.js",
+ "types": "dist/index.d.ts",
+ "license": "MIT",
+ "scripts": {
+ "build": "tsc --project tsconfig.prod.json",
+ "clean": "rm -rf .turbo dist",
+ "lint": "eslint src index.ts",
+ "test": "jest"
+ },
+ "dependencies": {
+ "@sentry/node": "^6.19.2",
+ "@sentry/tracing": "^6.19.2",
+ "winston": "^3.6.0",
+ "winston-daily-rotate-file": "^4.6.1"
+ },
+ "devDependencies": {
+ "@types/jest": "^27.4.1",
+ "@types/lodash": "^4.14.180",
+ "jest": "^27.5.1",
+ "ts-jest": "^27.1.3",
+ "typescript": "^4.6.2"
+ }
+}

packages/logger/src/base-logger.ts

@@ -0,0 +1,67 @@
+import { createLogger, format, Logger, transports } from 'winston';
+import { isObject } from 'lodash';
+import * as Sentry from '@sentry/node';
+import { LoggerInitOptions } from './types';
+
+const { combine, printf, timestamp }: typeof format = format;
+
+class BaseLogger {
+ protected logger: Logger = createLogger();
+ protected canLogToSentry = false;
+
+ init(options: LoggerInitOptions): void {
+ this.canLogToSentry = Boolean(options.logToSentry) && Boolean(options.sentryDsn);
+
+ this.initSentryIfNecessary();
+
+ this.logger = createLogger({
+ format: combine(timestamp(), this.customFormat()),
+ silent: Boolean(options.silent),
+ transports: [new transports.Console()],
+ });
+ }
+
+ error(error: unknown): void {
+ this.logger.error(this.logMessage(error));
+
+ if (this.canLogToSentry) {
+ this.logErrorToSentry(error);
+ }
+ }
+
+ info(output: unknown): void {
+ this.logger.info(this.logMessage(output));
+ }
+
+ private initSentryIfNecessary(sentryDsn?: string) {
+ if (!this.canLogToSentry || !sentryDsn) {
+ return;
+ }
+
+ Sentry.init({
+ dsn: sentryDsn,
+ // Set tracesSampleRate to 1.0 to capture 100% of transactions for performance monitoring.
+ // We recommend adjusting this value in production
+ tracesSampleRate: 1.0,
+ });
+ }
+
+ private logErrorToSentry(e: any) {
+ Sentry.captureException(e);
+ }
+
+ private logMessage(message: any): string {
+ // @ts-ignore
+ return isObject(message) ? (message.stack ? message.stack : JSON.stringify(message, null, 2)) : message.toString();
+ }
+
+ private customFormat() {
+ return printf((info) => {
+ const { level, message, timestamp } = info;
+
+ return `${timestamp} ${level}: ${this.logMessage(message)}`;
+ });
+ }
+}
+
+export default BaseLogger;

packages/logger/src/file-logger.ts

@@ -0,0 +1,27 @@
+import fs from 'fs';
+import WinstonFileRotation from 'winston-daily-rotate-file';
+import { FileLoggerInitOptions } from './types';
+import BaseLogger from './base-logger';
+
+class FileLogger extends BaseLogger {
+ public init(options: FileLoggerInitOptions) {
+ super.init(options);
+
+ if (!fs.existsSync(options.logFileDirectory)) {
+ fs.mkdirSync(options.logFileDirectory);
+ }
+
+ const transport = new WinstonFileRotation({
+ datePattern: 'YYYY-MM-DD',
+ dirname: options.logFileDirectory,
+ filename: `${options.appName}-%DATE%.log`,
+ maxFiles: '14d',
+ maxSize: '20m',
+ zippedArchive: true,
+ });
+
+ this.logger.add(transport);
+ }
+}
+
+export default FileLogger;

packages/logger/src/types.ts

@@ -0,0 +1,15 @@
+export type EnhancedLogger = {
+ error: (output: unknown, logToSentry?: boolean) => void;
+ info: (output: unknown) => void;
+};
+
+export type LoggerInitOptions = {
+ logToSentry?: boolean;
+ sentryDsn?: string;
+ silent?: boolean;
+};
+
+export type FileLoggerInitOptions = LoggerInitOptions & {
+ appName: string;
+ logFileDirectory: string;
+};

packages/logger/tsconfig.json

@@ -0,0 +1,16 @@
+{
+ "extends": "../../tsconfig.base.json",
+ "compilerOptions": {
+ "target": "es5",
+ "module": "commonjs",
+ "lib": ["dom"],
+ "outDir": "./dist",
+ "declaration": true,
+ "composite": true,
+ "sourceMap": true,
+ },
+ "include": ["./src/**/*", "./tests/**/*", "index.ts"],
+ "exclude": [
+ "node_modules"
+ ]
+}

packages/logger/tsconfig.prod.json

@@ -0,0 +1,7 @@
+{
+ "extends": "./tsconfig",
+ "compilerOptions": {
+ "sourceMap": false
+ },
+ "exclude": ["tests"]
+}