Add comments about where the information is coming

Author: Rui Marinho

lib/parsers.js

@@ -58,36 +58,81 @@ module.exports.parseQuery = function parseQuery(query, engine, kwargs) {
 module.exports.parseRequest = function parseRequest(req, kwargs) {
     kwargs = kwargs || {};
 
-    // headers
+    // headers:
+    //
+    //   node: req.headers
+    //   express: req.header
+    //   koa: req.header
+    //
     var headers = req.header || req.headers || {};
 
-    // method
+    // method:
+    //
+    //   node: req.method
+    //   express: req.method
+    //   koa: req.method
+    //
     var method = req.method;
 
-    // host
+    // host:
+    //
+    //   node: req.headers.host
+    //   express: req.host
+    //   koa: req.host
+    //
     var host = req.host || headers.host || '<no host>';
 
-    // protocol
+    // protocol:
+    //
+    //   node: <n/a>
+    //   express: req.protocol
+    //   koa: req.protocol
+    //
     var protocol = ('https' === req.protocol || true === req.secure || true === (req.socket || {}).encrypted ||
             ('https' === (headers['x-forwarded-proto'] || '').split(/\s*,\s*/)[0])) ||
-            (443 === Number(headers['x-forwarded-port'] || '')) ? 'https' : 'http';
+            ('443' === headers['x-forwarded-port'] || '') ? 'https' : 'http';
 
-    // url (including path and query string)
-    var originalUrl = req.url;
+    // url (including path and query string):
+    //
+    //   node: req.originalUrl
+    //   express: req.originalUrl
+    //   koa: req.url
+    //
+    var originalUrl = req.originalUrl || req.url;
 
     // absolute url
     var url = protocol + '://' + host + originalUrl;
 
     // query string
+    //
+    //   node: req.url (raw)
+    //   express: req.query
+    //   koa: req.query
+    //
     var query = req.query || urlParser.parse(originalUrl || '', true).query;
 
-    // cookies
+    // cookies:
+    //
+    //   node: req.headers.cookie
+    //   express: req.cookies (expressjs/cookies)
+    //   koa: req.headers.cookie
+    //
     var cookies = (isPlainObject(req.cookies) ? req.cookies : '' ) || cookie.parse(headers.cookie || headers.cookies || '');
 
-    // body data
+    // body data:
+    //
+    //   node: req.body
+    //   express: req.body
+    //   koa: req.body
+    //
     var data = req.body || '<unavailable>';
 
-    // client ip
+    // client ip:
+    //
+    //   node: req.connection.remoteAddress
+    //   express: req.ip
+    //   koa: req.ip
+    //
     var ip = req.ip || (headers['x-forwarded-for'] || '').split(/\s*,\s*/)[0] || (req.connection || {}).remoteAddress;
 
     // http interface

test/raven.parsers.js

@@ -387,6 +387,34 @@ describe('raven.parsers', function(){
       });
     });
 
+    describe('`url` detection', function() {
+      it('should detect url via `req.originalUrl`', function(){
+        var mockReq = {
+          method: 'GET',
+          protocol: 'https',
+          host: 'mattrobenolt.com',
+          originalUrl: '/some/path?key=value'
+        };
+
+        var parsed = raven.parsers.parseRequest(mockReq);
+
+        parsed['sentry.interfaces.Http'].url.should.equal('https://mattrobenolt.com/some/path?key=value');
+      });
+
+      it('should detect url via `req.url`', function(){
+        var mockReq = {
+          method: 'GET',
+          protocol: 'https',
+          host: 'mattrobenolt.com',
+          url: '/some/path?key=value'
+        };
+
+        var parsed = raven.parsers.parseRequest(mockReq);
+
+        parsed['sentry.interfaces.Http'].url.should.equal('https://mattrobenolt.com/some/path?key=value');
+      });
+    });
+
     describe('`body` detection', function() {
       it('should detect body via `req.body`', function(){
         var mockReq = {