Skip to content

feat: add admin pdf copy for storage mode #8950

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

Open
kevin9foong wants to merge 2 commits into
base: feat/add-admin-pdf-copy
Choose a base branch
from
+1,425 −556
Open

feat: add admin pdf copy for storage mode #8950

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a07cede
feat: add admin pdf copy for storage
kevin9foong Dec 5, 2025
3f60fb0
feat: add tc for storage mode admin email pdf
kevin9foong Dec 5, 2025
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
1 change: 1 addition & 0 deletions src/app/modules/payments/payments.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,7 @@ export const performPaymentPostSubmissionActions = (
performEncryptPostSubmissionActions({
submission,
responses: payment.responses,
emailFields: [], // TODO [EMAIL-CONFIRMATION-BUG]: Email confirmation email to email fields does not work for payment forms, this is an existing issue to be fixed.
})
.andThen(() =>
// If successfully sent email confirmations, delete response data from payment document.
Expand Down
153 changes: 134 additions & 19 deletions src/app/modules/submission/__tests__/submission.service.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,9 @@ describe('submission.service', () => {
form: mockForm,
recipientData,
submission: MOCK_SUBMISSION,
attachments: MOCK_ATTACHMENTS,
submissionAttachments: MOCK_ATTACHMENTS,
pdfAttachment: undefined,
isPaymentEnabled: false,
responsesData: MOCK_AUTOREPLY_DATA,
})

Expand All @@ -467,7 +469,9 @@ describe('submission.service', () => {
expect(MockMailService.sendAutoReplyEmails).toHaveBeenCalledWith({
form: mockForm,
submission: MOCK_SUBMISSION,
attachments: MOCK_ATTACHMENTS,
submissionAttachments: MOCK_ATTACHMENTS,
pdfAttachment: undefined,
isPaymentEnabled: false,
responsesData: MOCK_AUTOREPLY_DATA,
autoReplyMailDatas: expectedAutoReplyData,
})
Expand Down Expand Up @@ -496,7 +500,9 @@ describe('submission.service', () => {
form: mockForm,
recipientData,
submission: MOCK_SUBMISSION,
attachments: MOCK_ATTACHMENTS,
submissionAttachments: MOCK_ATTACHMENTS,
pdfAttachment: undefined,
isPaymentEnabled: false,
responsesData: MOCK_AUTOREPLY_DATA,
})

Expand Down Expand Up @@ -541,7 +547,9 @@ describe('submission.service', () => {
form: mockForm,
recipientData,
submission: MOCK_SUBMISSION,
attachments: MOCK_ATTACHMENTS,
submissionAttachments: MOCK_ATTACHMENTS,
pdfAttachment: undefined,
isPaymentEnabled: false,
responsesData: MOCK_AUTOREPLY_DATA,
})

Expand Down Expand Up @@ -592,7 +600,9 @@ describe('submission.service', () => {
form: mockForm,
recipientData,
submission: MOCK_SUBMISSION,
attachments: MOCK_ATTACHMENTS,
submissionAttachments: MOCK_ATTACHMENTS,
pdfAttachment: undefined,
isPaymentEnabled: false,
responsesData: MOCK_AUTOREPLY_DATA,
})

Expand All @@ -601,7 +611,9 @@ describe('submission.service', () => {
expect(MockMailService.sendAutoReplyEmails).toHaveBeenCalledWith({
form: mockForm,
submission: MOCK_SUBMISSION,
attachments: MOCK_ATTACHMENTS,
submissionAttachments: MOCK_ATTACHMENTS,
pdfAttachment: undefined,
isPaymentEnabled: false,
responsesData: MOCK_AUTOREPLY_DATA,
autoReplyMailDatas: expectedAutoReplyData,
})
Expand Down Expand Up @@ -655,8 +667,10 @@ describe('submission.service', () => {
form: mockForm,
recipientData,
submission: MOCK_SUBMISSION,
attachments: MOCK_ATTACHMENTS,
responsesData: undefined,
submissionAttachments: MOCK_ATTACHMENTS,
pdfAttachment: undefined,
isPaymentEnabled: false,
responsesData: [],
})

const expectedAutoReplyData = [
Expand All @@ -667,14 +681,16 @@ describe('submission.service', () => {
expect(MockMailService.sendAutoReplyEmails).toHaveBeenCalledWith({
form: mockForm,
submission: MOCK_SUBMISSION,
attachments: MOCK_ATTACHMENTS,
submissionAttachments: MOCK_ATTACHMENTS,
responsesData: [],
autoReplyMailDatas: expectedAutoReplyData,
pdfAttachment: undefined,
isPaymentEnabled: false,
})
expect(result._unsafeUnwrap()).toBe(true)
})

it('should call mail service with attachments undefined when there are no attachments', async () => {
it('should call mail service with pdfAttachment when a pdfAttachment is provided', async () => {
const mockForm = {
_id: MOCK_FORM_ID,
form_fields: [
Expand Down Expand Up @@ -717,12 +733,19 @@ describe('submission.service', () => {
responses,
mockForm.form_fields,
)

const MOCK_PDF_ATTACHMENT = {
content: Buffer.from('mock pdf buffer'),
filename: 'response.pdf',
}
const result = await SubmissionService.sendEmailConfirmations({
form: mockForm,
recipientData,
submission: MOCK_SUBMISSION,
attachments: undefined,
submissionAttachments: undefined,
responsesData: MOCK_AUTOREPLY_DATA,
isPaymentEnabled: false,
pdfAttachment: MOCK_PDF_ATTACHMENT,
})

const expectedAutoReplyData = [
Expand All @@ -733,7 +756,79 @@ describe('submission.service', () => {
expect(MockMailService.sendAutoReplyEmails).toHaveBeenCalledWith({
form: mockForm,
submission: MOCK_SUBMISSION,
attachments: undefined,
submissionAttachments: undefined,
pdfAttachment: MOCK_PDF_ATTACHMENT,
isPaymentEnabled: false,
responsesData: MOCK_AUTOREPLY_DATA,
autoReplyMailDatas: expectedAutoReplyData,
})
expect(result._unsafeUnwrap()).toBe(true)
})

it('should call mail service with submissionAttachments undefined and pdfAttachment undefined when there are no submissionAttachments or pdfAttachment', async () => {
const mockForm = {
_id: MOCK_FORM_ID,
form_fields: [
{
...generateDefaultField(BasicField.Email),
autoReplyOptions: AUTOREPLY_OPTIONS_1,
},
{
...generateDefaultField(BasicField.Email),
autoReplyOptions: AUTOREPLY_OPTIONS_2,
},
],
} as unknown as IPopulatedForm
MockMailService.sendAutoReplyEmails.mockResolvedValueOnce([
{
status: 'fulfilled',
value: ok(true),
},
{
status: 'fulfilled',
value: ok(true),
},
])

const responses = [
{
...generateNewSingleAnswerResponse(BasicField.Email, {
_id: mockForm.form_fields![0]._id,
answer: MOCK_EMAIL_1,
}),
},
{
...generateNewSingleAnswerResponse(BasicField.Email, {
_id: mockForm.form_fields![1]._id,
answer: MOCK_EMAIL_2,
}),
},
]
const recipientData = extractEmailConfirmationData(
responses,
mockForm.form_fields,
)
const result = await SubmissionService.sendEmailConfirmations({
form: mockForm,
recipientData,
submission: MOCK_SUBMISSION,
submissionAttachments: undefined,
responsesData: MOCK_AUTOREPLY_DATA,
isPaymentEnabled: false,
pdfAttachment: undefined,
})

const expectedAutoReplyData = [
EXPECTED_AUTOREPLY_DATA_1,
EXPECTED_AUTOREPLY_DATA_2,
]

expect(MockMailService.sendAutoReplyEmails).toHaveBeenCalledWith({
form: mockForm,
submission: MOCK_SUBMISSION,
submissionAttachments: undefined,
pdfAttachment: undefined,
isPaymentEnabled: false,
responsesData: MOCK_AUTOREPLY_DATA,
autoReplyMailDatas: expectedAutoReplyData,
})
Expand Down Expand Up @@ -780,8 +875,10 @@ describe('submission.service', () => {
form: mockForm,
recipientData,
submission: MOCK_SUBMISSION,
attachments: MOCK_ATTACHMENTS,
submissionAttachments: MOCK_ATTACHMENTS,
responsesData: MOCK_AUTOREPLY_DATA,
isPaymentEnabled: false,
pdfAttachment: undefined,
})

const expectedAutoReplyData = [
Expand All @@ -792,7 +889,9 @@ describe('submission.service', () => {
expect(MockMailService.sendAutoReplyEmails).toHaveBeenCalledWith({
form: mockForm,
submission: MOCK_SUBMISSION,
attachments: MOCK_ATTACHMENTS,
submissionAttachments: MOCK_ATTACHMENTS,
pdfAttachment: undefined,
isPaymentEnabled: false,
responsesData: MOCK_AUTOREPLY_DATA,
autoReplyMailDatas: expectedAutoReplyData,
})
Expand Down Expand Up @@ -849,8 +948,10 @@ describe('submission.service', () => {
form: mockForm,
recipientData,
submission: MOCK_SUBMISSION,
attachments: MOCK_ATTACHMENTS,
submissionAttachments: MOCK_ATTACHMENTS,
responsesData: MOCK_AUTOREPLY_DATA,
isPaymentEnabled: false,
pdfAttachment: undefined,
})

const expectedAutoReplyData = [
Expand All @@ -861,9 +962,11 @@ describe('submission.service', () => {
expect(MockMailService.sendAutoReplyEmails).toHaveBeenCalledWith({
form: mockForm,
submission: MOCK_SUBMISSION,
attachments: MOCK_ATTACHMENTS,
submissionAttachments: MOCK_ATTACHMENTS,
responsesData: MOCK_AUTOREPLY_DATA,
autoReplyMailDatas: expectedAutoReplyData,
pdfAttachment: undefined,
isPaymentEnabled: false,
})
expect(result._unsafeUnwrapErr()).toEqual(
new SendEmailConfirmationError(),
Expand Down Expand Up @@ -2747,7 +2850,11 @@ describe('submission.service', () => {

// Act
// empty string for version id to simulate failure
const actualResult = await downloadCleanFile('invalid-key', '')
const actualResult = await downloadCleanFile(
'invalid-key',
'',
'mock-bucket-name',
)

// Assert
expect(awsSpy).not.toHaveBeenCalled()
Expand All @@ -2761,7 +2868,11 @@ describe('submission.service', () => {

// Act
// empty string for version id to simulate failure
const actualResult = await downloadCleanFile(MOCK_VALID_UUID, '')
const actualResult = await downloadCleanFile(
MOCK_VALID_UUID,
'',
'mock-bucket-name',
)

// Assert
expect(awsSpy).toHaveBeenCalledOnce()
Expand Down Expand Up @@ -2796,7 +2907,11 @@ describe('submission.service', () => {

// Act
// empty strings for invalid keys and version ids
const actualResult = await downloadCleanFile(MOCK_VALID_UUID, versionId)
const actualResult = await downloadCleanFile(
MOCK_VALID_UUID,
versionId,
'mock-bucket-name',
)

// Assert
expect(awsSpy).toHaveBeenCalledOnce()
Expand Down
Loading
Loading