test: Add DOM events breadcrumbHint test (getsentry#2468)

kamilogorek · web-flow · commit 708bac401137 · 2020-03-04T11:55:33.000+01:00
diff --git a/packages/browser/test/integration/common/init.js b/packages/browser/test/integration/common/init.js
@@ -16,7 +16,9 @@ var originalBuiltIns = {
 };
 
 var events = [];
+var eventHints = [];
 var breadcrumbs = [];
+var breadcrumbHints = [];
 
 // Oh dear IE10...
 var dsn =
@@ -33,11 +35,12 @@ function initSDK() {
     attachStacktrace: true,
     ignoreErrors: ["ignoreErrorTest"],
     blacklistUrls: ["foo.js"],
-    beforeSend: function(event) {
+    beforeSend: function(event, eventHint) {
       events.push(event);
+      eventHints.push(eventHint);
       return event;
     },
-    beforeBreadcrumb: function(breadcrumb) {
+    beforeBreadcrumb: function(breadcrumb, breadcrumbHint) {
       // Filter console logs as we use them for debugging *a lot* and they are not *that* important
       // But allow then if we explicitly say so (for one of integration tests)
       if (
@@ -69,6 +72,7 @@ function initSDK() {
       }
 
       breadcrumbs.push(breadcrumb);
+      breadcrumbHints.push(breadcrumbHint);
       return breadcrumb;
     },
   });
diff --git a/packages/browser/test/integration/suites/breadcrumbs.js b/packages/browser/test/integration/suites/breadcrumbs.js
@@ -330,6 +330,28 @@ describe("breadcrumbs", function() {
     });
   });
 
+  it("should provide a hint for dom events that includes event name and event itself", function() {
+    return runInSandbox(sandbox, function() {
+      var input = document.getElementsByTagName("input")[0];
+      var clickHandler = function() {};
+      input.addEventListener("click", clickHandler);
+      var click = new MouseEvent("click");
+      input.dispatchEvent(click);
+      Sentry.captureMessage("test");
+    }).then(function(summary) {
+      if (IS_LOADER) {
+        // The async loader doesn't wrap event listeners, but we should receive the event without breadcrumbs
+        assert.lengthOf(summary.events, 1);
+      } else {
+        assert.equal(summary.breadcrumbHints.length, 1);
+        assert.equal(summary.breadcrumbHints[0].name, "click");
+        assert.equal(summary.breadcrumbHints[0].event.target.tagName, "INPUT");
+        // There should be no expection, if there is one it means we threw it
+        assert.isUndefined(summary.events[0].exception);
+      }
+    });
+  });
+
   it("should not fail with click or keypress handler with no callback", function() {
     return runInSandbox(sandbox, function() {
       var input = document.getElementsByTagName("input")[0];
diff --git a/packages/browser/test/integration/suites/helpers.js b/packages/browser/test/integration/suites/helpers.js
@@ -42,7 +42,9 @@ function runInSandbox(sandbox, options, code) {
   var finalize = function() {
     var summary = {
       events: events,
+      eventHints: eventHints,
       breadcrumbs: breadcrumbs,
+      breadcrumbHints: breadcrumbHints,
       window: window,
     };
 
