Don't crash on youtube-dl update write error

[github/Chocobozzz/PeerTube.git] / server / helpers / logger.ts

diff --git a/server/helpers/logger.ts b/server/helpers/logger.ts
index 480c5b49eac3df0ee1f2cc4766bab769f6b0ea15..a4bd414274b43da679569a533bef7ed0be5d225f 100644 (file)
--- a/server/helpers/logger.ts
+++ b/server/helpers/logger.ts
@@ -1,28 +1,48 @@
 // Thanks http://tostring.it/2014/06/23/advanced-logging-with-nodejs/
-import * as mkdirp from 'mkdirp'
+import { mkdirpSync } from 'fs-extra'
 import * as path from 'path'
 import * as winston from 'winston'
-import { CONFIG } from '../initializers'
+import { FileTransportOptions } from 'winston/lib/winston/transports'
+import { CONFIG } from '../initializers/config'
+import { omit } from 'lodash'
+import { LOG_FILENAME } from '../initializers/constants'
 
 const label = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
 
 // Create the directory if it does not exist
-mkdirp.sync(CONFIG.STORAGE.LOG_DIR)
+// FIXME: use async
+mkdirpSync(CONFIG.STORAGE.LOG_DIR)
 
-function loggerReplacer (key: string, value: any) {
-  if (value instanceof Error) {
-    const error = {}
+function getLoggerReplacer () {
+  const seen = new WeakSet()
 
-    Object.getOwnPropertyNames(value).forEach(key => error[ key ] = value[ key ])
+  // Thanks: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors/Cyclic_object_value#Examples
+  return (key: string, value: any) => {
+    if (key === 'cert') return 'Replaced by the logger to avoid large log message'
 
-    return error
-  }
+    if (typeof value === 'object' && value !== null) {
+      if (seen.has(value)) return
+
+      seen.add(value)
+    }
+
+    if (value instanceof Error) {
+      const error = {}
+
+      Object.getOwnPropertyNames(value).forEach(key => { error[key] = value[key] })
 
-  return value
+      return error
+    }
+
+    return value
+  }
 }
 
 const consoleLoggerFormat = winston.format.printf(info => {
-  let additionalInfos = JSON.stringify(info.meta || info.err, loggerReplacer, 2)
+  const obj = omit(info, 'label', 'timestamp', 'level', 'message')
+
+  let additionalInfos = JSON.stringify(obj, getLoggerReplacer(), 2)
+
   if (additionalInfos === undefined || additionalInfos === '{}') additionalInfos = ''
   else additionalInfos = ' ' + additionalInfos
 
@@ -30,44 +50,55 @@ const consoleLoggerFormat = winston.format.printf(info => {
 })
 
 const jsonLoggerFormat = winston.format.printf(info => {
-  return JSON.stringify(info, loggerReplacer)
+  return JSON.stringify(info, getLoggerReplacer())
 })
 
 const timestampFormatter = winston.format.timestamp({
   format: 'YYYY-MM-DD HH:mm:ss.SSS'
 })
-const labelFormatter = winston.format.label({
-  label
-})
+const labelFormatter = (suffix?: string) => {
+  return winston.format.label({
+    label: suffix ? `${label} ${suffix}` : label
+  })
+}
 
-const logger = winston.createLogger({
-  level: CONFIG.LOG.LEVEL,
+const fileLoggerOptions: FileTransportOptions = {
+  filename: path.join(CONFIG.STORAGE.LOG_DIR, LOG_FILENAME),
+  handleExceptions: true,
   format: winston.format.combine(
-    labelFormatter,
-    winston.format.splat()
-  ),
-  transports: [
-    new winston.transports.File({
-      filename: path.join(CONFIG.STORAGE.LOG_DIR, 'peertube.log'),
-      handleExceptions: true,
-      maxsize: 1024 * 1024 * 30,
-      maxFiles: 5,
-      format: winston.format.combine(
-        winston.format.timestamp(),
-        jsonLoggerFormat
-      )
-    }),
-    new winston.transports.Console({
-      handleExceptions: true,
-      format: winston.format.combine(
-        timestampFormatter,
-        winston.format.colorize(),
-        consoleLoggerFormat
-      )
-    })
-  ],
-  exitOnError: true
-})
+    winston.format.timestamp(),
+    jsonLoggerFormat
+  )
+}
+
+if (CONFIG.LOG.ROTATION.ENABLED) {
+  fileLoggerOptions.maxsize = CONFIG.LOG.ROTATION.MAX_FILE_SIZE
+  fileLoggerOptions.maxFiles = CONFIG.LOG.ROTATION.MAX_FILES
+}
+
+const logger = buildLogger()
+
+function buildLogger (labelSuffix?: string) {
+  return winston.createLogger({
+    level: CONFIG.LOG.LEVEL,
+    format: winston.format.combine(
+      labelFormatter(labelSuffix),
+      winston.format.splat()
+    ),
+    transports: [
+      new winston.transports.File(fileLoggerOptions),
+      new winston.transports.Console({
+        handleExceptions: true,
+        format: winston.format.combine(
+          timestampFormatter,
+          winston.format.colorize(),
+          consoleLoggerFormat
+        )
+      })
+    ],
+    exitOnError: true
+  })
+}
 
 function bunyanLogFactory (level: string) {
   return function () {
@@ -75,19 +106,20 @@ function bunyanLogFactory (level: string) {
     let args: any[] = []
     args.concat(arguments)
 
-    if (arguments[ 0 ] instanceof Error) {
-      meta = arguments[ 0 ].toString()
+    if (arguments[0] instanceof Error) {
+      meta = arguments[0].toString()
       args = Array.prototype.slice.call(arguments, 1)
       args.push(meta)
-    } else if (typeof (args[ 0 ]) !== 'string') {
-      meta = arguments[ 0 ]
+    } else if (typeof (args[0]) !== 'string') {
+      meta = arguments[0]
       args = Array.prototype.slice.call(arguments, 1)
       args.push(meta)
     }
 
-    logger[ level ].apply(logger, args)
+    logger[level].apply(logger, args)
   }
 }
+
 const bunyanLogger = {
   trace: bunyanLogFactory('debug'),
   debug: bunyanLogFactory('debug'),
@@ -99,6 +131,7 @@ const bunyanLogger = {
 // ---------------------------------------------------------------------------
 
 export {
+  buildLogger,
   timestampFormatter,
   labelFormatter,
   consoleLoggerFormat,