Merge branch 'main' into feat/forms-1240-external-api

usingtechnology · Jun 3, 2024 · 4021a10 · 4021a10
2 parents 754cbd4 + 44f5866
commit 4021a10
Show file tree

Hide file tree

Showing 11 changed files with 86 additions and 62 deletions.
diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
@@ -1,4 +1,4 @@
-ARG VARIANT="18.18.2-bullseye"
+ARG VARIANT="18.20.3-bookworm"
 FROM node:${VARIANT}
 
 # not much in here, could acheive this another way for sure...

diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -6,7 +6,7 @@
     "dockerfile": "Dockerfile",
     "context": "..",
     "args": {
-      "VARIANT": "18.18.2-bullseye"
+      "VARIANT": "18.20.3-bookworm"
     }
   },
 

diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-FROM docker.io/node:18.18.2-alpine
+FROM docker.io/node:18.20.3-alpine3.20
 
 ENV NO_UPDATE_NOTIFIER=true
 WORKDIR /opt/app-root/src/app

diff --git a/app/src/docs/v1.api-spec.yaml b/app/src/docs/v1.api-spec.yaml
@@ -1750,6 +1750,12 @@ paths:
       parameters:
         - $ref: '#/components/parameters/formSubmissionIdParam'
         - $ref: '#/components/parameters/documentTemplateIdParam'
+        - in: query
+          name: convertTo
+          schema:
+            type: string
+          description: file type to convert to
+          example: pdf
       responses:
         '200':
           description: Returns the document template with merged variables

diff --git a/app/src/forms/email/emailService.js b/app/src/forms/email/emailService.js
@@ -449,13 +449,11 @@ const service = {
    * @function submissionExportLink
    * Email with the link to the Form submissions export file
    * @param {string} formId
-   * @param {string} submissionId
    * @param {object} body
-   * @param {string} referer
    * @param {string} fileId
    * @returns The result of the email merge operation
    */
-  submissionExportLink: async (formId, submissionId, body, referer, fileId) => {
+  submissionExportLink: async (formId, body, fileId) => {
     try {
       const form = await formService.readForm(formId);
       const contextToVal = [body.to];
@@ -487,7 +485,6 @@ const service = {
         function: EmailTypes.SUBMISSION_EXPORT,
         formId: formId,
         body: body,
-        referer: referer,
       });
       throw e;
     }

diff --git a/app/src/forms/form/controller.js b/app/src/forms/form/controller.js
@@ -73,7 +73,7 @@ module.exports = {
 
   export: async (req, res, next) => {
     try {
-      const result = await exportService.export(req.params.formId, req.query, req.currentUser, req.headers.referer);
+      const result = await exportService.export(req.params.formId, req.query, req.currentUser);
       ['Content-Disposition', 'Content-Type'].forEach((h) => {
         res.setHeader(h, result.headers[h.toLowerCase()]);
       });
@@ -85,7 +85,7 @@ module.exports = {
 
   exportWithFields: async (req, res, next) => {
     try {
-      const result = await exportService.export(req.params.formId, req.body, req.currentUser, req.headers.referer);
+      const result = await exportService.export(req.params.formId, req.body, req.currentUser);
       ['Content-Disposition', 'Content-Type'].forEach((h) => {
         res.setHeader(h, result.headers[h.toLowerCase()]);
       });

diff --git a/app/src/forms/form/exportService.js b/app/src/forms/form/exportService.js
@@ -171,7 +171,7 @@ const service = {
     }
     return {};
   },
-  _formatData: async (exportFormat, exportType, exportTemplate, form, data = {}, columns, version, emailExport, currentUser, referer) => {
+  _formatData: async (exportFormat, exportType, exportTemplate, form, data = {}, columns, version, emailExport, currentUser) => {
     // inverting content structure nesting to prioritize submission content clarity
     const formatted = data.map((obj) => {
       const { submission, ...form } = obj;
@@ -181,7 +181,7 @@ const service = {
     if (EXPORT_TYPES.submissions === exportType) {
       if (EXPORT_FORMATS.csv === exportFormat) {
         let formVersion = version ? parseInt(version) : 1;
-        return await service._formatSubmissionsCsv(form, formatted, exportTemplate, columns, formVersion, emailExport, currentUser, referer);
+        return await service._formatSubmissionsCsv(form, formatted, exportTemplate, columns, formVersion, emailExport, currentUser);
       }
       if (EXPORT_FORMATS.json === exportFormat) {
         return await service._formatSubmissionsJson(form, formatted);
@@ -259,27 +259,33 @@ const service = {
       },
     };
   },
-  _formatSubmissionsCsv: async (form, data, exportTemplate, fields, version, emailExport, currentUser, referer) => {
+  _formatSubmissionsCsv: async (form, data, exportTemplate, fields, version, emailExport, currentUser) => {
     try {
       switch (exportTemplate) {
         case 'multiRowEmptySpacesCSVExport':
-          return service._multiRowsCSVExport(form, data, version, true, fields, emailExport, currentUser, referer);
+          return service._multiRowsCSVExport(form, data, version, true, fields, emailExport, currentUser);
         case 'multiRowBackFilledCSVExport':
-          return service._multiRowsCSVExport(form, data, version, false, fields, emailExport, currentUser, referer);
+          return service._multiRowsCSVExport(form, data, version, false, fields, emailExport, currentUser);
         case 'singleRowCSVExport':
-          return service._singleRowCSVExport(form, data, version, fields, currentUser, emailExport, referer);
+          return service._singleRowCSVExport(form, data, version, fields, currentUser, emailExport);
         case 'unFormattedCSVExport':
-          return service._unFormattedCSVExport(form, data, emailExport, currentUser, referer);
+          return service._unFormattedCSVExport(form, data, emailExport, currentUser);
         default:
-        // code block
+          throw new Problem(400, {
+            detail: `Bad export "template" value of "${exportTemplate}"`,
+          });
       }
     } catch (e) {
+      if (e instanceof Problem) {
+        throw e;
+      }
+
       throw new Problem(500, {
         detail: `Could not make a csv export of submissions for this form. ${e.message}`,
       });
     }
   },
-  _multiRowsCSVExport: async (form, data, version, blankout, fields, emailExport, currentUser, referer) => {
+  _multiRowsCSVExport: async (form, data, version, blankout, fields, emailExport, currentUser) => {
     const pathToUnwind = await unwindPath(data);
     let headers = await service._buildCsvHeaders(form, data, version, fields);
 
@@ -288,22 +294,22 @@ const service = {
       fields: headers,
     };
 
-    return service._submissionCSVExport(opts, form, data, emailExport, currentUser, referer);
+    return service._submissionCSVExport(opts, form, data, emailExport, currentUser);
   },
-  _singleRowCSVExport: async (form, data, version, fields, currentUser, emailExport, referer) => {
+  _singleRowCSVExport: async (form, data, version, fields, currentUser, emailExport) => {
     const headers = await service._buildCsvHeaders(form, data, version, fields, true);
     const opts = {
       transforms: [flatten({ objects: true, arrays: true, separator: '.' })],
       fields: headers,
     };
 
-    return service._submissionCSVExport(opts, form, data, emailExport, currentUser, referer);
+    return service._submissionCSVExport(opts, form, data, emailExport, currentUser);
   },
-  _unFormattedCSVExport: async (form, data, emailExport, currentUser, referer) => {
-    return service._submissionCSVExport({}, form, data, emailExport, currentUser, referer);
+  _unFormattedCSVExport: async (form, data, emailExport, currentUser) => {
+    return service._submissionCSVExport({}, form, data, emailExport, currentUser);
   },
 
-  _submissionCSVExport(opts, form, data, emailExport, currentUser, referer) {
+  _submissionCSVExport(opts, form, data, emailExport, currentUser) {
     // to work with object chunk in pipe instead of Buffer
     const transformOpts = {
       objectMode: true,
@@ -345,7 +351,7 @@ const service = {
             // Uploading to Object storage
             const fileResult = await fileService.create(fileData, fileCurrentUser, 'exports');
             // Sending the email with link to uploaded export
-            emailService.submissionExportLink(form.id, null, { to: currentUser.email }, referer, fileResult.id);
+            emailService.submissionExportLink(form.id, { to: currentUser.email }, fileResult.id);
           }
         });
       });
@@ -408,7 +414,7 @@ const service = {
     return await service._buildCsvHeaders(form, formatted, params.version, undefined, params.singleRow === 'true');
   },
 
-  export: async (formId, params = {}, currentUser = null, referer) => {
+  export: async (formId, params, currentUser) => {
     // ok, let's determine what we are exporting and do it!!!!
     // what operation?
     // what output format?
@@ -417,7 +423,7 @@ const service = {
     const exportTemplate = params.template ? params.template : 'multiRowEmptySpacesCSVExport';
     const form = await service._getForm(formId);
     const data = await service._getData(exportType, params.version, form, params);
-    const result = await service._formatData(exportFormat, exportType, exportTemplate, form, data, params.fields, params.version, params.emailExport, currentUser, referer);
+    const result = await service._formatData(exportFormat, exportType, exportTemplate, form, data, params.fields, params.version, params.emailExport, currentUser);
     return { data: result.data, headers: result.headers };
   },
 };

diff --git a/app/src/forms/submission/controller.js b/app/src/forms/submission/controller.js
@@ -137,6 +137,7 @@ module.exports = {
       const template = await formService.documentTemplateRead(req.params.documentTemplateId);
       const fileName = template.filename.substring(0, template.filename.lastIndexOf('.'));
       const fileExtension = template.filename.substring(template.filename.lastIndexOf('.') + 1);
+      const convertTo = req.query.convertTo || 'pdf';
 
       const templateBody = {
         data: {
@@ -148,12 +149,12 @@ module.exports = {
           },
         },
         options: {
-          convertTo: 'pdf',
+          convertTo: convertTo,
           overwrite: true,
           reportName: fileName,
         },
         template: {
-          content: btoa(template.template),
+          content: template.template.toString(),
           encodingType: 'base64',
           fileType: fileExtension,
         },

diff --git a/app/tests/unit/forms/form/exportService.spec.js b/app/tests/unit/forms/form/exportService.spec.js
@@ -25,27 +25,60 @@ const getCsvRow = (result, index) => {
 };
 
 describe('export', () => {
+  const form = {
+    id: formId,
+    snake: () => {
+      'form';
+    },
+  };
+  const formSchema = {
+    display: 'form',
+    type: 'form',
+    components: [
+      {
+        type: 'datagrid',
+        label: 'Data Grid',
+        components: [
+          {
+            type: 'simpletextfield',
+            label: 'Text Field',
+          },
+        ],
+      },
+    ],
+  };
+
+  // Mock the internal functions that only do Objection calls.
+  exportService._getForm = jest.fn().mockReturnValue(form);
+  exportService._readLatestFormSchema = jest.fn().mockReturnValue(formSchema);
+
   describe('csv', () => {
     const currentUser = {
       usernameIdp: 'PAT_TEST',
     };
-    const form = {
-      snake: () => {
-        'form';
-      },
-    };
-    exportService._getForm = jest.fn().mockReturnValue(form);
 
     describe('400 response when', () => {
       test('invalid preferences json', async () => {
-        const params = { preference: '{' };
-        exportService._readLatestFormSchema = jest.fn().mockReturnValueOnce();
+        const params = {
+          preference: '{',
+        };
+
+        await expect(exportService.export(formId, params, currentUser)).rejects.toThrow('400');
+      });
+
+      test('invalid export template', async () => {
+        exportService._getData = jest.fn().mockReturnValue([]);
+        const params = {
+          format: 'csv',
+          template: 'doesntexist',
+          type: 'submissions',
+        };
 
         await expect(exportService.export(formId, params, currentUser)).rejects.toThrow('400');
       });
     });
 
-    describe('type 1', () => {
+    describe('type 1 / multiRowEmptySpacesCSVExport', () => {
       const params = {
         emailExport: false,
         fields: ['form.submissionId', 'form.confirmationId', 'form.formName', 'form.version', 'form.createdAt', 'form.fullName', 'form.username', 'form.email', 'simpletextfield'],
@@ -73,30 +106,14 @@ describe('export', () => {
             },
           },
         ];
-        exportService._getData = jest.fn().mockReturnValueOnce(submission);
-        exportService._readLatestFormSchema = jest.fn().mockReturnValueOnce();
+        exportService._getData.mockReturnValueOnce(submission);
+        exportService._readLatestFormSchema.mockReturnValueOnce();
 
         await expect(exportService.export(formId, params, currentUser)).rejects.toThrow('400');
       });
     });
 
-    describe('type 3', () => {
-      const latestFormSchema = {
-        display: 'form',
-        type: 'form',
-        components: [
-          {
-            type: 'datagrid',
-            label: 'Data Grid',
-            components: [
-              {
-                type: 'simpletextfield',
-                label: 'Text Field',
-              },
-            ],
-          },
-        ],
-      };
+    describe('type 3 / singleRowCSVExport', () => {
       const params = {
         emailExport: false,
         fields: [
@@ -139,7 +156,6 @@ describe('export', () => {
           },
         ];
         exportService._getData = jest.fn().mockReturnValue(submission);
-        exportService._readLatestFormSchema = jest.fn().mockReturnValueOnce(latestFormSchema);
 
         const result = await exportService.export(formId, params, currentUser);
 
@@ -173,7 +189,6 @@ describe('export', () => {
           },
         ];
         exportService._getData = jest.fn().mockReturnValue(submission);
-        exportService._readLatestFormSchema = jest.fn().mockReturnValueOnce(latestFormSchema);
 
         const result = await exportService.export(formId, params, currentUser);
 
@@ -227,7 +242,6 @@ describe('export', () => {
           },
         ];
         exportService._getData = jest.fn().mockReturnValue(submission);
-        exportService._readLatestFormSchema = jest.fn().mockReturnValueOnce(latestFormSchema);
 
         const result = await exportService.export(formId, params, currentUser);
 

diff --git a/app/tests/unit/forms/submission/controller.spec.js b/app/tests/unit/forms/submission/controller.spec.js
@@ -125,7 +125,7 @@ describe('template rendering', () => {
 
   const validDocumentTemplate = {
     filename: 'template_hello_world.txt',
-    template: 'Hello {d.simpletextfield}!',
+    template: btoa('Hello {d.simpletextfield}!'),
   };
 
   const mockCdogsResponse = {

diff --git a/openshift/app.cronjob.yaml b/openshift/app.cronjob.yaml
@@ -54,7 +54,7 @@ objects:
             spec:
               containers:
                 - name: my-container
-                  image: docker.io/curlimages/curl:8.1.0
+                  image: docker.io/curlimages/curl:8.8.0
                   env:
                     - name: APITOKEN
                       valueFrom: