Add request duration in Sentry logs (getodk#723)

* add request duration in Sentry logs

* configure scope instead of polluting request header

* using sentry from the container

Author: sadiqkhoja

lib/external/sentry.js

@@ -8,7 +8,7 @@
 // except according to the terms contained in the LICENSE file.
 
 const { inspect } = require('util');
-const { isBlank, isPresent } = require('../util/util');
+const { isBlank, isPresent, noop } = require('../util/util');
 
 
 // Endpoints where query strings are sensitive and should be removed
@@ -91,6 +91,7 @@ const sanitizeEventRequest = (event) => {
       // filter out access tokens embedded in URLs
       event.request.url = filterTokenFromUrl(event.request.url);
     }
+
   }
 
   /* eslint-enable no-param-reassign */
@@ -110,7 +111,8 @@ const init = (config) => {
         process.stderr.write('attempted to log Sentry exception in development:\n');
         process.stderr.write(inspect(err));
         process.stderr.write('\n');
-      }
+      },
+      configureScope: noop
     };
   }
 
@@ -122,6 +124,10 @@ const init = (config) => {
     beforeSend(event, hint) {
       const sanitizedEvent = sanitizeEventRequest(event);
 
+      if (sanitizedEvent.extra && sanitizedEvent.extra.startTimestamp) { // just an extra safety check. this should be always true
+        sanitizedEvent.extra.duration = Date.now() - sanitizedEvent.extra.startTimestamp;
+      }
+
       // only file the event if it is a bare exception or it is a true 500.x Problem.
       const error = hint.originalException;
       if (error == null) return sanitizedEvent; // we aren't sure why there isn't an exception; pass through.

lib/http/service.js

@@ -11,7 +11,6 @@
 // defined elsewhere into an actual Express service. The only thing it needs in
 // order to do this is a valid dependency injection context container.
 
-
 module.exports = (container) => {
   const service = require('express')();
 
@@ -21,6 +20,13 @@ module.exports = (container) => {
   // apply the Sentry request hook.
   service.use(container.Sentry.Handlers.requestHandler());
 
+  service.use((req, res, next) => {
+    container.Sentry.configureScope(scope => {
+      scope.setExtra('startTimestamp', Date.now());
+    });
+    next();
+  });
+
   // automatically parse JSON if it is marked as such. otherwise, just pull the
   // plain-text body contents.
   const bodyParser = require('body-parser');

test/unit/external/sanitize-sentry.js

@@ -548,6 +548,7 @@ const filteredTokenUrls = [
 
 describe('external: sanitize-sentry', () => {
   it('removes sensitive data from request objects ', () => {
+
     for (const [input, expectedOutput] of cases) {
       sanitizeEventRequest({ request: input }).should.eql({ request: expectedOutput });
     }