✨ Add sentry option and tests

Related: #28

Author: smolijar

package.json

@@ -48,6 +48,7 @@
     "@sentry/node": "^5.9.0"
   },
   "devDependencies": {
+    "@sentry/node": "^5.9.0",
     "@types/jest": "^24.0.13",
     "@types/lodash.foreach": "^4.5.4",
     "@types/lodash.isempty": "^4.4.4",

src/index.ts

@@ -91,6 +91,10 @@ const defaultLogger = (options: AckeeLoggerOptions & { loggerName?: string } = {
         (pinoms as any).multistream(streams)
     ) as PinoLogger) as AckeeLogger;
 
+    if (options.sentryDsn) {
+        const sentry = require('@sentry/node');
+    }
+
     // Add maxLevel support to pino-multi-stream
     // This could be replaced with custom pass-through stream being passed to multistream, which would filter the messages
     const loggerStream = (logger as any)[(pino as any).symbols.streamSym] as any;

src/interfaces.ts

@@ -21,5 +21,6 @@ export interface AckeeLoggerOptions {
     ignoredHttpMethods?: string[];
     config?: LoggerOptions;
     pretty?: boolean;
+    sentryDsn?: string;
     skip?: (req: Request, res?: Response) => boolean;
 }

src/tests/sentry-mocked.test.ts

@@ -0,0 +1,8 @@
+import loggerFactory from '..';
+
+jest.mock('@sentry/node', () => {});
+
+test('can create logger with options', () => {
+    expect(() => loggerFactory()).not.toThrowError();
+    expect(() => loggerFactory({ sentryDsn: 'DSN' })).not.toThrowError();
+});

src/tests/sentry.test.ts

@@ -0,0 +1,12 @@
+import loggerFactory from '..';
+
+jest.mock('@sentry/node', () => {
+    throw new Error("Cannot find module '@sentry/node' from 'index.ts'");
+});
+
+test('without sentry lib works by default, but crashes on provided', () => {
+    expect(() => loggerFactory()).not.toThrowError();
+    expect(() => loggerFactory({ sentryDsn: 'DSN' })).toThrowErrorMatchingInlineSnapshot(
+        `"Cannot find module '@sentry/node' from 'index.ts'"`
+    );
+});