fix(contact): update username using action param instead of config

Author: annahassel

schemas/contacts.challenge.json

@@ -12,15 +12,22 @@
     },
     "contact": {
       "$ref": "common.json#/definitions/contact",
-      "required": ["value"]
+      "required": [
+        "value"
+      ]
     },
     "i18nLocale": {
       "type": "string",
       "minLength": 1,
       "maxLength": 10
     },
     "metadata": {
-      "type": "object"
+      "type": "object",
+      "properties": {
+        "updateUsername": {
+          "type": "boolean"
+        }
+      }
     }
   }
 }

schemas/contacts.remove.json

@@ -12,6 +12,9 @@
     },
     "contact": {
       "$ref": "common.json#/definitions/contact"
+    },
+    "updateUsername": {
+      "type": "boolean"
     }
   }
 }

src/actions/contacts/remove.js

@@ -14,8 +14,14 @@ const { getUserId } = require('../../utils/userData');
  * @apiParam (Payload) {String} username -
  */
 module.exports = async function remove({ params }) {
-  const userId = await getUserId.call(this, params.username);
-  return contacts.remove.call(this, { contact: params.contact, userId });
+  const { contact, updateUsername, username } = params;
+  const userId = await getUserId.call(this, username);
+
+  return contacts.remove.call(this, {
+    contact,
+    updateUsername,
+    userId,
+  });
 };
 
 module.exports.transports = [ActionTransport.amqp, ActionTransport.internal];

src/configs/verification-challenges.js

@@ -79,5 +79,4 @@ exports.contacts = {
   max: 5,
   onlyOneVerifiedEmail: true,
   allowRemoveFirstContact: true,
-  updateUsername: true,
 };

src/utils/contacts.js

@@ -166,7 +166,8 @@ async function challenge({ userId, contact, i18nLocale, metadata = {} }) {
 async function verifyEmail({ secret }) {
   const { redis, tokenManager } = this;
   const { metadata } = await tokenManager.verify(secret);
-  const { userId, contact } = metadata;
+  const { userId, contact, metadata: tokenMetadata } = metadata;
+  const { updateUsername } = tokenMetadata;
   const lock = await this.dlock.manager.once(lockContact(contact.value));
   const key = redisKey(userId, USERS_CONTACTS, contact.value);
 
@@ -175,7 +176,7 @@ async function verifyEmail({ secret }) {
     if (this.config.contacts.onlyOneVerifiedEmail) {
       await removeAllEmailContactsOfUser.call(this, pipe, userId, contact.value);
     }
-    if (this.config.contacts.updateUsername) {
+    if (updateUsername) {
       await replaceUserName.call(this, pipe, userId, contact.value);
     }
     pipe.hset(key, 'verified', 'true');
@@ -211,7 +212,7 @@ async function verify({ userId, contact, token }) {
   return redis.hgetall(key).then(parseObj);
 }
 
-async function remove({ userId, contact }) {
+async function remove({ contact, updateUsername, userId }) {
   const { redis, tokenManager, log } = this;
   const key = redisKey(userId, USERS_CONTACTS, contact.value);
 
@@ -241,7 +242,7 @@ async function remove({ userId, contact }) {
   pipe.del(key);
   pipe.srem(redisKey(userId, USERS_CONTACTS), contact.value);
 
-  if (this.config.contacts.updateUsername) {
+  if (updateUsername) {
     pipe.hdel(USERS_USERNAME_TO_ID, contact.value);
   }
 

test/suites/actions/contacts.js

@@ -256,6 +256,7 @@ describe('#user contacts', function registerSuite() {
       },
       metadata: {
         name: 'Test',
+        updateUsername: true,
       },
     };
 
@@ -291,23 +292,44 @@ describe('#user contacts', function registerSuite() {
   });
 
   it('should remove username to userid mapping on contact removal', async function test() {
-    const params = {
-      username: this.testUser.id,
-      contact: {
-        value: '[email protected]',
-        type: 'email',
+    await this.users.dispatch('contacts.add', {
+      params: {
+        contact: {
+          value: '[email protected]',
+          type: 'email',
+        },
+        username: this.testUser.id,
       },
-    };
-    await this.users.dispatch('contacts.add', { params });
+    });
     const amqpStub = sinon.stub(this.users.amqp, 'publish');
     amqpStub.withArgs('mailer.predefined').resolves({ queued: true });
-    await this.users.dispatch('contacts.challenge', { params });
+    await this.users.dispatch('contacts.challenge', {
+      params: {
+        contact: {
+          value: '[email protected]',
+          type: 'email',
+        },
+        metadata: {
+          updateUsername: true,
+        },
+        username: this.testUser.id,
+      },
+    });
     const { ctx: { template: { token: { secret } } } } = amqpStub.args[0][1];
     await this.users.dispatch('contacts.verify-email', { params: { secret } });
-    const userid = await this.users.redis.hget(USERS_USERNAME_TO_ID, params.contact.value);
+    const userid = await this.users.redis.hget(USERS_USERNAME_TO_ID, '[email protected]');
     assert.notEqual(userid, null);
-    await this.users.dispatch('contacts.remove', { params });
-    const useridRemoved = await this.users.redis.hget(USERS_USERNAME_TO_ID, params.contact.value);
+    await this.users.dispatch('contacts.remove', {
+      params: {
+        contact: {
+          value: '[email protected]',
+          type: 'email',
+        },
+        updateUsername: true,
+        username: this.testUser.id,
+      },
+    });
+    const useridRemoved = await this.users.redis.hget(USERS_USERNAME_TO_ID, '[email protected]');
     assert.equal(useridRemoved, null);
   });
 });