Feat : username and twitter id contains @ / special characters in the value in some user data. (#1320)

* feat:add validations in the signup api to check that username must be in the specific format and social id must not contain the special character @ to it also modify the error with a proper error message

* fix:the error message description

* fix:change the error message according to specific social id change

* fix:change the regex validation such that now it will accept numbers or characters or combination of both

* refactor:change the error message to meaningful text

* feat:add tests for invalid username and valid username and invalid social id

* fix:match the error message with the failing test case message, update the error messages in the signup api

* fix:remove unnecessary validation for linkedin_id, intagram_id we are not sending it during signup also remove the tests for that

* fix:remove unnecessary validation for linkedin_id, intagram_id we are not sending it during signup also remove the tests for that

* feat:add unit testing for the update user function to check if invalid username and twitter_id is passed or not

---------

Co-authored-by: pushpendu <[email protected]>

Author: Abhay5855

middlewares/validators/user.js

@@ -13,15 +13,25 @@ const updateUser = async (req, res, next) => {
     .keys({
       phone: joi.string().optional(),
       email: joi.string().optional(),
-      username: joi.string().optional(),
+      username: joi
+        .string()
+        .optional()
+        .min(4)
+        .max(20)
+        .regex(/^[a-zA-Z0-9]+$/)
+        .message("Username must be between 4 and 20 characters long and contain only letters or numbers."),
       first_name: joi.string().optional(),
       last_name: joi.string().optional(),
       yoe: joi.number().min(0).optional(),
       company: joi.string().optional(),
       designation: joi.string().optional(),
       img: joi.string().optional(),
       linkedin_id: joi.string().optional(),
-      twitter_id: joi.string().optional(),
+      twitter_id: joi
+        .string()
+        .optional()
+        .regex(/^[^@]*$/)
+        .message("Invalid Twitter ID. ID should not contain special character @"),
       instagram_id: joi.string().optional(),
       website: joi.string().optional(),
       status: joi

test/integration/users.test.js

@@ -100,6 +100,25 @@ describe("Users", function () {
         });
     });
 
+    it("Should update the username with valid username", function (done) {
+      chai
+        .request(app)
+        .patch("/users/self")
+        .set("cookie", `${cookieName}=${jwt}`)
+        .send({
+          username: "validUsername123",
+        })
+        .end((err, res) => {
+          if (err) {
+            return done(err);
+          }
+
+          expect(res).to.have.status(204);
+
+          return done();
+        });
+    });
+
     it("Should return 400 for invalid status value", function (done) {
       chai
         .request(app)
@@ -124,6 +143,56 @@ describe("Users", function () {
           return done();
         });
     });
+
+    it("Should return 400 for invalid username", function (done) {
+      chai
+        .request(app)
+        .patch("/users/self")
+        .set("cookie", `${cookieName}=${jwt}`)
+        .send({
+          username: "@invalidUser-name",
+        })
+        .end((err, res) => {
+          if (err) {
+            return done(err);
+          }
+
+          expect(res).to.have.status(400);
+          expect(res.body).to.be.an("object");
+          expect(res.body).to.eql({
+            statusCode: 400,
+            error: "Bad Request",
+            message: "Username must be between 4 and 20 characters long and contain only letters or numbers.",
+          });
+
+          return done();
+        });
+    });
+
+    it("Should return 400 for invalid Twitter ID", function (done) {
+      chai
+        .request(app)
+        .patch("/users/self")
+        .set("cookie", `${cookieName}=${jwt}`)
+        .send({
+          twitter_id: "invalid@twitter_id",
+        })
+        .end((err, res) => {
+          if (err) {
+            return done(err);
+          }
+
+          expect(res).to.have.status(400);
+          expect(res.body).to.be.an("object");
+          expect(res.body).to.eql({
+            statusCode: 400,
+            error: "Bad Request",
+            message: "Invalid Twitter ID. ID should not contain special character @",
+          });
+
+          return done();
+        });
+    });
   });
 
   describe("GET /users", function () {

test/unit/middlewares/user-validator.test.js

@@ -1,7 +1,9 @@
 const sinon = require("sinon");
 const { validateJoinData } = require("./../../../middlewares/validators/user");
 const joinData = require("./../../fixtures/user/join");
+const userData = require("./../../fixtures/user/user");
 const { expect } = require("chai");
+const { updateUser } = require("./../../../middlewares/validators/user");
 
 describe("Middleware | Validators | User", function () {
   describe("Create user validator for validateJoinData", function () {
@@ -34,4 +36,59 @@ describe("Middleware | Validators | User", function () {
       expect(nextSpy.calledOnce).to.be.equal(false);
     });
   });
+
+  describe("Create user validator for updateUser", function () {
+    it("lets the request pass to next", async function () {
+      const req = {
+        body: userData[1],
+      };
+
+      const res = {};
+      const next = sinon.spy();
+      await updateUser(req, res, next);
+      expect(next.calledOnce).to.be.equal(true);
+    });
+
+    it("Stops the propagation of the next if twitter_id is invalid", async function () {
+      const req = {
+        body: {
+          last_name: "patil",
+          first_name: "Abhay",
+          username: "invalidusername",
+          twitter_id: "@abhayisawesome",
+        },
+      };
+      const res = {
+        boom: {
+          badRequest: () => {},
+        },
+      };
+      const nextSpy = sinon.spy();
+      await updateUser(req, res, nextSpy).catch((err) => {
+        expect(err).to.be.an.instanceOf(Error);
+      });
+      expect(nextSpy.calledOnce).to.be.equal(false);
+    });
+
+    it("Stops the propagation of the next if username is invalid", async function () {
+      const req = {
+        body: {
+          last_name: "patil",
+          first_name: "Abhay",
+          username: "@invalidusername-12",
+          twitter_id: "abhayisawesome",
+        },
+      };
+      const res = {
+        boom: {
+          badRequest: () => {},
+        },
+      };
+      const nextSpy = sinon.spy();
+      await updateUser(req, res, nextSpy).catch((err) => {
+        expect(err).to.be.an.instanceOf(Error);
+      });
+      expect(nextSpy.calledOnce).to.be.equal(false);
+    });
+  });
 });