Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: allow single CC/BCC recipient to be sent via form-data #2286

Merged
merged 4 commits into from
Nov 25, 2024
Merged

Fix: allow single CC/BCC recipient to be sent via form-data #2286

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c08f6cf
fix cc and bcc to allow stringified array
kevinkim-ogp Nov 21, 2024
576578f
add tests for cc
kevinkim-ogp Nov 21, 2024
5d1626a
abstract email validator, update test cases
kevinkim-ogp Nov 22, 2024
b109a34
revert to 2d array for test inputs
kevinkim-ogp Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 9 additions & 13 deletions backend/src/email/routes/email-transactional.routes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,16 @@ export const InitEmailTransactionalRoute = (
const router = Router({ mergeParams: true })

// Validators
const emailValidator = Joi.string()
.trim()
.email()
.options({ convert: true })
.lowercase()

const emailArrayValidation = (fieldName: 'cc' | 'bcc') => {
return Joi.alternatives().try(
// array
Joi.array()
.unique()
.items(
Joi.string().trim().email().options({ convert: true }).lowercase()
),
Joi.array().unique().items(emailValidator),

// stringified array (form-data)
Joi.string().custom((value: string) => {
Expand All @@ -46,9 +48,7 @@ export const InitEmailTransactionalRoute = (
}
const { value: validatedEmails, error } = Joi.array()
.unique()
.items(
Joi.string().email().trim().lowercase().options({ convert: true })
)
.items(emailValidator)
.validate(parsed)

if (error) {
Expand Down Expand Up @@ -82,11 +82,7 @@ export const InitEmailTransactionalRoute = (
)
),
from: fromAddressValidator,
reply_to: Joi.string()
.trim()
.email()
.options({ convert: true })
.lowercase(),
reply_to: emailValidator,
attachments: Joi.array().items(Joi.object().keys().required()),
classification: Joi.string()
.uppercase()
Expand Down
29 changes: 12 additions & 17 deletions backend/src/email/routes/tests/email-transactional.routes.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -866,14 +866,11 @@ describe(`${emailTransactionalRoute}/send`, () => {
})

const ccValidTests = [
['[email protected]', '[email protected]'],
JSON.stringify([
'[email protected]',
'[email protected]',
]),
[['[email protected]']],
[['[email protected]', '[email protected]']],
jia1 marked this conversation as resolved.
Show resolved Hide resolved
]
test.each(ccValidTests)(
'Should throw api validation error if cc is not valid array or stringified array - JSON payload',
'Should send email with cc from valid array or stringified array - JSON payload',
async (cc) => {
mockSendEmail = jest
.spyOn(EmailService, 'sendEmail')
Expand All @@ -887,10 +884,8 @@ describe(`${emailTransactionalRoute}/send`, () => {
reply_to: user.email,
})

const arrayToCheck = Array.isArray(cc) ? cc : JSON.parse(cc)

expect(res.status).toBe(201)
expect(res.body.cc.sort()).toStrictEqual(arrayToCheck.sort())
expect(res.body.cc.sort()).toStrictEqual(cc.sort())
expect(mockSendEmail).toBeCalledTimes(1)
const transactionalEmail = await EmailMessageTransactional.findOne({
where: { id: res.body.id },
Expand All @@ -906,11 +901,14 @@ describe(`${emailTransactionalRoute}/send`, () => {
)

test.each(ccValidTests)(
'Should throw api validation error if cc is not valid array or stringified array - form-data',
'Should send email with cc from valid array or stringified array - form-data',
async (cc) => {
mockSendEmail = jest
.spyOn(EmailService, 'sendEmail')
.mockResolvedValue(true)
// in the case where single cc is sent, stringify the cc list
const ccSend = cc.length === 1 ? JSON.stringify(cc) : cc

const res = await request(app)
.post(endpoint)
.set('Authorization', `Bearer ${apiKey}`)
Expand All @@ -919,12 +917,10 @@ describe(`${emailTransactionalRoute}/send`, () => {
.field('body', validApiCall.body)
.field('from', 'Postman <[email protected]>')
.field('reply_to', validApiCall.reply_to)
.field('cc', cc)

const arrayToCheck = Array.isArray(cc) ? cc : JSON.parse(cc)
.field('cc', ccSend)

expect(res.status).toBe(201)
expect(res.body.cc.sort()).toStrictEqual(arrayToCheck.sort())
expect(res.body.cc.sort()).toStrictEqual(cc.sort())
expect(mockSendEmail).toBeCalledTimes(1)
const transactionalEmail = await EmailMessageTransactional.findOne({
where: { id: res.body.id },
Expand All @@ -949,7 +945,7 @@ describe(`${emailTransactionalRoute}/send`, () => {
transactionalEmail?.emailMessageTransactionalCc.map(
(item) => item.email
)
expect(transactionalCcEmails?.sort()).toStrictEqual(arrayToCheck.sort())
expect(transactionalCcEmails?.sort()).toStrictEqual(cc.sort())
}
)

Expand Down Expand Up @@ -995,14 +991,13 @@ describe(`${emailTransactionalRoute}/send`, () => {
)

test.each(ccInvalidTests)(
'Should throw api validation error if cc is not valid array or stringified array - JSON payload',
'Should throw api validation error if cc is not valid array or stringified array - form-data',
async ({ cc, errMsg }) => {
mockSendEmail = jest.spyOn(EmailService, 'sendEmail')

const res = await request(app)
.post(endpoint)
.set('Authorization', `Bearer ${apiKey}`)
.set('Authorization', `Bearer ${apiKey}`)
.field('recipient', validApiCall.recipient)
.field('subject', validApiCall.subject)
.field('body', validApiCall.body)
Expand Down
Loading