feat: implement attendance preference for hackers (#773)

brarsanmol · pengyk · logan-r · commit 20ef96403689 · 2021-11-28T21:48:38.000-05:00
* - Implement attendance preference for hackers.

Questions:
- Do we need to write unit tests for this?
- Do we need to update/regenerate api docs to reflect the change in response data for the hacker model.

* Fix spelling errors for accommodation in the codebase.

- Drew JSON for testing from the api docs and was getting a validator error, on closer inspection, the spelling of acccommodation was incorrect in the docs, and in my own commit for hacker.validator.js.

* feat: add unit testing for attendance preference.

- unit test the following failures:
  - invalid enum.
  - option not passed to the request.

- add valid attendance preferences that vary across the dummy hackers.

* fix: remove accidental changes on valid test for code of conduct.

* fix: add missing component on unit tests.

* fix: add attendance preference field to remaining dummy hackers.

* Potential fix to invalid input test

Co-authored-by: Yun Kai Peng &lt;yunkaipeng0129@gmail.com&gt;
diff --git a/constants/general.constant.js b/constants/general.constant.js
@@ -84,6 +84,7 @@ const SPONSOR_T5 = "SponsorT5";
 const JOB_INTERESTS = ["Internship", "Full Time", "None"];
 const SHIRT_SIZES = ["XS", "S", "M", "L", "XL", "XXL"];
 const PREVIOUS_HACKATHONS = [0, 1, 2, 3, 4, 5];
+const ATTENDANCE_PREFERENCES = ["Remote", "In Person"];
 
 const ROLE_CATEGORIES = {
     SELF: ":self",
@@ -198,6 +199,7 @@ module.exports = {
     JOB_INTERESTS: JOB_INTERESTS,
     SHIRT_SIZES: SHIRT_SIZES,
     PREVIOUS_HACKATHONS: PREVIOUS_HACKATHONS,
+    ATTENDANCE_PREFERENCES: ATTENDANCE_PREFERENCES,
     USER_TYPES: USER_TYPES,
     SPONSOR_TIERS: SPONSOR_TIERS,
     EXTENDED_USER_TYPES: EXTENDED_USER_TYPES,
diff --git a/docs/api/api_data.json b/docs/api/api_data.json
diff --git a/middlewares/validators/hacker.validator.js b/middlewares/validators/hacker.validator.js
@@ -38,6 +38,12 @@ module.exports = {
             "application.accommodation.barriers",
             true
         ),
+        VALIDATOR.enumValidator(
+            "body",
+            "application.accommodation.attendancePreference",
+            Constants.ATTENDANCE_PREFERENCES,
+            false
+        ),
         VALIDATOR.stringValidator(
             "body",
             "application.general.URL.resume",
diff --git a/models/hacker.model.js b/models/hacker.model.js
@@ -126,7 +126,12 @@ const HackerSchema = new mongoose.Schema({
                 enum: Constants.SHIRT_SIZES,
                 required: true
             },
-            travel: { type: Number, default: 0 }
+            travel: { type: Number, default: 0 },
+            attendancePreference: {
+                type: String,
+                enum: Constants.ATTENDANCE_PREFERENCES,
+                required: true
+            }
         },
         team: {
             type: mongoose.Schema.Types.ObjectId,
@@ -167,7 +172,8 @@ HackerSchema.methods.isApplicationComplete = function() {
     const question1Done = !!hs.application.shortAnswer.question1;
     const question2Done = !!hs.application.shortAnswer.question2;
     const previousHackathonsDone = !!hs.application.shortAnswer.previousHackathons;
-    return portfolioDone && jobInterestDone && question1Done && question2Done && previousHackathonsDone;
+    const attendancePreferenceDone = !!hs.application.accommodation.attendancePreference;
+    return portfolioDone && jobInterestDone && question1Done && question2Done && previousHackathonsDone && attendancePreferenceDone;
 };
 
 /**
diff --git a/routes/api/hacker.js b/routes/api/hacker.js
@@ -125,7 +125,7 @@ module.exports = {
                         "privacyPolicy": true,
                         "codeOfConduct": true,
                       }
-                      "accomodation": {
+                      "accommodation": {
                         "travel": 0
                       },
                       "location": {
@@ -173,7 +173,7 @@ module.exports = {
                             "privacyPolicy": true,
                             "codeOfConduct": true,
                           }
-                          "accomodation": {
+                          "accommodation": {
                             "travel": 0
                           },
                           "location": {
@@ -469,7 +469,7 @@ module.exports = {
                       "privacyPolicy": true,
                       "codeOfConduct": true,
                     }
-                    "accomodation": {
+                    "accommodation": {
                       "travel": 0
                     },
                     "location": {
@@ -517,7 +517,7 @@ module.exports = {
                             "privacyPolicy": true,
                             "codeOfConduct": true,
                           }
-                          "accomodation": {
+                          "accommodation": {
                             "travel": 0
                           },
                           "location": {
@@ -594,7 +594,7 @@ module.exports = {
                             "privacyPolicy": true,
                             "codeOfConduct": true,
                           }
-                          "accomodation": {
+                          "accommodation": {
                             "travel": 0
                           },
                           "location": {
@@ -667,7 +667,7 @@ module.exports = {
                             "privacyPolicy": true,
                             "codeOfConduct": true,
                           }
-                          "accomodation": {
+                          "accommodation": {
                             "travel": 0
                           },
                           "location": {
diff --git a/tests/hacker.test.js b/tests/hacker.test.js
@@ -34,6 +34,8 @@ const newHacker0 = util.hacker.newHacker0;
 const invalidHackerAccount0 = util.account.hackerAccounts.invalid;
 const invalidHacker0 = util.hacker.invalidHacker0;
 const invalidHacker2 = util.hacker.invalidHacker2;
+const invalidHacker3 = util.hacker.invalidHacker3;
+const invalidHacker4 = util.hacker.invalidHacker4;
 const newHacker1 = util.hacker.newHacker1;
 
 const noTeamHackerAccount0 = util.account.hackerAccounts.stored.noTeam[0];
@@ -612,6 +614,62 @@ describe("POST create hacker", function() {
         });
     });
 
+    // should fail due to 'asdf' on attendance preference.
+    it("should FAIL if the new hacker does not have valid attendance preference", function(done) {
+        util.auth.login(agent, newHackerAccount0, (error) => {
+            if (error) {
+                agent.close();
+                return done(error);
+            }
+            return agent
+                .post(`/api/hacker/`)
+                .type("application/json")
+                .send(invalidHacker3)
+                .end(function(err, res) {
+                    res.should.have.status(422);
+                    res.should.be.json;
+                    res.body.should.have.property("message");
+                    res.body.message.should.equal("Validation failed");
+                    res.body.should.have.property("data");
+                    res.body.data.should.have.property(
+                        "application.accommodation.attendancePreference"
+                    );
+                    res.body.data[
+                        "application.accommodation.attendancePreference"
+                    ].msg.should.equal("The value must be part of the enum");
+                    done();
+                });
+        });
+    });
+
+      // should fail due to attendance preference not being passed in the request body.
+      it("should FAIL if the new hacker does not have attendance preference", function(done) {
+        util.auth.login(agent, newHackerAccount0, (error) => {
+            if (error) {
+                agent.close();
+                return done(error);
+            }
+            return agent
+                .post(`/api/hacker/`)
+                .type("application/json")
+                .send(invalidHacker4)
+                .end(function(err, res) {
+                    res.should.have.status(422);
+                    res.should.be.json;
+                    res.body.should.have.property("message");
+                    res.body.message.should.equal("Validation failed");
+                    res.body.should.have.property("data");
+                    res.body.data.should.have.property(
+                        "application.accommodation.attendancePreference"
+                    );
+                    res.body.data[
+                        "application.accommodation.attendancePreference"
+                    ].msg.should.equal("The value being checked agains the enums must exist.");
+                    done();
+                });
+        });
+    });
+
     // fail on unconfirmed account, using admin
     it("should FAIL to create a new hacker if the account hasn't been confirmed", function(done) {
         util.auth.login(agent, Admin0, (error) => {
@@ -711,6 +769,15 @@ describe("POST create hacker", function() {
                     ].msg.should.equal(
                         "application.accommodation.travel must be an integer."
                     );
+                    res.body.data.should.have.property(
+                        "application.accommodation.attendancePreference"
+                    );
+                    res.body.data[
+                        "application.accommodation.attendancePreference"
+                    ].should.have.property("msg");
+                    res.body.data[
+                        "application.accommodation.attendancePreference"
+                    ].msg.should.equal("The value must be part of the enum");
 
                     done();
                 });
diff --git a/tests/util/hacker.test.util.js b/tests/util/hacker.test.util.js
