@trojs/logger 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 TroJS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,96 @@
+# logger
+Generic logger with intergrations for e.g. Sentry
+
+```javascript
+import makeLogger from '@trojs/logger';
+
+const logger = makeLogger({
+  level: 'info', 
+  service: 'user-service',
+  loggers: [
+    {
+      type: 'console'
+    },
+    {
+      type: 'sentry',
+      level: 'error',
+      location: 'https://12345678@234567151173.ingest.sentry.io/1234567'
+    }
+  ]
+})
+
+try {
+  throw new Error('example')
+} catch(error) {
+  logger.error(error, { whatever: "is sent as extra" });
+}
+```
+
+# level
+
+default: info
+
+Log only if [`info.level`](#streams-objectmode-and-info-objects) less than or equal to this level
+
+More info see: https://www.npmjs.com/package/winston#logging-levels
+
+# service
+
+default: user-service
+
+# Loggers:
+
+Set of logging targets for `info` messages
+
+default:
+```javascript
+[
+  {
+    type: 'console'
+  }
+]
+```
+
+Types:
+
+ * sentry
+ * errorFile
+ * combinedFile
+ * console
+
+The default loggers are overruled by the loggers in the `loggers` array.
+
+It use winston transports for all logger types.
+More info see: https://www.npmjs.com/package/winston#transports
+
+## sentry
+
+* location (sentry.dsn)
+* environment (default: production, sentry.environment)
+* serverName (default: localhost, sentry.serverName)
+* release (default: unknown, sentry.release)
+* debug (default: false, sentry.debug)
+* sampleRate (default: 1, sentry.sampleRate)
+* tracesSampleRate (default: 1, senty.tracesSampleRate)
+* level (default: info)
+
+DSN:
+
+The DSN tells the SDK where to send the events. If this value is not provided, the SDK will try to read it from the SENTRY_DSN environment variable. If that variable also does not exist, the SDK will just not send any events.
+
+More info: 
+
+* https://github.com/aandrewww/winston-transport-sentry-node
+* https://docs.sentry.io/platforms/node/
+* https://docs.sentry.io/platforms/javascript/
+
+## errorFile
+
+* location (default: error.log)
+* level (default: error)
+
+## combinedFile
+
+* location (default: combined.log)
+
+## console

package/package.json

@@ -0,0 +1,77 @@
+{
+    "name": "@trojs/logger",
+    "description": "Winston logger for TroJS",
+    "version": "0.4.0",
+    "author": {
+        "name": "Pieter Wigboldus",
+        "url": "https://trojs.org/"
+    },
+    "license": "MIT",
+    "scripts": {
+        "lint": "eslint src/*.js --config .eslintrc",
+        "lint:report": "eslint src/*.js --config .eslintrc -f json -o report.json",
+        "lint:fix": "eslint src/ --config .eslintrc --fix",
+        "test": "c8 node --test",
+        "cpd": "node_modules/jscpd/bin/jscpd src",
+        "vulnerabilities": "npm audit --omit=dev"
+    },
+    "type": "module",
+    "files": [
+        "src/logger.js",
+        "src/models/logger.js",
+        "src/models/schemas/logger.js",
+        "src/models/enums/level.js",
+        "src/models/mutators/logger.js",
+        "src/loggers/index.js",
+        "src/loggers/console.js",
+        "src/loggers/sentry.js",
+        "src/loggers/combined-file.js",
+        "src/loggers/error-file.js",
+        "src/helpers/stackdriver.js"
+    ],
+    "main": "src/logger.js",
+    "devDependencies": {
+        "@trojs/error": "^3.0.0",
+        "@hckrnews/eslint-config": "^3.0.0",
+        "c8": "^9.0.0",
+        "eslint": "^8.23.0",
+        "eslint-config-standard": "^17.1.0",
+        "eslint-plugin-import": "^2.26.0",
+        "eslint-plugin-jsdoc": "^48.0.6",
+        "eslint-plugin-n": "^16.6.2",
+        "eslint-plugin-promise": "^6.0.1",
+        "eslint-plugin-sonarjs": "^0.24.0",
+        "jscpd": "^3.2.1"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/hckrnews/logger"
+    },
+    "engines": {
+        "node": ">= 18.13"
+    },
+    "keywords": [
+        "javascript",
+        "sentry",
+        "logging",
+        "error"
+    ],
+    "dependencies": {
+        "@trojs/enum": "^3.0.0",
+        "@trojs/mutator": "^0.4.0",
+        "@trojs/objects": "^8.0.0",
+        "@sentry/integrations": "^7.36.0",
+        "@sentry/node": "^7.36.0",
+        "@sentry/tracing": "^7.36.0",
+        "compression": "^1.7.4",
+        "cors": "^2.8.5",
+        "dotenv": "^16.0.3",
+        "winston": "^3.13.0",
+        "winston-transport": "^4.5.0",
+        "winston-transport-sentry-node": "^2.7.0"
+    },
+    "funding": {
+        "type": "github",
+        "url": "https://github.com/sponsors/w3nl"
+    }
+}

package/src/helpers/stackdriver.js

@@ -0,0 +1,30 @@
+import os from 'node:os'
+
+const levelToSeverity = {
+  trace: 'DEBUG',
+  debug: 'DEBUG',
+  info: 'INFO',
+  warn: 'WARNING',
+  error: 'ERROR',
+  fatal: 'CRITICAL'
+}
+
+const levels = {
+  trace: 10,
+  debug: 20,
+  info: 30,
+  warn: 40,
+  error: 50,
+  fatal: 60
+}
+
+const stackdriver = ({ level, defaultLevel }) => (info) => ({
+  ...info,
+  severity: levelToSeverity[level] || levelToSeverity[defaultLevel],
+  level: levels[level] || levels[defaultLevel],
+  time: Date.now(),
+  pid: process.pid,
+  hostname: os.hostname()
+})
+
+export default stackdriver

package/src/logger.js

@@ -0,0 +1,37 @@
+import winston from 'winston'
+import makeLoggers from './loggers/index.js'
+
+const defaultLoggers = [
+  {
+    type: 'console'
+  }
+]
+
+const levels = {
+  fatal: 0,
+  error: 1,
+  warn: 2,
+  info: 3,
+  debug: 4,
+  trace: 5
+}
+
+/**
+ * Create the logger
+ * @param {object} config
+ * @param {Array=} config.loggers
+ * @param {string?=} config.level
+ * @param {object?=} config.meta
+ * @returns {winston.Logger}
+ */
+export default ({ loggers = defaultLoggers, level = 'info', meta = {} }) => {
+  const winstonLoggers = makeLoggers({ winston, loggers })
+
+  return winston.createLogger({
+    level,
+    levels,
+    format: winston.format.json(),
+    defaultMeta: meta,
+    transports: winstonLoggers
+  })
+}

package/src/loggers/combined-file.js

@@ -0,0 +1,3 @@
+export default ({ winston, logger }) => new winston.transports.File({
+  filename: logger?.location || 'combined.log'
+})

package/src/loggers/console.js

@@ -0,0 +1,13 @@
+import stackDriver from '../helpers/stackdriver.js'
+
+export default ({ winston, logger }) => {
+  const defaultLevel = 'trace'
+
+  return new winston.transports.Console({
+    level: logger?.level || defaultLevel,
+    format: winston.format.combine(
+      winston.format(stackDriver({ level: logger?.level, defaultLevel }))(),
+      winston.format.json()
+    )
+  })
+}

package/src/loggers/error-file.js

@@ -0,0 +1,4 @@
+export default ({ winston, logger }) => new winston.transports.File({
+  filename: logger?.location || 'error.log',
+  level: logger?.level || 'error'
+})

package/src/loggers/index.js

@@ -0,0 +1,29 @@
+import makeErrorFileLogger from './error-file.js'
+import makeCombinedFileLogger from './combined-file.js'
+import makeSentryLogger from './sentry.js'
+import makeConsoleLogger from './console.js'
+
+import Logger from '../models/logger.js'
+
+const winstonLoggers = {
+  sentry: makeSentryLogger,
+  errorFile: makeErrorFileLogger,
+  combinedFile: makeCombinedFileLogger,
+  console: makeConsoleLogger
+}
+
+const makeLoggers = ({ winston, loggers }) => Logger.createAll(loggers).map(logger => {
+  const loggerFn = winstonLoggers[logger.type]
+  if (!loggerFn) {
+    throw new Error(`Unknown logger type: ${logger.type}`)
+  }
+
+  const opts = {
+    logger,
+    winston
+  }
+
+  return loggerFn(opts)
+})
+
+export default makeLoggers

package/src/loggers/sentry.js

@@ -0,0 +1,20 @@
+import SentryPackage from 'winston-transport-sentry-node'
+
+const Sentry = SentryPackage?.default || SentryPackage
+
+export default ({ logger }) => {
+  const options = {
+    sentry: {
+      dsn: logger?.location,
+      environment: logger?.environment || 'production',
+      serverName: logger?.serverName || 'localhost',
+      release: logger?.release || 'unknown',
+      debug: logger?.debug || false,
+      sampleRate: logger?.sampleRate || 1,
+      tracesSampleRate: logger?.tracesSampleRate || 1
+    },
+    level: logger?.level || 'info'
+  }
+
+  return new Sentry(options)
+}

package/src/models/enums/level.js

@@ -0,0 +1,26 @@
+import { Enum } from '@trojs/enum'
+
+/**
+ * @typedef LevelType
+ * @property {string} info "info"
+ * @property {string} fatal "fatal"
+ * @property {string} error "error"
+ * @property {string} warn "warn"
+ * @property {string} debug "debug"
+ * @property {string} trace "trace"
+ */
+
+/**
+ * Level enum
+ * @augments Enum
+ * @readonly
+ * @enum { LevelType }
+ */
+export default class Level extends Enum {
+  static info = 'info'
+  static fatal = 'fatal'
+  static error = 'error'
+  static warn = 'warn'
+  static debug = 'debug'
+  static trace = 'trace'
+}

package/src/models/logger.js

@@ -0,0 +1,37 @@
+import { Obj } from '@trojs/objects'
+import loggerSchema from './schemas/logger.js'
+import LoggerMutator from './mutators/logger.js'
+
+/**
+ * @typedef {import('./schemas/logger.js').Logger} LoggerType
+ */
+
+/**
+ * @type {LoggerType}
+ */
+const LoggerObject = Obj({ schema: loggerSchema })
+
+export default class Logger {
+  /**
+   * Create a logger object
+   * @param {LoggerType} data
+   * @returns {LoggerType}
+   */
+  static create (data) {
+    const logger = LoggerMutator.create(data)
+    return LoggerObject.create(logger)
+  }
+
+  /**
+   * Create logger objects
+   * @param {LoggerType[]} data
+   * @returns {LoggerType[]}
+   */
+  static createAll (data) {
+    if (!data || data.length === 0) {
+      return []
+    }
+
+    return data.map(loggerData => Logger.create(loggerData))
+  }
+}

package/src/models/mutators/logger.js

@@ -0,0 +1,14 @@
+import DefaultMutator from '@trojs/mutator'
+import LevelEnum from '../enums/level.js'
+
+/**
+ * Logger mutator
+ * @augments DefaultMutator
+ */
+class Logger extends DefaultMutator {
+  setLevelAttribute (level) {
+    return LevelEnum.fromKey(level)
+  }
+}
+
+export default Logger

package/src/models/schemas/logger.js

@@ -0,0 +1,35 @@
+import Level from '../enums/level.js'
+
+/**
+ * @typedef {import('../enums/level.js').LevelType} LevelType
+ */
+
+/**
+ * The logger object
+ * @typedef {object} Logger
+ * @property {string} type
+ * @property {string?} location
+ * @property {LevelType?} level
+ * @property {string?} key
+ * @property {object?} credentials
+ * @property {string?} environment
+ * @property {string?} serverName
+ * @property {string?} release
+ * @property {boolean?} debug
+ * @property {number?} sampleRate
+ * @property {number?} tracesSampleRate
+ */
+
+export default {
+  type: String,
+  'location?': String,
+  'level?': Level,
+  'key?': String,
+  'credentials?': Object,
+  'environment?': String,
+  'serverName?': String,
+  'release?': String,
+  'debug?': Boolean,
+  'sampleRate?': Number,
+  'tracesSampleRate?': Number
+}