Send /wsapi/stage_* events to the KPI backend.

* Add tests in tests/kpi-test.js to ensure both staging and completion events are added to the queue.

fixes mozilla#3920

lib/logging/transports/filters/metrics.js

@@ -12,13 +12,11 @@ const coarse = require('../../../coarse_user_agent_parser');
 var MessageMatches = {
   'signin': true,
   'verify': true
-  'complete_email_confirmation.success': true,
-  'complete_reset.success': true,
-  'complete_transition.success': true,
-  'complete_user_creation.success': true
 };
 
 var RegExpMatches = [
+  /complete_(?:[^\.]+)\.success/,
+  /stage_(?:[^\.]+)\.success/,
   /^metrics\.report\./
 ];
 

lib/logging/transports/metrics-kpi.js

@@ -29,7 +29,6 @@ MetricsKpiggybankTransport.prototype.log
   if ( ! filter.test(msg)) return callback(null, true);
   if ( ! config.get('kpi_send_metrics')) return callback(null, true);
 
-
   var entry = toEntry(msg, meta);
   this.queue.push(entry);
 
@@ -40,10 +39,15 @@ MetricsKpiggybankTransport.prototype.log
   callback(null, true);
 };
 
+MetricsKpiggybankTransport.prototype.getQueue = function() {
+  return this.queue;
+};
+
 function isQueueFull() {
   return this.queue.length >= MetricsKpiggybankTransport.BATCH_SIZE;
 }
 
+
 function clearQueue() {
   var kpis = this.queue;
   this.queue = [];

lib/wsapi/stage_email.js

@@ -91,6 +91,7 @@ exports.process = function(req, res) {
 
             res.json({ success: true });
             // let's now kick out a verification email!
+            logger.info('stage_email.success');
             email.sendConfirmationEmail(req.params.email, req.params.site, secret, langContext,
                 req.params.backgroundColor, req.params.siteLogo);
           });

lib/wsapi/stage_reset.js

@@ -71,6 +71,8 @@ exports.process = function(req, res) {
 
           res.json({ success: true });
 
+          logger.info('stage_reset.success');
+
           // let's now kick out a verification email!
           email.sendForgotPasswordEmail(req.params.email, req.params.site, secret, langContext,
               req.params.backgroundColor, req.params.siteLogo);

lib/wsapi/stage_reverify.js

@@ -56,6 +56,8 @@ exports.process = function(req, res) {
           req.session.pendingReverification = secret;
 
           res.json({ success: true });
+          logger.info('stage_reverify.success');
+
           // let's now kick out a verification email!
           email.sendConfirmationEmail(req.params.email, req.params.site, secret, langContext,
               req.params.backgroundColor, req.params.siteLogo);

lib/wsapi/stage_transition.js

@@ -81,6 +81,8 @@ exports.process = function(req, res) {
 
             res.json({ success: true });
 
+            logger.info('stage_transition.success');
+
             // let's now kick out a verification email!
             email.sendTransitionEmail(req.params.email, req.params.site, secret, langContext,
                 req.params.backgroundColor, req.params.siteLogo);

lib/wsapi/stage_user.js

@@ -109,6 +109,7 @@ exports.process = function(req, res) {
             req.session.pendingCreation = secret;
 
             res.json({ success: true });
+            logger.info('stage_user.success');
 
             // let's now kick out a verification email!
             email.sendNewUserEmail(req.params.email, req.params.site, secret, langContext,

tests/kpi-test.js

@@ -12,7 +12,7 @@ const config = require('../lib/configuration');
 const kpi_data = require('../lib/kpi_data');
 const HttpMock = require('./lib/http-mock');
 const logger = require('../lib/logging/logging').logger;
-
+const KpiTransport = require('../lib/logging/transports/metrics-kpi');
 
 require('./lib/test_env');
 
@@ -133,6 +133,52 @@ suite.addBatch({
   }
 });
 
+function noOp() {}
+
+suite.addBatch({
+  "staging and verification events": {
+    topic: function() {
+      this.origSendMetricsValue = config.get('kpi_send_metrics');
+      this.expectedEvents = [
+        'stage_email.success',
+        'stage_reset.success',
+        'stage_reverify.success',
+        'stage_transition.success',
+        'stage_user.success',
+        'complete_email_confirmation.success',
+        'complete_reset.success',
+        'complete_transition.success',
+        'complete_user_creation.success'
+      ];
+      config.set('kpi_send_metrics', true);
+
+      var kpiTransport = new KpiTransport();
+
+      this.expectedEvents.forEach(function(event) {
+        kpiTransport.log('info', event, null, noOp);
+      });
+
+      return kpiTransport.getQueue();
+    },
+    "are added to the KPI queue": function(queue) {
+      var expectedEvents = this.expectedEvents;
+
+      // The test here is a bit backwards. Take the original set of events to
+      // test and remove the events that have been added to the queue. Hope
+      // that none remain.
+      queue.forEach(function(kpi) {
+        var eventName = kpi.event_name;
+        var index = expectedEvents.indexOf(eventName);
+        expectedEvents.splice(index, 1);
+      });
+      assert.equal(expectedEvents.length, 0);
+    },
+    "reset kpi_send_metrics": function() {
+      config.set('kpi_send_metrics', this.origSendMetricsValue);
+    }
+  }
+});
+
 start_stop.addShutdownBatches(suite);
 
 // run or export the suite.