# All files / lib layouts.js

14.55% Statements 16/110
6.9% Branches 4/58
10.26% Functions 4/39
14.55% Lines 16/110

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377

    4x
    4x
    4x

    4x
    4x

    4x

    4x

    8x
    14x

    14x

    8x
    8x

    8x

    4x

    8x

    4x

     'use strict';

    const dateFormat = require('./date_format');
    const os = require('os');
    const util = require('util');

    const eol = os.EOL || '\n';
    const layoutMakers = {
      messagePassThrough: function () {
        return messagePassThroughLayout;
      },
      basic: function () {
        return basicLayout;
      },
      colored: function () {
        return colouredLayout;
      },
      coloured: function () {
        return colouredLayout;
      },
      pattern: function (config) {
        return patternLayout(config && config.pattern, config && config.tokens);
      },
      dummy: function () {
        return dummyLayout;
      }
    };
    const colours = {
      ALL: 'grey',
      TRACE: 'blue',
      DEBUG: 'cyan',
      INFO: 'green',
      WARN: 'yellow',
      ERROR: 'red',
      FATAL: 'magenta',
      OFF: 'grey'
    };
    const semver = require('semver');

    function wrapErrorsWithInspect(items) {
      return items.map((item) => {
        Iif ((item instanceof Error) && item.stack) {
          return {
            inspect: function () {
              return semver.satisfies(process.version, '>=6') ? util.format(item) : `${util.format(item)}\n${item.stack}`;
            }
          };
        }
        return item;
      });
    }

    /* eslint prefer-rest-params:0 */
    // todo: once node v4 support dropped, use rest parameter instead
    function formatLogData(logData) {
      let data = logData;
      Iif (!Array.isArray(data)) {
        const numArgs = arguments.length;
        data = new Array(numArgs);
        for (let i = 0; i < numArgs; i++) { // eslint-disable-line no-plusplus
          data[i] = arguments[i];
        }
      }
      return util.format.apply(util, wrapErrorsWithInspect(data));
    }

    const styles = {
      // styles
      bold: [1, 22],
      italic: [3, 23],
      underline: [4, 24],
      inverse: [7, 27],
      // grayscale
      white: [37, 39],
      grey: [90, 39],
      black: [90, 39],
      // colors
      blue: [34, 39],
      cyan: [36, 39],
      green: [32, 39],
      magenta: [35, 39],
      red: [31, 39],
      yellow: [33, 39]
    };

    function colorizeStart(style) {
      return style ? `\x1B[${styles[style][0]}m` : '';
    }

    function colorizeEnd(style) {
      return style ? `\x1B[${styles[style][1]}m` : '';
    }

    /**
     * Taken from masylum's fork (https://github.com/masylum/log4js-node)
     */
    function colorize(str, style) {
      return colorizeStart(style) + str + colorizeEnd(style);
    }

    function timestampLevelAndCategory(loggingEvent, colour, timezoneOffset) {
      return colorize(
        formatLogData(
          '[%s] [%s] %s - '
          , dateFormat.asString(loggingEvent.startTime, timezoneOffset)
          , loggingEvent.level
          , loggingEvent.categoryName
        )
        , colour
      );
    }

    /**
     * BasicLayout is a simple layout for storing the logs. The logs are stored
     * in following format:
     * <pre>
     * [startTime] [logLevel] categoryName - message\n
     * </pre>
     *
     * @author Stephan Strittmatter
     */
    function basicLayout(loggingEvent, timezoneOffset) {
      return timestampLevelAndCategory(
          loggingEvent,
          undefined,
          timezoneOffset
        ) + formatLogData(loggingEvent.data);
    }

    /**
     * colouredLayout - taken from masylum's fork.
     * same as basicLayout, but with colours.
     */
    function colouredLayout(loggingEvent, timezoneOffset) {
      return timestampLevelAndCategory(
          loggingEvent,
          colours[loggingEvent.level.toString()],
          timezoneOffset
        ) + formatLogData(loggingEvent.data);
    }

    function messagePassThroughLayout(loggingEvent) {
      return formatLogData(loggingEvent.data);
    }

    function dummyLayout(loggingEvent) {
      return loggingEvent.data[0];
    }

    /**
     * PatternLayout
     * Format for specifiers is %[padding].[truncation][field]{[format]}
     * e.g. %5.10p - left pad the log level by 5 characters, up to a max of 10
     * Fields can be any of:
     *  - %r time in toLocaleTimeString format
     *  - %p log level
     *  - %c log category
     *  - %h hostname
     *  - %m log data
     *  - %d date in constious formats
     *  - %% %
     *  - %n newline
     *  - %z pid
     *  - %x{<tokenname>} add dynamic tokens to your log. Tokens are specified in the tokens parameter
     * You can use %[ and %] to define a colored block.
     *
     * Tokens are specified as simple key:value objects.
     * The key represents the token name whereas the value can be a string or function
     * which is called to extract the value to put in the log message. If token is not
     * found, it doesn't replace the field.
     *
     * A sample token would be: { 'pid' : function() { return process.pid; } }
     *
     * Takes a pattern string, array of tokens and returns a layout function.
     * @return {Function}
     * @param pattern
     * @param tokens
     * @param timezoneOffset
     *
     * @authors ['Stephan Strittmatter', 'Jan Schmidle']
     */
    function patternLayout(pattern, tokens, timezoneOffset) {
      const TTCC_CONVERSION_PATTERN = '%r %p %c - %m%n';
      const regex = /%(-?[0-9]+)?(\.?[0-9]+)?([[\]cdhmnprzxy%])(\{([^}]+)\})?|([^%]+)/;

      pattern = pattern || TTCC_CONVERSION_PATTERN;

      function categoryName(loggingEvent, specifier) {
        let loggerName = loggingEvent.categoryName;
        if (specifier) {
          const precision = parseInt(specifier, 10);
          const loggerNameBits = loggerName.split('.');
          if (precision < loggerNameBits.length) {
            loggerName = loggerNameBits.slice(loggerNameBits.length - precision).join('.');
          }
        }
        return loggerName;
      }

      function formatAsDate(loggingEvent, specifier) {
        let format = dateFormat.ISO8601_FORMAT;
        if (specifier) {
          format = specifier;
          // Pick up special cases
          if (format === 'ISO8601') {
            format = dateFormat.ISO8601_FORMAT;
          } else if (format === 'ISO8601_WITH_TZ_OFFSET') {
            format = dateFormat.ISO8601_WITH_TZ_OFFSET_FORMAT;
          } else if (format === 'ABSOLUTE') {
            format = dateFormat.ABSOLUTETIME_FORMAT;
          } else if (format === 'DATE') {
            format = dateFormat.DATETIME_FORMAT;
          }
        }
        // Format the date
        return dateFormat.asString(format, loggingEvent.startTime, timezoneOffset);
      }

      function hostname() {
        return os.hostname().toString();
      }

      function formatMessage(loggingEvent) {
        return formatLogData(loggingEvent.data);
      }

      function endOfLine() {
        return eol;
      }

      function logLevel(loggingEvent) {
        return loggingEvent.level.toString();
      }

      function startTime(loggingEvent) {
        return dateFormat.asString('hh:mm:ss', loggingEvent.startTime, timezoneOffset);
      }

      function startColour(loggingEvent) {
        return colorizeStart(colours[loggingEvent.level.toString()]);
      }

      function endColour(loggingEvent) {
        return colorizeEnd(colours[loggingEvent.level.toString()]);
      }

      function percent() {
        return '%';
      }

      function pid(loggingEvent) {
        return loggingEvent && loggingEvent.pid ? loggingEvent.pid : process.pid;
      }

      function clusterInfo(loggingEvent, specifier) {
        if (loggingEvent.cluster && specifier) {
          return specifier
            .replace('%m', loggingEvent.cluster.master)
            .replace('%w', loggingEvent.cluster.worker)
            .replace('%i', loggingEvent.cluster.workerId);
        } else if (loggingEvent.cluster) {
          return `${loggingEvent.cluster.worker}@${loggingEvent.cluster.master}`;
        }

        return pid();
      }

      function userDefined(loggingEvent, specifier) {
        if (typeof tokens[specifier] !== 'undefined') {
          return typeof tokens[specifier] === 'function' ? tokens[specifier](loggingEvent) : tokens[specifier];
        }

        return null;
      }

      /* eslint quote-props:0 */
      const replacers = {
        'c': categoryName,
        'd': formatAsDate,
        'h': hostname,
        'm': formatMessage,
        'n': endOfLine,
        'p': logLevel,
        'r': startTime,
        '[': startColour,
        ']': endColour,
        'y': clusterInfo,
        'z': pid,
        '%': percent,
        'x': userDefined
      };

      function replaceToken(conversionCharacter, loggingEvent, specifier) {
        return replacers[conversionCharacter](loggingEvent, specifier);
      }

      function truncate(truncation, toTruncate) {
        let len;
        if (truncation) {
          len = parseInt(truncation.substr(1), 10);
          return toTruncate.substring(0, len);
        }

        return toTruncate;
      }

      function pad(padding, toPad) {
        let len;
        if (padding) {
          if (padding.charAt(0) === '-') {
            len = parseInt(padding.substr(1), 10);
            // Right pad with spaces
            while (toPad.length < len) {
              toPad += ' ';
            }
          } else {
            len = parseInt(padding, 10);
            // Left pad with spaces
            while (toPad.length < len) {
              toPad = ` ${toPad}`;
            }
          }
        }
        return toPad;
      }

      function truncateAndPad(toTruncAndPad, truncation, padding) {
        let replacement = toTruncAndPad;
        replacement = truncate(truncation, replacement);
        replacement = pad(padding, replacement);
        return replacement;
      }

      return function (loggingEvent) {
        let formattedString = '';
        let result;
        let searchString = pattern;

        /* eslint no-cond-assign:0 */
        while ((result = regex.exec(searchString)) !== null) {
          // const matchedString = result[0];
          const padding = result[1];
          const truncation = result[2];
          const conversionCharacter = result[3];
          const specifier = result[5];
          const text = result[6];

          // Check if the pattern matched was just normal text
          if (text) {
            formattedString += text.toString();
          } else {
            // Create a raw replacement string based on the conversion
            // character and specifier
            const replacement = replaceToken(conversionCharacter, loggingEvent, specifier);
            formattedString += truncateAndPad(replacement, truncation, padding);
          }
          searchString = searchString.substr(result.index + result[0].length);
        }
        return formattedString;
      };
    }

    module.exports = {
      basicLayout: basicLayout,
      messagePassThroughLayout: messagePassThroughLayout,
      patternLayout: patternLayout,
      colouredLayout: colouredLayout,
      coloredLayout: colouredLayout,
      dummyLayout: dummyLayout,
      addLayout: function (name, serializerGenerator) {
        layoutMakers[name] = serializerGenerator;
      },
      layout: function (name, config) {
        return layoutMakers[name] && layoutMakers[name](config);
      }
    };