Skip to content

Commit d177199

Browse files
vikhyat187vikhyat187
authored
Merge branch 'develop' into develop
2 parents 42a8f86 + 0df8007 commit d177199

File tree

5 files changed

+144
-10
lines changed

5 files changed

+144
-10
lines changed

‎controllers/tasks.js‎

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -251,20 +251,32 @@ const getUserTasks = async (req, res) => {
251251
* @param req {Object} - Express request object
252252
* @param res {Object} - Express response object
253253
*/
254+
255+
/**
256+
* @deprecated
257+
* WARNING: This API endpoint is being deprecated and will be removed in future versions.
258+
* Please use the updated API endpoint: `/tasks/:username` for retrieving user's task details.
259+
*
260+
* This API is kept temporarily for backward compatibility.
261+
*/
262+
254263
const getSelfTasks = async (req, res) => {
255264
try {
256265
const { username } = req.userData;
257266

258-
if (username) {
259-
if (req.query.completed) {
260-
const allCompletedTasks = await tasks.fetchUserCompletedTasks(username);
261-
return res.json(allCompletedTasks);
262-
} else {
263-
const allTasks = await tasks.fetchSelfTasks(username);
264-
return res.json(allTasks);
265-
}
267+
if (!username) {
268+
return res.boom.notFound("User doesn't exist");
266269
}
267-
return res.boom.notFound("User doesn't exist");
270+
271+
const tasksData = req.query.completed
272+
? await tasks.fetchUserCompletedTasks(username)
273+
: await tasks.fetchSelfTasks(username);
274+
275+
res.set(
276+
"X-Deprecation-Warning",
277+
"WARNING: This endpoint is deprecated and will be removed in the future. Please use /tasks/:username to get the task details."
278+
);
279+
return res.json(tasksData);
268280
} catch (err) {
269281
logger.error(`Error while fetching tasks: ${err}`);
270282
return res.boom.badImplementation(INTERNAL_SERVER_ERROR);

‎routes/tasks.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ const enableDevModeMiddleware = (req, res, next) => {
3535

3636
router.get("/", getTasksValidator, cacheResponse({ invalidationKey: ALL_TASKS, expiry: 10 }), tasks.fetchTasks);
3737
router.get("/self", authenticate, tasks.getSelfTasks);
38+
3839
router.get("/overdue", authenticate, authorizeRoles([SUPERUSER]), tasks.overdueTasks);
3940
router.post(
4041
"/",
@@ -54,6 +55,7 @@ router.patch(
5455
);
5556
router.get("/:id/details", tasks.getTask);
5657
router.get("/:username", tasks.getUserTasks);
58+
5759
router.patch(
5860
"/self/:id",
5961
authenticate,

‎routes/users.js‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ const { authorizeAndAuthenticate } = require("../middlewares/authorizeUsersAndSe
1212
const ROLES = require("../constants/roles");
1313
const { Services } = require("../constants/bot");
1414
const authenticateProfile = require("../middlewares/authenticateProfile");
15+
const { devFlagMiddleware } = require("../middlewares/devFlag");
16+
const { userAuthorization } = require("../middlewares/userAuthorization");
1517

1618
router.post("/", authorizeAndAuthenticate([ROLES.SUPERUSER], [Services.CRON_JOB_HANDLER]), users.markUnverified);
1719
router.post("/update-in-discord", authenticate, authorizeRoles([SUPERUSER]), users.setInDiscordScript);
@@ -35,7 +37,15 @@ router.patch(
3537
);
3638
router.get("/:username", users.getUser);
3739
router.get("/:userId/intro", authenticate, authorizeRoles([SUPERUSER]), users.getUserIntro);
38-
router.put("/self/intro", authenticate, userValidator.validateJoinData, users.addUserIntro);
40+
router.put("/self/intro", authenticate, userValidator.validateJoinData, users.addUserIntro); // This route is being deprecated soon, please use alternate available route `/users/:userId/intro`.
41+
router.put(
42+
"/:userId/intro",
43+
devFlagMiddleware,
44+
authenticate,
45+
userValidator.validateJoinData,
46+
userAuthorization,
47+
users.addUserIntro
48+
);
3949
router.get("/:id/skills", users.getUserSkills);
4050
router.get("/:id/badges", getUserBadges);
4151
router.patch(

‎test/integration/tasks.test.js‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -583,6 +583,10 @@ describe("Tasks", function () {
583583
return done;
584584
}
585585
expect(res).to.have.status(200);
586+
expect(res).to.have.header(
587+
"X-Deprecation-Warning",
588+
"WARNING: This endpoint is deprecated and will be removed in the future. Please use /tasks/:username to get the task details."
589+
);
586590
expect(res.body).to.be.a("array");
587591
expect(res.body[0].status).to.equal(COMPLETED);
588592

@@ -630,6 +634,10 @@ describe("Tasks", function () {
630634
.get("/tasks/self")
631635
.set("cookie", `${cookieName}=${authService.generateAuthToken({ userId: assignedUser })}`);
632636
expect(res).to.have.status(200);
637+
expect(res).to.have.header(
638+
"X-Deprecation-Warning",
639+
"WARNING: This endpoint is deprecated and will be removed in the future. Please use /tasks/:username to get the task details."
640+
);
633641
expect(res.body).to.be.a("array");
634642
expect([taskId1, taskId2]).to.include(taskId1);
635643
});

‎test/integration/users.test.js‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1579,6 +1579,108 @@ describe("Users", function () {
15791579
});
15801580
});
15811581

1582+
describe("PUT /users/:userId/intro", function () {
1583+
let userStatusData;
1584+
1585+
beforeEach(async function () {
1586+
await userStatusModel.updateUserStatus(userId, userStatusDataAfterSignup);
1587+
const updateStatus = await userStatusModel.updateUserStatus(userId, userStatusDataAfterFillingJoinSection);
1588+
userStatusData = (await firestore.collection("usersStatus").doc(updateStatus.id).get()).data();
1589+
});
1590+
1591+
it("should return 409 if the data already present", function (done) {
1592+
addJoinData(joinData(userId)[3]);
1593+
chai
1594+
.request(app)
1595+
.put(`/users/${userId}/intro?dev=true`)
1596+
.set("Cookie", `${cookieName}=${jwt}`)
1597+
.send(joinData(userId)[3])
1598+
.end((err, res) => {
1599+
if (err) {
1600+
return done(err);
1601+
}
1602+
expect(res).to.have.status(409);
1603+
expect(res.body).to.be.a("object");
1604+
expect(res.body.message).to.equal("User data is already present!");
1605+
return done();
1606+
});
1607+
});
1608+
1609+
it("Should store the info in db", function (done) {
1610+
chai
1611+
.request(app)
1612+
.put(`/users/${userId}/intro?dev=true`)
1613+
.set("Cookie", `${cookieName}=${jwt}`)
1614+
.send(joinData()[2])
1615+
.end((err, res) => {
1616+
if (err) {
1617+
return done(err);
1618+
}
1619+
expect(res).to.have.status(201);
1620+
expect(res.body).to.be.a("object");
1621+
expect(res.body.message).to.equal("User join data and newstatus data added and updated successfully");
1622+
expect(userStatusData).to.have.own.property("currentStatus");
1623+
expect(userStatusData).to.have.own.property("monthlyHours");
1624+
expect(userStatusData.currentStatus.state).to.equal("ONBOARDING");
1625+
expect(userStatusData.monthlyHours.committed).to.equal(40);
1626+
return done();
1627+
});
1628+
});
1629+
1630+
it("Should return 401 for Unauthenticated User Request", function (done) {
1631+
chai
1632+
.request(app)
1633+
.put(`/users/${userId}/intro?dev=true`)
1634+
.set("Cookie", `${cookieName}=""`)
1635+
.send(joinData()[2])
1636+
.end((err, res) => {
1637+
if (err) {
1638+
return done(err);
1639+
}
1640+
expect(res).to.have.status(401);
1641+
expect(res.body).to.be.a("object");
1642+
expect(res.body.message).to.equal("Unauthenticated User");
1643+
return done();
1644+
});
1645+
});
1646+
1647+
it("Should return 400 for invalid Data", function (done) {
1648+
chai
1649+
.request(app)
1650+
.put(`/users/${userId}/intro?dev=true`)
1651+
.set("Cookie", `${cookieName}=${jwt}`)
1652+
.send(joinData()[1])
1653+
.end((err, res) => {
1654+
if (err) {
1655+
return done(err);
1656+
}
1657+
expect(res).to.have.status(400);
1658+
expect(res.body).to.be.a("object");
1659+
expect(res.body.message).to.be.equal('"firstName" is required');
1660+
return done();
1661+
});
1662+
});
1663+
1664+
it("Should return 403 for Forbidden access", function (done) {
1665+
const userId = "anotherUser123";
1666+
addJoinData(joinData(userId)[3]);
1667+
1668+
chai
1669+
.request(app)
1670+
.put(`/users/${userId}/intro?dev=true`)
1671+
.set("cookie", `${cookieName}=${jwt}`)
1672+
.send(joinData(userId)[3])
1673+
.end((err, res) => {
1674+
if (err) return done(err);
1675+
1676+
expect(res).to.have.status(403);
1677+
expect(res.body).to.be.an("object");
1678+
expect(res.body.message).to.equal("Unauthorized access");
1679+
return done();
1680+
});
1681+
});
1682+
});
1683+
15821684
describe("PATCH /users/rejectDiff", function () {
15831685
let profileDiffsId;
15841686

0 commit comments

Comments
 (0)