BHBC-2058: Edit Project as a Single Page / General UI Clean-up

Makefile

@@ -165,7 +165,7 @@ run-db-setup: ## Run the database migrations and seeding
 
 build-db-migrate: ## Build the db knex migrations image
 	@echo "==============================================="
-	@echo "Make: build-db-migrate - bnuilding db knex migrate image"
+	@echo "Make: build-db-migrate - building db knex migrate image"
 	@echo "==============================================="
 	@docker-compose -f docker-compose.yml build db_migrate
 

api/src/constants/status.ts

@@ -34,11 +34,33 @@ export enum SUBMISSION_STATUS_TYPE {
   'INVALID_MEDIA' = 'Media is not valid',
   'FAILED_VALIDATION' = 'Failed to validate',
   'FAILED_TRANSFORMED' = 'Failed to transform',
-  'FAILED_PROCESSING_OCCURRENCE_DATA' = 'Failed to process occurrence data'
+  'FAILED_PROCESSING_OCCURRENCE_DATA' = 'Failed to process occurrence data',
+  'FAILED_SUMMARY_PREPARATION' = 'Failed to prepare summary submission'
 }
 
+export enum SUMMARY_SUBMISSION_MESSAGE_TYPE {
+  'DUPLICATE_HEADER' = 'Duplicate Header',
+  'UNKNOWN_HEADER' = 'Unknown Header',
+  'MISSING_REQUIRED_HEADER' = 'Missing Required Header',
+  'MISSING_RECOMMENDED_HEADER' = 'Missing Recommended Header',
+  'MISCELLANEOUS' = 'Miscellaneous',
+  'MISSING_REQUIRED_FIELD' = 'Missing Required Field',
+  'UNEXPECTED_FORMAT' = 'Unexpected Format',
+  'OUT_OF_RANGE' = 'Out of Range',
+  'INVALID_VALUE' = 'Invalid Value',
+  'MISSING_VALIDATION_SCHEMA' = 'Missing Validation Schema',
+  'INVALID_MEDIA' = 'Media is Invalid',
+  'INVALID_XLSX_CSV' = 'XLSX CSV is Invalid',
+  'FAILED_TO_GET_TEMPLATE_NAME_VERSION' = 'Missing Name or Version Number',
+  'FAILED_GET_VALIDATION_RULES' = 'Failed to Get Validation Rules',
+  'FAILED_PARSE_VALIDATION_SCHEMA' = 'Failed to Parse Validation Schema',
+  'UNSUPPORTED_FILE_TYPE' = 'Unsupported File Type',
+  'FOUND_VALIDATION' = 'Found Validation',
+  'SYSTEM_ERROR' = 'System Error'
+}
+
+// Message types that match the submission_message_type table
 export enum SUBMISSION_MESSAGE_TYPE {
-  //message types that match the submission_message_type table
   'DUPLICATE_HEADER' = 'Duplicate header',
   'UNKNOWN_HEADER' = 'Unknown Header',
   'MISSING_REQUIRED_HEADER' = 'Missing Required Header',
@@ -64,6 +86,14 @@ export enum SUBMISSION_MESSAGE_TYPE {
   'FAILED_PERSIST_VALIDATION_RESULTS' = 'Failed to persist validation results',
   'FAILED_UPDATE_OCCURRENCE_SUBMISSION' = 'Failed to update occurrence submission',
   'FAILED_TO_GET_TRANSFORM_SCHEMA' = 'Unable to get transform schema for submission',
+  'FAILED_TO_GET_TEMPLATE_NAME_VERSION' = 'Missing name or version number.',
   'INVALID_MEDIA' = 'Media is invalid',
+  'INVALID_XLSX_CSV' = 'Media is not a valid XLSX CSV file.',
   'UNSUPPORTED_FILE_TYPE' = 'File submitted is not a supported type'
 }
+
+export enum MESSAGE_CLASS_NAME {
+  NOTICE = 'Notice',
+  ERROR = 'Error',
+  WARNING = 'Warning'
+}

api/src/models/project-create.test.ts

@@ -93,7 +93,7 @@ describe('PostProjectObject', () => {
         ]
       },
       funding: {
-        funding_sources: [
+        fundingSources: [
           {
             agency_id: 1,
             investment_action_category: 1,
@@ -522,48 +522,48 @@ describe('PostFundingData', () => {
       data = new PostFundingData(null);
     });
 
-    it('sets funding_sources', () => {
-      expect(data.funding_sources).to.eql([]);
+    it('sets fundingSources', () => {
+      expect(data.fundingSources).to.eql([]);
     });
   });
 
   describe('Values provided but not valid arrays', () => {
     let data: PostFundingData;
 
     const obj = {
-      funding_sources: null
+      fundingSources: null
     };
 
     before(() => {
       data = new PostFundingData(obj);
     });
 
-    it('sets funding_sources', () => {
-      expect(data.funding_sources).to.eql([]);
+    it('sets fundingSources', () => {
+      expect(data.fundingSources).to.eql([]);
     });
   });
 
   describe('Values provided but with no length', () => {
     let data: PostFundingData;
 
     const obj = {
-      funding_sources: []
+      fundingSources: []
     };
 
     before(() => {
       data = new PostFundingData(obj);
     });
 
-    it('sets funding_sources', () => {
-      expect(data.funding_sources).to.eql([]);
+    it('sets fundingSources', () => {
+      expect(data.fundingSources).to.eql([]);
     });
   });
 
   describe('All values provided', () => {
     let data: PostFundingData;
 
     const obj = {
-      funding_sources: [
+      fundingSources: [
         {
           agency_id: 1,
           investment_action_category: 1,
@@ -579,8 +579,8 @@ describe('PostFundingData', () => {
       data = new PostFundingData(obj);
     });
 
-    it('sets funding_sources', () => {
-      expect(data.funding_sources).to.eql(obj.funding_sources);
+    it('sets fundingSources', () => {
+      expect(data.fundingSources).to.eql(obj.fundingSources);
     });
   });
 });

api/src/models/project-create.ts

@@ -192,13 +192,13 @@ export class PostFundingSource {
  * @class PostFundingData
  */
 export class PostFundingData {
-  funding_sources: PostFundingSource[];
+  fundingSources: PostFundingSource[];
 
   constructor(obj?: any) {
     defaultLog.debug({ label: 'PostFundingData', message: 'params', obj });
 
-    this.funding_sources =
-      (obj?.funding_sources?.length && obj.funding_sources.map((item: any) => new PostFundingSource(item))) || [];
+    this.fundingSources =
+      (obj?.fundingSources?.length && obj.fundingSources.map((item: any) => new PostFundingSource(item))) || [];
   }
 }
 

api/src/models/project-update.test.ts

@@ -350,17 +350,13 @@ describe('PutFundingSource', () => {
 
     before(() => {
       data = new PutFundingSource({
-        fundingSources: [
-          {
-            id: 1,
-            investment_action_category: 1,
-            agency_project_id: 'agency project id',
-            funding_amount: 20,
-            start_date: '2020/04/04',
-            end_date: '2020/05/05',
-            revision_count: 1
-          }
-        ]
+        id: 1,
+        investment_action_category: 1,
+        agency_project_id: 'agency project id',
+        funding_amount: 20,
+        start_date: '2020/04/04',
+        end_date: '2020/05/05',
+        revision_count: 1
       });
     });
 

api/src/models/project-update.ts

@@ -117,15 +117,30 @@ export class PutFundingSource {
   constructor(obj?: any) {
     defaultLog.debug({ label: 'PutFundingSource', message: 'params', obj });
 
-    const fundingSource = obj?.fundingSources?.length && obj.fundingSources[0];
-
-    this.id = fundingSource?.id || null;
-    this.investment_action_category = fundingSource?.investment_action_category || null;
-    this.agency_project_id = fundingSource?.agency_project_id || null;
-    this.funding_amount = fundingSource?.funding_amount || null;
-    this.start_date = fundingSource?.start_date || null;
-    this.end_date = fundingSource?.end_date || null;
-    this.revision_count = fundingSource?.revision_count ?? null;
+    this.id = obj?.id || null;
+    this.investment_action_category = obj?.investment_action_category || null;
+    this.agency_project_id = obj?.agency_project_id || null;
+    this.funding_amount = obj?.funding_amount || null;
+    this.start_date = obj?.start_date || null;
+    this.end_date = obj?.end_date || null;
+    this.revision_count = obj?.revision_count ?? null;
+  }
+}
+
+/**
+ * Processes PUT /project funding data
+ *
+ * @export
+ * @class PostFundingData
+ */
+export class PutFundingData {
+  fundingSources: PutFundingSource[];
+
+  constructor(obj?: any) {
+    defaultLog.debug({ label: 'PostFundingData', message: 'params', obj });
+
+    this.fundingSources =
+      (obj?.fundingSources?.length && obj.fundingSources.map((item: any) => new PutFundingSource(item))) || [];
   }
 }
 

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

@@ -2,10 +2,11 @@ import chai, { expect } from 'chai';
 import { describe } from 'mocha';
 import sinon from 'sinon';
 import sinonChai from 'sinon-chai';
-import SQL from 'sql-template-strings';
+import { MESSAGE_CLASS_NAME } from '../../../../../../../constants/status';
 import * as db from '../../../../../../../database/db';
 import { HTTPError } from '../../../../../../../errors/http-error';
-import survey_queries from '../../../../../../../queries/survey';
+import { ISummarySubmissionMessagesResponse } from '../../../../../../../repositories/summary-repository';
+import { SummaryService } from '../../../../../../../services/summary-service';
 import { getMockDBConnection } from '../../../../../../../__mocks__/db';
 import * as summarySubmission from './get';
 
@@ -56,29 +57,6 @@ describe('getSummarySubmission', () => {
     }
   });
 
-  it('should throw a 400 error when no sql statement returned for getLatestSurveySummarySubmissionSQL', async () => {
-    sinon.stub(db, 'getDBConnection').returns({
-      ...dbConnectionObj,
-      systemUserId: () => {
-        return 20;
-      }
-    });
-
-    sinon.stub(survey_queries, 'getLatestSurveySummarySubmissionSQL').returns(null);
-
-    try {
-      const result = summarySubmission.getSurveySummarySubmission();
-
-      await result(sampleReq, (null as unknown) as any, (null as unknown) as any);
-      expect.fail();
-    } catch (actualError) {
-      expect((actualError as HTTPError).status).to.equal(400);
-      expect((actualError as HTTPError).message).to.equal(
-        'Failed to build getLatestSurveySummarySubmissionSQLStatement statement'
-      );
-    }
-  });
-
   it('should return a summary submission, on success', async () => {
     const mockQuery = sinon.stub();
 
@@ -100,16 +78,44 @@ describe('getSummarySubmission', () => {
       query: mockQuery
     });
 
-    sinon.stub(survey_queries, 'getLatestSurveySummarySubmissionSQL').returns(SQL`something`);
+    const messages: ISummarySubmissionMessagesResponse[] = [
+      {
+        id: 1,
+        class: MESSAGE_CLASS_NAME.ERROR,
+        type: 'Miscellaneous',
+        message: 'error message'
+      },
+      {
+        id: 2,
+        class: MESSAGE_CLASS_NAME.ERROR,
+        type: 'Miscellaneous',
+        message: 'another error message'
+      }
+    ];
+
+    const submission = {
+      id: 13,
+      file_name: 'file13.xlsx',
+      key: 's3_key',
+      delete_timestamp: null,
+      submission_message_type_id: 1,
+      message: 'another error message',
+      submission_message_type_name: 'Miscellaneous',
+      summary_submission_message_class_id: 1,
+      submission_message_class_name: MESSAGE_CLASS_NAME.ERROR
+    };
+
+    sinon.stub(SummaryService.prototype, 'getLatestSurveySummarySubmission').resolves(submission);
+    sinon.stub(SummaryService.prototype, 'getSummarySubmissionMessages').resolves(messages);
 
     const result = summarySubmission.getSurveySummarySubmission();
 
     await result(sampleReq, sampleRes as any, (null as unknown) as any);
 
     expect(actualResult).to.be.eql({
       id: 13,
-      fileName: 'file.xlsx',
-      messages: []
+      fileName: 'file13.xlsx',
+      messages
     });
   });
 
@@ -126,8 +132,6 @@ describe('getSummarySubmission', () => {
       query: mockQuery
     });
 
-    sinon.stub(survey_queries, 'getLatestSurveySummarySubmissionSQL').returns(SQL`something`);
-
     const result = summarySubmission.getSurveySummarySubmission();
 
     await result(sampleReq, sampleRes as any, (null as unknown) as any);