🐛 Update extendSentry options and types

Author: Michal Vlasák

src/index.ts

@@ -195,6 +195,6 @@ const loggerFactory = (data: string | CosmasOptions = {}, loggerOptions: CosmasO
     return loggerProxy;
 };
 
-const factoryProxy = makeCallable(loggerFactory(), loggerFactory);
+const factoryProxy: CosmasFactory = makeCallable(loggerFactory(), loggerFactory);
 
 export default factoryProxy;

src/interfaces.ts

@@ -22,8 +22,6 @@ export interface CosmasOptions {
     ignoredHttpMethods?: string[];
     config?: LoggerOptions;
     pretty?: boolean;
-    sentry?: string | boolean;
-    sentryLevel?: pino.LevelWithSilent;
     loggerName?: string;
     skip?: (req: Request, res?: Response) => boolean;
 }

src/sentry.ts

@@ -23,18 +23,18 @@ const PINO_TO_SENTRY: { [key: number]: Severity } = {
     60: Severity.Critical,
 };
 
-export const extendSentry = (logger: Cosmas, dsn: string | true) => {
+export const extendSentry = (logger: Cosmas, options: { sentry: string | true; sentryLevel: number }) => {
     const sentry = require('@sentry/node');
-    if (typeof dsn === 'string') {
-        sentry.init({ dsn });
+    if (typeof options.sentry === 'string') {
+        sentry.init({ dsn: options.sentry });
     }
 
     const originalWrite = logger[streamSym].write;
     // unfortunately, this is the only place in pino, we can hook onto, where we can be sure all
     // the hooks, formatters and serializers are already applied
     logger[streamSym].write = function (s: string) {
         const obj = JSON.parse(s);
-        if (obj.level >= (logger.options.sentryLevel || levels.warn)) {
+        if (obj.level >= (options.sentryLevel || levels.warn)) {
             withScope((scope) => {
                 scope.setLevel(PINO_TO_SENTRY[obj.level]);
                 scope.setExtras(obj);

src/tests/sentry-mocked.test.ts

@@ -1,7 +1,8 @@
 import omit = require('omit-deep');
+import { CosmasFactory } from '../index';
 import { levels } from '../levels';
 
-let loggerFactory;
+let loggerFactory: CosmasFactory;
 let extendSentry;
 const scope: any = {};
 const withScope = jest.fn((fn) =>
@@ -53,9 +54,9 @@ describe('sentry mocked', () => {
     });
     test('can create logger with options', () => {
         expect(() => loggerFactory()).not.toThrowError();
-        expect(() => extendSentry(loggerFactory, true)).not.toThrowError();
+        expect(() => extendSentry(loggerFactory, { sentry: true })).not.toThrowError();
         expect(init).not.toHaveBeenCalled();
-        expect(() => extendSentry(loggerFactory, 'dummy')).not.toThrowError();
+        expect(() => extendSentry(loggerFactory, { sentry: 'dummy' })).not.toThrowError();
         expect(init.mock.calls[0]).toMatchInlineSnapshot(`
             Array [
               Object {
@@ -69,11 +70,11 @@ describe('sentry mocked', () => {
         const dateNow = Date.now;
         Date.now = jest.fn(() => 1520343036000);
         await new Promise((resolve, reject) => {
-            const logger = loggerFactory({
+            const logger = loggerFactory();
+            extendSentry(logger, {
                 sentry: 'DSN',
                 sentryLevel: levels.fatal,
             });
-            extendSentry(logger);
             captureMessage.mockImplementation(createCapture(resolve));
             // expect to trigger only fatal
             logger.trace('trace');
@@ -110,10 +111,8 @@ Object {
 
     test('sentry captureException with stack and correct levels', async () => {
         await new Promise((resolve, reject) => {
-            const logger = loggerFactory({
-                sentry: 'DSN',
-            });
-            extendSentry(logger);
+            const logger = loggerFactory();
+            extendSentry(logger, { sentry: 'DSN' });
             captureException.mockReset();
             captureException.mockImplementation(createCapture(resolve));
             logger.error(new Error());