Added Deprecation Warning Header for /users/self (#2221)

* adding new route for query param profile

* removing some mixed changes of other commit

* modified test cases and and controller logic

* Implemented GET route /users?profile=true to fetch user's details

* refactored: moved authentication logic from controller to middleware

* test cases fo authCondition file

* updated test cases and routes and middleware of users

* bug fix for using only in test cases

* code refactor and updated function naming

* added deprecation headers, comment and warning for /users/self

* refactored code and removed one header

Author: vikasosmium

controllers/users.js

@@ -390,13 +390,27 @@ const generateUsername = async (req, res) => {
  * @param req {Object} - Express request object
  * @param res {Object} - Express response object
  */
-
+/**
+ * @deprecated
+ * WARNING: This API endpoint is being deprecated and will be removed in future versions.
+ * Please use the updated API endpoint: `/users?profile=true` for retrieving user profile details.
+ *
+ * For more information, refer to this PR:
+ * https://github.com/Real-Dev-Squad/website-backend/pull/2201
+ *
+ * This API is kept temporarily for backward compatibility.
+ */
 const getSelfDetails = async (req, res) => {
   try {
     if (req.userData) {
       const user = await dataAccess.retrieveUsers({
         userdata: req.userData,
       });
+
+      res.set(
+        "X-Deprecation-Warning",
+        "WARNING: This endpoint is deprecated and will be removed in the future. Please use /users?profile=true to get the updated profile details."
+      );
       return res.send(user);
     }
     return res.boom.notFound("User doesn't exist");

test/integration/users.test.js

@@ -978,6 +978,11 @@ describe("Users", function () {
           expect(res.body).to.not.have.property("phone");
           expect(res.body).to.not.have.property("email");
           expect(res.body).to.not.have.property("chaincode");
+          expect(res).to.have.header(
+            "X-Deprecation-Warning",
+            "WARNING: This endpoint is deprecated and will be removed in the future. Please use /users?profile=true to get the updated profile details."
+          );
+
           return done();
         });
     });