feature/DF-861: Geospatial component (#468)

* Support Geospatial components in CSV download output

* Add grid reference to the geospatial features

* Add route to get submission record by reference

* Remove duplicate imports

* Bump forms-engine-plugin version

* Add tests for getSubmissionRecordByReference

* Fix linting

* Move getSubmissionRecordByReference into new submission routes file

Author: davidjamesstone

package-lock.json

@@ -40,7 +40,7 @@
     "@aws-sdk/client-s3": "^3.679.0",
     "@aws-sdk/client-sqs": "^3.982.0",
     "@aws-sdk/s3-request-presigner": "^3.679.0",
-    "@defra/forms-engine-plugin": "^4.0.57",
+    "@defra/forms-engine-plugin": "^4.4.0",
     "@defra/forms-model": "^3.0.638",
     "@defra/hapi-tracing": "^1.12.0",
     "@elastic/ecs-pino-format": "^1.5.0",

package.json

@@ -60,6 +60,7 @@
  */
 
 /**
+ * @typedef {{ Params: { referenceNumber: string }}} GetSubmissionByReference
  * @typedef {{ Params: { dlq: string }}} DeadLetterQueueRequest
  */
 

src/api/types.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')
@@ -47,6 +49,21 @@ export const resetSaveAndExitLinkResponseSchema = Joi.object({
   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'
+ */
 export const dqlSchema = Joi.string().valid('form-submissions', 'save-and-exit')
 
 export const receiptHandleSchema = Joi.string()

src/models/form.js

@@ -4,6 +4,7 @@ import { FormStatus } from '@defra/forms-model'
 import { addDays } from '~/src/helpers/date-helper.js'
 
 export const STUB_FORM_ID = '688131eeff67f889d52c66cc'
+export const STUB_SUBMISSION_REF = '365-DFR-C67'
 export const STUB_SUBMISSION_RECORD_ID = '68d284ef5fa1a0fb2ede066a'
 
 /**

src/repositories/__stubs__/submission.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/repositories/submission-repository.js

@@ -2,10 +2,12 @@ import { db } from '~/src/mongo.js'
 import { buildMockCollection } from '~/src/repositories/__stubs__/mongo.js'
 import {
   STUB_FORM_ID,
+  STUB_SUBMISSION_REF,
   buildDbDocument
 } from '~/src/repositories/__stubs__/submission.js'
 import {
   createSubmissionRecord,
+  getSubmissionRecordByReference,
   getSubmissionRecords
 } from '~/src/repositories/submission-repository.js'
 
@@ -103,4 +105,25 @@ describe('submission repository', () => {
       ).rejects.toThrow(new Error('Failed'))
     })
   })
+
+  describe('getSubmissionRecordByReference', () => {
+    it('should get submission record', async () => {
+      jest.mocked(
+        mockCollection.findOne.mockResolvedValueOnce(submissionDocument)
+      )
+      const submissionRecord =
+        await getSubmissionRecordByReference(STUB_SUBMISSION_REF)
+      expect(submissionRecord).toEqual(submissionDocument)
+    })
+
+    it('should handle get submission record failures', async () => {
+      mockCollection.findOne.mockImplementation(() => {
+        throw new Error('an error')
+      })
+
+      await expect(
+        getSubmissionRecordByReference(STUB_SUBMISSION_REF)
+      ).rejects.toThrow(new Error('an error'))
+    })
+  })
 })

src/repositories/submission-repository.test.js

@@ -218,5 +218,5 @@ export default [
 
 /**
  * @import { ServerRoute } from '@hapi/hapi'
- * @import { DeadLetterQueueRequest, DeadLetterQueueAndHandleRequest, GenerateFeedbackSubmissionsFile, GenerateFormSubmissionsFile, ResetSaveAndExit } from '~/src/api/types.js'
+ * @import { DeadLetterQueueRequest, DeadLetterQueueAndHandleRequest, GenerateFeedbackSubmissionsFile, GenerateFormSubmissionsFile, GetSubmissionByReference, ResetSaveAndExit } from '~/src/api/types.js'
  */

src/routes/admin.js

@@ -2,5 +2,6 @@ import admin from '~/src/routes/admin.js'
 import files from '~/src/routes/files.js'
 import form from '~/src/routes/form.js'
 import health from '~/src/routes/health.js'
+import submission from '~/src/routes/submission.js'
 
-export default [health, files, form, admin].flat()
+export default [health, files, form, submission, admin].flat()

src/routes/index.js

@@ -0,0 +1,53 @@
+import { Scopes } from '@defra/forms-model'
+import Boom from '@hapi/boom'
+import Joi from 'joi'
+
+import { getSubmissionByReferenceResponseSchema } from '~/src/models/form.js'
+import { getSubmissionRecordByReference } from '~/src/repositories/submission-repository.js'
+
+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 { GetSubmissionByReference } from '~/src/api/types.js'
+ */