fix: skip Sentry.addBreadcrumb when breadcrumb data is empty (MD-05)

Author: w01fgang

.changeset/md-05-skip-empty-breadcrumb.md

@@ -0,0 +1,5 @@
+---
+'@power-rent/try-catch': patch
+---
+
+Fix MD-05: `.breadcrumbs(...)` no longer invokes the reporter's `addBreadcrumbs` (`Sentry.addBreadcrumb`) when the extracted data is empty (e.g. `.breadcrumbs([])`, transformer errors, or extraction against a primitive). Empty breadcrumb events are now suppressed rather than recorded as no-op entries.

src/__tests__/Try.test.ts

@@ -406,6 +406,7 @@ describe('Try', () => {
         .unwrap();
 
       await expect(exec).rejects.toThrow('validation error');
+      expect(Sentry.captureException).not.toHaveBeenCalled();
     });
 
     it('should not give typescript error', async () => {
@@ -1242,6 +1243,7 @@ describe('Try', () => {
           .report('failed')
           .unwrap();
       }).toThrow('validation error');
+      expect(Sentry.captureException).not.toHaveBeenCalled();
     });
 
     it('should not give typescript error', () => {
@@ -1891,7 +1893,7 @@ describe('Try', () => {
 
     it('async unwrap: breadcrumbs called once when .breadcrumbs() configured', async () => {
       await expect(
-        new Try(async () => { throw new Error('boom'); })
+        new Try(async (_p: { x: number }) => { throw new Error('boom'); }, { x: 1 })
           .breadcrumbs(['x'])
           .unwrap()
       ).rejects.toThrow('boom');
@@ -1900,31 +1902,31 @@ describe('Try', () => {
 
     it('sync unwrap: breadcrumbs called once when .breadcrumbs() configured', () => {
       expect(() =>
-        new Try(() => { throw new Error('boom'); })
+        new Try((_p: { x: number }) => { throw new Error('boom'); }, { x: 1 })
           .breadcrumbs(['x'])
           .unwrap()
       ).toThrow('boom');
       expect(mockAddBreadcrumbs).toHaveBeenCalledTimes(1);
     });
 
     it('async error(): breadcrumbs called once; returns normalized Error', async () => {
-      const err = await new Try(async () => { throw new Error('boom'); })
+      const err = await new Try(async (_p: { x: number }) => { throw new Error('boom'); }, { x: 1 })
         .breadcrumbs(['x'])
         .error();
       expect(mockAddBreadcrumbs).toHaveBeenCalledTimes(1);
       expect(err).toBeInstanceOf(Error);
     });
 
     it('sync error(): breadcrumbs called once; returns normalized Error', () => {
-      const err = new Try(() => { throw new Error('boom'); })
+      const err = new Try((_p: { x: number }) => { throw new Error('boom'); }, { x: 1 })
         .breadcrumbs(['x'])
         .error();
       expect(mockAddBreadcrumbs).toHaveBeenCalledTimes(1);
       expect(err).toBeInstanceOf(Error);
     });
 
     it('result(): breadcrumbs called once on failure', async () => {
-      const r = await new Try(async () => { throw new Error('boom'); })
+      const r = await new Try(async (_p: { x: number }) => { throw new Error('boom'); }, { x: 1 })
         .breadcrumbs(['x'])
         .result();
       expect(r.success).toBe(false);
@@ -1933,7 +1935,7 @@ describe('Try', () => {
 
     it('.report().breadcrumbs(): addBreadcrumbs called exactly once total (no double-add)', async () => {
       await expect(
-        new Try(async () => { throw new Error('boom'); })
+        new Try(async (_p: { x: number }) => { throw new Error('boom'); }, { x: 1 })
           .report('msg')
           .breadcrumbs(['x'])
           .unwrap()

src/__tests__/flexible-breadcrumbs.test.ts

@@ -45,12 +45,8 @@ describe('Flexible Breadcrumbs System', () => {
 
       await new Try(throwingFunction, params).breadcrumbs([]).value();
 
-      expect(Sentry.addBreadcrumb).toHaveBeenCalledWith(
-        expect.objectContaining({
-          message: 'Calling throwingFunction function',
-          data: {},
-        }),
-      );
+      // Empty extracted data should short-circuit the reporter call.
+      expect(Sentry.addBreadcrumb).not.toHaveBeenCalled();
     });
   });
 
@@ -332,12 +328,8 @@ describe('Flexible Breadcrumbs System', () => {
         'Error in breadcrumb transformer:',
         expect.any(Error),
       );
-      expect(Sentry.addBreadcrumb).toHaveBeenCalledWith(
-        expect.objectContaining({
-          message: 'Calling testFunction function',
-          data: {}, // Empty data due to transformer error
-        }),
-      );
+      // Transformer error yields empty data — reporter call is short-circuited.
+      expect(Sentry.addBreadcrumb).not.toHaveBeenCalled();
 
       consoleSpy.mockRestore();
     });
@@ -363,12 +355,8 @@ describe('Flexible Breadcrumbs System', () => {
         .value();
 
       expect(consoleSpy).not.toHaveBeenCalled();
-      expect(Sentry.addBreadcrumb).toHaveBeenCalledWith(
-        expect.objectContaining({
-          message: 'Calling testFunction function',
-          data: {}, // Empty data due to transformer error
-        }),
-      );
+      // Transformer error yields empty data — reporter call is short-circuited.
+      expect(Sentry.addBreadcrumb).not.toHaveBeenCalled();
 
       consoleSpy.mockRestore();
     });
@@ -409,12 +397,8 @@ describe('Flexible Breadcrumbs System', () => {
         .breadcrumbs([{ param: 0, keys: ['nonExistentKey'] } as any])
         .value();
 
-      expect(Sentry.addBreadcrumb).toHaveBeenCalledWith(
-        expect.objectContaining({
-          message: 'Calling testFunction function',
-          data: {}, // Empty because param 0 is not an object
-        }),
-      );
+      // No keys extracted from a primitive — reporter call is short-circuited.
+      expect(Sentry.addBreadcrumb).not.toHaveBeenCalled();
     });
   });
 
@@ -451,12 +435,8 @@ describe('Flexible Breadcrumbs System', () => {
 
       await new Try(testFunction, 'test').debug(false).breadcrumbs([]).value();
 
-      expect(Sentry.addBreadcrumb).toHaveBeenCalledWith(
-        expect.objectContaining({
-          message: 'Calling testFunction function',
-          data: {},
-        }),
-      );
+      // Empty config yields empty data — reporter call is short-circuited.
+      expect(Sentry.addBreadcrumb).not.toHaveBeenCalled();
     });
 
     it('should handle mixed valid and invalid extractors', async () => {
@@ -544,12 +524,8 @@ describe('Flexible Breadcrumbs System', () => {
 
       await new Try(noParams).debug(false).breadcrumbs([]).value();
 
-      expect(Sentry.addBreadcrumb).toHaveBeenCalledWith(
-        expect.objectContaining({
-          message: 'Calling noParams function',
-          data: {},
-        }),
-      );
+      // No data extracted — reporter call is short-circuited.
+      expect(Sentry.addBreadcrumb).not.toHaveBeenCalled();
     });
 
     it('should handle anonymous functions properly', async () => {

src/core/Try.ts

@@ -849,6 +849,14 @@ export class Try<
       this.local.breadcrumbData = this.extractAllBreadcrumbData();
     }
 
+    // Skip the reporter call when no data was extracted. Do not set the
+    // idempotence guard here — `breadcrumbConfig` is immutable on a single
+    // instance, so "empty now" implies "empty on any retry" and there is
+    // no double-recording risk from leaving the guard unset.
+    if (Object.keys(this.local.breadcrumbData).length === 0) {
+      return;
+    }
+
     const functionName = this.fn.name || 'anonymous';
 
     Try.defaultReporter.addBreadcrumbs(this.local.breadcrumbData, functionName);