fix: add confirmationType to confirmation token, and filter by type when returning invites (#681)

* fix: add confirmationType to confirmation token, and filter by type when returning invites

* fix: fix failing test

Author: pierreTklein

constants/general.constant.js

@@ -28,9 +28,16 @@ const HACKER_STATUSES = [
 // This date is Jan 6, 2020 00:00:00 GMT -0500
 const APPLICATION_CLOSE_TIME = 1578286800000;
 
+const CONFIRMATION_TYPE_INVITE = "Invite";
+const CONFIRMATION_TYPE_ORGANIC = "Organic";
+const CONFIRMATION_TYPES = [
+    CONFIRMATION_TYPE_INVITE,
+    CONFIRMATION_TYPE_ORGANIC
+];
+
 const TRAVEL_STATUS_NONE = "None"; // Hacker has not been offered compensation for travelling
 const TRAVEL_STATUS_BUS = "Bus"; // Hacker is taking bus to hackathon
-const TRAVEL_STATUS_POLICY = "Policy"; // Hacker has been offer some reimbursement, but we are waiting for hacker to accept travel policy first  
+const TRAVEL_STATUS_POLICY = "Policy"; // Hacker has been offer some reimbursement, but we are waiting for hacker to accept travel policy first
 const TRAVEL_STATUS_OFFERED = "Offered"; // Hacker has been offered some amount of compensation for travelling, but we have not verified their reciepts yet
 const TRAVEL_STATUS_VALID = "Valid"; // Hacker has been offered some amount of compensation for travelling and have uploaded reciepts which we have confirmed to be an approprate amount
 const TRAVEL_STATUS_INVALID = "Invalid"; // Hacker has been offered some amount of compensation for travelling but have uploaded reciepts which we have confirmed to be an inapproprate amount
@@ -213,5 +220,8 @@ module.exports = {
     CACHE_KEY_STATS: CACHE_KEY_STATS,
     MAX_TEAM_SIZE: MAX_TEAM_SIZE,
     WEEK_OF: WEEK_OF,
-    SAMPLE_DIET_RESTRICTIONS: SAMPLE_DIET_RESTRICTIONS
+    SAMPLE_DIET_RESTRICTIONS: SAMPLE_DIET_RESTRICTIONS,
+    CONFIRMATION_TYPES: CONFIRMATION_TYPES,
+    CONFIRMATION_TYPE_INVITE: CONFIRMATION_TYPE_INVITE,
+    CONFIRMATION_TYPE_ORGANIC: CONFIRMATION_TYPE_ORGANIC
 };

middlewares/account.middleware.js

@@ -16,7 +16,8 @@ const Middleware = {
 };
 
 const Constants = {
-    Error: require("../constants/error.constant")
+    Error: require("../constants/error.constant"),
+    General: require("../constants/general.constant")
 };
 
 /**
@@ -212,7 +213,8 @@ async function inviteAccount(req, res, next) {
     const accountType = req.body.accountType;
     const confirmationObj = await Services.AccountConfirmation.create(
         accountType,
-        email
+        email,
+        Constants.General.CONFIRMATION_TYPE_INVITE
     );
     const confirmationToken = Services.AccountConfirmation.generateToken(
         confirmationObj.id
@@ -248,7 +250,9 @@ async function inviteAccount(req, res, next) {
  * @param {(err?)=>void} next
  */
 async function getInvites(req, res, next) {
-    const invites = await Services.AccountConfirmation.find({});
+    const invites = await Services.AccountConfirmation.find({
+        confirmationType: Constants.General.CONFIRMATION_TYPE_INVITE
+    });
     req.body.invites = invites;
     next();
 }

middlewares/auth.middleware.js

@@ -217,6 +217,7 @@ async function sendConfirmAccountEmail(req, res, next) {
     await Services.AccountConfirmation.create(
         Constants.General.HACKER,
         account.email,
+        Constants.General.CONFIRMATION_TYPE_ORGANIC,
         account.id
     );
     const accountConfirmationToken = await Services.AccountConfirmation.findByAccountId(

models/accountConfirmationToken.model.js

@@ -18,6 +18,11 @@ const AccountConfirmationSchema = new mongoose.Schema({
     email: {
         type: String,
         required: true
+    },
+    confirmationType: {
+        type: String,
+        enum: Constants.General.CONFIRMATION_TYPES,
+        default: Constants.General.CONFIRMATION_TYPE_ORGANIC
     }
 });
 

services/accountConfirmation.service.js

@@ -56,14 +56,16 @@ function find(query) {
  * Creates Account Confirmation document in the database
  * @param {String} type the type of user which to create the token for
  * @param {String} email
+ * @param {"Invite"|"Organic"} confirmationType whether this confirmation token is for an organic acct creation, or an invited account
  * @param {ObjectId} accountId optional accountId parameter to link to account, optional when token is being made for not a hacker
  * @returns {Promise.<*>}
  */
-async function create(type, email, accountId) {
+async function create(type, email, confirmationType, accountId) {
     //Create new instance of account confirmation
     const newAccountToken = AccountConfirmation({
         accountType: type,
-        email: email
+        email: email,
+        confirmationType: confirmationType
     });
     if (accountId !== undefined) {
         newAccountToken.accountId = accountId;

tests/account.test.js

@@ -3,9 +3,8 @@ const chai = require("chai");
 const chaiHttp = require("chai-http");
 chai.use(chaiHttp);
 const server = require("../app");
-const logger = require("../services/logger.service");
 const Account = require("../models/account.model");
-const should = chai.should();
+chai.should();
 const Constants = {
     Error: require("../constants/error.constant"),
     General: require("../constants/general.constant"),
@@ -245,8 +244,8 @@ describe("POST create account", function() {
 
     it("should SUCCEED and create a new account without a phone number", function(done) {
         chai.request(server.app)
-            .post('/api/account')
-            .type('application/json')
+            .post("/api/account")
+            .type("application/json")
             .send(noPhoneAccount)
             .end(function(err, res) {
                 res.should.have.status(200);
@@ -265,8 +264,8 @@ describe("POST create account", function() {
                     JSON.stringify(acc)
                 );
                 done();
-            })
-    })
+            });
+    });
 });
 
 describe("POST confirm account", function() {
@@ -708,9 +707,7 @@ describe("GET invites", function() {
                 );
                 res.body.should.have.property("data");
                 res.body.data.should.have.property("invites");
-                res.body.data.invites.length.should.equal(
-                    util.accountConfirmation.AccountConfirmationTokens.length
-                );
+                res.body.data.invites.length.should.equal(1);
                 done();
             });
         });

tests/util/accountConfirmation.test.util.js

@@ -33,10 +33,11 @@ const HackerConfirmation3 = {
     email: Util.Account.unlinkedAccounts.new[0].email
 };
 
-const HackerConfirmation4 = {
+const InvitedConfirmation1 = {
     _id: mongoose.Types.ObjectId(),
     accountType: Constants.HACKER,
-    email: "abcd@efgh.com"
+    email: "abcd@efgh.com",
+    confirmationType: Constants.CONFIRMATION_TYPE_INVITE
 };
 
 // Using a real ID which is stored but corresponds to another account
@@ -59,7 +60,7 @@ const AccountConfirmationTokens = [
     HackerConfirmation,
     HackerConfirmation2,
     HackerConfirmation3,
-    HackerConfirmation4
+    InvitedConfirmation1
 ];
 
 function store(attributes) {
@@ -100,6 +101,7 @@ module.exports = {
     ConfirmationToken: ConfirmationToken,
     FakeToken: FakeToken,
     AccountConfirmationTokens: AccountConfirmationTokens,
+    InvitedConfirmation1: InvitedConfirmation1,
     storeAll: storeAll,
     dropAll: dropAll
 };