First pass at keypress breadcrumbs

benvinegar · benvinegar · commit 149a6c9b86b5 · 2016-04-27T18:35:52.000-07:00
diff --git a/example/index.html b/example/index.html
@@ -3,7 +3,7 @@
 <head>
     <title>Scratch Disk</title>
 </head>
-<script src="../dist/raven.js"></script>
+<script src="../build/raven.js"></script>
 <!-- <script src="scratch.min.js"></script> -->
 <script src="scratch.js" crossorigin></script>
 <script src="file.min.js" crossorigin></script>
@@ -39,6 +39,7 @@
 <button onclick="throwString()">throw string</button>
 <button onclick="showDialog()">show dialog</button>
 <button onclick="blobExample()">blob example</button>
+<input/>
 
 </body>
 </html>
diff --git a/src/raven.js b/src/raven.js
@@ -19,6 +19,7 @@ var urlencode = utils.urlencode;
 var uuid4 = utils.uuid4;
 var htmlTreeAsString = utils.htmlTreeAsString;
 var parseUrl = utils.parseUrl;
+var debounce = utils.debounce;
 
 var dsnKeys = 'source protocol user pass host port path'.split(' '),
     dsnPattern = /^(?:(\w+):)?\/\/(?:(\w+)(:\w+)?@)?([\w\.-]+)(?::(\d+))?(\/.*)/;
@@ -618,7 +619,6 @@ Raven.prototype = {
         }
     },
 
-
     /**
      * Wraps addEventListener to capture UI breadcrumbs
      * @param evtName the event name (e.g. "click")
@@ -644,6 +644,17 @@ Raven.prototype = {
         };
     },
 
+    _keypressEventHandler: function() {
+        var self = this;
+
+        // TODO: if somehow user switches keypress target before
+        //       debounce timeout is triggered, we will only capture
+        //       a single breadcrumb from the LAST target (acceptable?)
+        return debounce(function (evt) {
+            self._breadcrumbEventHandler('keypress')(evt);
+        }, 500); // 500ms after last consecutive keypress, record breadcrumb
+    },
+
     /**
      * Captures a breadcrumb of type "navigation", normalizing input URLs
      * @param to the originating URL
@@ -727,8 +738,12 @@ Raven.prototype = {
 
                         // TODO: more than just click
                         var before;
-                        if ((global === 'EventTarget' || global === 'Node') && evt === 'click') {
-                            before = self._breadcrumbEventHandler(evt, fn);
+                        if (global === 'EventTarget' || global === 'Node') {
+                            if (evt === 'click'){
+                                before = self._breadcrumbEventHandler(evt, fn);
+                            } else if (evt === 'keypress') {
+                                before = self._keypressEventHandler();
+                            }
                         }
                         return orig.call(this, evt, self.wrap(fn, undefined, before), capture, secure);
                     };
@@ -764,6 +779,7 @@ Raven.prototype = {
         // to the document. Do this before we instrument addEventListener.
         if (this._hasDocument) {
             document.addEventListener('click', self._breadcrumbEventHandler('click'));
+            document.addEventListener('keypress', self._keypressEventHandler());
         }
 
         // event targets borrowed from bugsnag-js:
diff --git a/src/utils.js b/src/utils.js
@@ -153,6 +153,26 @@ function uuid4() {
     }
 }
 
+// Returns a function, that, as long as it continues to be invoked, will not
+// be triggered. The function will be called after it stops being called for
+// N milliseconds. If `immediate` is passed, trigger the function on the
+// leading edge, instead of the trailing.
+// https://davidwalsh.name/javascript-debounce-function
+function debounce(func, wait) {
+    var timeout;
+    return function() {
+        var context = this,
+            args = arguments;
+
+        var later = function() {
+            timeout = null;
+            func.apply(context, args);
+        };
+        clearTimeout(timeout);
+        timeout = setTimeout(later, wait);
+    };
+};
+
 /**
  * Given a child DOM element, returns a query-selector statement describing that
  * and its ancestors
@@ -245,6 +265,7 @@ module.exports = {
     joinRegExp: joinRegExp,
     urlencode: urlencode,
     uuid4: uuid4,
+    debounce: debounce,
     htmlTreeAsString: htmlTreeAsString,
     htmlElementAsString: htmlElementAsString,
     parseUrl: parseUrl
