✨ Use CLS for sentry scope edit

Author: Michal Vlasák

package.json

@@ -32,6 +32,7 @@
   "dependencies": {
     "@types/express": "^4.16.0",
     "@types/pino": "^6.3.1",
+    "cls-hooked": "^4.2.2",
     "lodash.foreach": "^4.5.0",
     "lodash.isempty": "^4.4.0",
     "lodash.isobject": "^3.0.2",

src/sentry.ts

@@ -1,8 +1,13 @@
-import { captureException, captureMessage, Severity, withScope } from '@sentry/node';
+import { captureException, captureMessage, Scope, Severity, withScope } from '@sentry/node';
+import { createNamespace } from 'cls-hooked';
 import * as pino from 'pino';
 import { Cosmas } from '.';
 import { levels } from './levels';
 
+const clsNamespace = createNamespace('cosmas.sentryExtend');
+
+type SentryCallback = (scope: Scope) => void;
+
 const reportToSentry = (obj: any) => {
     if (!obj.stack) {
         return captureMessage(obj.message || obj);
@@ -36,10 +41,27 @@ export const extendSentry = (logger: Cosmas, options: { sentry: string | true; s
         originalWrite.call(this, s);
         const obj = JSON.parse(s);
         if (obj.level < (options.sentryLevel || levels.warn)) return;
+        const sentryCallback: SentryCallback | undefined = clsNamespace.get('sentryCallback');
         withScope((scope) => {
             scope.setLevel(PINO_TO_SENTRY[obj.level]);
             scope.setExtras(obj);
+            if (sentryCallback) sentryCallback(scope);
             reportToSentry(obj);
         });
     };
+
+    logger.realHooks.logMethod = function (inputArgs, method) {
+        // 2nd argument is Sentry options
+        const sentryCallback: SentryCallback | undefined = inputArgs[1];
+        // TODO: automatic type for 2nd log method arg
+
+        if (!sentryCallback) {
+            return method.apply(this, inputArgs);
+        }
+
+        clsNamespace.runAndReturn(() => {
+            clsNamespace.set('sentryCallback', sentryCallback);
+            return method.apply(this, inputArgs);
+        });
+    };
 };

src/tests/sentry-mocked.test.ts

@@ -1,3 +1,4 @@
+import { Scope } from '@sentry/node';
 import omit = require('omit-deep');
 import { CosmasFactory } from '../index';
 import { levels } from '../levels';
@@ -16,6 +17,9 @@ const withScope = jest.fn((fn) =>
         setLevel: (level: any) => {
             scope.level = level;
         },
+        setTags: (val: any) => {
+            scope.tags = val;
+        },
     })
 );
 
@@ -93,19 +97,19 @@ describe('sentry mocked', () => {
         `);
         expect(captureMessage.mock.results[0].value.scope.extras['cosmas.pkgVersion']).toBeDefined();
         expect(omit(captureMessage.mock.results[0].value, 'cosmas.pkgVersion')).toMatchInlineSnapshot(`
-Object {
-  "data": "fatal",
-  "scope": Object {
-    "extras": Object {
-      "level": 60,
-      "message": "fatal",
-      "severity": "CRITICAL",
-      "time": "2018-03-06T13:30:36.000Z",
-    },
-    "level": "critical",
-  },
-}
-`);
+            Object {
+              "data": "fatal",
+              "scope": Object {
+                "extras": Object {
+                  "level": 60,
+                  "message": "fatal",
+                  "severity": "CRITICAL",
+                  "time": "2018-03-06T13:30:36.000Z",
+                },
+                "level": "critical",
+              },
+            }
+        `);
         Date.now = dateNow;
     });
 
@@ -126,4 +130,46 @@ Object {
             },
         });
     });
+
+    test('can pass sentry tags', async () => {
+        const dateNow = Date.now;
+        Date.now = jest.fn(() => 1520343036000);
+        await new Promise((resolve, reject) => {
+            const logger = loggerFactory();
+            extendSentry(logger, { sentry: 'DSN' });
+            captureMessage.mockImplementation(createCapture(resolve));
+            logger.fatal('sentryfatal', (scope: Scope) => {
+                scope.setContext('dummyContext', { foo: 'bar' });
+                scope.setTags({ first: 'firstTag' });
+                scope.setExtras({ extra: 'extraValue' });
+            });
+        });
+        expect(captureMessage).toHaveBeenCalledTimes(1);
+        expect(captureException).not.toHaveBeenCalled();
+        expect(captureMessage.mock.calls[0]).toMatchInlineSnapshot(`
+            Array [
+              "sentryfatal",
+            ]
+        `);
+        expect(omit(captureMessage.mock.results[0].value, 'cosmas.pkgVersion')).toMatchInlineSnapshot(`
+            Object {
+              "data": "sentryfatal",
+              "scope": Object {
+                "context": Object {
+                  "dummyContext": Object {
+                    "foo": "bar",
+                  },
+                },
+                "extras": Object {
+                  "extra": "extraValue",
+                },
+                "level": "critical",
+                "tags": Object {
+                  "first": "firstTag",
+                },
+              },
+            }
+        `);
+        Date.now = dateNow;
+    });
 });