Bug 1025805 multiple RIDs over time

app/db/user/index.js

@@ -1,6 +1,10 @@
 module.exports = function (sequelize) {
   var hatchet = require('hatchet');
   var model = sequelize.import(__dirname + '/model.js');
+  var modelReferrerCode = sequelize.import(__dirname + '/modelreferrercode.js');
+
+  model.hasMany(modelReferrerCode);
+  modelReferrerCode.belongsTo(model);
 
   return {
 
@@ -94,7 +98,6 @@ module.exports = function (sequelize) {
         subscribeToWebmakerList: data.mailingList,
         username: data.username.toLowerCase(),
         lastLoggedIn: new Date(),
-        referrer: data.referrer,
         prefLocale: data.prefLocale
       });
 
@@ -115,7 +118,6 @@ module.exports = function (sequelize) {
           username: user.getDataValue("username"),
           email: user.getDataValue("email"),
           locale: user.getDataValue("prefLocale"),
-          referrer: user.getDataValue("referrer"),
           subscribeToWebmakerList: user.getDataValue("subscribeToWebmakerList")
         });
 
@@ -202,6 +204,48 @@ module.exports = function (sequelize) {
       model.findAll({
         where: { "email": emails }
       }).complete( callback );
+    },
+
+    /**
+     * engagedWithReferrerCode( email, data, userStatus, callback )
+     * -
+     * email: email address
+     * referrerCode: referrer code
+     * userStatus: enum ['new', 'existing']
+     * callback: function( err )
+     */
+    engagedWithReferrerCode: function ( email, referrerCode, userStatus, callback ) {
+      if ( !referrerCode ) {
+        return callback();
+      }
+
+      this.getUserByEmail( email, function( err, user ) {
+        if ( err ) {
+          return callback( err );
+        }
+
+        if ( !user  ) {
+          return callback( new Error ("User not found!") );
+        }
+
+        var desiredRecord = {
+          UserId: user.id,
+          referrer: referrerCode
+        };
+
+        // Using findOrCreate() so we only have one record per campaign + user
+        // but the updatedAt field can change with multiple interactions
+        modelReferrerCode.findOrCreate(desiredRecord, desiredRecord).success(function(referrercode, created) {
+          if (created) {
+            // this was new and has now been saved
+            referrercode.userStatus = userStatus;
+            referrercode.save().complete( callback );
+          } else {
+            // save this again to update the autogenerated updatedAt field
+            referrercode.save().complete( callback );
+          }
+        });
+      });
     }
   };
 };

app/db/user/model.js

@@ -106,10 +106,6 @@ module.exports = function( sequelize, DataTypes ) {
       type: DataTypes.BOOLEAN,
       defaultValue: false
     },
-    referrer: {
-      type: DataTypes.STRING,
-      allowNull: true
-    },
     bio: {
       type: DataTypes.STRING,
       validate: {

app/db/user/modelreferrercode.js

@@ -0,0 +1,17 @@
+/**
+ * Exports
+ */
+module.exports = function( sequelize, DataTypes ) {
+  return sequelize.define( "ReferrerCode", {
+    referrer: {
+      type: DataTypes.STRING
+    },
+    userStatus: {
+      type: DataTypes.ENUM,
+      values: ['new', 'existing']
+    }
+  }, {
+    charset: 'utf8',
+    collate: 'utf8_general_ci'
+  });
+};

app/http/middleware.js

@@ -86,3 +86,20 @@ module.exports.updateLastLoggedIn = function(User) {
     });
   };
 };
+
+module.exports.engagedWithReferrerCode = function(User, options) {
+  return function(req, res, next) {
+
+    // the referrer value is only passed in if the cookie exists client-side
+    if (req.body.user && req.body.user.referrer) {
+
+      User.engagedWithReferrerCode( res.locals.email, req.body.user.referrer, options.userStatus,
+        function( err ) {
+        //TODO do something useful if this error happens
+        process.nextTick(next);
+      });
+    }
+
+    process.nextTick(next);
+  };
+};

app/http/routes.js

@@ -92,6 +92,7 @@ module.exports = function( http, userHandle, webmakerAuth ){
     middleware.personaVerifier,
     routes.user2.authenticateUser( userHandle ),
     middleware.updateLastLoggedIn( userHandle ),
+    middleware.engagedWithReferrerCode( userHandle, {"userStatus": "existing"} ),
     middleware.filterUserAttributesForSession,
     routes.user2.outputUser
   );
@@ -101,6 +102,7 @@ module.exports = function( http, userHandle, webmakerAuth ){
     middleware.personaVerifier,
     routes.user2.createUser( userHandle ),
     middleware.updateLastLoggedIn( userHandle ),
+    middleware.engagedWithReferrerCode( userHandle, {"userStatus": "new"} ),
     middleware.filterUserAttributesForSession,
     routes.user2.outputUser
   );

migrations/2014-08-01-A-ReferrerCodes.sql

@@ -0,0 +1,4 @@
+# Create the new table, then migrate the existing data
+CREATE TABLE `ReferrerCodes` (`id` INTEGER PRIMARY KEY AUTOINCREMENT, `referrer` VARCHAR(255), `userStatus` TEXT, `createdAt` DATETIME NOT NULL, `updatedAt` DATETIME NOT NULL, `UserId` INTEGER);
+INSERT INTO `ReferrerCodes` (`referrer`, `userStatus`, `createdAt`, `updatedAt`, `UserId`)
+ SELECT referrer, 'new' as userStatus, createdAt, createdAt, id FROM Users WHERE referrer IS NOT NULL;

migrations/2014-08-01-B-drop-referrer-col.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `Users`
+  DROP COLUMN `referrer`;