feat: allow to pass our own addBreadcrumb

BREAKING CHANGE: requires that user pass their own addBreadcrumb
gajus · Oct 21, 2022 · 3ce8a26 · 3ce8a26
1 parent d681c02
commit 3ce8a26
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 48 deletions.
diff --git a/README.md b/README.md
@@ -15,13 +15,23 @@ Sentry [breadcrumbs](https://sentry.io/features/breadcrumbs/) allow one to trace
 ## Usage
 
 ```js
+import {
+  getCurrentHub,
+} from '@sentry/node';
 import {
   createRoarrSentryIntegration,
 } from '@roarr/sentry';
 
 createSentry({
   integrations: [
-    createRoarrSentryIntegration(),
+    createRoarrSentryIntegration({
+      addBreadcrumb: (breadcrumb) => {
+        // Your implementation might vary
+        const hub = getCurrentHub();
+
+        hub.addBreadcrumb(breadcrumb);
+      },
+    }),
   ],
 });
 

diff --git a/package.json b/package.json
@@ -25,14 +25,14 @@
     "ava": "^3.15.0",
     "coveralls": "^3.1.1",
     "del-cli": "^4.0.1",
-    "eslint": "^8.3.0",
-    "eslint-config-canonical": "^32.42.0",
+    "eslint": "^8.25.0",
+    "eslint-config-canonical": "^32.49.1",
     "husky": "^7.0.4",
     "nyc": "^15.1.0",
     "semantic-release": "^18.0.1",
     "sinon": "^12.0.1",
     "ts-node": "^10.4.0",
-    "typescript": "^4.5.2"
+    "typescript": "^4.8.4"
   },
   "engines": {
     "node": ">=10.0"

diff --git a/src/factories/createRoarrSentryIntegration.ts b/src/factories/createRoarrSentryIntegration.ts
@@ -1,15 +1,12 @@
-import type {
-  EventProcessor,
-  Hub,
-  Integration,
-  SeverityLevel,
+import {
+  type Breadcrumb,
+  type Integration,
+  type SeverityLevel,
 } from '@sentry/types';
-import type {
-  LogLevelName,
-} from 'roarr';
 import {
   ROARR,
   getLogLevelName,
+  type LogLevelName,
 } from 'roarr';
 
 const getSeverity = (logLevelName: LogLevelName): SeverityLevel => {
@@ -28,19 +25,21 @@ const getSeverity = (logLevelName: LogLevelName): SeverityLevel => {
   }
 };
 
-export const createRoarrSentryIntegration = () => {
+export const createRoarrSentryIntegration = ({
+  addBreadcrumb,
+}: {
+  addBreadcrumb: (breadcrumb: Breadcrumb) => void,
+}) => {
   return new class CaptureRoarr implements Integration {
     public name: string = 'CaptureRoarr';
 
-    public setupOnce = (addGlobalEventProcessor: (callback: EventProcessor) => void, getCurrentHub: () => Hub) => {
+    public setupOnce = () => {
       const originalWrite = ROARR.write;
 
       ROARR.write = (jsonMessage: string) => {
-        const hub = getCurrentHub();
-
         const message = JSON.parse(jsonMessage);
 
-        hub.addBreadcrumb(
+        addBreadcrumb(
           {
             category: message.context.namespace,
             data: {

diff --git a/test/roarr-sentry/factories/createRoarrSentryIntegration.ts b/test/roarr-sentry/factories/createRoarrSentryIntegration.ts
@@ -10,19 +10,20 @@ import {
 } from '../../../src/factories/createRoarrSentryIntegration';
 
 test('creates class with CaptureRoarr constructor name', (t) => {
-  t.is(createRoarrSentryIntegration().constructor.name, 'CaptureRoarr');
+  t.is(createRoarrSentryIntegration({
+    addBreadcrumb: () => {},
+  }).constructor.name, 'CaptureRoarr');
 });
 
 const noop = (): any => {};
 
 test('overrides ROARR.write method', (t) => {
   const originalWrite = ROARR.write;
 
-  createRoarrSentryIntegration()
-    .setupOnce(
-      noop,
-      noop,
-    );
+  createRoarrSentryIntegration({
+    addBreadcrumb: () => {},
+  })
+    .setupOnce();
 
   t.not(ROARR.write, originalWrite);
 });
@@ -32,15 +33,10 @@ test('passes-through calls to ROARR.write', (t) => {
 
   ROARR.write = spy;
 
-  createRoarrSentryIntegration()
-    .setupOnce(
-      noop,
-      (): any => {
-        return {
-          addBreadcrumb: () => {},
-        };
-      },
-    );
+  createRoarrSentryIntegration({
+    addBreadcrumb: () => {},
+  })
+    .setupOnce();
 
   const payload = JSON.stringify({
     context: {
@@ -55,23 +51,14 @@ test('passes-through calls to ROARR.write', (t) => {
 });
 
 test('adds logs to breadcrumbs', (t) => {
-  const spy = sinon.stub();
+  const addBreadcrumb = sinon.stub();
 
-  ROARR.write = spy;
-
-  const hub = {
-    addBreadcrumb: () => {},
-  };
+  ROARR.write = () => {};
 
-  const addBreadcrumbSpy = sinon.spy(hub, 'addBreadcrumb');
-
-  createRoarrSentryIntegration()
-    .setupOnce(
-      noop,
-      (): any => {
-        return hub;
-      },
-    );
+  createRoarrSentryIntegration({
+    addBreadcrumb,
+  })
+    .setupOnce();
 
   const payload = JSON.stringify({
     context: {
@@ -82,7 +69,7 @@ test('adds logs to breadcrumbs', (t) => {
 
   ROARR.write(payload);
 
-  t.like(addBreadcrumbSpy.firstCall.firstArg, {
+  t.like(addBreadcrumb.firstCall.firstArg, {
     category: 'bar',
     data: {
       context: {