logr-logfmt/test/logfmt.test.js

plugin for logr that posts tags and log message to logfmt

/* eslint-disable no-console */
const Logr = require('logr');
const logrFmt = require('../index.js');
const tap = require('tap');
const test = tap.test;

test('can load the logfmt  plugin ', (t) => {
  t.plan(1);
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt
      }
    }
  });
  t.equal(typeof log, 'function', 'should register a "log" function');
});

test('logfmt plugin can convert tags to the appropriate logfmt "level" keys', (t) => {
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt
      }
    }
  });
  log(['debug', 'warning', 'error', 'fatal'], 'a fatal log statement');
  log(['debug', 'warning', 'error'], 'a log statement');
  log(['debug', 'warning'], 'a log statement');
  log(['debug'], 'a log statement');
  log('a log statement');
  console.log = oldConsole;
  t.match(logs.length, 5, 'prints all tags');
  t.match(logs[0], 'level=FATAL');
  t.match(logs[1], 'level=ERROR');
  t.match(logs[2], 'level=WARN');
  t.match(logs[3], 'level=DEBUG');
  t.match(logs[4], 'level=INFO');
  t.end();
});

test('logfmt plugin can convert mesage content to the logfmt "msg" key', (t) => {
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt
      }
    }
  });
  log('a log statement');
  log({ msg: 'a log statement' });
  log({ message: 'a log statement' });
  log({ notAMEssage: 'not a log statement' });
  console.log = oldConsole;
  t.match(logs.length, 4, 'prints all tags');
  t.match(logs[0], 'level=INFO msg="a log statement"');
  t.match(logs[1], 'level=INFO msg="a log statement"');
  t.match(logs[2], 'level=INFO msg="a log statement"');
  t.notMatch(logs[3], 'level=INFO msg="a log statement"');
  t.end();
});

test('logfmt plugin can convert other tags to the logfmt "tag" key', (t) => {
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt
      }
    }
  });
  log(['tag1', 'tag2', 'tag3'], 'a log statement');
  console.log = oldConsole;
  t.match(logs[0], 'level=INFO msg="a log statement" tag="tag1,tag2,tag3"');
  t.end();
});

test('logfmt plugin will convert object to keys up to 2 levels deep', (t) => {
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt
      }
    }
  });
  log({
    obj: {
      key: 'a'
    },
    blah: {
      foo: 'test 123'
    },
    debug: 1
  });
  log({
    level1: {
      level2: {
        level3: {
          level4: {
            key1: 'hi'
          }
        }
      }
    },
  });
  console.log = oldConsole;
  t.match(logs[0], 'level=INFO obj.key="a" blah.foo="test 123" debug="1"');
  t.match(logs[1], 'level=INFO level1.level2="{\'level3\':{\'level4\':\'...\'}}"');
  t.end();
});

test('logfmt plugin will display strings, numbers, booleans and circular objects correctly', (t) => {
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt
      }
    }
  });
  const magellan = {};
  magellan.magellan = magellan;
  log(['error', 'tag1', 'tag2'], {
    message: 'a log statement',
    number: '1234.23',
    bool: false,
    magellan,
    obj: {
      key: 'a'
    },
    blah: {
      foo: 'test 123'
    },
    debug: 1
  });
  console.log = oldConsole;
  t.match(logs[0], 'level=ERROR msg="a log statement" tag="tag1,tag2" number="1234.23" bool="false" magellan.magellan="{\'magellan\':{\'magellan\':\'...\'}}" obj.key="a" blah.foo="test 123" debug="1"');
  t.end();
});

test('logfmt plugin will display all features together correctly', (t) => {
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt
      }
    }
  });
  log(['error', 'tag1', 'tag2'], {
    message: 'a log statement',
    obj: {
      key: 'a'
    },
    blah: {
      foo: 'test 123'
    },
    debug: 1
  });
  console.log = oldConsole;
  t.match(logs[0], 'level=ERROR msg="a log statement" tag="tag1,tag2" obj.key="a" blah.foo="test 123" debug="1"');
  t.end();
});

test('logfmt plugin will turn doublequotes to single and strip newlines', (t) => {
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt
      }
    }
  });

  log(`MongoClient connection created for {"url":"http://example.com&authSource=user","decorate":true}

here are some other things
`);

  log({ message: `MongoClient connection created for {"url":"http://example.com&authSource=user","decorate":true}

here are some other things
` });

  log({ key: `MongoClient connection created for {"url":"http://example.com&authSource=user","decorate":true}

here are some other things
` });

  console.log = oldConsole;
  t.match(logs[0], 'msg="MongoClient connection created for {\'url\':\'http://example.com&authSource=user\',\'decorate\':true} here are some other things "');
  t.match(logs[1], 'msg="MongoClient connection created for {\'url\':\'http://example.com&authSource=user\',\'decorate\':true} here are some other things "');
  t.match(logs[2], 'key="MongoClient connection created for {\'url\':\'http://example.com&authSource=user\',\'decorate\':true} here are some other things "');
  t.end();
});

test('logfmt plugin can convert other tags to the logfmt "tag" key', (t) => {
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt
      }
    }
  });
  log(['error'], { msg: 'testing123', tag: { test: { test: '123' } } });
  console.log = oldConsole;
  t.match(logs[0], 'level=ERROR msg="testing123" tag.test="{\'test\':\'123\'}"');
  t.end();
});

test('logfmt plugin will only colorize if "color" is true', (t) => {
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt,
        options: {
          appColor: true,
          tagColors: {
            redpaint: 'red'
          }
        }
      }
    }
  });
  log(['color1', 'gray1', 'gray2', 'redpaint'], { msg: 'testing123', tag: { test: { test: '123' } } });
  log(['color2', 'gray1', 'gray2', 'redpaint'], { msg: 'testing123', tag: { test: { test: '123' } } });
  t.match(logs, ['level=INFO msg="testing123" tag="color1,gray1,gray2,redpaint" tag.test="{\'test\':\'123\'}"',
    'level=INFO msg="testing123" tag="color2,gray1,gray2,redpaint" tag.test="{\'test\':\'123\'}"']);
  console.log = oldConsole;
  t.end();
});

test('logfmt plugin will display ansi colors when color is true', (t) => {
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt,
        options: {
          color: true,
          tagColors: {
            redpaint: 'red'
          }
        }
      }
    }
  });
  log(['color1', 'gray1', 'gray2', 'redpaint'], { msg: 'testing123', tag: { test: { test: '123' } } });
  log(['color2', 'gray1', 'gray2', 'redpaint'], { msg: 'testing123', tag: { test: { test: '123' } } });
  t.match(logs, ['level=INFO msg="testing123" tag="\u001b[35mcolor1\u001b[39m,\u001b[90mgray1\u001b[39m,\u001b[90mgray2\u001b[39m,\u001b[31mredpaint\u001b[39m" \u001b[36mtag.test\u001b[39m="\u001b[37m{\'test\':\'123\'}\u001b[39m"',
    'level=INFO msg="testing123" tag="\u001b[36mcolor2\u001b[39m,\u001b[90mgray1\u001b[39m,\u001b[90mgray2\u001b[39m,\u001b[31mredpaint\u001b[39m" \u001b[36mtag.test\u001b[39m="\u001b[37m{\'test\':\'123\'}\u001b[39m"']);
  console.log = oldConsole;
  t.end();
});

test('logfmt plugin will assign a color to the first tag if color and appColor are both true', (t) => {
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt,
        options: {
          appColor: true,
          color: true,
          tagColors: {
            redpaint: 'red'
          }
        }
      }
    }
  });
  log(['color1', 'gray1', 'gray2', 'redpaint'], { msg: 'testing123', tag: { test: { test: '123' } } });
  log(['color2', 'gray1', 'gray2', 'redpaint'], { msg: 'testing123', tag: { test: { test: '123' } } });
  t.match(logs, ['level=INFO msg="testing123" tag="\u001b[35mcolor1\u001b[39m,\u001b[90mgray1\u001b[39m,\u001b[90mgray2\u001b[39m,\u001b[31mredpaint\u001b[39m" \u001b[36mtag.test\u001b[39m="\u001b[37m{\'test\':\'123\'}\u001b[39m"',
    'level=INFO msg="testing123" tag="\u001b[36mcolor2\u001b[39m,\u001b[90mgray1\u001b[39m,\u001b[90mgray2\u001b[39m,\u001b[31mredpaint\u001b[39m" \u001b[36mtag.test\u001b[39m="\u001b[37m{\'test\':\'123\'}\u001b[39m"']);
  console.log = oldConsole;
  t.end();
});

test('logfmt plugin can handle undefined object keys', (t) => {
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt
      }
    }
  });
  log(['debug'], {
    val1: 'a value!',
    val2: undefined,
    val3: null
  });
  console.log = oldConsole;
  t.match(logs, ['level=DEBUG val1="a value!" val2="undefined" val3="null"']);
  t.end();
});

test('when theme is false do not apply colors to tags/keys', t => {
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt,
        options: {
          color: true,
          theme: false
        }
      }
    }
  });
  log(['color1', 'gray1', 'gray2', 'redpaint'], { msg: 'testing123', tag: { test: { test: '123' } } });
  log(['color2', 'gray1', 'gray2', 'redpaint'], { msg: 'testing123', tag: { test: { test: '123' } } });
  console.log = oldConsole;
  t.match(logs, ['level=INFO msg="testing123" tag="\u001b[35mcolor1\u001b[39m,gray1,gray2,redpaint" tag.test="{\'test\':\'123\'}"',
    'level=INFO msg="testing123" tag="\u001b[36mcolor2\u001b[39m,gray1,gray2,redpaint" tag.test="{\'test\':\'123\'}"']);
  t.end();
});

test('when LOGR_LOGFMT_THEME is false do not apply colors to tags/keys', t => {
  process.env.LOGR_LOGFMT_THEME = false;
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    reporters: {
      logfmt: {
        reporter: logrFmt,
        options: {
          color: true,
        }
      }
    }
  });
  log(['color1', 'gray1', 'gray2', 'redpaint'], { msg: 'testing123', tag: { test: { test: '123' } } });
  log(['color2', 'gray1', 'gray2', 'redpaint'], { msg: 'testing123', tag: { test: { test: '123' } } });
  console.log = oldConsole;
  t.match(logs, ['level=INFO msg="testing123" tag="\u001b[35mcolor1\u001b[39m,gray1,gray2,redpaint" tag.test="{\'test\':\'123\'}"',
    'level=INFO msg="testing123" tag="\u001b[36mcolor2\u001b[39m,gray1,gray2,redpaint" tag.test="{\'test\':\'123\'}"']);
  delete process.env.LOGR_LOGFMT_THEME;
  t.end();
});

test('when LOGR_LOGFMT_THEME is false still apply tagColors and appColors', t => {
  process.env.LOGR_LOGFMT_THEME = false;
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    appColor: true,
    reporters: {
      logfmt: {
        reporter: logrFmt,
        options: {
          appColor: true,
          color: true,
          tagColors: {
            redpaint: 'red'
          }
        }
      }
    }
  });
  log(['color1', 'gray1', 'gray2', 'redpaint'], { msg: 'testing123', tag: { test: { test: '123' } } });
  log(['color2', 'gray1', 'gray2', 'redpaint'], { msg: 'testing123', tag: { test: { test: '123' } } });
  console.log = oldConsole;
  t.match(logs, ['level=INFO msg="testing123" tag="\u001b[35mcolor1\u001b[39m,gray1,gray2,\u001b[31mredpaint\u001b[39m" tag.test="{\'test\':\'123\'}"',
    'level=INFO msg="testing123" tag="\u001b[36mcolor2\u001b[39m,gray1,gray2,\u001b[31mredpaint\u001b[39m" tag.test="{\'test\':\'123\'}"']);
  delete process.env.LOGR_LOGFMT_THEME;
  t.end();
});

test('use tagColor instead of theme', t => {
  const oldConsole = console.log;
  const logs = [];
  console.log = (data) => {
    logs.push(data);
  };
  const log = Logr.createLogger({
    type: 'logfmt',
    appColor: true,
    reporters: {
      logfmt: {
        reporter: logrFmt,
        options: {
          appColor: true,
          color: true,
          tagColors: {
            warning: 'red'
          }
        }
      }
    }
  });
  log(['color1', 'gray1', 'gray2', 'warning'], { msg: 'testing123', tag: { test: { test: '123' } } });
  log(['color2', 'gray1', 'gray2', 'warning'], { msg: 'testing123', tag: { test: { test: '123' } } });
  console.log = oldConsole;
  t.match(logs, ['level=WARN msg="testing123" tag="\u001b[35mcolor1\u001b[39m,\u001b[90mgray1\u001b[39m,\u001b[90mgray2\u001b[39m,\u001b[31mwarning\u001b[39m" \u001b[36mtag.test\u001b[39m="\u001b[37m{\'test\':\'123\'}\u001b[39m"',
    'level=WARN msg="testing123" tag="\u001b[36mcolor2\u001b[39m,\u001b[90mgray1\u001b[39m,\u001b[90mgray2\u001b[39m,\u001b[31mwarning\u001b[39m" \u001b[36mtag.test\u001b[39m="\u001b[37m{\'test\':\'123\'}\u001b[39m"']);
  t.end();
});