Added Email list for package and seperated package email calls

Author: RyanBirtch-aot

app/frontend/src/components/designer/FormDesigner.vue

@@ -413,6 +413,7 @@ async function schemaCreateNew() {
     showAssigneeInSubmissionsTable: form.value.showAssigneeInSubmissionsTable,
     showSubmissionConfirmation: form.value.showSubmissionConfirmation,
     submissionReceivedEmails: form.value.submissionReceivedEmails,
+    submissionPackageEmails: form.value.submissionPackageEmails,
     reminder_enabled: false,
     deploymentLevel: form.value.deploymentLevel,
     ministry: form.value.ministry,

app/frontend/src/components/designer/settings/FormSubmissionSettings.vue

@@ -1,6 +1,6 @@
 <script setup>
 import { storeToRefs } from 'pinia';
-import { ref } from 'vue';
+import { computed } from 'vue';
 import { useI18n } from 'vue-i18n';
 
 import { useFormStore } from '~/store/form';
@@ -12,16 +12,28 @@ const { t, locale } = useI18n({ useScope: 'global' });
 const { form, isRTL, isFormPublished } = storeToRefs(useFormStore());
 
 /* c8 ignore start */
-const emailArrayRules = ref([
-  (v) =>
-    !form.value.sendSubmissionReceivedEmail ||
+const makeEmailArrayRules = (enabledRefOrGetter) => [
+  (v = []) =>
+    !enabledRefOrGetter() ||
     v.length > 0 ||
     t('trans.formSettings.atLeastOneEmailReq'),
-  (v) =>
-    !form.value.sendSubmissionReceivedEmail ||
-    v.every((item) => new RegExp(Regex.EMAIL).test(item)) ||
+
+  (v = []) =>
+    !enabledRefOrGetter() ||
+    v.every((item) => new RegExp(Regex.EMAIL).test(String(item).trim())) ||
     t('trans.formSettings.validEmailRequired'),
-]);
+  (v) => {
+    console.log(v, typeof v, Array.isArray(v));
+  },
+];
+
+const submissionReceivedEmailRules = computed(() =>
+  makeEmailArrayRules(() => form.sendSubmissionReceivedEmail)
+);
+
+const submissionPackageEmailRules = computed(() =>
+  makeEmailArrayRules(() => form.enableSubmissionPackageEmail)
+);
 /* c8 ignore stop */
 </script>
 
@@ -105,7 +117,7 @@ const emailArrayRules = ref([
       <v-combobox
         v-model="form.submissionReceivedEmails"
         :hide-no-data="false"
-        :rules="emailArrayRules"
+        :rules="submissionReceivedEmailRules"
         solid
         variant="outlined"
         hide-selected
@@ -169,6 +181,35 @@ const emailArrayRules = ref([
       </v-checkbox>
 
       <div v-if="form.enableSubmissionPackageEmail" class="mt-4">
+        <v-combobox
+          v-model="form.submissionPackageEmails"
+          :hide-no-data="false"
+          :rules="submissionPackageEmailRules"
+          solid
+          variant="outlined"
+          hide-selected
+          clearable
+          :hint="$t('trans.formSettings.addMoreValidEmailAddrs')"
+          :label="$t('trans.formSettings.notificationEmailAddrs')"
+          multiple
+          chips
+          closable-chips
+          :delimiters="[' ', ',']"
+          append-icon=""
+          :lang="locale"
+        >
+          <template #no-data>
+            <v-list-item>
+              <v-list-item-title>
+                <span
+                  :lang="locale"
+                  v-html="$t('trans.formSettings.pressToAddMultiEmail')"
+                />
+              </v-list-item-title>
+            </v-list-item>
+          </template>
+        </v-combobox>
+
         <DocumentTemplate
           v-model:selected-template-id="form.submissionCompletionTemplateId"
           form-settings-mode

app/frontend/src/components/forms/manage/ManageForm.vue

@@ -105,6 +105,8 @@ function enableSettingsEdit() {
 
 async function updateSettings() {
   try {
+    console.log('update Settings');
+    console.log(settingsForm.value);
     const { valid } = await settingsForm.value.validate();
     if (valid) {
       await formStore.updateForm();

app/frontend/src/services/formService.js

@@ -36,6 +36,7 @@ export default {
    * @note Tenant ID is automatically included via x-tenant-id header when tenant is selected
    */
   updateForm(formId, formData) {
+    console.log(formData);
     return appAxios().put(`${ApiRoutes.FORMS}/${formId}`, formData);
   },
 

app/frontend/src/store/form.js

@@ -100,6 +100,7 @@ const genInitialForm = () => ({
   eventStreamConfig: genInitialEventStreamConfig(),
   enableSubmissionPackageEmail: false,
   submissionCompletionTemplateId: null,
+  submissionPackageEmails: [],
 });
 
 export const useFormStore = defineStore('form', {
@@ -465,6 +466,7 @@ export const useFormStore = defineStore('form', {
     },
     async updateForm() {
       try {
+        console.log('SubPackEmails' + this.form.submissionPackageEmails);
         const schedule = this.form.schedule.enabled ? this.form.schedule : {};
         const subscribe = this.form.subscribe.enabled
           ? this.form.subscribe
@@ -508,6 +510,7 @@ export const useFormStore = defineStore('form', {
           submissionCompletionTemplateId:
             this.form.submissionCompletionTemplateId,
           enableSubmissionPackageEmail: this.form.enableSubmissionPackageEmail,
+          submissionPackageEmails: this.form.submissionPackageEmails,
         });
 
         // update user labels with any new added labels

app/src/db/migrations/20260623191704_add_submission_package_email_list_to_form.js

@@ -0,0 +1,19 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function (knex) {
+  return knex.schema.alterTable('form', (table) => {
+    table.specificType('submissionPackageEmails', 'text ARRAY').comment('Array of email addresses to receive submission package emails.');
+  });
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function (knex) {
+  return knex.schema.alterTable('form', (table) => {
+    table.dropColumn('submissionPackageEmails');
+  });
+};

app/src/forms/common/models/tables/form.js

@@ -171,6 +171,7 @@ class Form extends Timestamps(Model) {
         },
         showSubmissionConfirmation: { type: 'boolean' },
         submissionReceivedEmails: { type: ['array', 'null'], items: { type: 'string', pattern: Regex.EMAIL } },
+        submissionPackageEmails: { type: ['array', 'null'], items: { type: 'string', pattern: Regex.EMAIL } },
         enableDocumentTemplates: { type: 'boolean' },
         enableStatusUpdates: { type: 'boolean' },
         enableSubmitterRevision: { type: 'boolean' },

app/src/forms/email/emailService.js

@@ -88,14 +88,10 @@ const buildEmailTemplate = async (formId, formSubmissionId, emailType, referer,
       priority: 'normal',
       form,
     };
-  } else if (emailType === EmailTypes.SUBMISSION_RECEIVED) {
-    console.log('SUB REC EMAIL ' + form.enableSubmissionPackageEmail);
-    contextToVal = form.sendSubmissionReceivedEmail ? form.submissionReceivedEmails : [];
+  } else if (emailType === EmailTypes.SUBMISSION_PACKAGE) {
     if (form.enableSubmissionPackageEmail) {
-      console.log(contextToVal);
+      contextToVal = form.submissionPackageEmails ? form.submissionPackageEmails : [];
       const subPackage = await packageService.writeSubmissionPackage({ form, submission, currentUser });
-      console.log('subPackage');
-      console.log(subPackage.fileRecord);
       userTypePath = 'form/view';
       configData = {
         submissionPackagePath: `api/v1/files/${subPackage.fileRecord.id}`,
@@ -107,19 +103,21 @@ const buildEmailTemplate = async (formId, formSubmissionId, emailType, referer,
         priority: 'normal',
         form,
       };
-      console.log(configData);
     } else {
-      userTypePath = 'form/view';
-      configData = {
-        body: additionalProperties.body,
-        bodyTemplate: 'submission-confirmation.html',
-        title: `${form.name} Submission`,
-        subject: `${form.name} Submission`,
-        messageLinkText: `There is a new ${form.name} submission. Please login to review it.`,
-        priority: 'normal',
-        form,
-      };
+      contextToVal = [];
     }
+  } else if (emailType === EmailTypes.SUBMISSION_RECEIVED) {
+    contextToVal = form.sendSubmissionReceivedEmail ? form.submissionReceivedEmails : [];
+    userTypePath = 'form/view';
+    configData = {
+      body: additionalProperties.body,
+      bodyTemplate: 'submission-confirmation.html',
+      title: `${form.name} Submission`,
+      subject: `${form.name} Submission`,
+      messageLinkText: `There is a new ${form.name} submission. Please login to review it.`,
+      priority: 'normal',
+      form,
+    };
   } else if (emailType === EmailTypes.SUBMISSION_CONFIRMATION) {
     contextToVal = [additionalProperties.body.to];
     userTypePath = 'form/success';
@@ -393,6 +391,35 @@ const service = {
     }
   },
 
+  /**
+   * @function submissionReceived
+   * Completing submission of a form
+   * @param {string} formId
+   * @param {string} submissionId
+   * @param {string} body
+   * @param {string} referer
+   * @returns The result of the email merge operation
+   */
+  submissionPackage: async (formId, submissionId, body, referer, currentUser) => {
+    try {
+      const { configData, contexts } = await buildEmailTemplate(formId, submissionId, EmailTypes.SUBMISSION_PACKAGE, referer, currentUser, { body });
+      if (contexts[0].to.length) {
+        return service._sendEmailTemplate(configData, contexts);
+      } else {
+        return {};
+      }
+    } catch (e) {
+      log.error(e.message, {
+        function: EmailTypes.SUBMISSION_PACKAGE,
+        formId: formId,
+        submissionId: submissionId,
+        body: body,
+        referer: referer,
+      });
+      throw e;
+    }
+  },
+
   /**
    * @function submissionReceived
    * Completing submission of a form

app/src/forms/email/packageService.js

@@ -1,4 +1,5 @@
 const JSZip = require('jszip');
+const config = require('config');
 
 const cdogsService = require('../../components/cdogsService');
 const log = require('../../components/log')(module.filename);
@@ -14,6 +15,9 @@ const fs = require('node:fs/promises');
 const os = require('node:os');
 const path = require('node:path');
 
+const PERMANENT_STORAGE = config.get('files.permanent');
+const { StorageTypes } = require('../common/constants');
+
 const streamToBuffer = async (stream) =>
   new Promise((resolve, reject) => {
     const chunks = [];
@@ -30,7 +34,6 @@ const service = {
    * Given the data for a submission, find uploaded files.
    */
   findFiles: (submission) => {
-    console.log('Parsing for file components and file ids');
     const files = [];
     const seen = new Set();
 
@@ -233,7 +236,12 @@ const service = {
         fileCount: zip.fileCount,
       };
     } finally {
-      await fs.rm(tempPath, { force: true });
+      //comment this out when running local storage, otherwise it'll just delete the zip from the folder it's "uploaded" to
+      if (PERMANENT_STORAGE !== StorageTypes.LOCAL_STORAGE) {
+        await fs.rm(tempPath, { force: true });
+      } else {
+        console.log('Local Development, Files not deleted');
+      }
     }
   },
 };

app/src/forms/form/controller.js

@@ -177,6 +177,9 @@ module.exports = {
         emailService.submissionReceived(req.params.formId, response.id, req.body, req.headers.referer, req.currentUser).catch((error) => {
           log.error('Failed to send submission received email', { error, submissionId: response.id, userId: req.currentUser.id });
         });
+        emailService.submissionPackage(req.params.formId, response.id, req.body, req.headers.referer, req.currentUser).catch((error) => {
+          log.error('Failed to send submission package email', { error, submissionId: response.id, userId: req.currentUser.id });
+        });
       }
       // do we want to await this? could take a while, but it could fail... maybe make an explicit api call?
       fileService.moveSubmissionFiles(response.id, req.currentUser).catch((error) => {