fix: return storage mode submission version when when retrieving from server

src/app/models/__tests__/encrypt-submission.server.model.spec.ts

@@ -4,19 +4,19 @@ import moment from 'moment-timezone'
 import mongoose from 'mongoose'
 
 import getSubmissionModel, {
+  getEmailSubmissionModel,
   getEncryptSubmissionModel,
 } from 'src/app/models/submission.server.model'
 import {
-  IEmailSubmissionSchema,
   IEncryptedSubmissionSchema,
-  ISubmissionSchema,
   SubmissionMetadata,
   SubmissionType,
 } from 'src/types'
 
 import dbHandler from 'tests/unit/backend/helpers/jest-db'
 
 const Submission = getSubmissionModel(mongoose)
+const EmailSubmission = getEmailSubmissionModel(mongoose)
 const EncryptSubmission = getEncryptSubmissionModel(mongoose)
 
 describe('Encrypt Submission Model', () => {
@@ -33,15 +33,14 @@ describe('Encrypt Submission Model', () => {
         const validFormId = new ObjectId().toHexString()
         const createdDate = new Date()
         // Add valid encrypt submission.
-        const validSubmission =
-          await Submission.create<IEncryptedSubmissionSchema>({
-            form: validFormId,
-            myInfoFields: [],
-            submissionType: SubmissionType.Encrypt,
-            encryptedContent: MOCK_ENCRYPTED_CONTENT,
-            version: 1,
-            created: createdDate,
-          })
+        const validSubmission = await EncryptSubmission.create({
+          form: validFormId,
+          myInfoFields: [],
+          submissionType: SubmissionType.Encrypt,
+          encryptedContent: MOCK_ENCRYPTED_CONTENT,
+          version: 1,
+          created: createdDate,
+        })
 
         // Act
         const result = await EncryptSubmission.findSingleMetadata(
@@ -110,7 +109,7 @@ describe('Encrypt Submission Model', () => {
         // Arrange
         // Add 3 valid encrypt submission.
         const validSubmissionPromises = times(3, (idx) =>
-          Submission.create<IEncryptedSubmissionSchema>({
+          EncryptSubmission.create({
             form: VALID_FORM_ID,
             myInfoFields: [],
             submissionType: SubmissionType.Encrypt,
@@ -119,9 +118,8 @@ describe('Encrypt Submission Model', () => {
             created: MOCK_CREATED_DATES_ASC[idx],
           }),
         )
-        const validSubmissions: ISubmissionSchema[] = await Promise.all(
-          validSubmissionPromises,
-        )
+        const validSubmissions: IEncryptedSubmissionSchema[] =
+          await Promise.all(validSubmissionPromises)
 
         // Act
         const actual = await EncryptSubmission.findAllMetadataByFormId(
@@ -149,7 +147,7 @@ describe('Encrypt Submission Model', () => {
         // Arrange
         // Add 3 valid encrypt submission.
         const validSubmissionPromises = times(3, (idx) =>
-          Submission.create<IEncryptedSubmissionSchema>({
+          EncryptSubmission.create({
             form: VALID_FORM_ID,
             myInfoFields: [],
             submissionType: SubmissionType.Encrypt,
@@ -158,9 +156,8 @@ describe('Encrypt Submission Model', () => {
             created: MOCK_CREATED_DATES_ASC[idx],
           }),
         )
-        const validSubmissions: ISubmissionSchema[] = await Promise.all(
-          validSubmissionPromises,
-        )
+        const validSubmissions: IEncryptedSubmissionSchema[] =
+          await Promise.all(validSubmissionPromises)
 
         // Act
         const actual = await EncryptSubmission.findAllMetadataByFormId(
@@ -192,7 +189,7 @@ describe('Encrypt Submission Model', () => {
         // Arrange
         // Add 3 valid encrypt submission.
         const validSubmissionPromises = times(3, (idx) =>
-          Submission.create<IEncryptedSubmissionSchema>({
+          EncryptSubmission.create({
             form: VALID_FORM_ID,
             myInfoFields: [],
             submissionType: SubmissionType.Encrypt,
@@ -201,9 +198,8 @@ describe('Encrypt Submission Model', () => {
             created: MOCK_CREATED_DATES_ASC[idx],
           }),
         )
-        const validSubmissions: ISubmissionSchema[] = await Promise.all(
-          validSubmissionPromises,
-        )
+        const validSubmissions: IEncryptedSubmissionSchema[] =
+          await Promise.all(validSubmissionPromises)
 
         // Act
         const actual = await EncryptSubmission.findAllMetadataByFormId(
@@ -235,7 +231,7 @@ describe('Encrypt Submission Model', () => {
         // Arrange
         // Add 3 valid encrypt submission.
         const validSubmissionPromises = times(3, (idx) =>
-          Submission.create<IEncryptedSubmissionSchema>({
+          EncryptSubmission.create({
             form: VALID_FORM_ID,
             myInfoFields: [],
             submissionType: SubmissionType.Encrypt,
@@ -244,9 +240,8 @@ describe('Encrypt Submission Model', () => {
             created: MOCK_CREATED_DATES_ASC[idx],
           }),
         )
-        const validSubmissions: ISubmissionSchema[] = await Promise.all(
-          validSubmissionPromises,
-        )
+        const validSubmissions: IEncryptedSubmissionSchema[] =
+          await Promise.all(validSubmissionPromises)
 
         // Act
         const actual = await EncryptSubmission.findAllMetadataByFormId(
@@ -288,11 +283,11 @@ describe('Encrypt Submission Model', () => {
       it('should return cursor that contains all the submissions', async () => {
         // Arrange
         const validFormId = new ObjectId().toHexString()
-        const validSubmission = await Submission.create({
+        const validSubmission = await EncryptSubmission.create({
           submissionType: SubmissionType.Encrypt,
           form: validFormId,
           encryptedContent: 'mock encrypted content abc',
-          version: 1,
+          version: 3,
         })
         const expectedSubmission = pick(
           validSubmission,
@@ -301,6 +296,7 @@ describe('Encrypt Submission Model', () => {
           'verifiedContent',
           'encryptedContent',
           'submissionType',
+          'version',
         )
 
         // Act
@@ -344,11 +340,11 @@ describe('Encrypt Submission Model', () => {
       it('should return correct submission by its id', async () => {
         // Arrange
         const validFormId = new ObjectId().toHexString()
-        const validSubmission = await Submission.create({
+        const validSubmission = await EncryptSubmission.create({
           submissionType: SubmissionType.Encrypt,
           form: validFormId,
           encryptedContent: 'mock encrypted content abc',
-          version: 1,
+          version: 33,
           attachmentMetadata: { someFileName: 'some url of attachment' },
         })
 
@@ -360,15 +356,16 @@ describe('Encrypt Submission Model', () => {
 
         // Assert
         const expected = pick(
-          validSubmission.toObject(),
+          validSubmission.toJSON(),
           '_id',
           'attachmentMetadata',
           'created',
           'encryptedContent',
           'submissionType',
+          'version',
         )
         expect(actual).not.toBeNull()
-        expect(actual?.toObject()).toEqual(expected)
+        expect(actual?.toJSON()).toEqual(expected)
       })
 
       it('should return null when submission id does not exist', async () => {
@@ -390,14 +387,13 @@ describe('Encrypt Submission Model', () => {
       it('should return null when type of submission with given id is not SubmissionType.Encrypt', async () => {
         // Arrange
         const validFormId = new ObjectId().toHexString()
-        const validEmailSubmission =
-          await Submission.create<IEmailSubmissionSchema>({
-            submissionType: SubmissionType.Email,
-            form: validFormId,
-            recipientEmails: ['[email protected]'],
-            responseHash: 'any hash',
-            responseSalt: 'any salt',
-          })
+        const validEmailSubmission = await EmailSubmission.create({
+          submissionType: SubmissionType.Email,
+          form: validFormId,
+          recipientEmails: ['[email protected]'],
+          responseHash: 'any hash',
+          responseSalt: 'any salt',
+        })
 
         // Act
         const actual = await EncryptSubmission.findEncryptedSubmissionById(

src/app/models/submission.server.model.ts

@@ -360,6 +360,7 @@ EncryptSubmissionSchema.statics.getSubmissionCursorByFormId = function (
         verifiedContent: 1,
         attachmentMetadata: 1,
         created: 1,
+        version: 1,
         id: 1,
       })
       .batchSize(2000)
@@ -384,6 +385,7 @@ EncryptSubmissionSchema.statics.findEncryptedSubmissionById = function (
       verifiedContent: 1,
       attachmentMetadata: 1,
       created: 1,
+      version: 1,
     })
     .exec()
 }

src/app/modules/form/admin-form/__tests__/admin-form.routes.spec.ts

@@ -3609,7 +3609,7 @@ describe('admin-form.routes', () => {
         encryptedContent: 'any encrypted content',
         verifiedContent: 'any verified content',
       }
-      const submission = await createSubmission({
+      const submission = await createEncryptSubmission({
         form: defaultForm,
         ...expectedSubmissionParams,
       })
@@ -3629,6 +3629,7 @@ describe('admin-form.routes', () => {
         refNo: String(submission._id),
         submissionTime: expect.any(String),
         verified: expectedSubmissionParams.verifiedContent,
+        version: submission.version,
       })
     })
 
@@ -3642,7 +3643,7 @@ describe('admin-form.routes', () => {
           ['fieldId2', 'some.other.attachment.url'],
         ]),
       }
-      const submission = await createSubmission({
+      const submission = await createEncryptSubmission({
         form: defaultForm,
         ...expectedSubmissionParams,
       })
@@ -3669,6 +3670,7 @@ describe('admin-form.routes', () => {
         refNo: String(submission._id),
         submissionTime: expect.any(String),
         verified: expectedSubmissionParams.verifiedContent,
+        version: submission.version,
       })
     })
 
@@ -3819,7 +3821,7 @@ describe('admin-form.routes', () => {
       jest
         .spyOn(EncryptSubmissionModel, 'findEncryptedSubmissionById')
         .mockRejectedValueOnce(new Error('ohno'))
-      const submission = await createSubmission({
+      const submission = await createEncryptSubmission({
         form: defaultForm,
         encryptedContent: 'any encrypted content',
         verifiedContent: 'any verified content',
@@ -3848,7 +3850,7 @@ describe('admin-form.routes', () => {
         .spyOn(aws.s3, 'getSignedUrlPromise')
         .mockRejectedValueOnce(new Error('something went wrong'))
 
-      const submission = await createSubmission({
+      const submission = await createEncryptSubmission({
         form: defaultForm,
         encryptedContent: 'any encrypted content',
         verifiedContent: 'any verified content',
@@ -4349,7 +4351,7 @@ describe('admin-form.routes', () => {
       // Create 11 submissions
       const submissions = await Promise.all(
         times(11, (count) =>
-          createSubmission({
+          createEncryptSubmission({
             form: defaultForm,
             encryptedContent: `any encrypted content ${count}`,
             verifiedContent: `any verified content ${count}`,
@@ -4384,7 +4386,7 @@ describe('admin-form.routes', () => {
     it('should return 200 with empty results if query.page does not have metadata', async () => {
       // Arrange
       // Create single submission
-      await createSubmission({
+      await createEncryptSubmission({
         form: defaultForm,
         encryptedContent: `any encrypted content`,
         verifiedContent: `any verified content`,
@@ -4412,7 +4414,7 @@ describe('admin-form.routes', () => {
       // Create 3 submissions
       const submissions = await Promise.all(
         times(3, (count) =>
-          createSubmission({
+          createEncryptSubmission({
             form: defaultForm,
             encryptedContent: `any encrypted content ${count}`,
             verifiedContent: `any verified content ${count}`,
@@ -4603,7 +4605,7 @@ describe('admin-form.routes', () => {
       // Arrange
       const submissions = await Promise.all(
         times(11, (count) =>
-          createSubmission({
+          createEncryptSubmission({
             form: defaultForm,
             encryptedContent: `any encrypted content ${count}`,
             verifiedContent: `any verified content ${count}`,
@@ -4639,6 +4641,7 @@ describe('admin-form.routes', () => {
             encryptedContent: s.encryptedContent,
             verifiedContent: s.verifiedContent,
             created: s.created,
+            version: s.version,
           }),
         )
         .sort((a, b) => String(a._id).localeCompare(String(b._id)))
@@ -4659,7 +4662,7 @@ describe('admin-form.routes', () => {
       // Arrange
       const submissions = await Promise.all(
         times(5, (count) =>
-          createSubmission({
+          createEncryptSubmission({
             form: defaultForm,
             encryptedContent: `any encrypted content ${count}`,
             verifiedContent: `any verified content ${count}`,
@@ -4695,6 +4698,7 @@ describe('admin-form.routes', () => {
             encryptedContent: s.encryptedContent,
             verifiedContent: s.verifiedContent,
             created: s.created,
+            version: s.version,
           }),
         )
         .sort((a, b) => String(a._id).localeCompare(String(b._id)))
@@ -4723,7 +4727,7 @@ describe('admin-form.routes', () => {
       // Arrange
       const submissions = await Promise.all(
         times(5, (count) =>
-          createSubmission({
+          createEncryptSubmission({
             form: defaultForm,
             encryptedContent: `any encrypted content ${count}`,
             verifiedContent: `any verified content ${count}`,
@@ -4774,6 +4778,7 @@ describe('admin-form.routes', () => {
             encryptedContent: s.encryptedContent,
             verifiedContent: s.verifiedContent,
             created: s.created,
+            version: s.version,
           }),
         )
         .filter((s) => expectedSubmissionIds.includes(s._id))
@@ -5385,7 +5390,7 @@ describe('admin-form.routes', () => {
 })
 
 // Helper utils
-const createSubmission = ({
+const createEncryptSubmission = ({
   form,
   encryptedContent,
   verifiedContent,
@@ -5398,7 +5403,7 @@ const createSubmission = ({
   verifiedContent?: string
   created?: Date
 }) => {
-  return SubmissionModel.create({
+  return EncryptSubmissionModel.create({
     submissionType: SubmissionType.Encrypt,
     form: form._id,
     authType: form.authType,

src/app/modules/submission/encrypt-submission/encrypt-submission.utils.ts

@@ -208,5 +208,6 @@ export const createEncryptedSubmissionDto = (
     content: submissionData.encryptedContent,
     verified: submissionData.verifiedContent,
     attachmentMetadata: attachmentPresignedUrls,
+    version: submissionData.version,
   }
 }