BHBC-934: Edit funding rework (#207)

BHBC-934: Edit funding rework
bcgov · Apr 9, 2021 · d8a1242 · d8a1242
1 parent 0982608
commit d8a1242
Show file tree

Hide file tree

Showing 37 changed files with 2,290 additions and 2,096 deletions.
diff --git a/api/src/models/project-create.ts b/api/src/models/project-create.ts
@@ -238,13 +238,13 @@ export class PostFundingSource {
  * @class PostFundingData
  */
 export class PostFundingData {
-  funding_agencies: PostFundingSource[];
+  funding_sources: PostFundingSource[];
 
   constructor(obj?: any) {
     defaultLog.debug({ label: 'PostFundingData', message: 'params', obj });
 
-    this.funding_agencies =
-      (obj?.funding_agencies.length && obj.funding_agencies.map((item: any) => new PostFundingSource(item))) || [];
+    this.funding_sources =
+      (obj?.funding_sources.length && obj.funding_sources.map((item: any) => new PostFundingSource(item))) || [];
   }
 }
 

diff --git a/api/src/models/project-update.ts b/api/src/models/project-update.ts
@@ -273,3 +273,27 @@ export class GetProjectData {
     this.revision_count = projectData?.revision_count ?? null;
   }
 }
+
+export class PutFundingSource {
+  id: number;
+  investment_action_category: number;
+  agency_project_id: string;
+  funding_amount: number;
+  start_date: string;
+  end_date: string;
+  revision_count: number;
+
+  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;
+  }
+}
diff --git a/api/src/models/project-view-update.test.ts b/api/src/models/project-view-update.test.ts
@@ -1,6 +1,6 @@
 import { expect } from 'chai';
 import { describe } from 'mocha';
-import { GetSpeciesData } from './project-view-update';
+import { GetSpeciesData, GetFundingData } from './project-view-update';
 
 describe('GetSpeciesData', () => {
   describe('No values provided', () => {
@@ -75,4 +75,45 @@ describe('GetSpeciesData', () => {
       expect(data.ancillary_species).to.eql(['species 3']);
     });
   });
+
+  describe('GetFundingData', () => {
+    describe('No values provided', () => {
+      let fundingData: GetFundingData;
+
+      before(() => {
+        fundingData = new GetFundingData([]);
+      });
+
+      it('sets project funding sources', function () {
+        expect(fundingData.fundingSources).to.eql([]);
+      });
+    });
+
+    describe('All values provided', () => {
+      let fundingData: GetFundingData;
+
+      const fundingDataObj = [
+        {
+          id: 1,
+          agency_id: '123',
+          agency_name: 'Agency name',
+          agency_project_id: 'Agency123',
+          investment_action_category: 'Investment',
+          investment_action_category_name: 'Investment name',
+          start_date: '01/01/2020',
+          end_date: '01/01/2021',
+          funding_amount: 123,
+          revision_count: 0
+        }
+      ];
+
+      before(() => {
+        fundingData = new GetFundingData(fundingDataObj);
+      });
+
+      it('sets project funding sources', function () {
+        expect(fundingData.fundingSources).to.eql(fundingDataObj);
+      });
+    });
+  });
 });
diff --git a/api/src/models/project-view-update.ts b/api/src/models/project-view-update.ts
@@ -19,3 +19,46 @@ export class GetSpeciesData {
     this.ancillary_species = (ancillary_species?.length && ancillary_species.map((item: any) => item.name)) || [];
   }
 }
+
+interface IGetFundingSource {
+  id: number;
+  agency_id: number;
+  investment_action_category: number;
+  investment_action_category_name: string;
+  agency_name: string;
+  funding_amount: number;
+  start_date: string;
+  end_date: string;
+  agency_project_id: string;
+  revision_count: number;
+}
+
+export class GetFundingData {
+  fundingSources: IGetFundingSource[];
+
+  constructor(fundingData?: any[]) {
+    defaultLog.debug({
+      label: 'GetFundingData',
+      message: 'params',
+      fundingData: fundingData
+    });
+
+    this.fundingSources =
+      (fundingData &&
+        fundingData.map((item: any) => {
+          return {
+            id: item.id,
+            agency_id: item.agency_id,
+            investment_action_category: item.investment_action_category,
+            investment_action_category_name: item.investment_action_category_name,
+            agency_name: item.agency_name,
+            funding_amount: item.funding_amount,
+            start_date: item.start_date,
+            end_date: item.end_date,
+            agency_project_id: item.agency_project_id,
+            revision_count: item.revision_count
+          };
+        })) ||
+      [];
+  }
+}
diff --git a/api/src/models/project-view.test.ts b/api/src/models/project-view.test.ts
@@ -2,7 +2,6 @@ import { expect } from 'chai';
 import { describe } from 'mocha';
 import {
   GetCoordinatorData,
-  GetFundingData,
   GetIUCNClassificationData,
   GetLocationData,
   GetObjectivesData,
@@ -201,43 +200,6 @@ describe('GetIUCNClassificationData', () => {
   });
 });
 
-describe('GetFundingData', () => {
-  describe('No values provided', () => {
-    let fundingData: GetFundingData;
-
-    before(() => {
-      fundingData = new GetFundingData([]);
-    });
-
-    it('sets funding agencies', function () {
-      expect(fundingData.fundingAgencies).to.eql([]);
-    });
-  });
-
-  describe('All values provided', () => {
-    let fundingData: GetFundingData;
-
-    const fundingDataObj = [
-      {
-        agency_id: '123',
-        agency_name: 'Agency name',
-        investment_action_category: 'investment',
-        start_date: '01/01/2020',
-        end_date: '01/01/2021',
-        funding_amount: 123
-      }
-    ];
-
-    before(() => {
-      fundingData = new GetFundingData(fundingDataObj);
-    });
-
-    it('sets funding agencies', function () {
-      expect(fundingData.fundingAgencies).to.eql(fundingDataObj);
-    });
-  });
-});
-
 describe('GetObjectivesData', () => {
   describe('No values provided', () => {
     let projectObjectivesData: GetObjectivesData;

diff --git a/api/src/models/project-view.ts b/api/src/models/project-view.ts
@@ -140,47 +140,6 @@ export class GetIUCNClassificationData {
   }
 }
 
-interface IGetFundingSource {
-  agency_id: string;
-  investment_action_category: string;
-  agency_name: string;
-  funding_amount: number;
-  start_date: string;
-  end_date: string;
-}
-
-/**
- * Pre-processes GET /projects/{id} funding data
- *
- * @export
- * @class GetFundingData
- */
-export class GetFundingData {
-  fundingAgencies: IGetFundingSource[];
-
-  constructor(fundingData?: any[]) {
-    defaultLog.debug({
-      label: 'GetFundingData',
-      message: 'params',
-      fundingData: fundingData
-    });
-
-    this.fundingAgencies =
-      (fundingData &&
-        fundingData.map((item: any) => {
-          return {
-            agency_id: item.agency_id,
-            investment_action_category: item.investment_action_category,
-            agency_name: item.agency_name,
-            funding_amount: item.funding_amount,
-            start_date: item.start_date,
-            end_date: item.end_date
-          };
-        })) ||
-      [];
-  }
-}
-
 /**
  * Pre-processes GET /projects/{id} partnerships data
  *

diff --git a/api/src/openapi/schemas/project.ts b/api/src/openapi/schemas/project.ts
@@ -149,7 +149,7 @@ export const projectCreatePostRequestObject = {
       title: 'Project funding sources',
       type: 'object',
       properties: {
-        funding_agencies: {
+        funding_sources: {
           type: 'array',
           items: {
             title: 'Project funding agency',

diff --git a/api/src/paths/project.ts b/api/src/paths/project.ts
@@ -144,10 +144,10 @@ function createProject(): RequestHandler {
           )
         );
 
-        // Handle funding agencies
+        // Handle funding sources
         promises.push(
           Promise.all(
-            sanitizedProjectPostData.funding.funding_agencies.map((fundingSource: PostFundingSource) =>
+            sanitizedProjectPostData.funding.funding_sources.map((fundingSource: PostFundingSource) =>
               insertFundingSource(fundingSource, projectId, connection)
             )
           )

diff --git a/api/src/paths/project/{projectId}/update.ts b/api/src/paths/project/{projectId}/update.ts
@@ -17,9 +17,10 @@ import {
   PutIUCNData,
   PutSpeciesData,
   IGetPutIUCN,
-  GetLocationData
+  GetLocationData,
+  PutFundingSource
 } from '../../../models/project-update';
-import { GetSpeciesData } from '../../../models/project-view-update';
+import { GetSpeciesData, GetFundingData } from '../../../models/project-view-update';
 import {
   projectIdResponseObject,
   projectUpdateGetResponseObject,
@@ -31,6 +32,7 @@ import {
   getIUCNActionClassificationByProjectSQL,
   getObjectivesByProjectSQL,
   getProjectByProjectSQL,
+  putProjectFundingSourceSQL,
   putProjectSQL
 } from '../../../queries/project/project-update-queries';
 import {
@@ -41,7 +43,8 @@ import {
   deleteAncillarySpeciesSQL,
   deleteIndigenousPartnershipsSQL,
   deleteStakeholderPartnershipsSQL,
-  deleteRegionsSQL
+  deleteRegionsSQL,
+  deleteFundingSQL
 } from '../../../queries/project/project-delete-queries';
 import {
   getStakeholderPartnershipsByProjectSQL,
@@ -149,7 +152,7 @@ export interface IGetProjectForUpdate {
   location: any;
   species: any;
   iucn: GetIUCNClassificationData | null;
-  funding: any;
+  funding: GetFundingData | null;
   partnerships: GetPartnershipsData | null;
 }
 
@@ -242,6 +245,13 @@ function getProjectForUpdate(): RequestHandler {
           })
         );
       }
+      if (entities.includes(GET_ENTITIES.funding)) {
+        promises.push(
+          getProjectData(projectId, connection).then((value) => {
+            results.project = value;
+          })
+        );
+      }
 
       await Promise.all(promises);
 
@@ -529,6 +539,10 @@ function updateProject(): RequestHandler {
         promises.push(updateProjectSpeciesData(projectId, entities, connection));
       }
 
+      if (entities?.funding) {
+        promises.push(updateProjectFundingData(projectId, entities, connection));
+      }
+
       await Promise.all(promises);
 
       await connection.commit();
@@ -776,3 +790,35 @@ export const updateProjectData = async (
 
   await Promise.all([...insertActivityPromises, ...insertClimateInitiativesPromises]);
 };
+
+export const updateProjectFundingData = async (
+  projectId: number,
+  entities: IUpdateProject,
+  connection: IDBConnection
+): Promise<void> => {
+  const putFundingSource = entities?.funding && new PutFundingSource(entities.funding);
+
+  const sqlDeleteStatement = deleteFundingSQL(putFundingSource?.id);
+
+  if (!sqlDeleteStatement) {
+    throw new HTTP400('Failed to build SQL delete statement');
+  }
+
+  const deleteResult = await connection.query(sqlDeleteStatement.text, sqlDeleteStatement.values);
+
+  if (!deleteResult) {
+    throw new HTTP409('Failed to delete project funding source');
+  }
+
+  const sqlInsertStatement = putProjectFundingSourceSQL(putFundingSource, projectId);
+
+  if (!sqlInsertStatement) {
+    throw new HTTP400('Failed to build SQL insert statement');
+  }
+
+  const insertResult = await connection.query(sqlInsertStatement.text, sqlInsertStatement.values);
+
+  if (!insertResult) {
+    throw new HTTP409('Failed to put (insert) project funding source with incremented revision count');
+  }
+};
diff --git a/api/src/paths/project/{projectId}/view.ts b/api/src/paths/project/{projectId}/view.ts
@@ -5,17 +5,15 @@ import { getDBConnection } from '../../../database/db';
 import { HTTP400 } from '../../../errors/CustomError';
 import {
   GetCoordinatorData,
-  GetFundingData,
   GetIUCNClassificationData,
   GetObjectivesData,
   GetPartnershipsData,
   GetProjectData,
   GetLocationData
 } from '../../../models/project-view';
-import { GetSpeciesData } from '../../../models/project-view-update';
+import { GetSpeciesData, GetFundingData } from '../../../models/project-view-update';
 import { projectViewGetResponseObject } from '../../../openapi/schemas/project';
 import {
-  getFundingSourceByProjectSQL,
   getIndigenousPartnershipsByProjectSQL,
   getIUCNActionClassificationByProjectSQL,
   getProjectSQL
@@ -26,7 +24,8 @@ import {
   getAncillarySpeciesByProjectSQL,
   getLocationByProjectSQL,
   getClimateInitiativesByProjectSQL,
-  getActivitiesByProjectSQL
+  getActivitiesByProjectSQL,
+  getFundingSourceByProjectSQL
 } from '../../../queries/project/project-view-update-queries';
 import { getLogger } from '../../../utils/logger';
 import { logRequest } from '../../../utils/path-utils';