Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add logger package #474

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open
19 changes: 19 additions & 0 deletions packages/logger/libraries/core/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Typescript compiled files
/lib/**

/tsconfig.tsbuildinfo
/tsconfig.cjs.tsbuildinfo
/tsconfig.esm.tsbuildinfo

# Test coverage report
/coverage

# Test mutation report
/reports

# node modules
/node_modules/

# Turborepo files
.turbo/

9 changes: 9 additions & 0 deletions packages/logger/libraries/core/.lintstagedrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"*.js": [
"prettier --write"
],
"*.ts": [
"prettier --write",
"eslint"
]
}
25 changes: 25 additions & 0 deletions packages/logger/libraries/core/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/.turbo
/coverage
/reports

**/*.spec.js
**/*.spec.js.map
**/*.ts
!lib/cjs/**/*.d.ts
lib/esm/**/*.d.ts.map
!lib/esm/index.d.ts
!lib/esm/index.d.ts.map

.lintstagedrc.json
eslint.config.mjs
vitest.config.mjs
vitest.config.stryker.mjs
vitest.workspace.mjs
prettier.config.mjs
rollup.config.mjs
stryker.config.mjs
tsconfig.cjs.json
tsconfig.cjs.tsbuildinfo
tsconfig.esm.json
tsconfig.esm.tsbuildinfo
tsconfig.json
6 changes: 6 additions & 0 deletions packages/logger/libraries/core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[![Test coverage](https://codecov.io/gh/inversify/monorepo/branch/main/graph/badge.svg?flag=%40inversifyjs%2Fhttp-core)](https://codecov.io/gh/inversify/monorepo/branch/main/graph/badge.svg?flag=%40inversifyjs%2Fhttp-core)
[![npm version](https://img.shields.io/github/package-json/v/inversify/monorepo?filename=packages%2Fcontainer%2Flibraries%2Fhttp-core%2Fpackage.json&style=plastic)](https://www.npmjs.com/package/@inversifyjs/http-core)

# @inversifyjs/http-core

Inversify monorepo http core modules.
3 changes: 3 additions & 0 deletions packages/logger/libraries/core/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import myconfig from '@inversifyjs/foundation-eslint-config';

export default [...myconfig];
74 changes: 74 additions & 0 deletions packages/logger/libraries/core/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
{
"author": "Adrián Martínez Jiménez",
"bugs": {
"url": "https://github.com/inversify/monorepo/issues"
},
"description": "InversifyJs logger core package",
"devDependencies": {
"@stryker-mutator/core": "8.7.1",
"@stryker-mutator/typescript-checker": "8.7.1",
"@stryker-mutator/vitest-runner": "8.7.1",
"@types/node": "22.13.9",
"@vitest/coverage-v8": "3.0.7",
"eslint": "9.21.0",
"logform": "^2.7.0",
"prettier": "3.5.3",
"rimraf": "6.0.1",
"rollup": "4.34.9",
"ts-loader": "9.5.2",
"tslib": "2.8.1",
"typescript": "5.8.2",
"vitest": "3.0.7"
},
"devEngines": {
"node": "^22.10.2",
"pnpm": "^9.12.1"
},
"homepage": "https://inversify.io",
"keywords": [
"dependency injection",
"dependency inversion",
"di",
"inversion of control container",
"ioc",
"javascript",
"node",
"typescript"
],
"license": "MIT",
"main": "lib/cjs/index.js",
"module": "lib/esm/index.js",
"exports": {
".": {
"import": "./lib/esm/index.js",
"require": "./lib/cjs/index.js"
}
},
"name": "@inversifyjs/logger",
"publishConfig": {
"access": "public"
},
"repository": {
"type": "git",
"url": "git+https://github.com/inversify/monorepo.git"
},
"scripts": {
"build": "pnpm run build:cjs && pnpm run build:esm",
"build:cjs": "tsc --build tsconfig.cjs.json && pnpm exec foundation-ts-package-cjs ./lib/cjs",
"build:esm": "rollup -c ./rollup.config.mjs && pnpm exec foundation-ts-package-esm ./lib/esm",
"build:clean": "rimraf lib",
"format": "prettier --write ./src",
"lint": "eslint ./src",
"prebuild": "pnpm run build:clean",
"test": "vitest run",
"test:integration": "pnpm run test --project Integration",
"test:coverage": "pnpm run test:unit --coverage",
"test:mutation": "stryker run",
"test:uncommitted": "pnpm run test --changed=HEAD",
"test:unit": "pnpm run test --project Unit"
},
"version": "1.0.0",
"dependencies": {
"winston": "^3.17.0"
}
}
3 changes: 3 additions & 0 deletions packages/logger/libraries/core/prettier.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import config from '@inversifyjs/foundation-prettier-config';

export default config;
4 changes: 4 additions & 0 deletions packages/logger/libraries/core/rollup.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import config from '@inversifyjs/foundation-rollup-config';

/** @type {!import("rollup").MergedRollupOptions[]} */
export default config;
7 changes: 7 additions & 0 deletions packages/logger/libraries/core/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { ConsoleLogger } from './logger/ConsoleLogger';
import { FileLogger } from './logger/FileLogger';
import { Logger } from './logger/model/Logger';
import { LoggerOptions } from './model/LoggerOptions';
import { LogType } from './model/LogType';

export { ConsoleLogger, FileLogger, Logger, LoggerOptions, LogType };
14 changes: 14 additions & 0 deletions packages/logger/libraries/core/src/logger/ConsoleLogger.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { createLogger, transports } from 'winston';

import { LoggerOptions } from '../model/LoggerOptions';
import { WinstonLoggerAdapter } from '../winston/adapter/WinstonLoggerAdapter';

export class ConsoleLogger extends WinstonLoggerAdapter {
constructor(context?: string, loggerOptions?: LoggerOptions) {
super(
createLogger({ transports: [new transports.Console()] }),
context,
loggerOptions,
);
}
}
20 changes: 20 additions & 0 deletions packages/logger/libraries/core/src/logger/FileLogger.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { createLogger, transports } from 'winston';

import { LoggerOptions } from '../model/LoggerOptions';
import { WinstonLoggerAdapter } from '../winston/adapter/WinstonLoggerAdapter';

export class FileLogger extends WinstonLoggerAdapter {
constructor(
fileName: string,
context?: string,
loggerOptions?: LoggerOptions,
) {
super(
createLogger({
transports: [new transports.File({ filename: fileName })],
}),
context,
loggerOptions,
);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
import { LoggerOptions } from '../../model/LoggerOptions';
import { LogType } from '../../model/LogType';
import { ContextMetadata } from '../model/ContextMetadata';
import { Logger } from '../model/Logger';

export abstract class LoggerAdapter implements Logger {
readonly #context: string | undefined;

constructor(
context?: string,
protected readonly _loggerOptions: LoggerOptions = {
json: true,
logTypes: [
LogType.DEBUG,
LogType.ERROR,
LogType.HTTP,
LogType.INFO,
LogType.SILLY,
LogType.VERBOSE,
LogType.WARN,
],
timestamp: true,
},
) {
this.#context = context;
}

public info(message: string, contextMetadata?: ContextMetadata): void {
this.log(LogType.INFO, message, contextMetadata);
}

public http(message: string, contextMetadata?: ContextMetadata): void {
this.log(LogType.HTTP, message, contextMetadata);
}

public silly(message: string, contextMetadata?: ContextMetadata): void {
this.log(LogType.SILLY, message, contextMetadata);
}

public log(
logType: LogType,
message: string,
contextMetadata?: ContextMetadata,
): void {
if (this._loggerOptions.logTypes.includes(logType)) {
this.printLog(logType, message, {
...contextMetadata,
context: contextMetadata?.context ?? this.#context,
});
}
}

public error(message: string, contextMetadata?: ContextMetadata): void {
this.log(LogType.ERROR, message, contextMetadata);
}

public warn(message: string, contextMetadata?: ContextMetadata): void {
this.log(LogType.WARN, message, contextMetadata);
}

public debug(message: string, contextMetadata?: ContextMetadata): void {
this.log(LogType.DEBUG, message, contextMetadata);
}

public verbose(message: string, contextMetadata?: ContextMetadata): void {
this.log(LogType.VERBOSE, message, contextMetadata);
}

protected abstract printLog(
logType: LogType,
message: string,
context?: ContextMetadata,
): void;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
export interface ContextMetadata {
[key: string]: unknown;
context?: string | undefined;
}
13 changes: 13 additions & 0 deletions packages/logger/libraries/core/src/logger/model/Logger.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { LogType } from '../../model/LogType';
import { ContextMetadata } from './ContextMetadata';

export interface Logger {
log(logType: LogType, message: string, context?: ContextMetadata): void;
error(message: string, context?: ContextMetadata): void;
warn(message: string, context?: ContextMetadata): void;
info(message: string, context?: ContextMetadata): void;
http(message: string, context?: ContextMetadata): void;
verbose(message: string, context?: ContextMetadata): void;
debug(message: string, context?: ContextMetadata): void;
silly(message: string, context?: ContextMetadata): void;
}
9 changes: 9 additions & 0 deletions packages/logger/libraries/core/src/model/LogType.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
export enum LogType {
ERROR = 'error',
WARN = 'warn',
INFO = 'info',
HTTP = 'http',
VERBOSE = 'verbose',
DEBUG = 'debug',
SILLY = 'silly',
}
7 changes: 7 additions & 0 deletions packages/logger/libraries/core/src/model/LoggerOptions.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { LogType } from './LogType';

export interface LoggerOptions {
json: boolean;
logTypes: LogType[];
timestamp: boolean;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import { Format, TransformableInfo } from 'logform';
import { format, Logger } from 'winston';

import { LoggerAdapter } from '../../logger/adapter/LoggerAdapter';
import { ContextMetadata } from '../../logger/model/ContextMetadata';
import { LoggerOptions } from '../../model/LoggerOptions';
import { LogType } from '../../model/LogType';

export class WinstonLoggerAdapter extends LoggerAdapter {
readonly #logger: Logger;

constructor(logger: Logger, context?: string, loggerOptions?: LoggerOptions) {
super(context, loggerOptions);
this.#logger = logger;

const formatList: Format[] = [];

if (this._loggerOptions.timestamp) {
formatList.push(
format.timestamp({
format: 'YYYY-MM-DD hh:mm:ss.SSS A',
}),
);
}

if (this._loggerOptions.json) {
formatList.push(format.json(), format.prettyPrint());
} else {
formatList.push(
format.colorize({ all: true }),
format.printf(
(info: TransformableInfo): string =>
`[InversifyJS] - ${String(process.pid)}${this._loggerOptions.timestamp ? ` ${info['timestamp'] as string}` : ''} ${info.level}${info['context'] !== undefined ? ` [${info['context'] as string}]` : ''}: ${info.message as string}`,
),
);
}

this.#logger.format = format.combine(this.#logger.format, ...formatList);
}

protected printLog(
logType: LogType,
message: string,
context?: ContextMetadata,
): void {
this.#logger.log(logType, message, context);
}
}
3 changes: 3 additions & 0 deletions packages/logger/libraries/core/stryker.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import config from '@inversifyjs/foundation-stryker-config';

export default config;
10 changes: 10 additions & 0 deletions packages/logger/libraries/core/tsconfig.cjs.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"$schema": "http://json.schemastore.org/tsconfig",
"extends": "@inversifyjs/foundation-typescript-config/tsconfig.base.cjs.json",
"compilerOptions": {
"outDir": "./lib/cjs",
"rootDir": "./src",
"tsBuildInfoFile": "tsconfig.cjs.tsbuildinfo"
},
"include": ["src"]
}
10 changes: 10 additions & 0 deletions packages/logger/libraries/core/tsconfig.esm.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"$schema": "http://json.schemastore.org/tsconfig",
"extends": "@inversifyjs/foundation-typescript-config/tsconfig.base.esm.json",
"compilerOptions": {
"outDir": "./lib/esm",
"rootDir": "./src",
"tsBuildInfoFile": "tsconfig.esm.tsbuildinfo"
},
"include": ["src"]
}
4 changes: 4 additions & 0 deletions packages/logger/libraries/core/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "http://json.schemastore.org/tsconfig",
"extends": "./tsconfig.cjs.json"
}
3 changes: 3 additions & 0 deletions packages/logger/libraries/core/vitest.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { defaultConfig } from '@inversifyjs/foundation-vitest-config';

export default defaultConfig;
3 changes: 3 additions & 0 deletions packages/logger/libraries/core/vitest.config.stryker.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { strykerConfig } from '@inversifyjs/foundation-vitest-config';

export default strykerConfig;
3 changes: 3 additions & 0 deletions packages/logger/libraries/core/vitest.workspace.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { workspaceConfig } from '@inversifyjs/foundation-vitest-config';

export default workspaceConfig;
Loading
Loading