#187419058 Reset password via email #17

YvetteNyibuka · 2024-04-23T22:12:54Z

What does this PR do?

      Enables users who forgot his/her password to reset it and get a new one without creating a new account

Description of Task to be completed?

A user who forgot their password can request resetting it
Sending a reset password email containing a link along with a token to reset the password
Reset the password using the provided token
Token is used only once even if it is not expired

How should this be manually tested?

Chrone Repository into your local machine
Run npm install
Fill all environment variables in .env file as they appear in .env example file
Run npm run dev
Use Postman to create a user on the endpoint: api/v1/users/register
Create another request in Postman to request a password reset on the endpoint: /api/v1/users/forgot-password
Check the message containing the reset link on the email you have provided or the one of the account you are resetting the password for
Add another request for resetting the password by setting the token you have got from the above step in the params on the endpoint: /api/v1/users/reset-password/:token and provide a new password in the body
Try login with both old and new passwords to see if the reset happened successfully on the endpoint: /api/v1/users/login

What are the relevant pivotal tracker/Trello stories?

#187419058

hound · 2024-04-23T22:12:59Z

src/controllers/resetPasswort.ts

@@ -0,0 +1,99 @@
+import { Request, Response, NextFunction } from 'express';


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

codeclimate · 2024-04-23T22:13:16Z

src/controllers/resetPasswort.ts

+};
+
+
+export const resetPassword = async (req: Request, res: Response, next: NextFunction) => {


Function resetPassword has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.

codeclimate · 2024-04-23T22:13:16Z

src/helpers/security.helpers.ts


 export const generateAccessToken = (userData: TokenData) => {
 	const token = jwt.sign(userData, ACCESS_TOKEN_SECRET as string, {
 		expiresIn: "1d",
 	});
 	return token;
 };
+export const generatePasswordResetToken = (userData1: resetTokenData) => {


Similar blocks of code found in 2 locations. Consider refactoring.

gitguardian · 2024-04-25T14:02:45Z

️✅ There are no secrets present in this pull request anymore.

If these secrets were true positive and are still valid, we highly recommend you to revoke them.
Once a secret has been leaked into a git repository, you should consider it compromised, even if it was deleted immediately.
Find here more information about risks.

^{_{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!}}

codeclimate · 2024-04-25T14:04:15Z

src/controllers/resetPasswort.ts

+	}
+};
+
+export const resetPassword = async (req: Request, res: Response) => {


Function resetPassword has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.

codeclimate · 2024-04-25T14:04:15Z

src/middlewares/user.middleware.ts

+	try {
+		if (req.body) {
+			const { error } = userValidate(req.body);
+			if (error) {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-25T14:04:15Z

src/middlewares/user.middleware.ts

-          error.details[0].message.replace(/\"/g, "")
-        )
-      );
+	if (error) {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-25T14:04:16Z

src/documention/user/index.ts

+			// security: [{ JWT: [] }],
+			summary: "Request password reset",
+			parameters: [
+				{


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-25T14:04:16Z

src/documention/user/index.ts

+					},
+					description: "The reset password token",
+				},
+				{


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-25T22:10:06Z

src/__test__/users.test.ts

+
+		resetToken = body.token;
+	});
+	it("it should return 404 when user requesting reset is not found in database", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-25T22:10:06Z

src/__test__/users.test.ts

+
+		expect(body.message).toEqual("User not found");
+	});
+	it("it should return 200 when email is sent", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-25T22:10:06Z

src/__test__/users.test.ts

-		expect(401);
-		expect(body.status).toStrictEqual("UNAUTHORIZED");
-		expect(body.message).toStrictEqual("Already logged out");
+	it("should return 400 when no token is provided", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-25T22:10:06Z

src/documention/user/index.ts

+				// security: [{ JWT: [] }],
+				summary: "Request password reset",
+				parameters: [
+					{


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-25T22:10:07Z

src/documention/user/index.ts

+						},
+						description: "The reset password token",
+					},
+					{


Similar blocks of code found in 2 locations. Consider refactoring.

src/controllers/usedTokens.json

hound · 2024-04-28T22:44:11Z

src/database/models/resetPassword.ts

@@ -0,0 +1,33 @@
+import { DataTypes, Model } from "sequelize";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-28T22:44:11Z

src/validations/reset.validation.ts

@@ -0,0 +1,18 @@
+import Joi from "joi";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-29T07:33:06Z

src/validations/newPassword.validations.ts

@@ -0,0 +1,14 @@
+import Joi from "joi";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

codeclimate · 2024-04-29T09:08:11Z

src/middlewares/user.middleware.ts

+
+	next();
+};
+const isPassword = (req: Request, res: Response, next: NextFunction) => {


Similar blocks of code found in 3 locations. Consider refactoring.

codeclimate · 2024-04-29T09:08:11Z

src/middlewares/user.middleware.ts

@@ -45,7 +47,42 @@ const logInValidated = (req: Request, res: Response, next: NextFunction) => {
 	next();
 };

+const resetValidated = (req: Request, res: Response, next: NextFunction) => {


Similar blocks of code found in 3 locations. Consider refactoring.

codeclimate · 2024-04-29T09:08:11Z

src/controllers/resetPasswort.ts

+	}
+};
+
+export const resetPasswort = async (req: Request, res: Response) => {


Function resetPasswort has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.

codeclimate · 2024-04-29T09:08:11Z

src/validations/reset.validation.ts

+import Joi from "joi";
+
+const ResetPasswordValidation = Joi.object({
+	email: Joi.string().required().email().messages({


Similar blocks of code found in 3 locations. Consider refactoring.

codeclimate · 2024-04-29T09:08:11Z

src/documention/user/index.ts

+			// security: [{ JWT: [] }],
+			summary: "Request password reset",
+			parameters: [
+				{


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-29T10:59:07Z

src/__test__/users.test.ts

+			.expect(400);
+	});
+
+	it("it should return 200 when password reset successfully", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-29T10:59:08Z

src/__test__/users.test.ts

+			.expect(404);
+	});
+
+	it("it should return 400 when new password is the same to old password", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-29T10:59:08Z

src/__test__/users.test.ts

+			.send(newPasswordBody)
+			.expect(200);
+	});
+	it("it should return 400 no decoded token is found", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-29T10:59:08Z

src/__test__/users.test.ts

+			.expect(400);
+	});
+
+	it("it should return 400 when invalid link is provided", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-29T14:37:06Z

src/__test__/users.test.ts

+		sendEmail: jest.fn(),
+	}));
+
+	it("should send an email with the correct mailOptions", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-29T14:37:06Z

src/__test__/users.test.ts

+		sendEmail: jest.fn(),
+	}));
+
+	it("should send an email with the correct mailOptions", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

hound · 2024-04-29T19:15:37Z

src/database/migrations/20240429163608-reset-password-tokens.js

+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+	async up(queryInterface, Sequelize) {


Parsing error: Unexpected token up

hound · 2024-04-29T19:15:37Z

src/helpers/nodemailer.ts

@@ -0,0 +1,35 @@
+import nodemailer from "nodemailer";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

codeclimate · 2024-04-29T19:16:52Z

src/documention/user/index.ts

+			// security: [{ JWT: [] }],
+			summary: "Request password reset",
+			parameters: [
+				{


Similar blocks of code found in 3 locations. Consider refactoring.

codeclimate · 2024-04-29T19:16:52Z

src/documention/user/index.ts

+					},
+					description: "The reset password token",
+				},
+				{


Similar blocks of code found in 3 locations. Consider refactoring.

- User who forgot password can request resetting it - Sending reset-password email containing link along with token to reset password - Reset password using the provided token - Token is used only once [Delivers #187419058]

codeclimate · 2024-04-29T20:24:20Z

Code Climate has analyzed commit f011810 and detected 11 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Duplication	11

The test coverage on the diff in this pull request is 94.0% (60% is the threshold).

This pull request will bring the total coverage in the repository to 91.0% (1.5% change).

View more on Code Climate.

hound bot reviewed Apr 23, 2024

View reviewed changes

codeclimate bot reviewed Apr 23, 2024

View reviewed changes

YvetteNyibuka requested review from dniwemugisha, leandreAlly, GarrixA and Tuyisenge2 April 23, 2024 22:14

YvetteNyibuka added the WIP label Apr 23, 2024

YvetteNyibuka changed the title ~~feat(Reset-password):User who forgot password can reset it via email~~ ft(Reset-password):User who forgot password can reset it via email Apr 24, 2024

YvetteNyibuka changed the title ~~ft(Reset-password):User who forgot password can reset it via email~~ #187419058 User who forgot password can reset it via email Apr 24, 2024

YvetteNyibuka changed the title ~~#187419058 User who forgot password can reset it via email~~ #187419058 Reset password via email Apr 24, 2024

YvetteNyibuka force-pushed the ft-reset-user-password-187419058 branch from 3bba3d8 to d0f87db Compare April 25, 2024 08:21

codeclimate bot reviewed Apr 25, 2024

View reviewed changes

YvetteNyibuka force-pushed the ft-reset-user-password-187419058 branch from 643520c to fd3ef65 Compare April 25, 2024 22:08

codeclimate bot reviewed Apr 25, 2024

View reviewed changes

YvetteNyibuka force-pushed the ft-reset-user-password-187419058 branch 10 times, most recently from 6a007d1 to fda81e4 Compare April 26, 2024 10:18

YvetteNyibuka added Ready for Review and removed WIP labels Apr 26, 2024

YvetteNyibuka requested review from Hakizimana-Clement and kwizera-bonheur25 and removed request for Tuyisenge2 April 26, 2024 10:29

GarrixA approved these changes Apr 26, 2024

View reviewed changes

leandreAlly requested changes Apr 26, 2024

View reviewed changes

src/controllers/usedTokens.json Outdated Show resolved Hide resolved

Hakizimana-Clement approved these changes Apr 26, 2024

View reviewed changes

YvetteNyibuka force-pushed the ft-reset-user-password-187419058 branch from 2cd8400 to 414d414 Compare April 26, 2024 13:07

YvetteNyibuka added WIP and removed Ready for Review labels Apr 27, 2024

hound bot reviewed Apr 28, 2024

View reviewed changes

hound bot reviewed Apr 29, 2024

View reviewed changes

YvetteNyibuka force-pushed the ft-reset-user-password-187419058 branch from 5678f04 to 4cabfce Compare April 29, 2024 08:48

codeclimate bot reviewed Apr 29, 2024

View reviewed changes

YvetteNyibuka force-pushed the ft-reset-user-password-187419058 branch 2 times, most recently from b40cf2a to 92ae79f Compare April 29, 2024 09:28

YvetteNyibuka added Ready for Review and removed WIP labels Apr 29, 2024

YvetteNyibuka force-pushed the ft-reset-user-password-187419058 branch from 92ae79f to 4ba44f6 Compare April 29, 2024 10:57

codeclimate bot reviewed Apr 29, 2024

View reviewed changes

YvetteNyibuka force-pushed the ft-reset-user-password-187419058 branch 2 times, most recently from 6515900 to 50dfa1a Compare April 29, 2024 14:28

codeclimate bot reviewed Apr 29, 2024

View reviewed changes

YvetteNyibuka force-pushed the ft-reset-user-password-187419058 branch from 50dfa1a to 145cb1d Compare April 29, 2024 19:15

hound bot reviewed Apr 29, 2024

View reviewed changes

codeclimate bot reviewed Apr 29, 2024

View reviewed changes

YvetteNyibuka force-pushed the ft-reset-user-password-187419058 branch from 145cb1d to f011810 Compare April 29, 2024 20:21

leandreAlly self-requested a review April 29, 2024 20:26

leandreAlly approved these changes Apr 29, 2024

View reviewed changes

leandreAlly merged commit 570b249 into develop Apr 29, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#187419058 Reset password via email #17

#187419058 Reset password via email #17

YvetteNyibuka commented Apr 23, 2024

hound bot Apr 23, 2024

codeclimate bot Apr 23, 2024

codeclimate bot Apr 23, 2024

gitguardian bot commented Apr 25, 2024 •

edited

Loading

codeclimate bot Apr 25, 2024

codeclimate bot Apr 25, 2024

codeclimate bot Apr 25, 2024

codeclimate bot Apr 25, 2024

codeclimate bot Apr 25, 2024

codeclimate bot Apr 25, 2024

codeclimate bot Apr 25, 2024

codeclimate bot Apr 25, 2024

codeclimate bot Apr 25, 2024

codeclimate bot Apr 25, 2024

hound bot Apr 28, 2024

hound bot Apr 28, 2024

hound bot Apr 29, 2024

codeclimate bot Apr 29, 2024

codeclimate bot Apr 29, 2024

codeclimate bot Apr 29, 2024

codeclimate bot Apr 29, 2024

codeclimate bot Apr 29, 2024

codeclimate bot Apr 29, 2024

codeclimate bot Apr 29, 2024

codeclimate bot Apr 29, 2024

codeclimate bot Apr 29, 2024

codeclimate bot Apr 29, 2024

codeclimate bot Apr 29, 2024

hound bot Apr 29, 2024

hound bot Apr 29, 2024

codeclimate bot Apr 29, 2024

codeclimate bot Apr 29, 2024

codeclimate bot commented Apr 29, 2024

		@@ -0,0 +1,99 @@
		import { Request, Response, NextFunction } from 'express';

		};


		export const resetPassword = async (req: Request, res: Response, next: NextFunction) => {

		@@ -0,0 +1,33 @@
		import { DataTypes, Model } from "sequelize";

#187419058 Reset password via email #17

#187419058 Reset password via email #17

Conversation

YvetteNyibuka commented Apr 23, 2024

What does this PR do?

Description of Task to be completed?

How should this be manually tested?

What are the relevant pivotal tracker/Trello stories?

hound bot Apr 23, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 23, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 23, 2024

Choose a reason for hiding this comment

gitguardian bot commented Apr 25, 2024 • edited Loading

️✅ There are no secrets present in this pull request anymore.

codeclimate bot Apr 25, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 25, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 25, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 25, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 25, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 25, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 25, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 25, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 25, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 25, 2024

Choose a reason for hiding this comment

hound bot Apr 28, 2024

Choose a reason for hiding this comment

hound bot Apr 28, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot commented Apr 29, 2024

gitguardian bot commented Apr 25, 2024 •

edited

Loading