>((acc, attachment) => {
+ acc[attachment.fieldId] = attachment
+ return acc
+ }, {})
+
+ if (responses) {
+ // matches responses to attachments using id, adding filename and content to response
+ responses.forEach((response) => {
+ if (isAttachmentResponseFromMap(attachmentMap, response)) {
+ const file = attachmentMap[response._id]
+ response.answer = file.filename
+ response.filename = file.filename
+ response.content = file.content
+ }
+ })
+ }
+}
+
+/**
+ * Looks for duplicated filenames and changes the filename
+ * to for example 1-abc.txt, 2-abc.txt.
+ * One of the duplicated files will not have its name changed.
+ * Two abc.txt will become 1-abc.txt and abc.txt
+ * @param attachments - Array of file objects
+ * @returns void. Modifies array in-place.
+ */
+export const handleDuplicatesInAttachments = (
+ attachments: IAttachmentInfo[],
+): void => {
+ const names = new Map()
+
+ // fill up the map, the key: filename and value: count
+ attachments.forEach((a) => {
+ if (names.get(a.filename)) {
+ names.set(a.filename, names.get(a.filename) + 1)
+ } else {
+ names.set(a.filename, 1)
+ }
+ })
+
+ // Change names of duplicates
+ attachments.forEach((a) => {
+ if (names.get(a.filename) > 1) {
+ const count = names.get(a.filename) - 1
+ names.set(a.filename, count)
+ a.filename = `${count}-${a.filename}`
+ }
+ })
+}
diff --git a/src/app/modules/submission/submission.constants.ts b/src/app/modules/submission/submission.constants.ts
new file mode 100644
index 0000000000..d76fd4b57e
--- /dev/null
+++ b/src/app/modules/submission/submission.constants.ts
@@ -0,0 +1,40 @@
+import { Joi } from 'celebrate'
+
+import { BasicField } from '../../../../shared/types'
+import { paymentConfig } from '../../config/features/payment.config'
+
+export const sharedSubmissionParams = {
+ responses: Joi.array()
+ .items(
+ Joi.object()
+ .keys({
+ _id: Joi.string().required(),
+ question: Joi.string(),
+ fieldType: Joi.string()
+ .required()
+ .valid(...Object.values(BasicField)),
+ answer: Joi.string().allow(''),
+ answerArray: Joi.array(),
+ filename: Joi.string(),
+ content: Joi.binary(),
+ isHeader: Joi.boolean(),
+ myInfo: Joi.object(),
+ signature: Joi.string().allow(''),
+ })
+ .xor('answer', 'answerArray') // only answer or answerArray can be present at once
+ .with('filename', 'content'), // if filename is present, content must be present
+ )
+ .required(),
+ paymentReceiptEmail: Joi.string(),
+ payments: Joi.object({
+ amount_cents: Joi.number()
+ .integer()
+ .positive()
+ .min(paymentConfig.minPaymentAmountCents)
+ .max(paymentConfig.maxPaymentAmountCents),
+ }),
+ responseMetadata: Joi.object({
+ responseTimeMs: Joi.number(),
+ numVisibleFields: Joi.number(),
+ }),
+}
diff --git a/src/app/modules/submission/submission.types.ts b/src/app/modules/submission/submission.types.ts
index 6fd5e44050..f687cdbc41 100644
--- a/src/app/modules/submission/submission.types.ts
+++ b/src/app/modules/submission/submission.types.ts
@@ -9,7 +9,7 @@ import {
} from '../../../../shared/types'
import {
EncryptAttachmentResponse,
- ParsedEmailAttachmentResponse,
+ ParsedClearAttachmentResponse,
} from '../../../types/api'
import { FormFieldSchema } from '../../../types/field'
import {
@@ -67,7 +67,7 @@ export type ProcessedChildrenResponse = ChildBirthRecordsResponse &
* Storage mode attachment response is the default response.
*/
export type ProcessedAttachmentResponse = (
- | ParsedEmailAttachmentResponse
+ | ParsedClearAttachmentResponse
| EncryptAttachmentResponse
) &
ProcessedResponse
diff --git a/src/app/modules/submission/submission.utils.ts b/src/app/modules/submission/submission.utils.ts
index 672abb7f02..bc5b0bec5c 100644
--- a/src/app/modules/submission/submission.utils.ts
+++ b/src/app/modules/submission/submission.utils.ts
@@ -8,6 +8,10 @@ import {
FormResponseMode,
} from '../../../../shared/types'
import { FieldResponse, FormFieldSchema, IFormDocument } from '../../../types'
+import {
+ ParsedClearAttachmentResponse,
+ ParsedClearFormFieldResponse,
+} from '../../../types/api'
import { AutoReplyMailData } from '../../services/mail/mail.types'
import { ConflictError } from './submission.errors'
@@ -155,3 +159,12 @@ export const getNormalisedResponseTime = (
) => {
return (10 * responseTimeMs) / numVisibleFields
}
+
+export const isAttachmentResponse = (
+ response: ParsedClearFormFieldResponse,
+): response is ParsedClearAttachmentResponse => {
+ return (
+ response.fieldType === BasicField.Attachment &&
+ response.content !== undefined
+ )
+}
diff --git a/src/app/routes/api/v3/forms/public-forms.submissions.routes.ts b/src/app/routes/api/v3/forms/public-forms.submissions.routes.ts
index 8988ad49b4..ad1c012a9c 100644
--- a/src/app/routes/api/v3/forms/public-forms.submissions.routes.ts
+++ b/src/app/routes/api/v3/forms/public-forms.submissions.routes.ts
@@ -30,8 +30,9 @@ PublicFormsSubmissionsRouter.route(
EmailSubmissionController.handleEmailSubmission,
)
+// TODO (FRM-1232): remove endpoint after encryption boundary is shifted
/**
- * Submit a form response, submit a form response, and stores the encrypted
+ * Submit a form response, validate submission params and stores the encrypted
* contents.
* Optionally, an autoreply confirming submission is sent back to the user, if
* an email address was given. SMS autoreplies for mobile number fields are also
@@ -48,3 +49,19 @@ PublicFormsSubmissionsRouter.route(
limitRate({ max: rateLimitConfig.submissions }),
EncryptSubmissionController.handleEncryptedSubmission,
)
+
+/**
+ * Submit a form response before public key encryption, performs pre-encryption
+ * steps (e.g. field validation, virus scanning) and stores the encrypted contents.
+ * @route POST /forms/:formId/submissions/storage
+ * @param response.body.required - contains the entire form submission
+ * @param captchaResponse.query - contains the reCAPTCHA response artifact, if any
+ * @returns 200 - submission made
+ * @returns 400 - submission has bad data and could not be processed
+ */
+PublicFormsSubmissionsRouter.route(
+ '/:formId([a-fA-F0-9]{24})/submissions/storage',
+).post(
+ limitRate({ max: rateLimitConfig.submissions }),
+ EncryptSubmissionController.handleStorageSubmission,
+)
diff --git a/src/app/routes/api/v3/payments/payments.routes.ts b/src/app/routes/api/v3/payments/payments.routes.ts
index 03ff819b07..19c27e72d9 100644
--- a/src/app/routes/api/v3/payments/payments.routes.ts
+++ b/src/app/routes/api/v3/payments/payments.routes.ts
@@ -20,24 +20,11 @@ PaymentsRouter.get(
StripeController.checkPaymentReceiptStatus,
)
-/**
- * Downloads the receipt pdf
- * @route GET /payments/:formId/:paymentId/receipt/download
- *
- * @returns 200 with receipt attatchment as content in PDF
- * @returns 404 if receipt url doesn't exist or payment does not exist
- */
-PaymentsRouter.get(
- '/:formId([a-fA-F0-9]{24})/:paymentId([a-fA-F0-9]{24})/receipt/download',
- limitRate({ max: rateLimitConfig.downloadPaymentReceipt }),
- StripeController.downloadPaymentReceipt,
-)
-
/**
* Downloads the invoice pdf
* @route GET /payments/:formId/:paymentId/invoice/download
*
- * @returns 200 with receipt attatchment as content in PDF
+ * @returns 200 with receipt attachment as content in PDF
* @returns 404 if receipt url doesn't exist or payment does not exist
*/
PaymentsRouter.get(
diff --git a/src/app/services/mail/mail.utils.ts b/src/app/services/mail/mail.utils.ts
index af3dc831df..392b0a2880 100644
--- a/src/app/services/mail/mail.utils.ts
+++ b/src/app/services/mail/mail.utils.ts
@@ -292,12 +292,12 @@ export const generatePaymentOnboardingHtml = ({
appName: string
}): string => {
return dedent`
- Dear Sir or Madam,
- Thank you for your interest in our payments feature! Download the file to learn how to get started with payments today!
+ Dear Form admin,
+ Thank you for your interest in our payments feature! Download our payments guide to learn how to start collecting payments on your form today!
If you have any questions regarding payments, feel free to reach out to support@form.gov.sg.
Regards,
- ${appName} team
+ ${appName}
`
}
diff --git a/src/app/utils/field-validation/answerValidator.factory.ts b/src/app/utils/field-validation/answerValidator.factory.ts
index ff8497722b..032589ccb5 100644
--- a/src/app/utils/field-validation/answerValidator.factory.ts
+++ b/src/app/utils/field-validation/answerValidator.factory.ts
@@ -14,6 +14,7 @@ import {
import { constructAttachmentValidator } from './validators/attachmentValidator'
import { constructCheckboxValidator } from './validators/checkboxValidator'
import { constructChildrenValidator } from './validators/childrenValidator'
+import { constructCountryRegionValidator } from './validators/countryRegionValidator'
import { constructDateValidator } from './validators/dateValidator'
import { constructDecimalValidator } from './validators/decimalValidator'
import { constructDropdownValidator } from './validators/dropdownValidator'
@@ -61,6 +62,8 @@ export const constructSingleAnswerValidator = (
return constructDecimalValidator(formField)
case BasicField.Dropdown:
return constructDropdownValidator(formField)
+ case BasicField.CountryRegion:
+ return constructCountryRegionValidator()
case BasicField.Email:
return constructEmailValidator(formField)
case BasicField.Uen:
diff --git a/src/app/utils/field-validation/validators/__tests__/country-region-validation.spec.ts b/src/app/utils/field-validation/validators/__tests__/country-region-validation.spec.ts
new file mode 100644
index 0000000000..12b0c50811
--- /dev/null
+++ b/src/app/utils/field-validation/validators/__tests__/country-region-validation.spec.ts
@@ -0,0 +1,115 @@
+import {
+ generateDefaultField,
+ generateNewSingleAnswerResponse,
+} from '__tests__/unit/backend/helpers/generate-form-data'
+
+import { ValidateFieldError } from 'src/app/modules/submission/submission.errors'
+import { validateField } from 'src/app/utils/field-validation'
+
+import { CountryRegion } from '../../../../../../shared/constants/countryRegion'
+import { BasicField } from '../../../../../../shared/types'
+
+// We want users to see the country/region options in title-case but we also need the data in the backend to remain in upper-case.
+// As such, in handleSubmitForm, which runs before validation, we change the title-case country/region value into upper-case.
+const simulateTransformationsHandleSubmitForm = (
+ countryRegion: CountryRegion,
+) => (countryRegion as string).toUpperCase()
+
+describe('Country/region validation', () => {
+ it('should allow valid option', () => {
+ const formField = generateDefaultField(BasicField.CountryRegion, {})
+ const response = generateNewSingleAnswerResponse(BasicField.CountryRegion, {
+ answer: simulateTransformationsHandleSubmitForm(CountryRegion.Singapore),
+ })
+
+ const validateResult = validateField('formId', formField, response)
+ expect(validateResult.isOk()).toBe(true)
+ expect(validateResult._unsafeUnwrap()).toEqual(true)
+ })
+
+ it('should disallow invalid option', () => {
+ const formField = generateDefaultField(BasicField.Dropdown, {})
+ const response = generateNewSingleAnswerResponse(BasicField.Dropdown, {
+ answer: 'NOT A COUNTRY/REGION',
+ })
+ const validateResult = validateField('formId', formField, response)
+ expect(validateResult.isErr()).toBe(true)
+ expect(validateResult._unsafeUnwrapErr()).toEqual(
+ new ValidateFieldError('Invalid answer submitted'),
+ )
+ })
+
+ it('should disallow empty answer when required', () => {
+ const formField = generateDefaultField(BasicField.CountryRegion, {})
+ const response = generateNewSingleAnswerResponse(BasicField.CountryRegion, {
+ answer: '',
+ })
+ const validateResult = validateField('formId', formField, response)
+ expect(validateResult.isErr()).toBe(true)
+ expect(validateResult._unsafeUnwrapErr()).toEqual(
+ new ValidateFieldError('Invalid answer submitted'),
+ )
+ })
+
+ it('should allow empty answer when not required', () => {
+ const formField = generateDefaultField(BasicField.CountryRegion, {
+ required: false,
+ })
+ const response = generateNewSingleAnswerResponse(BasicField.CountryRegion, {
+ answer: '',
+ })
+ const validateResult = validateField('formId', formField, response)
+ expect(validateResult.isOk()).toBe(true)
+ expect(validateResult._unsafeUnwrap()).toEqual(true)
+ })
+
+ it('should allow empty answer when it is required but not visible', () => {
+ const formField = generateDefaultField(BasicField.CountryRegion, {})
+ const response = generateNewSingleAnswerResponse(BasicField.CountryRegion, {
+ answer: '',
+ isVisible: false,
+ })
+ const validateResult = validateField('formId', formField, response)
+ expect(validateResult.isOk()).toBe(true)
+ expect(validateResult._unsafeUnwrap()).toEqual(true)
+ })
+
+ it('should disallow empty answer when it is required and visible', () => {
+ const formField = generateDefaultField(BasicField.CountryRegion, {})
+ const response = generateNewSingleAnswerResponse(BasicField.CountryRegion, {
+ answer: '',
+ })
+ const validateResult = validateField('formId', formField, response)
+ expect(validateResult.isErr()).toBe(true)
+ expect(validateResult._unsafeUnwrapErr()).toEqual(
+ new ValidateFieldError('Invalid answer submitted'),
+ )
+ })
+
+ it('should disallow multiple answers', () => {
+ const formField = generateDefaultField(BasicField.CountryRegion, {})
+ const response = generateNewSingleAnswerResponse(BasicField.CountryRegion, {
+ answer: [
+ simulateTransformationsHandleSubmitForm(CountryRegion.Singapore),
+ simulateTransformationsHandleSubmitForm(CountryRegion.Slovak_Republic),
+ ] as unknown as string,
+ })
+ const validateResult = validateField('formId', formField, response)
+ expect(validateResult.isErr()).toBe(true)
+ expect(validateResult._unsafeUnwrapErr()).toEqual(
+ new ValidateFieldError('Response has invalid shape'),
+ )
+ })
+ it('should disallow responses submitted for hidden fields', () => {
+ const formField = generateDefaultField(BasicField.CountryRegion, {})
+ const response = generateNewSingleAnswerResponse(BasicField.CountryRegion, {
+ answer: simulateTransformationsHandleSubmitForm(CountryRegion.Singapore),
+ isVisible: false,
+ })
+ const validateResult = validateField('formId', formField, response)
+ expect(validateResult.isErr()).toBe(true)
+ expect(validateResult._unsafeUnwrapErr()).toEqual(
+ new ValidateFieldError('Attempted to submit response on a hidden field'),
+ )
+ })
+})
diff --git a/src/app/utils/field-validation/validators/countryRegionValidator.ts b/src/app/utils/field-validation/validators/countryRegionValidator.ts
new file mode 100644
index 0000000000..c15a21b515
--- /dev/null
+++ b/src/app/utils/field-validation/validators/countryRegionValidator.ts
@@ -0,0 +1,38 @@
+import { chain, left, right } from 'fp-ts/lib/Either'
+import { flow } from 'fp-ts/lib/function'
+
+import { CountryRegion } from '../../../../../shared/constants/countryRegion'
+import { ResponseValidator } from '../../../../types/field/utils/validation'
+import { ProcessedSingleAnswerResponse } from '../../../modules/submission/submission.types'
+
+import { notEmptySingleAnswerResponse } from './common'
+import { isOneOfOptions } from './options'
+
+type CountryRegionValidator = ResponseValidator
+type CountryRegionValidatorConstructor = () => CountryRegionValidator
+
+/**
+ * Returns a validation function
+ * to check if country/region selection is one of the options.
+ * We need to validate the response against options in upper-case because PublicFormProvider.handleSubmitForm transforms the response into upper-case.
+ * We want users to see the country/region options in title-case but we also need the data in the backend to remain in upper-case.
+ */
+const makeCountryRegionValidator: CountryRegionValidatorConstructor =
+ () => (response) => {
+ const validOptions = Object.values(CountryRegion)
+ const validOptionsInUpperCase = validOptions.map((option) =>
+ option.toUpperCase(),
+ )
+ const { answer } = response
+ return isOneOfOptions(validOptionsInUpperCase, answer)
+ ? right(response)
+ : left(
+ `CountryRegionValidator:\t answer is not a valid country/region option`,
+ )
+ }
+
+/**
+ * Returns a validation function for a country/region field when called.
+ */
+export const constructCountryRegionValidator: CountryRegionValidatorConstructor =
+ () => flow(notEmptySingleAnswerResponse, chain(makeCountryRegionValidator()))
diff --git a/src/types/api/email_submission.ts b/src/types/api/email_submission.ts
index 5e9f2f3232..c52e7f83c7 100644
--- a/src/types/api/email_submission.ts
+++ b/src/types/api/email_submission.ts
@@ -1,23 +1,11 @@
import type { Merge } from 'type-fest'
import {
- AttachmentResponse,
EmailModeSubmissionContentDto,
- FieldResponse,
ResponseMetadata,
} from '../../../shared/types'
-/**
- * AttachmentResponses with additional server injected metadata on email forms.
- */
-export type ParsedEmailAttachmentResponse = AttachmentResponse & {
- filename: string
- content: Buffer
-}
-
-export type ParsedEmailFormFieldResponse =
- | Exclude
- | ParsedEmailAttachmentResponse
+import { ParsedClearFormFieldResponse } from './submission'
/**
* Email submission body after req.body's FormData has passed through the
@@ -26,7 +14,7 @@ export type ParsedEmailFormFieldResponse =
export type ParsedEmailModeSubmissionBody = Merge<
EmailModeSubmissionContentDto,
{
- responses: ParsedEmailFormFieldResponse[]
+ responses: ParsedClearFormFieldResponse[]
responseMetadata?: ResponseMetadata
}
>
diff --git a/src/types/api/encrypt_submission.ts b/src/types/api/encrypt_submission.ts
index 55a948bbfc..0c1afb6c04 100644
--- a/src/types/api/encrypt_submission.ts
+++ b/src/types/api/encrypt_submission.ts
@@ -6,6 +6,8 @@ import {
StorageModeSubmissionContentDto,
} from '../../../shared/types'
+import { ParsedEmailModeSubmissionBody } from './email_submission'
+
export type EncryptSubmissionDto = Merge<
StorageModeSubmissionContentDto,
{ responses: EncryptFormFieldResponse[] }
@@ -19,3 +21,11 @@ export type EncryptAttachmentResponse = AttachmentResponse & {
export type EncryptFormFieldResponse =
| Exclude
| EncryptAttachmentResponse
+
+/**
+ * Storage submission body after req.body's FormData has passed through the
+ * ReceiverMiddleware.receiveStorageSubmission middleware.
+ */
+export type ParsedStorageModeSubmissionBody = ParsedEmailModeSubmissionBody & {
+ version: number
+}
diff --git a/src/types/api/index.ts b/src/types/api/index.ts
index f67633b409..2e91794e1a 100644
--- a/src/types/api/index.ts
+++ b/src/types/api/index.ts
@@ -2,3 +2,4 @@ export * from './field'
export * from './form'
export * from './encrypt_submission'
export * from './email_submission'
+export * from './submission'
diff --git a/src/types/api/submission.ts b/src/types/api/submission.ts
new file mode 100644
index 0000000000..089f7558e2
--- /dev/null
+++ b/src/types/api/submission.ts
@@ -0,0 +1,13 @@
+import { AttachmentResponse, FieldResponse } from '../../../shared/types'
+
+/**
+ * AttachmentResponses with additional server injected metadata on email forms.
+ */
+export type ParsedClearAttachmentResponse = AttachmentResponse & {
+ filename: string
+ content: Buffer
+}
+
+export type ParsedClearFormFieldResponse =
+ | Exclude
+ | ParsedClearAttachmentResponse
diff --git a/src/types/field/countryRegionField.ts b/src/types/field/countryRegionField.ts
new file mode 100644
index 0000000000..517e23caa3
--- /dev/null
+++ b/src/types/field/countryRegionField.ts
@@ -0,0 +1,9 @@
+import { BasicField, CountryRegionFieldBase } from '../../../shared/types'
+
+import { IFieldSchema } from './baseField'
+
+export interface ICountryRegionFieldSchema
+ extends CountryRegionFieldBase,
+ IFieldSchema {
+ fieldType: BasicField.CountryRegion
+}
diff --git a/src/types/field/index.ts b/src/types/field/index.ts
index b68bb2c1b1..7fef28f146 100644
--- a/src/types/field/index.ts
+++ b/src/types/field/index.ts
@@ -4,6 +4,7 @@ import type { ConditionalExcept, Merge } from 'type-fest'
import type { IAttachmentFieldSchema } from './attachmentField'
import type { ICheckboxFieldSchema } from './checkboxField'
import type { IChildrenCompoundFieldSchema } from './childrenCompoundField'
+import type { ICountryRegionFieldSchema } from './countryRegionField'
import type { IDateFieldSchema } from './dateField'
import type { IDecimalFieldSchema } from './decimalField'
import type { IDropdownFieldSchema } from './dropdownField'
@@ -29,6 +30,7 @@ export * from './checkboxField'
export * from './dateField'
export * from './decimalField'
export * from './dropdownField'
+export * from './countryRegionField'
export * from './emailField'
export * from './homeNoField'
export * from './imageField'
@@ -63,6 +65,7 @@ export type FormFieldSchema =
| IDateFieldSchema
| IDecimalFieldSchema
| IDropdownFieldSchema
+ | ICountryRegionFieldSchema
| IEmailFieldSchema
| IHomenoFieldSchema
| IImageFieldSchema
@@ -104,6 +107,7 @@ export type FieldValidationSchema =
| OmitUnusedValidatorProps
| OmitUnusedValidatorProps
| OmitUnusedValidatorProps
+ | OmitUnusedValidatorProps
| OmitUnusedValidatorProps
| OmitUnusedValidatorProps
| OmitUnusedValidatorProps
diff --git a/src/types/form.ts b/src/types/form.ts
index 6f8f520762..86d10af692 100644
--- a/src/types/form.ts
+++ b/src/types/form.ts
@@ -61,6 +61,7 @@ type FormDefaultableKey =
| 'startPage'
| 'endPage'
| 'hasCaptcha'
+ | 'hasIssueNotification'
| 'authType'
| 'status'
| 'inactiveMessage'
@@ -250,6 +251,7 @@ interface IFormBaseDocument {
form_logics: NonNullable
permissionList: NonNullable
hasCaptcha: NonNullable
+ hasIssueNotification: NonNullable
authType: NonNullable
status: NonNullable
inactiveMessage: NonNullable
diff --git a/src/types/response/index.ts b/src/types/response/index.ts
index dd6607b200..4d6f110d0f 100644
--- a/src/types/response/index.ts
+++ b/src/types/response/index.ts
@@ -6,12 +6,12 @@ import {
import {
EncryptAttachmentResponse,
EncryptFormFieldResponse,
- ParsedEmailAttachmentResponse,
- ParsedEmailFormFieldResponse,
+ ParsedClearAttachmentResponse,
+ ParsedClearFormFieldResponse,
} from '../api'
export type IAttachmentResponse =
- | ParsedEmailAttachmentResponse
+ | ParsedClearAttachmentResponse
| EncryptAttachmentResponse
export type SingleAnswerFieldResponse =
@@ -23,7 +23,7 @@ export type SingleAnswerFieldResponse =
| ChildBirthRecordsResponse
>
| Exclude<
- ParsedEmailFormFieldResponse,
+ ParsedClearFormFieldResponse,
| TableResponse
| CheckboxResponse
| IAttachmentResponse
@@ -32,4 +32,4 @@ export type SingleAnswerFieldResponse =
export type FieldResponse =
| EncryptFormFieldResponse
- | ParsedEmailFormFieldResponse
+ | ParsedClearFormFieldResponse