Import Observations and See Validation Status/Errors

api/src/paths/project/{projectId}/survey/{surveyId}/observation/submission/get.test.ts

@@ -60,7 +60,7 @@ describe('getObservationSubmission', () => {
     sinon.stub(db, 'getDBConnection').returns(dbConnectionObj);
 
     try {
-      const result = observationSubmission.getObservationSubmission();
+      const result = observationSubmission.getOccurenceSubmission();
       await result(
         { ...sampleReq, params: { ...sampleReq.params, surveyId: null } },
         (null as unknown) as any,
@@ -84,27 +84,26 @@ describe('getObservationSubmission', () => {
     sinon.stub(survey_occurrence_queries, 'getLatestSurveyOccurrenceSubmissionSQL').returns(null);
 
     try {
-      const result = observationSubmission.getObservationSubmission();
+      const result = observationSubmission.getOccurenceSubmission();
 
       await result(sampleReq, (null as unknown) as any, (null as unknown) as any);
       expect.fail();
     } catch (actualError) {
       expect(actualError.status).to.equal(400);
-      expect(actualError.message).to.equal('Failed to build SQL get statement');
+      expect(actualError.message).to.equal('Failed to build SQL getLatestSurveyOccurrenceSubmissionSQL statement');
     }
   });
 
-  it('should return an observation submission, on success', async () => {
+  it('should return an observation submission, on success with no rejected files', async () => {
     const mockQuery = sinon.stub();
 
     mockQuery.resolves({
       rows: [
         {
           id: 13,
-          file_name: 'filename.txt',
-          create_date: '2020-01-01',
-          update_date: '',
-          file_size: 0
+          file_name: 'dwca_moose.zip',
+          submission_status_type_name: 'Darwin Core Validated',
+          message: 'some message'
         }
       ]
     });
@@ -119,13 +118,107 @@ describe('getObservationSubmission', () => {
 
     sinon.stub(survey_occurrence_queries, 'getLatestSurveyOccurrenceSubmissionSQL').returns(SQL`something`);
 
-    const result = observationSubmission.getObservationSubmission();
+    const result = observationSubmission.getOccurenceSubmission();
 
     await result(sampleReq, sampleRes as any, (null as unknown) as any);
 
     expect(actualResult).to.be.eql({
       id: 13,
-      fileName: 'filename.txt'
+      fileName: 'dwca_moose.zip',
+      status: 'Darwin Core Validated',
+      messages: []
+    });
+  });
+
+  it('should throw a 400 error with rejected files when failed to getOccurrenceSubmissionMessagesSQL', async () => {
+    const mockQuery = sinon.stub();
+
+    mockQuery.resolves({
+      rows: [
+        {
+          id: 13,
+          file_name: 'dwca_moose.zip',
+          message: 'some message',
+          submission_status_type_name: 'Rejected'
+        }
+      ]
+    });
+
+    sinon.stub(db, 'getDBConnection').returns({
+      ...dbConnectionObj,
+      systemUserId: () => {
+        return 20;
+      },
+      query: mockQuery
+    });
+
+    sinon.stub(survey_occurrence_queries, 'getLatestSurveyOccurrenceSubmissionSQL').returns(SQL`something`);
+    sinon.stub(survey_occurrence_queries, 'getOccurrenceSubmissionMessagesSQL').returns(null);
+
+    try {
+      const result = observationSubmission.getOccurenceSubmission();
+
+      await result(sampleReq, (null as unknown) as any, (null as unknown) as any);
+      expect.fail();
+    } catch (actualError) {
+      expect(actualError.status).to.equal(400);
+      expect(actualError.message).to.equal('Failed to build SQL getOccurrenceSubmissionMessagesSQL statement');
+    }
+  });
+
+  it('should return an observation submission on success, with rejected files', async () => {
+    const mockQuery = sinon.stub();
+
+    mockQuery
+      .onFirstCall()
+      .resolves({
+        rows: [
+          {
+            id: 13,
+            file_name: 'dwca_moose.zip',
+            message: 'some message',
+            submission_status_type_name: 'Rejected'
+          }
+        ]
+      })
+      .onSecondCall()
+      .resolves({
+        rows: [
+          {
+            id: 1,
+            type: 'type',
+            status: 'status',
+            message: 'some error message'
+          },
+          {
+            id: 2,
+            type: 'type',
+            status: 'status',
+            message: 'some other error message'
+          }
+        ]
+      });
+
+    sinon.stub(db, 'getDBConnection').returns({
+      ...dbConnectionObj,
+      systemUserId: () => {
+        return 20;
+      },
+      query: mockQuery
+    });
+
+    sinon.stub(survey_occurrence_queries, 'getLatestSurveyOccurrenceSubmissionSQL').returns(SQL`something`);
+    sinon.stub(survey_occurrence_queries, 'getOccurrenceSubmissionMessagesSQL').returns(SQL`something`);
+
+    const result = observationSubmission.getOccurenceSubmission();
+
+    await result(sampleReq, sampleRes as any, (null as unknown) as any);
+
+    expect(actualResult).to.be.eql({
+      id: 13,
+      fileName: 'dwca_moose.zip',
+      status: 'Rejected',
+      messages: ['some error message', 'some other error message']
     });
   });
 
@@ -144,7 +237,7 @@ describe('getObservationSubmission', () => {
 
     sinon.stub(survey_occurrence_queries, 'getLatestSurveyOccurrenceSubmissionSQL').returns(SQL`something`);
 
-    const result = observationSubmission.getObservationSubmission();
+    const result = observationSubmission.getOccurenceSubmission();
 
     await result(sampleReq, sampleRes as any, (null as unknown) as any);
 

api/src/paths/project/{projectId}/survey/{surveyId}/observation/submission/get.ts

@@ -5,15 +5,18 @@ import { Operation } from 'express-openapi';
 import { SYSTEM_ROLE } from '../../../../../../../constants/roles';
 import { getDBConnection } from '../../../../../../../database/db';
 import { HTTP400 } from '../../../../../../../errors/CustomError';
-import { getLatestSurveyOccurrenceSubmissionSQL } from '../../../../../../../queries/survey/survey-occurrence-queries';
+import {
+  getLatestSurveyOccurrenceSubmissionSQL,
+  getOccurrenceSubmissionMessagesSQL
+} from '../../../../../../../queries/survey/survey-occurrence-queries';
 import { getLogger } from '../../../../../../../utils/logger';
 
 const defaultLog = getLogger('/api/project/{projectId}/survey/{surveyId}/observation/submission/get');
 
-export const GET: Operation = [getObservationSubmission()];
+export const GET: Operation = [getOccurenceSubmission()];
 
 GET.apiDoc = {
-  description: 'Fetches an observation submission for a survey.',
+  description: 'Fetches an observation occurrence submission for a survey.',
   tags: ['observation_submission'],
   security: [
     {
@@ -50,8 +53,20 @@ GET.apiDoc = {
                 type: 'number'
               },
               fileName: {
-                description: 'The file name of the attachment',
+                description: 'The file name of the submission',
                 type: 'string'
+              },
+              status: {
+                description: 'The validation status of the submission',
+                type: 'string'
+              },
+              messages: {
+                description: 'The validation status messages of the submission',
+                type: 'array',
+                items: {
+                  type: 'string',
+                  description: 'A validation status message of the submission'
+                }
               }
             }
           }
@@ -76,9 +91,9 @@ GET.apiDoc = {
   }
 };
 
-export function getObservationSubmission(): RequestHandler {
+export function getOccurenceSubmission(): RequestHandler {
   return async (req, res) => {
-    defaultLog.debug({ label: 'Get an observation submission', message: 'params', req_params: req.params });
+    defaultLog.debug({ label: 'Get an occurrence submission', message: 'params', req_params: req.params });
 
     if (!req.params.surveyId) {
       throw new HTTP400('Missing required path param `surveyId`');
@@ -87,33 +102,62 @@ export function getObservationSubmission(): RequestHandler {
     const connection = getDBConnection(req['keycloak_token']);
 
     try {
-      const getObservationSubmissionSQLStatement = getLatestSurveyOccurrenceSubmissionSQL(Number(req.params.surveyId));
+      const getOccurrenceSubmissionSQLStatement = getLatestSurveyOccurrenceSubmissionSQL(Number(req.params.surveyId));
 
-      if (!getObservationSubmissionSQLStatement) {
-        throw new HTTP400('Failed to build SQL get statement');
+      if (!getOccurrenceSubmissionSQLStatement) {
+        throw new HTTP400('Failed to build SQL getLatestSurveyOccurrenceSubmissionSQL statement');
       }
 
       await connection.open();
 
-      const observationSubmissionData = await connection.query(
-        getObservationSubmissionSQLStatement.text,
-        getObservationSubmissionSQLStatement.values
+      const occurrenceSubmissionData = await connection.query(
+        getOccurrenceSubmissionSQLStatement.text,
+        getOccurrenceSubmissionSQLStatement.values
       );
 
+      let messageList = [];
+
+      if (
+        occurrenceSubmissionData &&
+        occurrenceSubmissionData.rows &&
+        occurrenceSubmissionData.rows[0] &&
+        occurrenceSubmissionData.rows[0].submission_status_type_name === 'Rejected'
+      ) {
+        const occurrence_submission_id = occurrenceSubmissionData.rows[0].id;
+        const getSubmissionErrorListSQLStatement = getOccurrenceSubmissionMessagesSQL(Number(occurrence_submission_id));
+
+        if (!getSubmissionErrorListSQLStatement) {
+          throw new HTTP400('Failed to build SQL getOccurrenceSubmissionMessagesSQL statement');
+        }
+
+        const submissionErrorListData = await connection.query(
+          getSubmissionErrorListSQLStatement.text,
+          getSubmissionErrorListSQLStatement.values
+        );
+
+        messageList =
+          (submissionErrorListData &&
+            submissionErrorListData.rows &&
+            submissionErrorListData.rows.map((row) => row.message)) ||
+          [];
+      }
+
       await connection.commit();
 
-      const getObservationSubmissionData =
-        (observationSubmissionData &&
-          observationSubmissionData.rows &&
-          observationSubmissionData.rows[0] && {
-            id: observationSubmissionData.rows[0].id,
-            fileName: observationSubmissionData.rows[0].file_name
+      const getOccurrenceSubmissionData =
+        (occurrenceSubmissionData &&
+          occurrenceSubmissionData.rows &&
+          occurrenceSubmissionData.rows[0] && {
+            id: occurrenceSubmissionData.rows[0].id,
+            fileName: occurrenceSubmissionData.rows[0].file_name,
+            status: occurrenceSubmissionData.rows[0].submission_status_type_name,
+            messages: messageList
           }) ||
         null;
 
-      return res.status(200).json(getObservationSubmissionData);
+      return res.status(200).json(getOccurrenceSubmissionData);
     } catch (error) {
-      defaultLog.debug({ label: 'getObservationSubmission', message: 'error', error });
+      defaultLog.debug({ label: 'getOccurenceSubmission', message: 'error', error });
       await connection.rollback();
       throw error;
     } finally {

api/src/paths/project/{projectId}/survey/{surveyId}/observation/submission/upload.ts

@@ -151,7 +151,7 @@ export function uploadMedia(): RequestHandler {
 
       await uploadFileToS3(rawMediaFile, key, metadata);
 
-      return res.status(200).send();
+      return res.status(200).send({ submissionId });
     } catch (error) {
       defaultLog.debug({ label: 'uploadMedia', message: 'error', error });
       await connection.rollback();

api/src/queries/survey/survey-occurrence-queries.test.ts

@@ -3,8 +3,11 @@ import { describe } from 'mocha';
 import {
   deleteSurveyOccurrencesSQL,
   getLatestSurveyOccurrenceSubmissionSQL,
+  getOccurrenceSubmissionMessagesSQL,
   getSurveyOccurrenceSubmissionSQL,
   insertSurveyOccurrenceSubmissionSQL,
+  insertSurveySubmissionMessageSQL,
+  insertSurveySubmissionStatusSQL,
   updateSurveyOccurrenceSubmissionWithKeySQL
 } from './survey-occurrence-queries';
 
@@ -83,7 +86,7 @@ describe('updateSurveyOccurrenceSubmissionwithKeySQL', () => {
 });
 
 describe('getSurveyOccurrenceSubmissionSQL', () => {
-  it('returns null response when null submissionId provided', () => {
+  it('returns null response when null occurrenceSubmissionId provided', () => {
     const response = getSurveyOccurrenceSubmissionSQL((null as unknown) as number);
 
     expect(response).to.be.null;
@@ -95,3 +98,63 @@ describe('getSurveyOccurrenceSubmissionSQL', () => {
     expect(response).to.not.be.null;
   });
 });
+
+describe('insertSurveySubmissionStatusSQL', () => {
+  it('returns null response when null occurrenceSubmissionId provided', () => {
+    const response = insertSurveySubmissionStatusSQL((null as unknown) as number, 'type');
+
+    expect(response).to.be.null;
+  });
+
+  it('returns null response when null submissionStatusType provided', () => {
+    const response = insertSurveySubmissionStatusSQL(1, (null as unknown) as string);
+
+    expect(response).to.be.null;
+  });
+
+  it('returns non null response when valid params provided', () => {
+    const response = insertSurveySubmissionStatusSQL(1, 'type');
+
+    expect(response).to.not.be.null;
+  });
+});
+
+describe('insertSurveySubmissionMessageSQL', () => {
+  it('returns null response when null occurrenceSubmissionId provided', () => {
+    const response = insertSurveySubmissionMessageSQL((null as unknown) as number, 'type', 'message');
+
+    expect(response).to.be.null;
+  });
+
+  it('returns null response when null submissionStatusType provided', () => {
+    const response = insertSurveySubmissionMessageSQL(1, (null as unknown) as string, 'message');
+
+    expect(response).to.be.null;
+  });
+
+  it('returns null response when null submissionMessage provided', () => {
+    const response = insertSurveySubmissionMessageSQL(1, 'type', (null as unknown) as string);
+
+    expect(response).to.be.null;
+  });
+
+  it('returns non null response when valid params provided', () => {
+    const response = insertSurveySubmissionMessageSQL(1, 'type', 'message');
+
+    expect(response).to.not.be.null;
+  });
+});
+
+describe('getOccurrenceSubmissionMessagesSQL', () => {
+  it('returns null response when null occurrenceSubmissionId provided', () => {
+    const response = getOccurrenceSubmissionMessagesSQL((null as unknown) as number);
+
+    expect(response).to.be.null;
+  });
+
+  it('returns non null response when valid params provided', () => {
+    const response = getOccurrenceSubmissionMessagesSQL(1);
+
+    expect(response).to.not.be.null;
+  });
+});