18089118599

Committed 29 Sep 2025 07:21AM UTC coverage: 71.723% (-0.04%) from 71.76%

Build # 18089118599

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #8766 from opengovsg/release-al2

build: merge release v6.249.0 to develop

Run Details

3073 of 5208 branches covered (59.01%)

Branch coverage included in aggregate %.

10966 of 14366 relevant lines covered (76.33%)

48.03 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

82.37

/src/app/modules/form/admin-form/admin-form.controller.ts

import JoiDate from '@joi/date'
import axios from 'axios'
import { ObjectId } from 'bson'
import { celebrate, Joi as BaseJoi, Segments } from 'celebrate'
import { AuthedSessionData } from 'express-session'
import { StatusCodes } from 'http-status-codes'
import JSONStream from 'JSONStream'
import { ResultAsync } from 'neverthrow'

import {
  KB,
  MAX_UPLOAD_FILE_SIZE,
  VALID_UPLOAD_FILE_TYPES,
} from '../../../../../shared/constants/file'
import {
  AdminDashboardFormMetaDto,
  BasicField,
  CreateFormBodyDto,
  DeserializeTransform,
  DuplicateFormBodyDto,
  EndPageUpdateDto,
  ErrorDto,
  FieldCreateDto,
  FieldUpdateDto,
  FormAuthType,
  FormColorTheme,
  FormDto,
  FormFeedbackMetaDto,
  FormFieldDto,
  FormLogoState,
  FormResponseMode,
  FormSettings,
  FormWebhookResponseModeSettings,
  FormWebhookSettings,
  FormWorkflowDto,
  FormWorkflowStepDto,
  Language,
  LogicConditionState,
  LogicDto,
  LogicIfValue,
  LogicType,
  PermissionsUpdateDto,
  PreviewFormViewDto,
  PrivateFormErrorDto,
  PublicFormDto,
  SettingsUpdateDto,
  SmsCountsDto,
  StartPageUpdateDto,
  SubmissionCountQueryDto,
  WebhookSettingsUpdateDto,
} from '../../../../../shared/types'
import {
  EncryptedStringsMessageContent,
  encryptStringsMessage,
} from '../../../../../shared/utils/crypto'
import { IFormDocument, IPopulatedForm } from '../../../../types'
import {
  EncryptSubmissionDto,
  FormUpdateParams,
  ParsedEmailModeSubmissionBody,
} from '../../../../types/api'
import { goGovConfig } from '../../../config/features/gogov.config'
import { smsConfig } from '../../../config/features/sms.config'
import { createLoggerWithLabel } from '../../../config/logger'
import MailService from '../../../services/mail/mail.service'
import * as SmsService from '../../../services/sms/sms.service'
import { createReqMeta } from '../../../utils/request'
import * as AuthService from '../../auth/auth.service'
import {
  DatabaseConflictError,
  DatabaseError,
  DatabasePayloadSizeError,
  DatabaseValidationError,
} from '../../core/core.errors'
import { ControllerHandler } from '../../core/core.types'
import * as FeedbackService from '../../feedback/feedback.service'
import * as EmailSubmissionMiddleware from '../../submission/email-submission/email-submission.middleware'
import * as EmailSubmissionService from '../../submission/email-submission/email-submission.service'
import {
  mapRouteError as mapEmailSubmissionError,
  SubmissionEmailObj,
} from '../../submission/email-submission/email-submission.util'
import * as EncryptSubmissionService from '../../submission/encrypt-submission/encrypt-submission.service'
import ParsedResponsesObject from '../../submission/ParsedResponsesObject.class'
import * as ReceiverMiddleware from '../../submission/receiver/receiver.middleware'
import * as SubmissionService from '../../submission/submission.service'
import {
  extractEmailConfirmationData,
  mapAttachmentsFromResponses,
  mapRouteError as mapSubmissionError,
} from '../../submission/submission.utils'
import * as UserService from '../../user/user.service'
import { removeFormsFromAllWorkspaces } from '../../workspace/workspace.service'
import { PrivateFormError } from '../form.errors'
import * as FormService from '../form.service'
import { getSubmissionType } from '../form.utils'

import {
  PREVIEW_CORPPASS_UID,
  PREVIEW_CORPPASS_UINFIN,
  PREVIEW_SINGPASS_UINFIN,
} from './admin-form.constants'
import { EditFieldError, GoGovServerError } from './admin-form.errors'
import {
  createWorkflowStepValidator,
  getWebhookSettingsValidator,
  updateSettingsValidator,
  updateWebhookSettingsValidator,
  updateWorkflowStepValidator,
} from './admin-form.middlewares'
import * as AdminFormService from './admin-form.service'
import { PermissionLevel } from './admin-form.types'
import {
  mapGoGovErrors,
  mapRouteError,
  verifyValidUnicodeString,
} from './admin-form.utils'

// NOTE: Refer to this for documentation: https://github.com/sideway/joi-date/blob/master/API.md
const Joi = BaseJoi.extend(JoiDate) as typeof BaseJoi

const logger = createLoggerWithLabel(module)

// Validators
const createFormValidator = celebrate({
  [Segments.BODY]: {
    form: BaseJoi.object<CreateFormBodyDto>()
      .keys({
        // Require valid responsesMode field.
        responseMode: Joi.string()
          .valid(...Object.values(FormResponseMode))
          .required(),
        // Require title field.
        title: Joi.string().min(4).max(200).required(),
        // Require emails string (for backwards compatibility) or string
        // array if form to be created in Email mode.
        // Must be string array (which can be empty) if form is to be created in Encrypt mode.
        emails: Joi.when('responseMode', {
          switch: [
            {
              is: FormResponseMode.Email,
              then: Joi.alternatives()
                .try(
                  Joi.array().items(Joi.string().email()).min(1),
                  Joi.string().email(),
                )
                .required(),
            },
            {
              is: FormResponseMode.Encrypt,
              then: Joi.array().items(Joi.string().email()).required(),
            },
            {
              is: FormResponseMode.Multirespondent,
              then: Joi.forbidden(),
            },
          ],
          otherwise: Joi.forbidden(),
        }),
        // Require publicKey field if form to be created in Storage mode or
        // Multirespondent mode
        publicKey: Joi.when('responseMode', {
          is: [FormResponseMode.Encrypt, FormResponseMode.Multirespondent],
          then: Joi.string().required().disallow(''),
          otherwise: Joi.forbidden(),
        }),
        workspaceId: Joi.string(),
      })
      .required()
      // Allow other form schema keys to be passed for form creation.
      .unknown(true)
      .custom((value, helpers) => verifyValidUnicodeString(value, helpers)),
  },
})

const duplicateFormValidator = celebrate({
  // uses CreateFormBodyDto as that is the shape of the data used in client's WorkspaceService
  [Segments.BODY]: BaseJoi.object<DuplicateFormBodyDto>({
    // Require valid responsesMode field.
    responseMode: Joi.string()
      .valid(...Object.values(FormResponseMode))
      .required(),
    // Require title field.
    title: Joi.string().min(4).max(200).required(),
    // Require emails string (for backwards compatibility) or string array
    // if form to be duplicated in Email mode.
    emails: Joi.when('responseMode', {
      switch: [
        {
          is: FormResponseMode.Email,
          then: Joi.alternatives()
            .try(
              Joi.array().items(Joi.string().email()).min(1),
              Joi.string().email(),
            )
            .required(),
        },
        {
          is: FormResponseMode.Encrypt,
          then: Joi.array().items(Joi.string().email()).required(),
        },
        {
          is: FormResponseMode.Multirespondent,
          then: Joi.forbidden(),
        },
      ],
      otherwise: Joi.forbidden(),
    }),
    // Require publicKey field if form to be duplicated in Storage mode or
    // Multirespondent mode
    publicKey: Joi.when('responseMode', {
      is: [FormResponseMode.Encrypt, FormResponseMode.Multirespondent],
      then: Joi.string().required().disallow(''),
      otherwise: Joi.forbidden(),
    }),
    workspaceId: Joi.string(),
  }),
})

const transferFormOwnershipValidator = celebrate({
  [Segments.BODY]: {
    email: Joi.string()
      .required()
      .email()
      .message('Please enter a valid email')
      .lowercase(),
  },
})

const fileUploadValidator = celebrate({
  [Segments.BODY]: {
    fileId: Joi.string().required(),
    fileMd5Hash: Joi.string().base64().required(),
    fileType: Joi.string()
      .valid(...VALID_UPLOAD_FILE_TYPES)
      .required(),
    isNewClient: Joi.boolean().optional(), // TODO(#4228): isNewClient in param was allowed for backward compatibility after #4213 removed isNewClient flag from frontend. To remove 2 weeks after release.
  },
})

/**
 * Handler for GET /adminform endpoint.
 * @security session
 *
 * @returns 200 with list of forms user can access when list is retrieved successfully
 * @returns 422 when user of given id cannnot be found in the database
 * @returns 500 when database errors occur
 */
export const handleListDashboardForms: ControllerHandler<
  unknown,
  AdminDashboardFormMetaDto[] | ErrorDto
> = async (req, res) => {
  const authedUserId = (req.session as AuthedSessionData).user._id

  return AdminFormService.getDashboardForms(authedUserId)
    .map((dashboardView) => res.json(dashboardView))
    .mapErr((error) => {
      logger.error({
        message: 'Error listing dashboard forms',
        meta: {
          action: 'handleListDashboardForms',
          userId: authedUserId,
        },
        error,
      })
      const { errorMessage, statusCode } = mapRouteError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

/**
 * Handler for GET /:formId/adminform.
 * @security session
 *
 * @returns 200 with retrieved form with formId if user has read permissions
 * @returns 403 when user does not have permissions to access form
 * @returns 404 when form cannot be found
 * @returns 410 when form is archived
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleGetAdminForm: ControllerHandler<{ formId: string }> = (
  req,
  res,
) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  return (
    // Step 1: Retrieve currently logged in user.
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Check whether user has read permissions to form
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Read,
        }),
      )
      .map((form) => res.status(StatusCodes.OK).json({ form }))
      .mapErr((error) => {
        logger.error({
          message: 'Error retrieving single form',
          meta: {
            action: 'handleGetSingleForm',
            ...createReqMeta(req),
          },
          error,
        })

        const { statusCode, errorMessage } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for GET /api/v3/admin/forms/:formId/collaborators
 * @security session
 *
 * @returns 200 with collaborators
 * @returns 403 when current user does not have read permissions for the form
 * @returns 404 when form cannot be found
 * @returns 410 when retrieving collaborators for an archived form
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleGetFormCollaborators: ControllerHandler<
  { formId: string },
  PermissionsUpdateDto | ErrorDto
> = (req, res) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  return (
    // Step 1: Retrieve currently logged in user.
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Check whether user has read permissions to form
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Read,
        }),
      )
      .map(({ permissionList }) =>
        res.status(StatusCodes.OK).send(permissionList),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error retrieving form collaborators',
          meta: {
            action: 'handleGetFormCollaborators',
            ...createReqMeta(req),
          },
          error,
        })

        const { statusCode, errorMessage } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for GET /:formId/adminform/preview.
 * @security session
 *
 * @returns 200 with form with private details scrubbed for previewing if user has read permissions
 * @returns 403 when user does not have permissions to access form
 * @returns 404 when form cannot be found
 * @returns 410 when form is archived
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handlePreviewAdminForm: ControllerHandler<{ formId: string }> = (
  req,
  res,
) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id
  return (
    // Step 1: Retrieve currently logged in user.
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Check whether user has read permissions to form
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Read,
        }),
      )
      // Step 3: Remove private details from form for previewing.
      .map((populatedForm) => populatedForm.getPublicView())
      .map((scrubbedForm) =>
        res.status(StatusCodes.OK).json({ form: scrubbedForm }),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error previewing admin form',
          meta: {
            action: 'handlePreviewAdminForm',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for POST /:formId([a-fA-F0-9]{24})/adminform/images.
 * @security session
 *
 * @returns 200 with presigned POST URL object
 * @returns 400 when error occurs whilst creating presigned POST URL object
 * @returns 403 when user does not have write permissions for form
 * @returns 404 when form cannot be found
 * @returns 410 when form is archived
 * @returns 422 when user in session cannot be retrieved from the database
 */
export const createPresignedPostUrlForImages: ControllerHandler<
  { formId: string },
  unknown,
  {
    fileId: string
    fileMd5Hash: string
    fileType: string
  }
> = async (req, res) => {
  const { formId } = req.params
  const { fileId, fileMd5Hash, fileType } = req.body
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Adding random objectId ensures fileId is unpredictable by client
  const randomizedFileId = `${String(new ObjectId())}-${fileId}`

  return (
    // Step 1: Retrieve currently logged in user.
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Check whether user has write permissions to form
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )
      // Step 3: Has write permissions, generate presigned POST URL.
      .andThen(() =>
        AdminFormService.createPresignedPostUrlForImages({
          fileId: randomizedFileId,
          fileMd5Hash,
          fileType,
        }),
      )
      .map((presignedPostUrl) => res.json(presignedPostUrl))
      .mapErr((error) => {
        logger.error({
          message: 'Presigning post data encountered an error',
          meta: {
            action: 'createPresignedPostUrlForImages',
            ...createReqMeta(req),
          },
          error,
        })

        const { statusCode, errorMessage } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

export const handleCreatePresignedPostUrlForImages = [
  fileUploadValidator,
  createPresignedPostUrlForImages,
] as ControllerHandler[]

/**
 * Handler for POST /:formId([a-fA-F0-9]{24})/adminform/logos.
 * @security session
 *
 * @returns 200 with presigned POST URL object
 * @returns 400 when error occurs whilst creating presigned POST URL object
 * @returns 403 when user does not have write permissions for form
 * @returns 404 when form cannot be found
 * @returns 410 when form is archived
 * @returns 422 when user in session cannot be retrieved from the database
 */
export const createPresignedPostUrlForLogos: ControllerHandler<
  { formId: string },
  unknown,
  {
    fileId: string
    fileMd5Hash: string
    fileType: string
  }
> = async (req, res) => {
  const { formId } = req.params
  const { fileId, fileMd5Hash, fileType } = req.body
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Adding random objectId ensures fileId is unpredictable by client
  const randomizedFileId = `${String(new ObjectId())}-${fileId}`

  return (
    // Step 1: Retrieve currently logged in user.
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Check whether user has write permissions to form
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )
      // Step 3: Has write permissions, generate presigned POST URL.
      .andThen(() =>
        AdminFormService.createPresignedPostUrlForLogos({
          fileId: randomizedFileId,
          fileMd5Hash,
          fileType,
        }),
      )
      .map((presignedPostUrl) => res.json(presignedPostUrl))
      .mapErr((error) => {
        logger.error({
          message: 'Presigning post data encountered an error',
          meta: {
            action: 'createPresignedPostUrlForLogos',
            ...createReqMeta(req),
          },
          error,
        })

        const { statusCode, errorMessage } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

export const handleCreatePresignedPostUrlForLogos = [
  fileUploadValidator,
  createPresignedPostUrlForLogos,
] as ControllerHandler[]

// Validates that the ending date >= starting date
const validateDateRange = celebrate({
  [Segments.QUERY]: Joi.object()
    .keys({
      startDate: Joi.date().format('YYYY-MM-DD').raw(),
      endDate: Joi.date().format('YYYY-MM-DD').min(Joi.ref('startDate')).raw(),
    })
    .and('startDate', 'endDate'),
})

/**
 * NOTE: This is exported solely for testing
 * @security session
 *
 * @returns 200 with submission counts of given form
 * @returns 400 when query.startDate or query.endDate is malformed
 * @returns 403 when user does not have permissions to access form
 * @returns 404 when form cannot be found
 * @returns 410 when form is archived
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const countFormSubmissions: ControllerHandler<
  { formId: string },
  ErrorDto | number,
  unknown,
  SubmissionCountQueryDto
> = async (req, res) => {
  const { formId } = req.params
  const dateRange = req.query
  const sessionUserId = (req.session as AuthedSessionData).user._id

  const logMeta = {
    action: 'handleCountFormSubmissions',
    ...createReqMeta(req),
    userId: sessionUserId,
    formId,
  }

  // Step 1: Retrieve currently logged in user.
  const formResult = await UserService.getPopulatedUserById(
    sessionUserId,
  ).andThen((user) =>
    // Step 2: Check whether user has read permissions to form
    AuthService.getFormAfterPermissionChecks({
      user,
      formId,
      level: PermissionLevel.Read,
    }),
  )

  if (formResult.isErr()) {
    logger.warn({
      message: 'Error occurred when checking user permissions for form',
      meta: logMeta,
      error: formResult.error,
    })
    const { errorMessage, statusCode } = mapRouteError(formResult.error)
    return res.status(statusCode).json({ message: errorMessage })
  }

  // Step 3: Has permissions, continue to retrieve submission counts.
  return formResult
    .map(({ responseMode }) => getSubmissionType(responseMode))
    .asyncAndThen((submissionType) =>
      SubmissionService.getFormSubmissionsCount({
        formId,
        dateRange,
        submissionType, // RATIONALE: For storage mode forms converted from email mode, only count encrypt mode submissions
      }),
    )
    .map((count) => res.json(count))
    .mapErr((error) => {
      logger.error({
        message: 'Error retrieving form submission count',
        meta: {
          action: 'handleCountFormSubmissions',
          ...createReqMeta(req),
          userId: sessionUserId,
          formId,
        },
        error,
      })
      const { errorMessage, statusCode } = mapRouteError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

// Handler for GET /admin/forms/:formId/submissions/count
export const handleCountFormSubmissions = [
  validateDateRange,
  countFormSubmissions,
] as ControllerHandler[]

/**
 * Handler for GET /{formId}/adminform/feedback/count.
 * @security session
 *
 * @returns 200 with feedback counts of given form
 * @returns 403 when user does not have permissions to access form
 * @returns 404 when form cannot be found
 * @returns 410 when form is archived
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleCountFormFeedback: ControllerHandler<
  { formId: string },
  number | ErrorDto
> = async (req, res) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  return (
    // Step 1: Retrieve currently logged in user.
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Check whether user has read permissions to form
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Read,
        }),
      )
      // Step 3: Retrieve form feedback counts.
      .andThen(() => FeedbackService.getFormFeedbackCount(formId))
      .map((feedbackCount) => res.json(feedbackCount))
      // Some error occurred earlier in the chain.
      .mapErr((error) => {
        logger.error({
          message: 'Error retrieving form feedback count',
          meta: {
            action: 'handleCountFormFeedback',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for GET /{formId}/adminform/feedback/download.
 * @security session
 *
 * @returns 200 with feedback stream
 * @returns 403 when user does not have permissions to access form
 * @returns 404 when form cannot be found
 * @returns 410 when form is archived
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database or stream error occurs
 */
export const handleStreamFormFeedback: ControllerHandler<{
  formId: string
}> = async (req, res) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Retrieve currently logged in user.
  const hasReadPermissionResult = await UserService.getPopulatedUserById(
    sessionUserId,
  ).andThen((user) =>
    // Step 2: Check whether user has read permissions to form
    AuthService.getFormAfterPermissionChecks({
      user,
      formId,
      level: PermissionLevel.Read,
    }),
  )

  const logMeta = {
    action: 'handleStreamFormFeedback',
    ...createReqMeta(req),
    userId: sessionUserId,
    formId,
  }

  if (hasReadPermissionResult.isErr()) {
    logger.error({
      message: 'Error occurred whilst verifying user permissions',
      meta: logMeta,
      error: hasReadPermissionResult.error,
    })
    const { errorMessage, statusCode } = mapRouteError(
      hasReadPermissionResult.error,
    )
    return res.status(statusCode).json({ message: errorMessage })
  }

  // No errors, start stream.
  const cursor = FeedbackService.getFormFeedbackStream(formId)

  cursor
    .on('error', (error) => {
      logger.error({
        message: 'Error streaming feedback from MongoDB',
        meta: logMeta,
        error,
      })
      return res.status(StatusCodes.INTERNAL_SERVER_ERROR).json({
        message: 'Error retrieving from database.',
      })
    })
    .pipe(JSONStream.stringify())
    .on('error', (error) => {
      logger.error({
        message: 'Error converting feedback to JSON',
        meta: logMeta,
        error,
      })
      return res.status(StatusCodes.INTERNAL_SERVER_ERROR).json({
        message: 'Error converting feedback to JSON',
      })
    })
    .pipe(res.type('json'))
    .on('error', (error) => {
      logger.error({
        message: 'Error writing feedback to HTTP stream',
        meta: logMeta,
        error,
      })
      return res.status(StatusCodes.INTERNAL_SERVER_ERROR).json({
        message: 'Error writing feedback to HTTP stream',
      })
    })
    .on('close', () => {
      logger.info({
        message: 'Stream feedback closed',
        meta: logMeta,
      })

      return res.end()
    })
}

/**
 * Handler for GET /{formId}/adminform/feedback.
 * @security session
 *
 * @returns 200 with feedback response
 * @returns 403 when user does not have permissions to access form
 * @returns 404 when form cannot be found
 * @returns 410 when form is archived
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleGetFormFeedback: ControllerHandler<
  { formId: string },
  FormFeedbackMetaDto | ErrorDto
> = (req, res) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  return UserService.getPopulatedUserById(sessionUserId)
    .andThen((user) =>
      AuthService.getFormAfterPermissionChecks({
        user,
        formId,
        level: PermissionLevel.Read,
      }),
    )
    .andThen(() => FeedbackService.getFormFeedbacks(formId))
    .map((fbResponse) => res.json(fbResponse))
    .mapErr((error) => {
      logger.error({
        message: 'Error retrieving form feedbacks',
        meta: {
          action: 'handleGetFormFeedback',
          ...createReqMeta(req),
          userId: sessionUserId,
          formId,
        },
        error,
      })
      const { errorMessage, statusCode } = mapRouteError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

/**
 * Handler for DELETE /{formId}/adminform.
 * @security session
 *
 * @returns 200 with success message when successfully archived
 * @returns 403 when user does not have permissions to archive form
 * @returns 404 when form cannot be found
 * @returns 410 when form is already archived
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleArchiveForm: ControllerHandler<{ formId: string }> = async (
  req,
  res,
) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  return (
    // Step 1: Retrieve currently logged in user.
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Check whether user has delete permissions for form.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Delete,
        }),
      )
      // Step 3: Currently logged in user has permissions to archive form.
      .andThen((formToArchive) => AdminFormService.archiveForm(formToArchive))
      .andThen((archivedForm) => {
        // Step 4: For each collaborator, remove the form from their workspaces
        archivedForm.permissionList?.forEach(async (permissions) => {
          await UserService.findUserByEmail(permissions.email).map(
            async (user) =>
              await removeFormsFromAllWorkspaces({
                formIds: [formId],
                userId: user._id,
              }),
          )
        })
        // Step 5: remove form from workspace of current user
        return removeFormsFromAllWorkspaces({
          formIds: [formId],
          userId: sessionUserId,
        })
      })
      .map(() => res.json({ message: 'Form has been archived' }))
      .mapErr((error) => {
        logger.warn({
          message: 'Error occurred when archiving form',
          meta: {
            action: 'handleArchiveForm',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for POST /:formId/adminform
 * Duplicates the form corresponding to the formId. The currently logged in user
 * must have read permissions to the form being copied.
 * @note Even if current user is not admin of the form, the current user will be the admin of the new form
 * @security session
 *
 * @returns 200 with the duplicate form dashboard view
 * @returns 403 when user does not have permissions to access form
 * @returns 404 when form cannot be found
 * @returns 410 when form is archived
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const duplicateAdminForm: ControllerHandler<
  { formId: string },
  unknown,
  DuplicateFormBodyDto
> = (req, res) => {
  const { formId } = req.params
  const userId = (req.session as AuthedSessionData).user._id
  const { workspaceId, ...overrideParams } = req.body

  return (
    // Step 1: Retrieve currently logged in user.
    UserService.getPopulatedUserById(userId)
      .andThen((user) =>
        // Step 2: Check if current user has permissions to read form.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Read,
        })
          .andThen((originalForm) =>
            // Step 3: Duplicate form.
            AdminFormService.duplicateForm(
              originalForm,
              userId,
              overrideParams,
              { workspaceId: workspaceId },
            ),
          )
          // Step 4: Retrieve dashboard view of duplicated form.
          .map((duplicatedForm) => duplicatedForm.getDashboardView(user)),
      )
      // Success; return duplicated form's dashboard view.
      .map((dupedDashView) => res.json(dupedDashView))
      // Error; some error occurred in the chain.
      .mapErr((error) => {
        logger.error({
          message: 'Error duplicating form',
          meta: {
            action: 'duplicateAdminForm',
            ...createReqMeta(req),
            userId,
            formId,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

export const handleDuplicateAdminForm = [
  duplicateFormValidator,
  duplicateAdminForm,
] as ControllerHandler[]

/**
 * Handler for GET /:formId/adminform/template
 * Handler for GET /api/v3/admin/forms/:formId/use-template
 * @security session
 *
 * @returns 200 with target form's template view
 * @returns 403 when the target form is private
 * @returns 404 when form cannot be found
 * @returns 410 when form is archived
 * @returns 500 when database error occurs
 */
export const handleGetTemplateForm: ControllerHandler<
  { formId: string },
  PreviewFormViewDto | ErrorDto | PrivateFormErrorDto
> = (req, res) => {
  const { formId } = req.params
  const userId = (req.session as AuthedSessionData).user._id

  return (
    // Step 1: Retrieve form only if form is currently public.
    AuthService.getFormIfPublic(formId)
      // Step 2: Remove private form details before being returned.
      .map((populatedForm) => populatedForm.getPublicView())
      .map((scrubbedForm) =>
        res
          .status(StatusCodes.OK)
          .json({ form: scrubbedForm as PublicFormDto }),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error retrieving form template',
          meta: {
            action: 'handleGetTemplateForm',
            ...createReqMeta(req),
            userId,
            formId,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)

        // Specialized error response for PrivateFormError.
        if (error instanceof PrivateFormError) {
          return res.status(statusCode).json({
            message: error.message,
            // Flag to prevent default 404 subtext ("please check link") from
            // showing.
            isPageFound: true,
            formTitle: error.formTitle,
          })
        }
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for POST /:formId/adminform/use-template
 * Duplicates the form corresponding to the formId. The form must be public to
 * be copied.
 * @note The current user will be the admin of the new duplicated form
 * @security session
 *
 * @returns 200 with the new form dashboard view
 * @returns 403 when form is private
 * @returns 404 when form cannot be found
 * @returns 410 when form is archived
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleCopyTemplateForm: ControllerHandler<
  { formId: string },
  AdminDashboardFormMetaDto | ErrorDto,
  DuplicateFormBodyDto
> = (req, res) => {
  const { formId } = req.params
  const userId = (req.session as AuthedSessionData).user._id
  const overrideParams = req.body

  return (
    // Step 1: Retrieve currently logged in user.
    UserService.getPopulatedUserById(userId)
      .andThen((user) =>
        // Step 2: Check if form is currently public.
        AuthService.getFormIfPublic(formId).andThen((originalForm) =>
          // Step 3: Duplicate form.
          AdminFormService.duplicateForm(originalForm, userId, overrideParams, {
            duplicateStripped: true,
          })
            // Step 4: Retrieve dashboard view of duplicated form.
            .map((duplicatedForm) => duplicatedForm.getDashboardView(user)),
        ),
      )
      // Success; return new form's dashboard view.
      .map((dupedDashView) => res.json(dupedDashView))
      // Error; some error occurred in the chain.
      .mapErr((error) => {
        logger.error({
          message: 'Error copying template form',
          meta: {
            action: 'handleCopyTemplateForm',
            ...createReqMeta(req),
            userId: userId,
            formId,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)

        // Specialized error response for PrivateFormError.
        if (error instanceof PrivateFormError) {
          return res.status(statusCode).json({
            message: 'Form must be public to be copied',
          })
        }
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for POST /admin/forms/all-transfer-owner.
 * @security session
 *
 * @returns 200 with true if transfer was successful
 * @returns 400 when new owner is not in the database yet
 * @returns 400 when new owner is already current owner
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const transferAllFormsOwnership: ControllerHandler<
  unknown,
  unknown,
  { email: string }
> = (req, res) => {
  const { email: newOwnerEmail } = req.body
  const sessionUserId = (req.session as AuthedSessionData).user._id

  return (
    // Step 1: Retrieve currently logged in user.
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Transfer all forms to new owner
        AdminFormService.transferAllFormsOwnership(user, newOwnerEmail),
      )
      .map((data) => {
        return res.status(StatusCodes.OK).json(data)
      })
      // Some error occurred earlier in the chain.
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred whilst transferring all forms ownership',
          meta: {
            action: 'transferAllFormsOwnership',
            ...createReqMeta(req),
            userId: sessionUserId,
            newOwnerEmail,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

export const handleTransferAllFormsOwnership = [
  transferFormOwnershipValidator,
  transferAllFormsOwnership,
] as ControllerHandler[]

/**
 * Handler for POST /{formId}/adminform/transfer-owner.
 * @security session
 *
 * @returns 200 with updated form with transferred owners
 * @returns 400 when new owner is not in the database yet
 * @returns 400 when new owner is already current owner
 * @returns 403 when user is not the current owner of the form
 * @returns 404 when form cannot be found
 * @returns 410 when form is archived
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const transferFormOwnership: ControllerHandler<
  { formId: string },
  unknown,
  { email: string }
> = (req, res) => {
  const { formId } = req.params
  const { email: newOwnerEmail } = req.body
  const sessionUserId = (req.session as AuthedSessionData).user._id

  return (
    // Step 1: Retrieve currently logged in user.
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with delete permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Delete,
        }),
      )
      // Step 3: User has permissions, transfer form ownership.
      .andThen((retrievedForm) =>
        AdminFormService.transferFormOwnership(retrievedForm, newOwnerEmail),
      )
      // Success, return updated form.
      .map((updatedPopulatedForm) => res.json({ form: updatedPopulatedForm }))
      // Some error occurred earlier in the chain.
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred whilst transferring form ownership',
          meta: {
            action: 'transferFormOwnership',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            newOwnerEmail,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

export const handleTransferFormOwnership = [
  transferFormOwnershipValidator,
  transferFormOwnership,
] as ControllerHandler[]

/**
 * Handler for POST /adminform.
 * @security session
 *
 * @returns 200 with newly created form
 * @returns 409 when a database conflict error occurs
 * @returns 413 when payload for created form exceeds size limit
 * @returns 422 when user of given id cannnot be found in the database, or when form parameters are invalid
 * @returns 500 when database error occurs
 */
export const createForm: ControllerHandler<
  unknown,
  DeserializeTransform<FormDto> | ErrorDto,
  { form: CreateFormBodyDto }
> = async (req, res) => {
  const {
    form: { workspaceId, ...formParams },
  } = req.body
  const sessionUserId = (req.session as AuthedSessionData).user._id

  return (
    // Step 1: Retrieve currently logged in user.
    UserService.findUserById(sessionUserId)
      // Step 2: Create form with given params and set admin to logged in user.
      .andThen((user) =>
        AdminFormService.createForm(
          {
            ...formParams,
            admin: user._id,
          },
          workspaceId,
        ),
      )
      .map((createdForm) => {
        return res
          .status(StatusCodes.OK)
          .json(createdForm as DeserializeTransform<FormDto>)
      })
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when creating form',
          meta: {
            action: 'createForm',
            ...createReqMeta(req),
            userId: sessionUserId,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

export const handleCreateForm = [
  createFormValidator,
  createForm,
] as ControllerHandler[]

/**
 * Handler for PUT /:formId/adminform.
 * @security session
 *
 * @returns 200 with updated form
 * @returns 400 when form field has invalid updates to be performed
 * @returns 403 when current user does not have permissions to update form
 * @returns 404 when form to update cannot be found
 * @returns 409 when saving updated form incurs a conflict in the database
 * @returns 410 when form to update is archived
 * @returns 413 when updated form is too large to be saved in the database
 * @returns 422 when an invalid update is attempted on the form
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleUpdateForm: ControllerHandler<
  { formId: string },
  unknown,
  { form: FormUpdateParams }
> = (req, res) => {
  const { formId } = req.params
  const { form: formUpdateParams } = req.body
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Retrieve currently logged in user.
  return UserService.getPopulatedUserById(sessionUserId)
    .andThen((user) =>
      // Step 2: Retrieve form with write permission check.
      AuthService.getFormAfterPermissionChecks({
        user,
        formId,
        level: PermissionLevel.Write,
      }),
    )
    .andThen((retrievedForm) => {
      // Step 3: Update form or form fields depending on form update parameters
      // passed in.
      const { editFormField } = formUpdateParams

      // Use different service function depending on type of form update.
      const updateFormResult: ResultAsync<
        IPopulatedForm,
        | EditFieldError
        | DatabaseError
        | DatabaseValidationError
        | DatabaseConflictError
        | DatabasePayloadSizeError
      > = editFormField
        ? AdminFormService.editFormFields(retrievedForm, editFormField)
        : AdminFormService.updateForm(retrievedForm, formUpdateParams)

      return updateFormResult
    })
    .map((updatedForm) => res.status(StatusCodes.OK).json(updatedForm))
    .mapErr((error) => {
      logger.error({
        message: 'Error occurred when updating form',
        meta: {
          action: 'handleUpdateForm',
          ...createReqMeta(req),
          userId: sessionUserId,
          formId,
          formUpdateParams,
        },
        error,
      })
      const { errorMessage, statusCode } = mapRouteError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

/**
 * Handler for POST /:formId/fields/:fieldId/duplicate
 * @security session
 *
 * @returns 200 with duplicated field
 * @returns 400 when form field has invalid updates to be performed
 * @returns 403 when current user does not have permissions to update form
 * @returns 404 when form or field to duplicate cannot be found
 * @returns 409 when saving updated form field causes sms limit to be exceeded
 * @returns 409 when saving updated form incurs a conflict in the database
 * @returns 410 when form to update is archived
 * @returns 413 when updated form is too large to be saved in the database
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleDuplicateFormField: ControllerHandler<
  { formId: string; fieldId: string },
  FormFieldDto | ErrorDto
> = (req, res) => {
  const { formId, fieldId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Retrieve currently logged in user.
  return UserService.getPopulatedUserById(sessionUserId)
    .andThen((user) =>
      // Step 2: Retrieve form with write permission check.
      AuthService.getFormAfterPermissionChecks({
        user,
        formId,
        level: PermissionLevel.Write,
      }),
    )
    .andThen((form) => AdminFormService.duplicateFormField(form, fieldId))
    .map((duplicatedField) =>
      res.status(StatusCodes.OK).json(duplicatedField as FormFieldDto),
    )
    .mapErr((error) => {
      logger.error({
        message: 'Error occurred when duplicating field',
        meta: {
          action: 'handleDuplicateFormField',
          ...createReqMeta(req),
          userId: sessionUserId,
          formId,
          fieldId,
        },
        error,
      })
      const { errorMessage, statusCode } = mapRouteError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

export const _handleUpdateSettings: ControllerHandler<
  { formId: string },
  FormSettings | ErrorDto,
  SettingsUpdateDto
> = (req, res) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id
  const settingsToPatch = req.body

  // Step 1: Retrieve currently logged in user.
  return UserService.getPopulatedUserById(sessionUserId)
    .andThen((user) =>
      // Step 2: Retrieve form with write permission check.
      AuthService.getFormAfterPermissionChecks({
        user,
        formId,
        level: PermissionLevel.Write,
      }),
    )
    .andThen((retrievedForm) =>
      AdminFormService.updateFormSettings(retrievedForm, settingsToPatch),
    )
    .map((updatedSettings) => res.status(StatusCodes.OK).json(updatedSettings))
    .mapErr((error) => {
      logger.error({
        message: 'Error occurred when updating form settings',
        meta: {
          action: 'handleUpdateSettings',
          ...createReqMeta(req),
          userId: sessionUserId,
          formId,
          settingsKeysToUpdate: Object.keys(settingsToPatch),
        },
        error,
      })
      const { errorMessage, statusCode } = mapRouteError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

/**
 * Handler for PATCH /forms/:formId/settings.
 * @security session
 *
 * @returns 200 with updated form settings
 * @returns 400 when body is malformed
 * @returns 403 when current user does not have permissions to update form settings
 * @returns 404 when form to update settings for cannot be found
 * @returns 409 when saving form settings incurs a conflict in the database
 * @returns 410 when updating settings for archived form
 * @returns 413 when updating settings causes form to be too large to be saved in the database
 * @returns 422 when an invalid settings update is attempted on the form
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleUpdateSettings = [
  updateSettingsValidator,
  _handleUpdateSettings,
] as ControllerHandler[]

export const _handleUpdateWebhookSettings: ControllerHandler<
  { formId: string },
  FormWebhookSettings | ErrorDto,
  WebhookSettingsUpdateDto
> = (req, res) => {
  const { formId } = req.params
  const { userEmail, webhook: webhookSettings } = req.body
  const authedUserId = (req.session as AuthedSessionData).user._id

  logger.info({
    message: 'User attempting to update webhook settings',
    meta: {
      action: '_handleUpdateWebhookSettings',
      ...createReqMeta(req),
      reqBody: req.body,
      formId,
      userEmail,
      webhookSettings,
    },
  })

  // Step 1: Retrieve currently logged in user.
  return UserService.findUserById(authedUserId)
    .andThen((user) =>
      // Step 2: Retrieve form with write permission check.
      AuthService.getFormAfterPermissionChecks({
        user,
        formId,
        level: PermissionLevel.Write,
      }),
    )
    .andThen((retrievedForm) =>
      AdminFormService.updateFormSettings(retrievedForm, {
        webhook: webhookSettings,
      }),
    )
    .map((updatedSettings) => {
      const webhookSettings = { webhook: updatedSettings.webhook }
      res.status(StatusCodes.OK).json(webhookSettings)
    })
    .mapErr((error) => {
      logger.error({
        message: 'Error occurred when updating form settings',
        meta: {
          action: 'handleUpdateWebhookSettings',
          ...createReqMeta(req),
          userEmail,
          formId,
          settingsKeysToUpdate: Object.keys(webhookSettings),
        },
        error,
      })
      const { errorMessage, statusCode } = mapRouteError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

/**
 * Handler for PATCH api/public/v1/admin/forms/:formId/webhooksettings.
 * @security session
 *
 * @returns 200 with updated form settings
 * @returns 400 when body is malformed
 * @returns 403 when user email does not have permissions to update form settings
 * @returns 404 when form to update settings for cannot be found
 * @returns 409 when saving form settings incurs a conflict in the database
 * @returns 410 when updating settings for archived form
 * @returns 413 when updating settings causes form to be too large to be saved in the database
 * @returns 422 when an invalid settings update is attempted on the form
 * @returns 422 when user from user email cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleUpdateWebhookSettings = [
  updateWebhookSettingsValidator,
  _handleUpdateWebhookSettings,
] as ControllerHandler[]

export const _handleCreateWorkflowStep: ControllerHandler<
  { formId: string },
  FormWorkflowDto | ErrorDto,
  FormWorkflowStepDto
> = (req, res) => {
  const { formId } = req.params
  const workflowStepToCreate = req.body
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Retrieve currently logged in user.
  return (
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with write permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )
      // Step 3: User has permissions, proceed to create form field with provided body.
      .andThen((form) =>
        AdminFormService.createWorkflowStep(form, workflowStepToCreate),
      )
      .map((updatedWorkflow) =>
        res.status(StatusCodes.OK).json(updatedWorkflow),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when creating form field',
          meta: {
            action: 'handleCreateFormField',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            workflowStepToCreate,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

export const handleCreateWorkflowStep = [
  createWorkflowStepValidator,
  _handleCreateWorkflowStep,
]

const _handleUpdateWorkflowStep: ControllerHandler<
  {
    formId: string
    stepNumber: number
  },
  FormWorkflowDto | ErrorDto,
  FormWorkflowStepDto
> = (req, res) => {
  const { formId, stepNumber } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id
  const updatedWorkflowStep = req.body

  // Step 1: Retrieve currently logged in user.
  return UserService.getPopulatedUserById(sessionUserId)
    .andThen((user) =>
      // Step 2: Retrieve form with write permission check.
      AuthService.getFormAfterPermissionChecks({
        user,
        formId,
        level: PermissionLevel.Write,
      }),
    )
    .andThen((retrievedForm) =>
      AdminFormService.updateFormWorkflowStep(
        retrievedForm,
        stepNumber,
        updatedWorkflowStep,
      ),
    )
    .map((updatedWorkflow) => res.status(StatusCodes.OK).json(updatedWorkflow))
    .mapErr((error) => {
      logger.error({
        message: 'Error occurred when updating form workflow step',
        meta: {
          action: 'handleUpdateWorkflowStep',
          ...createReqMeta(req),
          userId: sessionUserId,
          formId,
          updatedWorkflowStep,
        },
        error,
      })
      const { errorMessage, statusCode } = mapRouteError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

export const handleUpdateWorkflowStep = [
  updateWorkflowStepValidator,
  _handleUpdateWorkflowStep,
] as ControllerHandler[]

export const handleDeleteWorkflowStep: ControllerHandler<
  {
    formId: string
    stepNumber: number
  },
  FormWorkflowDto | ErrorDto
> = (req, res) => {
  const { formId, stepNumber } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Retrieve currently logged in user.
  return (
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with write permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )
      // Step 3: Delete workflow step.
      .andThen((retrievedForm) =>
        AdminFormService.deleteFormWorkflowStep(retrievedForm, stepNumber),
      )
      .map((updatedWorkflow) =>
        res.status(StatusCodes.OK).json(updatedWorkflow),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when deleting form workflow step',
          meta: {
            action: 'handleDeleteWorkflowStep',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            stepNumber,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

const LIMIT_IN_KB = 250
const STRING_MAX_LENGTH = LIMIT_IN_KB * KB
const _handleUpdateWhitelistSettingValidator = celebrate({
  [Segments.PARAMS]: Joi.object({
    formId: Joi.string()
      .required()
      .pattern(/^[a-fA-F0-9]{24}$/)
      .message('Your form ID is invalid.'),
  }),
  [Segments.BODY]: Joi.object({
    whitelistCsvString: Joi.string()
      .allow(null) // for removal of whitelist
      .max(STRING_MAX_LENGTH)
      .pattern(/^[a-zA-Z0-9,\r\n]+$/)
      .messages({
        'string.empty': 'Your csv is empty.',
        'string.pattern.base': 'Your csv has one or more invalid characters.',
        'string.max': `You have exceeded the file size limit, please upload a file below ${LIMIT_IN_KB} kB.`,
      }),
  }),
})

const _parseWhitelistCsvString = (whitelistCsvString: string | null) => {
  if (!whitelistCsvString) {
    return null
  }
  return whitelistCsvString.split(',').map((entry: string) => entry.trim())
}

const _handleUpdateWhitelistSetting: ControllerHandler<
  { formId: string },
  object,
  { whitelistCsvString: string | null }
> = async (req, res) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  const logMeta = {
    action: '_handleUpdateWhitelistSetting',
    ...createReqMeta(req),
    userId: sessionUserId,
    formId,
  }

  // Step 1: Retrieve form only if currently logged in user has write permissions for form.
  const formResult = await UserService.getPopulatedUserById(
    sessionUserId,
  ).andThen((user) =>
    AuthService.getFormAfterPermissionChecks({
      user,
      formId,
      level: PermissionLevel.Write,
    }),
  )

  if (formResult.isErr()) {
    const { error } = formResult
    logger.error({
      message: 'Error occurred when updating form settings',
      meta: logMeta,
      error,
    })
    const { errorMessage, statusCode } = mapRouteError(error)
    return res.status(statusCode).json({ message: errorMessage })
  }

  const form = formResult.value

  const { whitelistCsvString } = req.body
  const whitelistedSubmitterIds = _parseWhitelistCsvString(whitelistCsvString)

  const upperCaseWhitelistedSubmitterIds =
    whitelistedSubmitterIds && whitelistedSubmitterIds.length > 0
      ? whitelistedSubmitterIds.map((id) => id.toUpperCase())
      : null

  // Step 2: perform validation on submitted whitelist setting
  const isWhitelistSettingValid = AdminFormService.checkIsWhitelistSettingValid(
    upperCaseWhitelistedSubmitterIds,
  )
  if (!isWhitelistSettingValid.isValid) {
    logger.error({
      message: 'Invalid whitelist setting',
      meta: logMeta,
    })
    return res.status(StatusCodes.UNPROCESSABLE_ENTITY).json({
      message: isWhitelistSettingValid.invalidReason,
    })
  }

  // Step 3: Encrypt whitelist settings
  if (!form.publicKey) {
    logger.error({
      message: 'Form does not have a public key',
      meta: logMeta,
    })
    return res.status(StatusCodes.INTERNAL_SERVER_ERROR).json({
      message: 'Form does not have a public key',
    })
  }
  const formPublicKey = form.publicKey
  const encryptedWhitelistSubmitterIdsContent = upperCaseWhitelistedSubmitterIds
    ? encryptStringsMessage(upperCaseWhitelistedSubmitterIds, formPublicKey)
    : null

  // Step 4: Update form with encrypted whitelist settings
  return AdminFormService.updateFormWhitelistSetting(
    form,
    encryptedWhitelistSubmitterIdsContent,
  )
    .map((updatedSettings) => res.status(StatusCodes.OK).json(updatedSettings))
    .mapErr((error) => {
      logger.error({
        message: 'Error occurred when updating form settings',
        meta: {
          action: 'handleUpdateSettings',
          ...createReqMeta(req),
          userId: sessionUserId,
          formId,
          // do not log the whitelist setting as it may contain sensitive data and be large in size
        },
        error,
      })
      const { errorMessage, statusCode } = mapRouteError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

export const _handleUpdateWhitelistSettingForTest =
  _handleUpdateWhitelistSetting

export const handleUpdateWhitelistSetting = [
  _handleUpdateWhitelistSettingValidator,
  _handleUpdateWhitelistSetting,
] as ControllerHandler[]

/**
 * NOTE: Exported for testing.
 * Private handler for PUT /forms/:formId/fields/:fieldId
 * @precondition Must be preceded by request validation
 */
export const _handleUpdateFormField: ControllerHandler<
  {
    formId: string
    fieldId: string
  },
  FormFieldDto | ErrorDto,
  FieldUpdateDto
> = (req, res) => {
  const { formId, fieldId } = req.params
  const updatedFormField = req.body
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Retrieve currently logged in user.
  return (
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with write permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )
      // Step 3: User has permissions, update form field of retrieved form.
      .andThen((form) =>
        AdminFormService.updateFormField(form, fieldId, updatedFormField),
      )
      .map((updatedFormField) =>
        res.status(StatusCodes.OK).json(updatedFormField as FormFieldDto),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when updating form field',
          meta: {
            action: 'handleUpdateFormField',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            fieldId,
            updateFieldBody: updatedFormField,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for GET /form/:formId/settings.
 * @security session
 *
 * @returns 200 with latest form settings on successful update
 * @returns 403 when current user does not have permissions to obtain form settings
 * @returns 404 when form to retrieve settings for cannot be found
 * @returns 409 when saving form settings incurs a conflict in the database
 * @returns 500 when database error occurs
 */
export const handleGetSettings: ControllerHandler<
  { formId: string },
  FormSettings | ErrorDto
> = (req, res) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  return UserService.getPopulatedUserById(sessionUserId)
    .andThen((user) =>
      // Retrieve form for settings as well as for permissions checking
      FormService.retrieveFullFormById(formId).map((form) => ({
        form,
        user,
      })),
    )
    .andThen(AuthService.checkFormForPermissions(PermissionLevel.Read))
    .map((form) => res.status(StatusCodes.OK).json(form.getSettings()))
    .mapErr((error) => {
      logger.error({
        message: 'Error occurred when retrieving form settings',
        meta: {
          action: 'handleGetSettings',
          ...createReqMeta(req),
          userId: sessionUserId,
          formId,
        },
        error,
      })
      const { errorMessage, statusCode } = mapRouteError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

export const handleGetWhitelistSetting: ControllerHandler<
  {
    formId: string
  },
  | {
      encryptedWhitelistedSubmitterIds: EncryptedStringsMessageContent | null
    }
  | ErrorDto
> = (req, res) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  return UserService.getPopulatedUserById(sessionUserId)
    .andThen((user) =>
      // Retrieve form for settings as well as for permissions checking
      FormService.retrieveFullFormById(formId).map((form) => ({
        form,
        user,
      })),
    )
    .andThen(AuthService.checkFormForPermissions(PermissionLevel.Read))
    .andThen((form) => EncryptSubmissionService.checkFormIsEncryptMode(form))
    .map(async (form) => AdminFormService.getFormWhitelistSetting(form))
    .andThen((formWhitelistedSubmitterIds) => formWhitelistedSubmitterIds)
    .map((formWhitelistedSubmitterIds) => {
      return res.status(StatusCodes.OK).json({
        encryptedWhitelistedSubmitterIds: formWhitelistedSubmitterIds,
      })
    })
    .mapErr((error: Error) => {
      logger.error({
        message: 'Error occurred when retrieving form whitelist settings',
        meta: {
          action: 'handleGetWhitelistSetting',
          ...createReqMeta(req),
          userId: sessionUserId,
          formId,
        },
        error,
      })
      const { errorMessage, statusCode } = mapRouteError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

/**
 * Handler for POST api/public/v1/admin/forms/:formId/webhooksettings.
 *
 * @returns 200 with latest webhook and response mode settings
 * @returns 401 when current user is not logged in
 * @returns 403 when current user does not have permissions to obtain form settings
 * @returns 404 when form to retrieve settings for cannot be found
 * @returns 422 when user from user email cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const _handleGetWebhookSettings: ControllerHandler<
  { formId: string },
  FormWebhookResponseModeSettings | ErrorDto,
  { userEmail: string }
> = (req, res) => {
  const { formId } = req.params
  const { userEmail } = req.body
  const authedUserId = (req.session as AuthedSessionData).user._id

  const logMeta = {
    action: 'handleGetWebhookSettings',
    ...createReqMeta(req),
    userEmail,
    formId,
  }

  logger.info({
    message: 'User attempting to get webhook settings',
    meta: logMeta,
  })

  return UserService.findUserById(authedUserId)
    .mapErr((error) => {
      logger.error({
        message: 'Error occurred when retrieving user from database',
        meta: logMeta,
        error,
      })
      return error
    })
    .andThen((user) =>
      // Retrieve form for settings as well as for permissions checking
      FormService.retrieveFullFormById(formId).map((form) => ({
        form,
        user,
      })),
    )
    .andThen(AuthService.checkFormForPermissions(PermissionLevel.Read))
    .map((form) =>
      res.status(StatusCodes.OK).json(form.getWebhookAndResponseModeSettings()),
    )
    .mapErr((error) => {
      logger.error({
        message: 'Error occurred when retrieving form settings',
        meta: logMeta,
        error,
      })
      const { errorMessage, statusCode } = mapRouteError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

/**
 * Handler for POST api/public/v1/admin/forms/:formId/webhooksettings.
 * @security session
 *
 * @returns 200 with latest webhook and response mode settings
 * @returns 400 when body is malformed
 * @returns 401 when current user is not logged in
 * @returns 403 when user email does not have permissions to obtain form settings
 * @returns 404 when form to retrieve settings for cannot be found
 * @returns 422 when user from user email cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleGetWebhookSettings = [
  getWebhookSettingsValidator,
  _handleGetWebhookSettings,
] as ControllerHandler[]

/**
 * Handler for POST /v2/submissions/encrypt/preview/:formId.
 * @security session
 *
 * @returns 200 with a mock submission ID
 * @returns 400 when body is malformed; e.g. invalid plaintext responses or encoding for encrypted content
 * @returns 403 when current user does not have read permissions to given form
 * @returns 404 when given form ID does not exist
 * @returns 410 when given form has been deleted
 * @returns 422 when user ID in session is not found in database
 * @returns 500 when database error occurs
 */
export const submitEncryptPreview: ControllerHandler<
  { formId: string },
  { message: string; submissionId: string } | ErrorDto,
  EncryptSubmissionDto
> = async (req, res) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id
  // No need to process attachments as we don't do anything with them
  const logMeta = {
    action: 'submitEncryptPreview',
    formId,
  }

  // eslint-disable-next-line typesafe/no-await-without-trycatch
  return UserService.getPopulatedUserById(sessionUserId)
    .andThen((user) =>
      // Step 2: Retrieve form with write permission check.
      AuthService.getFormAfterPermissionChecks({
        user,
        formId,
        level: PermissionLevel.Read,
      }),
    )
    .andThen((form) =>
      EncryptSubmissionService.checkFormIsEncryptMode(form).mapErr((error) => {
        logger.error({
          message: 'Error while retrieving form for preview submission',
          meta: logMeta,
          error,
        })
        return error
      }),
    )
    .map(() => {
      const fakeSubmissionId = new ObjectId().toString()
      // Return the reply early to the submitter
      return res.json({
        message: 'Form submission successful.',
        submissionId: fakeSubmissionId,
      })
    })
    .mapErr((error) => {
      const { errorMessage, statusCode } = mapSubmissionError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

export const handleEncryptPreviewSubmission = [
  submitEncryptPreview,
] as ControllerHandler[]

/**
 * Handler for POST /v2/submissions/email/preview/:formId.
 * @security session
 *
 * @returns 200 with a mock submission ID
 * @returns 400 when body is malformed; e.g. invalid responses, or when admin email fails to be sent
 * @returns 403 when current user does not have read permissions to given form
 * @returns 404 when given form ID does not exist
 * @returns 410 when given form has been deleted
 * @returns 422 when user ID in session is not found in database
 * @returns 500 when database error occurs
 */
export const submitEmailPreview: ControllerHandler<
  { formId: string },
  { message: string; submissionId?: string },
  ParsedEmailModeSubmissionBody,
  { captchaResponse?: unknown }
> = async (req, res) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id
  // No need to process attachments as we don't do anything with them
  const { responses } = req.body
  const logMeta = {
    action: 'submitEmailPreview',
    formId,
    ...createReqMeta(req),
  }

  const formResult = await UserService.getPopulatedUserById(sessionUserId)
    .andThen((user) =>
      AuthService.getFormAfterPermissionChecks({
        user,
        formId,
        level: PermissionLevel.Read,
      }),
    )
    .andThen(EmailSubmissionService.checkFormIsEmailMode)
  if (formResult.isErr()) {
    logger.error({
      message: 'Error while retrieving form for preview submission',
      meta: logMeta,
      error: formResult.error,
    })
    const { errorMessage, statusCode } = mapEmailSubmissionError(
      formResult.error,
    )
    return res.status(statusCode).json({ message: errorMessage })
  }
  const form = formResult.value

  const parsedResponsesResult = await SubmissionService.validateAttachments(
    responses,
    form.responseMode,
  ).andThen(() => ParsedResponsesObject.parseResponses(form, responses))
  if (parsedResponsesResult.isErr()) {
    logger.error({
      message: 'Error while parsing responses for preview submission',
      meta: logMeta,
      error: parsedResponsesResult.error,
    })
    const { errorMessage, statusCode } = mapEmailSubmissionError(
      parsedResponsesResult.error,
    )
    return res.status(statusCode).json({ message: errorMessage })
  }
  const parsedResponses = parsedResponsesResult.value
  const attachments = mapAttachmentsFromResponses(req.body.responses)

  // Handle SingPass, CorpPass and MyInfo authentication and validation
  const { authType } = form
  if (authType === FormAuthType.SP || authType === FormAuthType.MyInfo) {
    parsedResponses.addNdiResponses({
      authType,
      uinFin: PREVIEW_SINGPASS_UINFIN,
    })
  } else if (authType === FormAuthType.CP) {
    parsedResponses.addNdiResponses({
      authType,
      uinFin: PREVIEW_CORPPASS_UINFIN,
      userInfo: PREVIEW_CORPPASS_UID,
    })
  }

  const emailData = new SubmissionEmailObj(
    parsedResponses.getAllResponses(),
    // All MyInfo fields are verified in preview
    new Set(AdminFormService.extractMyInfoFieldIds(form.form_fields)),
    form.authType,
  )
  const submission = EmailSubmissionService.createEmailSubmissionWithoutSave(
    form,
    // Don't need to care about response hash or salt
    '',
    '',
  )

  const sendAdminEmailResult = await MailService.sendSubmissionToAdmin({
    replyToEmails: EmailSubmissionService.extractEmailAnswers(
      parsedResponses.getAllResponses(),
    ),
    form,
    submission,
    attachments,
    dataCollationData: emailData.dataCollationData,
    formData: emailData.formData,
  })
  if (sendAdminEmailResult.isErr()) {
    logger.error({
      message: 'Error sending submission to admin',
      meta: logMeta,
      error: sendAdminEmailResult.error,
    })
    const { statusCode, errorMessage } = mapEmailSubmissionError(
      sendAdminEmailResult.error,
    )
    return res.status(statusCode).json({
      message: errorMessage,
    })
  }

  // Don't await on email confirmations, so submission is successful even if
  // this fails
  void SubmissionService.sendEmailConfirmations({
    form,
    submission,
    attachments,
    responsesData: emailData.autoReplyData,
    recipientData: extractEmailConfirmationData(
      parsedResponses.getAllResponses(),
      form.form_fields,
    ),
    isUseLambdaOutput: false, // TODO: [PDF-LAMBDA-GENERATION]: To remove once pdf lambda rollout is complete. Currently set to false since v2 api is not being used.
  }).mapErr((error) => {
    logger.error({
      message: 'Error while sending email confirmations',
      meta: logMeta,
      error,
    })
  })

  return res.json({
    message: 'Form submission successful.',
    submissionId: submission.id,
  })
}

export const handleEmailPreviewSubmission = [
  ReceiverMiddleware.receiveEmailSubmission,
  EmailSubmissionMiddleware.validateResponseParams,
  submitEmailPreview,
] as ControllerHandler[]

/**
 * Handler for PUT /forms/:formId/fields/:fieldId
 * @security session
 *
 * @returns 200 with updated form field
 * @returns 403 when current user does not have permissions to update form field
 * @returns 404 when form cannot be found
 * @returns 404 when form field cannot be found
 * @returns 409 when form field update conflicts with database state
 * @returns 410 when updating form field of an archived form
 * @returns 413 when updating form field causes form to be too large to be saved in the database
 * @returns 422 when an invalid form field update is attempted on the form
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleUpdateFormField = [
  celebrate(
    {
      [Segments.BODY]: Joi.object({
        // Ensures given field is same as accessed field.
        _id: Joi.string().valid(Joi.ref('$params.fieldId')).required(),
        fieldType: Joi.string()
          .valid(...Object.values(BasicField))
          .required(),
        description: Joi.string().allow('').required(),
        required: Joi.boolean().required(),
        title: Joi.string().trim().required(),
        disabled: Joi.boolean().required(),
        // Allow other field related key-values to be provided and let the model
        // layer handle the validation.
      })
        .unknown(true)
        .custom((value, helpers) => verifyValidUnicodeString(value, helpers)),
    },
    undefined,
    // Required so req.body can be validated against values in req.params.
    // See https://github.com/arb/celebrate#celebrateschema-joioptions-opts.
    { reqContext: true },
  ),
  _handleUpdateFormField,
]

const _handleUpdateOptionsToRecipientsMap: ControllerHandler<
  {
    formId: string
    fieldId: string
  },
  FormFieldDto | ErrorDto,
  {
    optionsToRecipientsMap: Record<string, string[]>
    fieldOptions: string[]
  }
> = (req, res) => {
  const { formId, fieldId } = req.params
  const { optionsToRecipientsMap, fieldOptions } = req.body
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Retrieve currently logged in user.
  return UserService.getPopulatedUserById(sessionUserId)
    .andThen((user) =>
      // Step 2: Retrieve form with write permission check.
      AuthService.getFormAfterPermissionChecks({
        user,
        formId,
        level: PermissionLevel.Write,
      }),
    )
    .andThen((form) => {
      return AdminFormService.updateOptionsToRecipientsMap(
        form,
        fieldId,
        optionsToRecipientsMap,
        fieldOptions,
      )
    })
    .map((updatedFormField) =>
      res.status(StatusCodes.OK).json(updatedFormField as FormFieldDto),
    )
    .mapErr((error) => {
      logger.error({
        message: 'Error occurred when updating options to recipients map',
        meta: {
          action: '_handleUpdateOptionsToRecipientsMap',
          ...createReqMeta(req),
          userId: sessionUserId,
          formId,
          fieldId,
          optionsToRecipientsMap,
        },
        error,
      })
      const { errorMessage, statusCode } = mapRouteError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

export const handleUpdateOptionsToRecipientsMap = [
  celebrate({
    [Segments.BODY]: Joi.object({
      optionsToRecipientsMap: Joi.object(),
      fieldOptions: Joi.array().items(Joi.string()).required(),
    }),
    [Segments.PARAMS]: Joi.object({
      formId: Joi.string().required(),
      fieldId: Joi.string().required(),
    }),
  }),
  _handleUpdateOptionsToRecipientsMap,
] as ControllerHandler[]

/**
 * NOTE: Exported for testing.
 * Private handler for POST /forms/:formId/fields
 * @precondition Must be preceded by request validation
 * @security session
 *
 * @returns 200 with created form field
 * @returns 403 when current user does not have permissions to create a form field
 * @returns 404 when form cannot be found
 * @returns 409 when form field update conflicts with database state
 * @returns 410 when creating form field for an archived form
 * @returns 413 when creating form field causes form to be too large to be saved in the database
 * @returns 422 when an invalid form field creation is attempted on the form
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const _handleCreateFormField: ControllerHandler<
  { formId: string },
  FormFieldDto | ErrorDto,
  FieldCreateDto,
  { to?: number }
> = (req, res) => {
  const { formId } = req.params
  const { to } = req.query
  const formFieldToCreate = req.body
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Retrieve currently logged in user.
  return (
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with write permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )
      // Step 3: User has permissions, proceed to create form field with provided body.
      .andThen((form) =>
        AdminFormService.createFormField(form, formFieldToCreate, to),
      )
      .map((createdFormField) =>
        res.status(StatusCodes.OK).json(createdFormField as FormFieldDto),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when creating form field',
          meta: {
            action: '_handleCreateFormField',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            createFieldBody: formFieldToCreate,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * NOTE: Exported for testing.
 * Private handler for POST /forms/:formId/logic
 * @precondition Must be preceded by request validation
 * @security session
 *
 * @returns 200 with created logic object when successfully created
 * @returns 403 when user does not have permissions to create logic
 * @returns 404 when form cannot be found
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const _handleCreateLogic: ControllerHandler<
  { formId: string },
  LogicDto | ErrorDto,
  LogicDto
> = (req, res) => {
  const { formId } = req.params
  const createLogicBody = req.body
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Retrieve currently logged in user.
  return (
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with write permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )
      // Step 3: Create form logic
      .andThen((retrievedForm) =>
        AdminFormService.createFormLogic(retrievedForm, createLogicBody),
      )
      .map((createdLogic) =>
        res.status(StatusCodes.OK).json(createdLogic as LogicDto),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when creating form logic',
          meta: {
            action: 'handleCreateLogic',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            createLogicBody,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Shape of request body used for joi validation for create and update logic
 */
const joiLogicBody = {
  logicType: Joi.string()
    .valid(...Object.values(LogicType))
    .required(),
  conditions: Joi.array()
    .items(
      Joi.object({
        field: Joi.string().required(),
        state: Joi.string()
          .valid(...Object.values(LogicConditionState))
          .required(),
        value: Joi.alternatives()
          .try(
            Joi.number(),
            Joi.string(),
            Joi.array().items(Joi.string()),
            Joi.array().items(Joi.number()),
          )
          .required(),
        ifValueType: Joi.string()
          .valid(...Object.values(LogicIfValue))
          .required(),
      }).unknown(true),
    )
    .required(),
  show: Joi.alternatives().conditional('logicType', {
    is: LogicType.ShowFields,
    then: Joi.array().items(Joi.string()).required(),
  }),
  preventSubmitMessage: Joi.alternatives().conditional('logicType', {
    is: LogicType.PreventSubmit,
    then: Joi.string().required(),
  }),
  preventSubmitMessageTranslations: Joi.alternatives().conditional(
    'logicType',
    {
      is: LogicType.PreventSubmit,
      then: Joi.array()
        .items(
          Joi.object({
            language: Joi.string()
              .valid(...Object.values(Language))
              .required(),
            translation: Joi.string().required(),
          }),
        )
        .optional()
        .default([]),
    },
  ),
}

/**
 * Handler for POST /forms/:formId/logic
 */
export const handleCreateLogic = [
  celebrate({
    [Segments.BODY]: joiLogicBody,
  }),
  _handleCreateLogic,
] as ControllerHandler[]

/**
 * Handler for DELETE /forms/:formId/logic/:logicId
 * @security session
 *
 * @returns 200 with success message when successfully deleted
 * @returns 403 when user does not have permissions to delete logic
 * @returns 404 when form cannot be found
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleDeleteLogic: ControllerHandler<{
  formId: string
  logicId: string
}> = (req, res) => {
  const { formId, logicId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Retrieve currently logged in user.
  return (
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with write permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )

      // Step 3: Delete form logic
      .andThen((retrievedForm) =>
        AdminFormService.deleteFormLogic(retrievedForm, logicId),
      )
      .map(() => res.sendStatus(StatusCodes.OK))
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when deleting form logic',
          meta: {
            action: 'handleDeleteLogic',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            logicId,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for POST /forms/:formId/fields
 */
export const handleCreateFormField = [
  celebrate({
    [Segments.BODY]: Joi.object({
      // Ensures id is not provided.
      _id: Joi.any().forbidden(),
      globalId: Joi.any().forbidden(),
      fieldType: Joi.string()
        .valid(...Object.values(BasicField))
        .required(),
      title: Joi.string().trim().required(),
      description: Joi.string().allow(''),
      required: Joi.boolean(),
      disabled: Joi.boolean(),
      // Allow other field related key-values to be provided and let the model
      // layer handle the validation.
    })
      .unknown(true)
      .custom((value, helpers) => verifyValidUnicodeString(value, helpers)),
    [Segments.QUERY]: {
      // Optional index to insert the field at.
      to: Joi.number().min(0),
    },
  }),
  _handleCreateFormField,
]

/**
 * NOTE: Exported for testing.
 * Private handler for POST /forms/:formId/fields/:fieldId/reorder
 * @precondition Must be preceded by request validation
 * @security session
 *
 * @returns 200 with new ordering of form fields
 * @returns 403 when current user does not have permissions to create a form field
 * @returns 404 when form cannot be found
 * @returns 404 when given fieldId cannot be found in form
 * @returns 410 when reordering form fields for an archived form
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const _handleReorderFormField: ControllerHandler<
  { formId: string; fieldId: string },
  FormFieldDto[] | ErrorDto,
  unknown,
  { to: number }
> = (req, res) => {
  const { formId, fieldId } = req.params
  const { to } = req.query
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Retrieve currently logged in user.
  return (
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with write permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )
      // Step 3: User has permissions, proceed to reorder field
      .andThen((form) => AdminFormService.reorderFormField(form, fieldId, to))
      .map((reorderedFormFields) =>
        res.status(StatusCodes.OK).json(reorderedFormFields as FormFieldDto[]),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when reordering form field',
          meta: {
            action: '_handleReorderFormField',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            fieldId,
            reqQuery: req.query,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for POST /forms/:formId/fields/:fieldId/reorder
 */
export const handleReorderFormField = [
  celebrate({
    [Segments.QUERY]: {
      to: Joi.number().min(0).required(),
    },
  }),
  _handleReorderFormField,
] as ControllerHandler[]

/**
 * NOTE: Exported for testing.
 * Private handler for PUT /forms/:formId/logic/:logicId
 * @precondition Must be preceded by request validation
 * @security session
 *
 * @returns 200 with updated logic object when successfully updated
 * @returns 403 when user does not have permissions to update logic
 * @returns 404 when form cannot be found
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const _handleUpdateLogic: ControllerHandler<
  { formId: string; logicId: string },
  LogicDto | ErrorDto,
  LogicDto
> = (req, res) => {
  const { formId, logicId } = req.params
  const updatedLogic = { ...req.body }
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Retrieve currently logged in user.
  return (
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with write permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )
      // Step 3: Update form logic
      .andThen((retrievedForm) =>
        AdminFormService.updateFormLogic(retrievedForm, logicId, updatedLogic),
      )
      .map((updatedLogic) =>
        res.status(StatusCodes.OK).json(updatedLogic as LogicDto),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when updating form logic',
          meta: {
            action: 'handleUpdateLogic',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            logicId,
            updatedLogic,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for PUT /forms/:formId/logic/:logicId
 */
export const handleUpdateLogic = [
  celebrate(
    {
      [Segments.BODY]: Joi.object({
        // Ensures given logic is same as accessed logic
        _id: Joi.string().valid(Joi.ref('$params.logicId')).required(),
        ...joiLogicBody,
      }),
    },
    undefined,
    // Required so req.body can be validated against values in req.params.
    // See https://github.com/arb/celebrate#celebrateschema-joioptions-opts.
    { reqContext: true },
  ),
  _handleUpdateLogic,
] as ControllerHandler[]

/**
 * Handler for DELETE /forms/:formId/fields/:fieldId
 * @security session
 *
 * @returns 204 when deletion is successful
 * @returns 403 when current user does not have permissions to delete form field
 * @returns 404 when form cannot be found
 * @returns 404 when form field to delete cannot be found
 * @returns 410 when deleting form field of an archived form
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs during deletion
 */
export const handleDeleteFormField: ControllerHandler<
  { formId: string; fieldId: string },
  ErrorDto | void
> = (req, res) => {
  const { formId, fieldId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  return (
    // Step 1: Retrieve currently logged in user.
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with write permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )
      // Step 3: Delete form field.
      .andThen((form) => AdminFormService.deleteFormField(form, fieldId))
      .map(() => res.sendStatus(StatusCodes.NO_CONTENT))
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when deleting form field',
          meta: {
            action: 'handleDeleteFormField',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            fieldId,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for POST /forms/:formId/fields/delete
 * @security session
 *
 * @returns 204 when deletion is successful
 * @returns 403 when current user does not have permissions to delete form fields
 * @returns 404 when form cannot be found
 * @returns 410 when deleting fields of an archived form
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs during deletion
 */
export const handleDeleteFormFields: ControllerHandler<
  { formId: string },
  { message: string } | ErrorDto,
  { fieldIds: string[] }
> = (req, res) => {
  const { formId } = req.params
  const { fieldIds } = req.body
  const sessionUserId = (req.session as AuthedSessionData).user._id

  return (
    // Step 1: Retrieve currently logged in user.
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with write permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )
      // Step 3: Delete form fields.
      .andThen((form) => AdminFormService.deleteFormFields(form, fieldIds))
      .map(() => res.sendStatus(StatusCodes.NO_CONTENT))
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when deleting form fields',
          meta: {
            action: 'handleDeleteFormFields',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            fieldIds,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * NOTE: Exported for testing.
 * Private handler for PUT /forms/:formId/end-page
 * @precondition Must be preceded by request validation
 * @security session
 *
 * @returns 200 with updated end page
 * @returns 400 when end page form field has invalid updates to be performed
 * @returns 403 when current user does not have permissions to update the end page
 * @returns 404 when form cannot be found
 * @returns 410 when updating the end page for an archived form
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const _handleUpdateEndPage: ControllerHandler<
  { formId: string },
  IFormDocument['endPage'] | ErrorDto,
  EndPageUpdateDto
> = (req, res) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Retrieve currently logged in user.
  return (
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with write permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )
      // Step 3: User has permissions, proceed to allow updating of end page
      .andThen(() => AdminFormService.updateEndPage(formId, req.body))
      .map((updatedEndPage) => res.status(StatusCodes.OK).json(updatedEndPage))
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when updating end page',
          meta: {
            action: '_handleUpdateEndPage',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            body: req.body,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for PUT /forms/:formId/end-page
 */
export const handleUpdateEndPage = [
  celebrate({
    [Segments.BODY]: Joi.object({
      title: Joi.string(),
      paragraph: Joi.string().allow(''),
      buttonLink: Joi.string()
        .uri({ scheme: ['http', 'https'] })
        .allow('')
        .message('Please enter a valid HTTP or HTTPS URI'),
      buttonText: Joi.string().allow(''),
      // TODO(#1895): Remove when deprecated `buttons` key is removed from all forms in the database
      titleTranslations: Joi.array()
        .items(
          Joi.object({
            language: Joi.string()
              .valid(...Object.values(Language))
              .required(),
            translation: Joi.string().required(),
          }),
        )
        .optional()
        .default([]),
      paragraphTranslations: Joi.array()
        .items(
          Joi.object({
            language: Joi.string()
              .valid(...Object.values(Language))
              .required(),
            translation: Joi.string().required(),
          }),
        )
        .optional()
        .default([]),
    }).unknown(true),
  }),
  _handleUpdateEndPage,
] as ControllerHandler[]

/**
 * Handler for GET /admin/forms/:formId/fields/:fieldId
 * @security session
 *
 * @returns 200 with form field when retrieval is successful
 * @returns 403 when current user does not have permissions to retrieve form field
 * @returns 404 when form cannot be found
 * @returns 404 when form field cannot be found
 * @returns 410 when retrieving form field of an archived form
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleGetFormField: ControllerHandler<
  {
    formId: string
    fieldId: string
  },
  ErrorDto | FormFieldDto
> = (req, res) => {
  const { formId, fieldId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  return (
    // Step 1: Retrieve currently logged in user.
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with read permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Read,
        }),
      )
      .andThen((form) => AdminFormService.getFormField(form, fieldId))
      .map((formField) =>
        res.status(StatusCodes.OK).json(formField as FormFieldDto),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when retrieving form field',
          meta: {
            action: 'handleGetFormField',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            fieldId,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * NOTE: Exported for testing.
 * Private handler for PUT /api/v3/admin/forms/:formId/collaborators
 * @precondition Must be preceded by request validation
 * @security session
 *
 * @returns 200 with updated collaborators and permissions
 * @returns 403 when current user does not havße permissions to update the collaborators
 * @returns 404 when form cannot be found
 * @returns 410 when updating collaborators for an archived form
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const _handleUpdateCollaborators: ControllerHandler<
  { formId: string },
  PermissionsUpdateDto | ErrorDto,
  PermissionsUpdateDto
> = (req, res) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id
  // Step 1: Get the form after permission checks
  return (
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with write permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )
      // Step 2: Update the form collaborators
      .andThen((form) =>
        AdminFormService.updateFormCollaborators(form, req.body),
      )
      .map((updatedCollaborators) =>
        res.status(StatusCodes.OK).json(updatedCollaborators),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when updating collaborators',
          meta: {
            action: '_handleUpdateCollaborators',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            formCollaborators: req.body,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for PUT /api/v3/admin/forms/:formId/collaborators
 */
export const handleUpdateCollaborators = [
  celebrate({
    [Segments.BODY]: Joi.array().items(
      Joi.object({
        email: Joi.string()
          .required()
          .email()
          .message('Please enter a valid email')
          .lowercase(),
        write: Joi.bool().optional(),
        _id: Joi.string().optional(),
      }),
    ),
  }),
  _handleUpdateCollaborators,
] as ControllerHandler[]

/**
 * Handler for DELETE /api/v3/admin/forms/:formId/collaborators/self
 * @precondition Must be preceded by request validation
 * @security session
 *
 * @returns 200 with updated collaborators and permissions
 * @returns 403 when current user does not have permissions to remove themselves from the collaborators list
 * @returns 404 when form cannot be found
 * @returns 410 when updating collaborators for an archived form
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const handleRemoveSelfFromCollaborators: ControllerHandler<
  { formId: string },
  PermissionsUpdateDto | ErrorDto
> = (req, res) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id
  let currentUserEmail = ''
  // Step 1: Get the form after permission checks
  return (
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) => {
        // Step 2: Retrieve form with read permission check, since we are only removing the user themselves
        currentUserEmail = user.email
        return AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Read,
        })
      })
      // Step 3: Update the form collaborators
      .andThen((form) => {
        const updatedPermissionList = form.permissionList.filter(
          (user) => user.email.toLowerCase() !== currentUserEmail.toLowerCase(),
        )
        return AdminFormService.updateFormCollaborators(
          form,
          updatedPermissionList,
        )
      })
      .map((updatedCollaborators) =>
        res.status(StatusCodes.OK).json(updatedCollaborators),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when updating collaborators',
          meta: {
            action: 'handleRemoveSelfFromCollaborators',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            formCollaborators: req.body,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * NOTE: Exported for testing.
 * Private handler for PUT /forms/:formId/start-page
 * @precondition Must be preceded by request validation
 * @security session
 *
 * @returns 200 with updated start page
 * @returns 403 when current user does not have permissions to update the start page
 * @returns 404 when form cannot be found
 * @returns 410 when updating the start page for an archived form
 * @returns 422 when user in session cannot be retrieved from the database
 * @returns 500 when database error occurs
 */
export const _handleUpdateStartPage: ControllerHandler<
  { formId: string },
  IFormDocument['startPage'] | ErrorDto,
  StartPageUpdateDto
> = (req, res) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Retrieve currently logged in user.
  return (
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) =>
        // Step 2: Retrieve form with write permission check.
        AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        }),
      )
      // Step 3: User has permissions, proceed to allow updating of start page
      .andThen(() => AdminFormService.updateStartPage(formId, req.body))
      .map((updatedStartPage) =>
        res.status(StatusCodes.OK).json(updatedStartPage),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when updating start page',
          meta: {
            action: '_handleUpdateStartPage',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
            body: req.body,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

/**
 * Handler for PUT /forms/:formId/start-page
 */
export const handleUpdateStartPage = [
  celebrate({
    [Segments.BODY]: {
      paragraph: Joi.string().allow('').optional(),
      estTimeTaken: Joi.number().min(1).max(1000).optional(),
      colorTheme: Joi.string()
        .valid(...Object.values(FormColorTheme))
        .required(),
      logo: Joi.object({
        state: Joi.string().valid(...Object.values(FormLogoState)),
        fileId: Joi.when('state', {
          is: FormLogoState.Custom,
          then: Joi.string().required(),
          otherwise: Joi.any().forbidden(),
        }),
        fileName: Joi.when('state', {
          is: FormLogoState.Custom,
          then: Joi.string()
            // Captures only the extensions below regardless of their case
            // Refer to https://regex101.com/ with the below regex for a full explanation
            .pattern(/\.(gif|png|jpeg|jpg|jfif)$/im)
            .required(),
          otherwise: Joi.any().forbidden(),
        }),
        fileSizeInBytes: Joi.when('state', {
          is: FormLogoState.Custom,
          then: Joi.number().max(MAX_UPLOAD_FILE_SIZE).required(),
          otherwise: Joi.any().forbidden(),
        }),
      }).required(),
      paragraphTranslations: Joi.array()
        .items(
          Joi.object({
            language: Joi.string()
              .valid(...Object.values(Language))
              .required(),
            translation: Joi.string().required(),
          }),
        )
        .optional()
        .default([]),
    },
  }),
  _handleUpdateStartPage,
] as ControllerHandler[]

export const handleGetGoLinkSuffix: ControllerHandler<{ formId: string }> = (
  req,
  res,
) => {
  const { formId } = req.params
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Get the form after permission checks
  return (
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) => {
        return AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Read,
        })
      })
      // Step 2: After permission checks, get the GoGov link suffix
      .andThen(() => {
        return AdminFormService.getGoLinkSuffix(formId)
      })
      .map((goLinkSuffix) => res.status(StatusCodes.OK).json(goLinkSuffix))
      .mapErr((error) => {
        const { errorMessage, statusCode } = mapRouteError(error)
        // Don't log 404 errors as they are expected for most forms
        if (statusCode !== StatusCodes.NOT_FOUND) {
          logger.error({
            message: 'Error occurred when getting GoGov link suffix',
            meta: {
              action: 'handleGetGoLinkSuffix',
              ...createReqMeta(req),
              userId: sessionUserId,
              formId,
            },
            error,
          })
        }
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

export const handleSetGoLinkSuffix: ControllerHandler<
  { formId: string },
  unknown,
  { linkSuffix: string; adminEmail: string }
> = (req, res) => {
  const goGovBaseUrl = goGovConfig.goGovBaseUrl
  const { formId } = req.params
  const { linkSuffix, adminEmail } = req.body
  const sessionUserId = (req.session as AuthedSessionData).user._id

  // Step 1: Get the form after permission checks
  return (
    UserService.getPopulatedUserById(sessionUserId)
      .andThen((user) => {
        return AuthService.getFormAfterPermissionChecks({
          user,
          formId,
          level: PermissionLevel.Write,
        })
      })
      // Step 2: After permission checks, try to get GoGov link
      .andThen(() => {
        return ResultAsync.fromPromise(
          axios.post(
            `${goGovBaseUrl}/api/v1/admin/urls`,
            {
              longUrl: `${process.env.APP_URL}/${formId}`,
              shortUrl: linkSuffix,
              email: adminEmail,
            },
            {
              headers: {
                Authorization: `Bearer ${goGovConfig.goGovAPIKey}`,
                // Required due to bug introduced in axios 1.2.1: https://github.com/axios/axios/issues/5346
                // TODO: remove when axios is upgraded to 1.2.2
                'Accept-Encoding': 'gzip,deflate,compress',
              },
            },
          ),
          (error) => {
            if (axios.isAxiosError(error)) {
              return mapGoGovErrors(error)
            }

            return new GoGovServerError()
          },
        )
      })
      // Step 3: After obtaining GoGov link, save it to the form
      .andThen(() => AdminFormService.setGoLinkSuffix(formId, linkSuffix))
      .map(() => res.sendStatus(StatusCodes.OK))
      .mapErr((error) => {
        logger.error({
          message: 'Error occurred when setting GoGov link suffix',
          meta: {
            action: 'handleSetGoLinkSuffix',
            ...createReqMeta(req),
            userId: sessionUserId,
            formId,
          },
          error,
        })
        const { errorMessage, statusCode } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

export const handleConvertEmailToStorageMode: ControllerHandler<
  { formId: string },
  unknown,
  { publicKey: string }
> = (req, res) => {
  const { formId } = req.params
  const { publicKey } = req.body
  const sessionUserId = (req.session as AuthedSessionData).user._id

  return UserService.getPopulatedUserById(sessionUserId)
    .andThen((user) => {
      return AuthService.getFormAfterPermissionChecks({
        user,
        formId,
        level: PermissionLevel.Write,
      })
    })
    .andThen((form) => EmailSubmissionService.checkFormIsEmailMode(form))
    .map((form) => {
      return AdminFormService.convertEmailToStorageMode({ form, publicKey })
    })
    .map(() => {
      logger.info({
        message: 'Form successfully converted to storage mode',
        meta: {
          action: 'handleConvertEmailToStorageMode',
          ...createReqMeta(req),
          userId: sessionUserId,
          formId,
        },
      })
      return res.sendStatus(StatusCodes.OK)
    })
    .mapErr((error) => {
      const { errorMessage, statusCode } = mapRouteError(error)
      return res.status(statusCode).json({ message: errorMessage })
    })
}

/**
 * Handler to retrieve the sms counts used by a form's administrator and the sms verifications quota
 * This is the controller for GET /admin/forms/:formId/verified-sms/count
 * @param formId The id of the form to retrieve the sms counts for
 * @returns 200 with sms counts and quota when successful
 * @returns 404 when the formId is not found in the database
 * @returns 500 when a database error occurs during retrieval
 */
export const handleGetSmsCountForFormAdmin: ControllerHandler<
  {
    formId: string
  },
  ErrorDto | SmsCountsDto
> = (req, res) => {
  const { formId } = req.params
  const logMeta = {
    action: 'handleGetSmsCountForFormAdmin',
    ...createReqMeta(req),
    formId,
  }

  // Step 1: Check that the form exists
  return (
    FormService.retrieveFormById(formId)
      // Step 2: Retrieve the current sms count
      .andThen(() => {
        return SmsService.retrieveSmsCounts(formId)
      })
      // Step 3: Map/MapErr accordingly
      .map((smsCountForForm) =>
        res.status(StatusCodes.OK).json({
          smsCounts: smsCountForForm,
          quota: smsConfig.smsVerificationLimit,
        }),
      )
      .mapErr((error) => {
        logger.error({
          message: 'Error while retrieving sms counts for user',
          meta: logMeta,
          error,
        })
        const { statusCode, errorMessage } = mapRouteError(error)
        return res.status(statusCode).json({ message: errorMessage })
      })
  )
}

opengovsg / FormSG / 18089118599

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous