feat: fap data export for a call and refactor data collections for export

apps/backend/db_patches/0156_CreateFAPProposalView.sql

@@ -0,0 +1,40 @@
+DO
+$$
+BEGIN
+    IF register_patch('0156_CreateFAPProposalView.sql', 'Thomas Cottee Meldrum', 'Create View for FAP data', '2024-04-05') THEN
+
+    CREATE VIEW review_data AS 
+	Select proposal.*, grade.avg as average_grade from (
+        Select 
+                fp.proposal_pk,
+                p.proposal_id,
+                p.title,
+                i.name as instrument_name,
+                chi.availability_time,
+                tr.time_allocation,
+                f.fap_id,
+                fmd.rank_order, 
+                c.call_id,
+                p.proposer_id,
+                i.instrument_id,
+                fp.fap_time_allocation,
+				p.questionary_id
+            from fap_proposals as fp
+            join faps as f on f.fap_id = fp.fap_id
+            join call c on c.call_id = fp.call_id
+            join proposals p on p.proposal_pk = fp.proposal_pk
+            join technical_review tr on tr.proposal_pk = p.proposal_pk and tr.instrument_id = fp.instrument_id
+            left join fap_meeting_decisions as fmd on fmd.proposal_pk = p.proposal_pk
+            join call_has_instruments as chi on chi.instrument_id = fp.instrument_id and chi.call_id = c.call_id
+            join instruments as i on i.instrument_id = chi.instrument_id) as proposal
+            left join (
+                Select fr.proposal_pk, AVG(fr.grade) from 
+                fap_proposals as fp
+                join fap_reviews as fr on fr.proposal_pk = fp.proposal_pk
+                group by fr.proposal_pk
+            ) grade on grade.proposal_pk = proposal.proposal_pk;
+
+    END IF;
+END;
+$$
+LANGUAGE plpgsql;

apps/backend/src/datasources/FapDataSource.ts

@@ -18,7 +18,10 @@ import {
 import { RemoveProposalsFromFapsArgs } from '../resolvers/mutations/AssignProposalsToFapsMutation';
 import { SaveFapMeetingDecisionInput } from '../resolvers/mutations/FapMeetingDecisionMutation';
 import { FapsFilter } from '../resolvers/queries/FapsQuery';
-import { AssignProposalsToFapsInput } from './postgres/records';
+import {
+  FapReviewsRecord,
+  AssignProposalsToFapsInput,
+} from './postgres/records';
 
 export interface FapDataSource {
   create(
@@ -152,4 +155,5 @@ export interface FapDataSource {
     reviewerId: number,
     rank: number
   ): Promise<boolean>;
+  getFapReviewData(callId: number, fapId: number): Promise<FapReviewsRecord[]>;
 }

apps/backend/src/datasources/mockups/FapDataSource.ts

@@ -19,7 +19,10 @@ import { RemoveProposalsFromFapsArgs } from '../../resolvers/mutations/AssignPro
 import { SaveFapMeetingDecisionInput } from '../../resolvers/mutations/FapMeetingDecisionMutation';
 import { FapsFilter } from '../../resolvers/queries/FapsQuery';
 import { FapDataSource } from '../FapDataSource';
-import { AssignProposalsToFapsInput } from '../postgres/records';
+import {
+  FapReviewsRecord,
+  AssignProposalsToFapsInput,
+} from '../postgres/records';
 import { basicDummyUser } from './UserDataSource';
 
 export const dummyFap = new Fap(
@@ -738,4 +741,8 @@ export class FapDataSourceMock implements FapDataSource {
   ): Promise<boolean> {
     throw new Error('Method not implemented.');
   }
+
+  getFapReviewData(callId: number, fapId: number): Promise<FapReviewsRecord[]> {
+    throw new Error('Method not implemented.');
+  }
 }

apps/backend/src/datasources/postgres/FapDataSource.ts

@@ -53,6 +53,7 @@ import {
   InstitutionRecord,
   AssignProposalsToFapsInput,
   CountryRecord,
+  FapReviewsRecord,
 } from './records';
 
 @injectable()
@@ -1275,4 +1276,15 @@ export default class PostgresFapDataSource implements FapDataSource {
         return true;
       });
   }
+
+  async getFapReviewData(
+    callId: number,
+    fapId: number
+  ): Promise<FapReviewsRecord[]> {
+    return await database
+      .select('*')
+      .from('review_data')
+      .where('fap_id', fapId)
+      .andWhere('call_id', callId);
+  }
 }

apps/backend/src/datasources/postgres/records.ts

@@ -440,6 +440,23 @@ export interface FapAssignmentRecord {
   readonly rank: number | null;
 }
 
+export interface FapReviewsRecord {
+  readonly proposal_pk: number;
+  readonly proposal_id: number;
+  readonly title: string;
+  readonly instrument_name: string;
+  readonly availability_time: number;
+  readonly time_allocation: number;
+  readonly fap_id: number;
+  readonly rank_order: number;
+  readonly call_id: number;
+  readonly proposer_id: number;
+  readonly instrument_id: number;
+  readonly fap_time_allocation: number;
+  readonly average_grade: number;
+  readonly questionary_id: number;
+}
+
 export interface FapReviewerRecord {
   readonly user_id: number;
   readonly fap_id: number;

apps/backend/src/factory/service.ts

@@ -16,7 +16,8 @@ export enum DownloadType {
 
 export enum XLSXType {
   PROPOSAL = 'proposal',
-  Fap = 'fap',
+  FAP = 'fap',
+  CALL_FAP = 'call_fap',
 }
 
 export enum PDFType {

apps/backend/src/factory/xlsx/FapDataRow.ts

@@ -1,29 +1,28 @@
-import { FapProposal } from '../../models/Fap';
-import { FapMeetingDecision } from '../../models/FapMeetingDecision';
-import { InstrumentWithAvailabilityTime } from '../../models/Instrument';
-import { Proposal } from '../../models/Proposal';
-import { TechnicalReview } from '../../models/TechnicalReview';
 import { RowObj } from './fap';
 
 export function getDataRow(
+  proposalPk: number,
   piName: string,
   proposalAverageScore: number,
-  instrument: InstrumentWithAvailabilityTime,
-  fapMeetingDecision: FapMeetingDecision | null,
-  proposal: Proposal | null,
-  technicalReview: TechnicalReview | null,
-  fapProposal: FapProposal | null
-) {
+  instrumentName: string,
+  instrumentAvailabilityTime: number,
+  fapTimeAllocation: number | null,
+  proposalTitle: string,
+  proposalId: number | null,
+  techReviewTimeAllocation: number | null,
+  propFapRankOrder: number | null
+): RowObj {
   return {
-    propShortCode: proposal?.proposalId,
-    propTitle: proposal?.title,
+    proposalPk: proposalPk,
+    propShortCode: proposalId?.toString(),
+    propTitle: proposalTitle,
     principalInv: piName,
-    instrName: instrument.name,
-    instrAvailTime: instrument.availabilityTime,
-    techReviewTimeAllocation: technicalReview?.timeAllocation,
-    fapTimeAllocation: fapProposal?.fapTimeAllocation ?? null,
-    propReviewAvgScore: proposalAverageScore,
-    propFapRankOrder: fapMeetingDecision?.rankOrder ?? null,
+    instrName: instrumentName,
+    instrAvailTime: instrumentAvailabilityTime,
+    techReviewTimeAllocation: techReviewTimeAllocation,
+    fapTimeAllocation: fapTimeAllocation ?? null,
+    propReviewAvgScore: proposalAverageScore ?? 0,
+    propFapRankOrder: propFapRankOrder ?? null,
     inAvailZone: null,
   };
 }

apps/backend/src/factory/xlsx/callFaps.ts

@@ -0,0 +1,177 @@
+// import { Review } from '../../models/Review';
+import { stripHtml } from 'string-strip-html';
+import { container } from 'tsyringe';
+
+import baseContext from '../../buildContext';
+import { Tokens } from '../../config/Tokens';
+import { FapDataSource } from '../../datasources/FapDataSource';
+import { ProposalEndStatus } from '../../models/Proposal';
+import { UserWithRole } from '../../models/User';
+import { RowObj, collectFapXLSXRowData } from './fap';
+
+const fapDataSource: FapDataSource = container.resolve(Tokens.FapDataSource);
+
+const ProposalEndStatusStringValue = {
+  [ProposalEndStatus.UNSET]: 'Unset',
+  [ProposalEndStatus.ACCEPTED]: 'Accepted',
+  [ProposalEndStatus.RESERVED]: 'Reserved',
+  [ProposalEndStatus.REJECTED]: 'Rejected',
+};
+
+export type CallRowRowObj = RowObj & {
+  fapMeetingDecision?: string | null;
+  fapMeetingExComment?: string | null;
+  fapMeetingInComment?: string | null;
+};
+
+export const collectCallFapXLSXData = async (
+  callId: number,
+  user: UserWithRole
+) => {
+  const faps = await baseContext.queries.fap.dataSource.getFapsByCallId(callId);
+  const call = await baseContext.queries.call.get(user, callId);
+  const filename = `${call?.shortCode}_FAP_Results.xlsx`;
+
+  const baseData = await Promise.all(
+    faps.map(async (fap) => {
+      return {
+        sheetName: fap.code,
+        rows: await collectFAPRowData(fap.id, callId, user),
+      };
+    })
+  );
+
+  return { data: baseData, filename: filename.replace(/\s+/g, '_') };
+};
+
+const collectFAPRowData = async (
+  fapId: number,
+  callId: number,
+  user: UserWithRole
+) => {
+  const data = await collectFapXLSXRowData(fapId, callId, user);
+
+  const extraData = await Promise.all(
+    data.map(async (sheet) => {
+      return {
+        sheetName: sheet.sheetName,
+        rows: await Promise.all(
+          sheet.rows.map(async (proposal) => {
+            const fapMeetingDecision =
+              await fapDataSource.getProposalsFapMeetingDecisions([
+                proposal.proposalPk,
+              ]);
+
+            return {
+              ...proposal,
+              fapMeetingDecision: fapMeetingDecision[0]
+                ? ProposalEndStatusStringValue[
+                    fapMeetingDecision[0].recommendation
+                  ]
+                : null,
+              fapMeetingExComment: fapMeetingDecision[0]
+                ? stripHtml(fapMeetingDecision[0].commentForUser).result
+                : null,
+              fapMeetingInComment: fapMeetingDecision[0]
+                ? stripHtml(fapMeetingDecision[0].commentForManagement).result
+                : null,
+            };
+          })
+        ),
+      };
+    })
+  );
+
+  const allRowData = extraData.map((inst) => {
+    const instName: (string | number)[][] = [[inst.sheetName]];
+
+    const sortedData = sortByRankOrAverageScore(inst.rows).map(
+      (row: CallRowRowObj) => populateRow(row)
+    );
+
+    instName.concat(instName);
+
+    return instName.concat(sortedData);
+  });
+
+  return allRowData.length
+    ? allRowData.reduce((arr, inst) => {
+        return arr.concat(inst);
+      })
+    : allRowData;
+};
+
+function populateRow(row: CallRowRowObj): (string | number)[] {
+  const individualReviews = row.reviews?.flatMap((rev) => [
+    rev.grade,
+    rev.comment && stripHtml(rev.comment).result,
+  ]);
+
+  return [
+    row.propShortCode ?? '<missing>',
+    row.principalInv ?? '<missing>',
+    row.piCountry ?? '<missing>',
+    row.instrName ?? '<missing>',
+    row.daysRequested ?? '<missing>',
+    row.propTitle ?? '<missing>',
+    row.propReviewAvgScore ?? '<missing>',
+    row.fapTimeAllocation ?? row.daysRequested ?? '<missing>',
+    row.fapMeetingDecision ?? '<missing>',
+    row.fapMeetingInComment ?? '<missing>',
+    row.fapMeetingExComment ?? '<missing>',
+  ].concat(individualReviews ? individualReviews : []);
+}
+
+export const CallFapDataColumns = [
+  'Proposal Reference Number',
+  'Principal Investigator',
+  'PI Country',
+  'Instrument Name',
+  'Requested Time',
+  'Proposal Title',
+  'Average score',
+  'Fap Time allocation',
+  'Fap Meeting Decision',
+  'Fap Meeting Comment for User',
+  'Fap Meeting Internal Comment',
+  'Reviewer 1 score',
+  'Reviewer 1 review comment',
+  'Reviewer 2 score',
+  'Reviewer 2 review comment',
+];
+
+const sortByRankOrder = (a: RowObj, b: RowObj) => {
+  if (a.propFapRankOrder === b.propFapRankOrder) {
+    return -1;
+  } else if (a.propFapRankOrder === null) {
+    return 1;
+  } else if (b.propFapRankOrder === null) {
+    return -1;
+  } else {
+    return a.propFapRankOrder > b.propFapRankOrder ? 1 : -1;
+  }
+};
+
+const sortByRankOrAverageScore = (data: RowObj[]) => {
+  let allocationTimeSum = 0;
+
+  return data
+    .sort((a, b) =>
+      (a.propReviewAvgScore || 0) > (b.propReviewAvgScore || 0) ? 1 : -1
+    )
+    .sort(sortByRankOrder)
+    .map((row) => {
+      const proposalAllocationTime =
+        row.fapTimeAllocation !== null
+          ? row.fapTimeAllocation
+          : row.techReviewTimeAllocation || 0;
+
+      const isInAvailabilityZone =
+        allocationTimeSum + proposalAllocationTime <= (row.instrAvailTime || 0);
+      allocationTimeSum = allocationTimeSum + proposalAllocationTime;
+
+      row.inAvailZone = isInAvailabilityZone ? 'yes' : 'no';
+
+      return row;
+    });
+};