Allow using `username` and `email` in SMTP configuration #3398

samaradel · 2024-09-10T14:15:25Z

Description

Remove isDiscourse check and apply adding email or username for all apps with SMTP.
Add the minimum and maximum lengths for the username and email.
validate the email input to accept the username too.
Accept usernames that contain dashes and underscores and they must start with an alphabetical character and validate them.

limit the password length to 69 chars as per sendgrid documentation

Changes

Related Issues

🐞 [Bug]: Change mail config validator on taiga #3343

Tested Scenarios

Check if the user used an email or username in the Email/username input and validate it.
Check if the input accepts less than 2 characters.
Check if the input accepts more than 50 characters.
Check if the username or email can start with anything except an alphabetical character.
Check if we could leave the input empty

Documentation PR

Update SMTP Server docs info_grid#645

Checklist

…pps with smtp

packages/playground/src/components/smtp_server.vue

Co-authored-by: Zainab Elgohary <[email protected]>

packages/playground/src/components/smtp_server.vue

packages/playground/src/weblets/tf_discourse.vue

packages/playground/src/utils/validators.ts

Co-authored-by: Zainab Elgohary <[email protected]>

packages/playground/src/utils/validators.ts

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

packages/playground/src/components/smtp_server.vue

packages/playground/src/utils/validators.ts

0oM4R · 2024-09-22T06:57:18Z

please mention the idea behind the validation rules, 69 characters, and the regex of the username

packages/playground/src/utils/validators.ts

Co-authored-by: Omar Kassem <[email protected]>

0oM4R · 2024-09-26T03:24:47Z

packages/playground/src/utils/validators.ts

Please add unit tests

0oM4R

i think we need to include those changes in manual Please open an issue for it in https://github.com/threefoldtech/info_grid

0oM4R · 2024-09-26T08:18:02Z

packages/playground/src/components/smtp_server.vue

-          },
+          validators.required('Email or Username is required.'),
+          (v: string) => {
+            return validators.isValidSmtp(v);


as we accepts a username now i think we should add min char validation to be at least two chars

@AhmedHanafy725 agree?

I discussed it with him earlier today, you can go a head :D

samaradel · 2024-09-26T08:44:37Z

i think we need to include those changes in manual Please open an issue for it in https://github.com/threefoldtech/info_grid

I see all mail server apps in the manual don't mention anything about validation, it is just about filling fields, I don't think it's necessary

0oM4R · 2024-09-26T08:47:58Z

i think we need to include those changes in manual Please open an issue for it in https://github.com/threefoldtech/info_grid

I see all mail server apps in the manual don't mention anything about validation, it is just about filling fields, I don't think it's necessary

what i mean is to mention that we accepts username not only email,

samaradel · 2024-09-26T09:18:21Z

@0oM4R you mean the Admin Email point, ok I will create one .. thanks :)

- Add space checker in validator function - Add unit test for smtp validation function

xmonader · 2024-09-29T15:22:12Z

packages/playground/src/utils/validators.ts

+ * @returns {{ message: string }} - An object with an error message if the input is invalid, or undefined if the input is valid.
+ */
+
+export function isValidSmtp(input: string) {


1- where is the return type of the function?
2-if the function is named isX is expect it to return a boolean. True if X and false if not. To return null that may denote a failure e.g failure to allocate memory, or no data available in such context.

So we have multiple options

1- return a boolean (and discard the error messages, keep it constant to invalid smtp information)
2- return a boolean with a context, e.g boolean, null in case of success and boolean and error string in case of failure so [boolean, string|null] 3- return a boolean (success) or an error message (failure)boolean | string`
4- return a new type e.g Result that encapsulates the success/failure status, and message/error fields

type Result<T> = { success: true; value: T; } | { success: false; error: string; };

good point. the function is deleted now and the validation is created in the input validation rules.

xmonader · 2024-09-29T15:24:17Z

packages/playground/tests/utils/isValidSmtp.test.ts

+
+import { isValidSmtp } from "../../src/utils/validators";
+
+describe("isValidSmtp", () => {


Probably need more cases e.g empty string, multiple invalid forms of email as well, usage of special characters

as the function is deleted, the test case is deleted too and you could check it in the current rules.

xmonader · 2024-09-29T15:26:11Z

packages/playground/src/utils/validators.ts

+/**
+ * Validates an SMTP input string.
+ *
+ * Checks if the input string is a valid email address and does not contain special characters.


Is it only email? if so change the input parameter to email

It now accepts usernames and email in the same input and it can validate each.

xmonader · 2024-09-29T15:31:20Z

packages/playground/src/utils/validators.ts

+export function isValidSmtp(input: string) {
+  const emailValidation = isEmail("Please provide a valid email address.")(input);
+  const username = /[!@#$%^&*()\s_+\-={}:<>?,./]/.test(input);
+  if (username && emailValidation) {


I don't understand this condition, does that mean if it's email and a username (doesn't have special characters) then it's true?

shouldn't it be like that

const isValidEmail = isEmail("Please provide a valid email address.")(input); const hasSpecialCharacters = /[!@#$%^&*()\s_+\-={}:<>?,./]/.test(input); if (hasSpecialCharacters && isValidEmail) { return { message: "Please provide a valid username or email" }; }

Which I still don't understand.

I meant here it could accept both and validate if it's not a valid email or username with a special character.

xmonader · 2024-09-29T15:48:25Z

packages/playground/src/utils/validators.ts

+
+export function isValidSmtp(input: string) {
+  const emailValidation = isEmail("Please provide a valid email address.")(input);
+  const username = /[!@#$%^&*()\s_+\-={}:<>?,./]/.test(input);


This could have been simplified instead of matching against special characters you could have just made it match against valid characters which are a-z[A-Z0-9]+

This could have been simplified instead of matching against special characters you could have just made it match against valid characters which are a-z[A-Z0-9]+

Please note this is the right way, given there's a very long of list of unhandled utf8 input, that's why you should state the allowed ones as long as you can iterate them, instead of chasing a very long list of symbols.

thanks, the regex was implemented separately in the validator function and used in the input validation.

xmonader · 2024-09-29T15:49:43Z

packages/playground/tests/utils/isValidSmtp.test.ts

+import { isValidSmtp } from "../../src/utils/validators";
+
+describe("isValidSmtp", () => {
+  it("returns nothing for valid username and email", () => {


I truly don't understand can you point out the username and the email because there's only just one input name input which looks like an email.

done in the current validation rules.

xmonader · 2024-09-29T15:53:36Z

packages/playground/tests/utils/isValidSmtp.test.ts

+  });
+
+  it("returns an error message for special characters in username", () => {
+    const input = "invalid_email";


_ is not the only special character

Of course not but I used one of them to test as I can't test all of them (too many cases).

xmonader · 2024-09-29T15:54:05Z

packages/playground/tests/utils/isValidSmtp.test.ts

+  });
+
+  it("returns an error message for white spaces in username", () => {
+    const input = "invalid username";


there're more types of spaces beyond " " there's is \t and \v

noted in the current validation.

- Accept usernames that contain dashs and underscores and it must start with an alphabetical character and validate them

0oM4R · 2024-10-08T08:10:20Z

packages/playground/src/components/smtp_server.vue

-            return isDiscourse ? undefined : validators.isEmail('Please provide a valid email address.')(v);
+          validators.required('Email or Username is required.'),
+          validators.minLength('Username must be at least 2 characters.', 2),
+          validators.maxLength('Username must be at least 50 characters.', 50),


we shouldn't use the at least on max length

also is this validation on user name only? what if the email exceeds the 50 char ? the length validation message will appear

0oM4R

the validation need a revisit

Remove isDiscourse check and apply adding email or username for all a…

cd7e4e4

…pps with smtp

samaradel requested review from AhmedHanafy725, zaelgohary, maayarosama, MohamedElmdary, Mahmoud-Emad, amiraabouhadid, AlaaElattar, 0oM4R and mohamedamer453 as code owners September 10, 2024 14:15

samaradel changed the title ~~Remove isDiscourse check and apply adding email or username for all a…~~ Allow username or email in SMTP configuration Sep 10, 2024

samaradel changed the title ~~Allow username or email in SMTP configuration~~ Allow using username and email in SMTP configuration Sep 10, 2024

zaelgohary reviewed Sep 11, 2024

View reviewed changes

packages/playground/src/components/smtp_server.vue Outdated Show resolved Hide resolved

Update packages/playground/src/components/smtp_server.vue

6f50303

Co-authored-by: Zainab Elgohary <[email protected]>

zaelgohary reviewed Sep 11, 2024

View reviewed changes

packages/playground/src/components/smtp_server.vue Outdated Show resolved Hide resolved

packages/playground/src/weblets/tf_discourse.vue Outdated Show resolved Hide resolved

packages/playground/src/utils/validators.ts Outdated Show resolved Hide resolved

Update packages/playground/src/weblets/tf_discourse.vue

f994a54

Co-authored-by: Zainab Elgohary <[email protected]>

samaradel marked this pull request as draft September 11, 2024 12:36

Validate SMTP username/email

b7a7836

samaradel marked this pull request as ready for review September 19, 2024 08:29

samaradel requested a review from zaelgohary September 19, 2024 08:30

Fix build

81af97c

github-advanced-security bot found potential problems Sep 19, 2024

View reviewed changes

packages/playground/src/utils/validators.ts Fixed Show fixed Hide fixed

Apply code scanning fix for overly permissive regular expression range

bc4c149

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

0oM4R reviewed Sep 22, 2024

View reviewed changes

packages/playground/src/components/smtp_server.vue Show resolved Hide resolved

0oM4R reviewed Sep 22, 2024

View reviewed changes

packages/playground/src/utils/validators.ts Outdated Show resolved Hide resolved

0oM4R reviewed Sep 22, 2024

View reviewed changes

packages/playground/src/utils/validators.ts Outdated Show resolved Hide resolved

maayarosama reviewed Sep 22, 2024

View reviewed changes

packages/playground/src/utils/validators.ts Outdated Show resolved Hide resolved

samaradel and others added 2 commits September 23, 2024 12:25

Update packages/playground/src/utils/validators.ts

4c1c955

Co-authored-by: Omar Kassem <[email protected]>

rn validate smtp function

f2e0fc8

Add doc string for validate smtp function

a05eb55

0oM4R requested changes Sep 26, 2024

View reviewed changes

0oM4R reviewed Sep 26, 2024

View reviewed changes

samaradel marked this pull request as draft September 26, 2024 08:39

samaradel mentioned this pull request Sep 26, 2024

Update SMTP Server docs threefoldtech/info_grid#645

Closed

- Set validation to limit username

0674977

- Add space checker in validator function - Add unit test for smtp validation function

samaradel marked this pull request as ready for review September 29, 2024 14:42

samaradel requested a review from 0oM4R September 29, 2024 14:42

xmonader reviewed Sep 29, 2024

View reviewed changes

samaradel marked this pull request as draft October 1, 2024 08:08

- Add min length and max length for the username and Email

788077b

- Accept usernames that contain dashs and underscores and it must start with an alphabetical character and validate them

samaradel requested a review from xmonader October 2, 2024 10:25

samaradel marked this pull request as ready for review October 2, 2024 10:25

samaradel marked this pull request as draft October 2, 2024 11:58

samaradel added 2 commits October 2, 2024 15:02

Add doc string for IsAlphaExpectDashAndUnderscore validator

0d6a1b3

Add unit test for IsAlphaExpectDashAndUnderscore function

9fb6875

samaradel marked this pull request as ready for review October 2, 2024 12:52

0oM4R reviewed Oct 8, 2024

View reviewed changes

0oM4R requested changes Oct 8, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow using `username` and `email` in SMTP configuration #3398

Allow using `username` and `email` in SMTP configuration #3398

samaradel commented Sep 10, 2024 •

edited

Loading

0oM4R commented Sep 22, 2024

0oM4R Sep 26, 2024

samaradel Oct 1, 2024

0oM4R left a comment

0oM4R Sep 26, 2024

samaradel Sep 26, 2024

0oM4R Sep 26, 2024

samaradel Oct 1, 2024

samaradel commented Sep 26, 2024

0oM4R commented Sep 26, 2024

samaradel commented Sep 26, 2024

xmonader Sep 29, 2024

samaradel Oct 2, 2024 •

edited

Loading

xmonader Sep 29, 2024

samaradel Oct 2, 2024 •

edited

Loading

xmonader Sep 29, 2024

samaradel Oct 2, 2024 •

edited

Loading

xmonader Sep 29, 2024

samaradel Oct 2, 2024

xmonader Sep 29, 2024

xmonader Sep 29, 2024

samaradel Oct 2, 2024

xmonader Sep 29, 2024

samaradel Oct 2, 2024

xmonader Sep 29, 2024

samaradel Oct 2, 2024

xmonader Sep 29, 2024

samaradel Oct 2, 2024

0oM4R Oct 8, 2024 •

edited

Loading

0oM4R Oct 8, 2024

0oM4R left a comment


		import { isValidSmtp } from "../../src/utils/validators";

		describe("isValidSmtp", () => {

Allow using username and email in SMTP configuration #3398

Are you sure you want to change the base?

Allow using username and email in SMTP configuration #3398

Conversation

samaradel commented Sep 10, 2024 • edited Loading

Description

Changes

Related Issues

Tested Scenarios

Documentation PR

Checklist

0oM4R commented Sep 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0oM4R left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samaradel commented Sep 26, 2024

0oM4R commented Sep 26, 2024

samaradel commented Sep 26, 2024

Choose a reason for hiding this comment

samaradel Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samaradel Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samaradel Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0oM4R Oct 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0oM4R left a comment

Choose a reason for hiding this comment

Allow using `username` and `email` in SMTP configuration #3398

Allow using `username` and `email` in SMTP configuration #3398

samaradel commented Sep 10, 2024 •

edited

Loading

samaradel Oct 2, 2024 •

edited

Loading

samaradel Oct 2, 2024 •

edited

Loading

samaradel Oct 2, 2024 •

edited

Loading

0oM4R Oct 8, 2024 •

edited

Loading