Add route to get submission record by reference

Author: davidjamesstone

src/api/types.js

@@ -59,6 +59,10 @@
  * @typedef {{ Params: { formId: string }}} GenerateFeedbackSubmissionsFile
  */
 
+/**
+ * @typedef {{ Params: { referenceNumber: string }}} GetSubmissionByReference
+ */
+
 /**
  * @typedef {object} UploadPayload
  * @property {('initiated'|'pending'|'ready')} uploadStatus - Have all scans completed, can be initiated, pending or ready

src/models/form.js

@@ -1,3 +1,4 @@
+import { formAdapterSubmissionMessagePayloadSchema } from '@defra/forms-engine-plugin/engine/types/schema.js'
 import Joi from 'joi'
 
 export const magicLinkSchema = Joi.string().uuid().required()
@@ -38,6 +39,7 @@ export const validateSavedLinkResponseSchema = Joi.object({
 export const generateFormSubmissionsFileResponseSchema = Joi.object({
   message: Joi.string().required()
 }).label('generateFormSubmissionsFileResponse')
+
 export const generateFeedbackSubmissionsFileResponseSchema = Joi.object({
   message: Joi.string().required()
 }).label('generateFeedbackSubmissionsFileResponse')
@@ -46,3 +48,19 @@ export const resetSaveAndExitLinkResponseSchema = Joi.object({
   recordFound: Joi.boolean().required(),
   recordUpdated: Joi.boolean().required()
 }).label('resetSaveAndExitLinkResponseSchema')
+
+/**
+ * @type {Joi.ObjectSchema<FormSubmissionDocument>}
+ */
+export const getSubmissionByReferenceResponseSchema = Joi.object()
+  .keys({
+    _id: Joi.string().hex().required(),
+    recordCreatedAt: Joi.string().isoDate().required(),
+    expireAt: Joi.string().isoDate().required()
+  })
+  .concat(formAdapterSubmissionMessagePayloadSchema)
+  .label('getSubmissionByReferenceResponseSchema')
+
+/**
+ * @import { FormSubmissionDocument } from '~/src/api/types.js'
+ */

src/repositories/submission-repository.js

@@ -65,6 +65,35 @@ export async function createSubmissionRecord(document, session) {
   }
 }
 
+/**
+ * Gets a submission record based on reference number
+ * @param {string} referenceNumber - the reference number
+ * @returns { Promise<WithId<FormSubmissionDocument> | null> }
+ */
+export async function getSubmissionRecordByReference(referenceNumber) {
+  logger.info('Reading submission record')
+
+  const coll = /** @type {Collection<FormSubmissionDocument>} */ (
+    db.collection(SUBMISSIONS_COLLECTION_NAME)
+  )
+
+  try {
+    const result = await coll.findOne({
+      'meta.referenceNumber': referenceNumber
+    })
+
+    logger.info('Read submission record')
+
+    return result
+  } catch (err) {
+    logger.error(
+      err,
+      `Failed to read submission record - ${getErrorMessage(err)}`
+    )
+    throw err
+  }
+}
+
 /**
  * @import { ClientSession, ObjectId, WithId, Collection, FindCursor } from 'mongodb'
  * @import { FormSubmissionDocument } from '~/src/api/types.js'

src/routes/admin.js

@@ -1,12 +1,15 @@
 import { Scopes, idSchema } from '@defra/forms-model'
+import Boom from '@hapi/boom'
 import Joi from 'joi'
 
 import {
   generateFeedbackSubmissionsFileResponseSchema,
   generateFormSubmissionsFileResponseSchema,
+  getSubmissionByReferenceResponseSchema,
   magicLinkSchema,
   resetSaveAndExitLinkResponseSchema
 } from '~/src/models/form.js'
+import { getSubmissionRecordByReference } from '~/src/repositories/submission-repository.js'
 import { resetSaveAndExitLink } from '~/src/services/save-and-exit-service.js'
 import {
   generateFeedbackSubmissionsFileForAll,
@@ -125,10 +128,50 @@ export default [
         }
       }
     }
+  }),
+
+  /**
+   * @satisfies {ServerRoute<GetSubmissionByReference>}
+   */
+  ({
+    method: 'GET',
+    path: '/submission/{referenceNumber}',
+    async handler(request) {
+      const { params } = request
+      const { referenceNumber } = params
+
+      const record = await getSubmissionRecordByReference(referenceNumber)
+
+      if (!record) {
+        return Boom.notFound(
+          `Submission record with reference ${referenceNumber} was not found`
+        )
+      }
+
+      return record
+    },
+    options: {
+      tags: ['api'],
+      auth: {
+        scope: [`+${Scopes.FormRead}`]
+      },
+      validate: {
+        params: Joi.object()
+          .keys({
+            referenceNumber: Joi.string().required()
+          })
+          .label('getSubmissionByReferenceParams')
+      },
+      response: {
+        status: {
+          200: getSubmissionByReferenceResponseSchema
+        }
+      }
+    }
   })
 ]
 
 /**
  * @import { ServerRoute } from '@hapi/hapi'
- * @import { GenerateFeedbackSubmissionsFile, GenerateFormSubmissionsFile, ResetSaveAndExit } from '~/src/api/types.js'
+ * @import { GenerateFeedbackSubmissionsFile, GenerateFormSubmissionsFile, GetSubmissionByReference, ResetSaveAndExit } from '~/src/api/types.js'
  */