feat(mrf): retain workflow through a submission lifetime (#7087)

* feat: retain workflow through a submission lifetime

* test: fix submission model tests with workflow object

* fix: add db migration script

* chore: update package-lock for virus scanner

frontend/src/features/public-form/PublicFormProvider.tsx

@@ -148,10 +148,13 @@ export const PublicFormProvider = ({
     /* enabled= */ !submissionData,
   )
 
-  // Replace form fields and logic with the previous version for MRF consistency.
+  // Replace form fields, logic, and workflow with the previous version for MRF consistency.
   if (data && encryptedPreviousSubmission) {
     data.form.form_fields = encryptedPreviousSubmission.form_fields
     data.form.form_logics = encryptedPreviousSubmission.form_logics
+    if (data.form.responseMode === FormResponseMode.Multirespondent) {
+      data.form.workflow = encryptedPreviousSubmission.workflow
+    }
   }
 
   const isLoading = isFormLoading || isSubmissionLoading

scripts/20240215_mrf-retain-workflow-in-submissions/mrf-retain-workflow-in-submissions.js

@@ -0,0 +1,99 @@
+/* eslint-disable */
+
+// Creates a new workflow key in all existing mrf submissions, populated with
+// the form's existing workflow. From this point on, workflows should be captured
+// when the submission is initially created (i.e. the workflow is started),
+
+// BEFORE
+// COUNT existing number of MRF submissions with no workflow key 
+db.submissions.aggregate([
+  {
+    $match: {
+      submissionType: 'multirespondentSubmission',
+      workflow: { $exists: false },
+    },
+  },
+  {
+    $lookup: {
+      from: 'forms',
+      localField: 'form',
+      foreignField: '_id',
+      as: 'forms',
+    },
+  },
+  {
+    $addFields: {
+      formWorkflow: { $first: '$forms.workflow' },
+    },
+  },
+  {
+    $match: {
+      formWorkflow: { $exists: true },
+    },
+  },
+  {
+    $count: 'count',
+  },
+])
+
+// UPDATE
+db.submissions.aggregate([
+  {
+    $match: {
+      submissionType: 'multirespondentSubmission',
+    },
+  },
+  {
+    $lookup: {
+      from: 'forms',
+      localField: 'form',
+      foreignField: '_id',
+      as: 'forms',
+    },
+  },
+  {
+    $addFields: {
+      workflow: { $first: '$forms.workflow' },
+    },
+  },
+  {
+    $merge: {
+      into: 'submissions',
+      on: '_id',
+      whenNotMatched: 'discard',
+    },
+  },
+])
+
+// AFTER
+// Count number of MRF submissions with workflow key
+// Expect this to match the COUNT in BEFORE
+db.submissions.aggregate([
+  {
+    $match: {
+      submissionType: 'multirespondentSubmission',
+      workflow: { $exists: true },
+    },
+  },
+  {
+    $lookup: {
+      from: 'forms',
+      localField: 'form',
+      foreignField: '_id',
+      as: 'forms',
+    },
+  },
+  {
+    $addFields: {
+      formWorkflow: { $first: '$forms.workflow' },
+    },
+  },
+  {
+    $match: {
+      formWorkflow: { $exists: true },
+    },
+  },
+  {
+    $count: 'count',
+  },
+])