server/web/middlewares/track-login-for-provider.js

   1 'use strict';
   2
   3 var env = require('gitter-web-env');
   4 var stats = env.stats;
   5
   6 /** TODO move onto its own method once we find the need for it elsewhere
   7  * isRelativeURL() checks if the URL is relative
   8  *
   9  * url      String - the url to be check
  10  * @return  Boolean - the result of the check
  11  */
  12 function isRelativeURL(url) {
  13   var relativeUrl = new RegExp('^/[^/]');
  14   return relativeUrl.test(url);
  15 }
  16
  17 // Stop random input from being tracked
  18 const ACTION_ALLOWLIST = ['signup', 'login'];
  19 function validateAction(inputAction) {
  20   return ACTION_ALLOWLIST.includes(inputAction);
  21 }
  22
  23 module.exports = function trackLoginForProvider(provider) {
  24   return function(req, res, next) {
  25     var query = req.query;
  26
  27     // adds the source of the action to the session (for tracking how users
  28     // 'come in' to the app)
  29     req.session.source = query.source;
  30
  31     // checks if we have a relative url path and adds it to the session
  32     if (query.returnTo && isRelativeURL(query.returnTo)) {
  33       req.session.returnTo = query.returnTo;
  34     }
  35
  36     //send data to stats service
  37     if (query.action && validateAction(query.action)) {
  38       stats.event(query.action + '_clicked', {
  39         method: provider + '_oauth',
  40         button: query.source
  41       });
  42     }
  43     next();
  44   };
  45 };