feat: add export to excel functionality in reviewers and assignments tab in fap page

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

@@ -118,7 +118,10 @@ export const dummyFapAssignment = new FapAssignment(
   false,
   null,
   false,
-  null
+  null,
+  'dummy comment',
+  'dummy grade',
+  1
 );
 
 export const anotherDummyFapAssignment = new FapAssignment(
@@ -129,7 +132,10 @@ export const anotherDummyFapAssignment = new FapAssignment(
   false,
   null,
   false,
-  null
+  null,
+  'dummy comment',
+  'dummy grade',
+  1
 );
 
 export const dummyFapReview = new Review(

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

@@ -287,13 +287,13 @@ export default class PostgresFapDataSource implements FapDataSource {
   ): Promise<FapAssignment[]> {
     const fapAssignments: ReviewRecord[] = await database
       .from('fap_reviews')
+      .where('fap_id', fapId)
+      .andWhere('proposal_pk', proposalPk)
       .modify((query) => {
         if (reviewerId !== null) {
-          query.where('user_id', reviewerId);
+          query.andWhere('user_id', reviewerId);
         }
-      })
-      .where('fap_id', fapId)
-      .andWhere('proposal_pk', proposalPk);
+      });
 
     return fapAssignments.map((fapAssignment) =>
       createFapAssignmentObject(fapAssignment)
@@ -1345,20 +1345,20 @@ export default class PostgresFapDataSource implements FapDataSource {
     fapId: number,
     instrumentId?: number | null
   ): Promise<FapReviewsRecord[]> {
-    if (instrumentId) {
-      return await database
-        .select('*')
-        .from('review_data')
-        .where('fap_id', fapId)
-        .andWhere('call_id', callId)
-        .andWhere('instrument_id', instrumentId);
-    }
-
-    return await database
+    const query = database
       .select('*')
       .from('review_data')
-      .where('fap_id', fapId)
-      .andWhere('call_id', callId);
+      .where('fap_id', fapId);
+
+    if (callId != 0) {
+      query.andWhere('call_id', callId);
+    }
+
+    if (instrumentId != null) {
+      query.andWhere('instrument_id', instrumentId);
+    }
+
+    return await query;
   }
 
   async submitFapMeetings(

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

@@ -1191,7 +1191,10 @@ export const createFapAssignmentObject = (fapAssignment: ReviewRecord) => {
     fapAssignment.reassigned,
     fapAssignment.date_reassigned,
     fapAssignment.email_sent,
-    fapAssignment.rank
+    fapAssignment.rank,
+    fapAssignment.comment,
+    fapAssignment.grade,
+    fapAssignment.status
   );
 };
 

apps/backend/src/factory/service.ts

@@ -19,6 +19,7 @@ export enum XLSXType {
   PROPOSAL = 'proposal',
   FAP = 'fap',
   CALL_FAP = 'call_fap',
+  FAP_REVIEWS = 'fap_reviews',
   TECHNIQUE = 'technique',
   MANAGEMENT_DECISION = 'management_decision',
 }

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

@@ -23,6 +23,37 @@ export type FapDataRowInput = {
 
 export type FapDataRow = (input: FapDataRowInput) => RowObj | Promise<RowObj>;
 
+export type ReviewRowInput = {
+  proposalId: number | null;
+  title: string | null;
+  instrumentName: string | null;
+  dateAssigned: Date | string | null;
+  rank: number | null;
+  grade: string | null;
+  comment: string | null;
+  status: string | null;
+};
+
+export const buildReviewRow = ({
+  proposalId,
+  title,
+  instrumentName,
+  dateAssigned,
+  rank,
+  grade,
+  comment,
+  status,
+}: ReviewRowInput): Array<string | number> => [
+  proposalId ?? '-',
+  title ?? '-',
+  instrumentName ?? '-',
+  dateAssigned ? String(dateAssigned) : '-',
+  rank ?? '-',
+  grade ?? '-',
+  comment ?? '-',
+  status ?? '-',
+];
+
 export function getDataRow({
   proposalPk,
   piName,

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

@@ -1,8 +1,9 @@
 import { groupBy } from 'lodash';
+import { DateTime } from 'luxon';
 import { container } from 'tsyringe';
 
 import { collectCallFapXLSXData } from './callFaps';
-import { FapDataRow, FapDataRowInput } from './FapDataRow';
+import { buildReviewRow, FapDataRow, FapDataRowInput } from './FapDataRow';
 import baseContext from '../../buildContext';
 import { Tokens } from '../../config/Tokens';
 import { FapDataSource } from '../../datasources/FapDataSource';
@@ -174,3 +175,108 @@ export const collectFapXLSXData = async (
     data: transformedData,
   };
 };
+export const collectFapReviewXLSXData = async (
+  fapId: number,
+  callId: number,
+  reviewerProposals: Record<number, number[]>,
+  user: UserWithRole
+): Promise<{ data: FapXLSXData; filename: string }> => {
+  const reviewData = await fapDataSource.getFapReviewData(callId, fapId);
+
+  const data: FapXLSXData = [];
+  for (const [reviewerIdString, proposalPks] of Object.entries(
+    reviewerProposals
+  )) {
+    const reviewerId = Number(reviewerIdString);
+
+    const reviewer = await baseContext.queries.user.getBasic(user, reviewerId);
+
+    const reviewerName =
+      `${reviewer?.firstname ?? ''} ${reviewer?.lastname ?? ''}`.trim();
+    const rankedRows: Array<{
+      rank: number | null;
+      grade: number | null;
+      row: Array<string | number>;
+    }> = [];
+    for (const proposalPk of proposalPks) {
+      const review = reviewData.find((item) => item.proposal_pk === proposalPk);
+
+      if (!review) {
+        continue;
+      }
+
+      const assignments = await fapDataSource.getFapProposalAssignments(
+        fapId,
+        proposalPk,
+        reviewerId
+      );
+
+      const assignment = assignments.find(
+        (item) => item.fapMemberUserId === reviewerId
+      );
+
+      if (!assignment) {
+        continue;
+      }
+
+      const grade = Number(assignment.grade);
+      rankedRows.push({
+        rank: assignment.rank,
+        grade: Number.isFinite(grade) ? grade : null,
+        row: buildReviewRow({
+          proposalId: review.proposal_id,
+          title: review.title ?? '-',
+          instrumentName: review.instrument_name ?? '-',
+          dateAssigned: formatDate(assignment.dateAssigned),
+          rank: assignment.rank ?? null,
+          grade: assignment.grade,
+          comment: stripHtml(assignment.comment ?? '-'),
+          status: assignment.status == 1 ? 'Submitted' : 'Draft',
+        }),
+      });
+    }
+
+    const rows = rankedRows
+      .sort((a, b) => {
+        if (a.rank === null || b.rank === null) {
+          if (a.rank !== b.rank) {
+            return a.rank === null ? 1 : -1;
+          }
+        } else if (a.rank !== b.rank) {
+          return a.rank - b.rank;
+        }
+
+        if (a.grade === null || b.grade === null) {
+          if (a.grade !== b.grade) {
+            return a.grade === null ? 1 : -1;
+          }
+        } else if (a.grade !== b.grade) {
+          return b.grade - a.grade;
+        }
+
+        return 0;
+      })
+      .map(({ row }) => row);
+
+    data.push({
+      sheetName: reviewerName.substring(0, 31),
+      rows,
+    });
+  }
+
+  return {
+    filename: 'fap_reviews.xlsx',
+    data,
+  };
+};
+
+const formatDate = (value: string | Date | null | undefined): string => {
+  if (!value) return '-';
+
+  const dt =
+    typeof value === 'string'
+      ? DateTime.fromISO(value)
+      : DateTime.fromJSDate(value);
+
+  return dt.isValid ? dt.toFormat('dd-MM-yyyy') : '-';
+};

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

@@ -14,7 +14,10 @@ import {
   DefaultCallExtraFapDataColumns,
   collectCallFapXLSXData,
 } from '../../factory/xlsx/callFaps';
-import { collectFapXLSXData } from '../../factory/xlsx/fap';
+import {
+  collectFapXLSXData,
+  collectFapReviewXLSXData,
+} from '../../factory/xlsx/fap';
 import { collectManagementDecisionXLSXData } from '../../factory/xlsx/managementDecision';
 import {
   collectProposalXLSXData,
@@ -130,6 +133,79 @@ router.get(`/${XLSXType.FAP}/:fap_id/call/:call_id`, async (req, res, next) => {
   }
 });
 
+router.get(
+  `/${XLSXType.FAP_REVIEWS}/:fap_id/call/:call_id`,
+  async (req, res, next) => {
+    try {
+      if (!req.user) {
+        throw new Error('Not authorized');
+      }
+
+      const userWithRole = {
+        ...res.locals.agent,
+      };
+
+      const fapId = parseInt(req.params.fap_id);
+      const callId = parseInt(req.params.call_id);
+
+      if (isNaN(fapId) || isNaN(callId)) {
+        throw new Error(
+          `Invalid Fap or call ID: Fap ${req.params.fap_id}, Call ${req.params.call_id}`
+        );
+      }
+
+      const reviewerProposalsParam = req.query.reviewerProposals;
+
+      if (typeof reviewerProposalsParam !== 'string') {
+        throw new Error('Proposal reviewer is required');
+      }
+
+      const reviewerProposals: Record<number, number[]> = JSON.parse(
+        reviewerProposalsParam
+      );
+
+      const { data, filename } = await collectFapReviewXLSXData(
+        fapId,
+        callId,
+        reviewerProposals,
+        userWithRole
+      );
+
+      const meta: XLSXMetaBase = {
+        singleFilename: filename,
+        collectionFilename: filename,
+        columns: [
+          'Proposal ID',
+          'Proposal title',
+          'Instrument',
+          'Date assigned',
+          'Rank',
+          'Grade',
+          'Comment',
+          'Status',
+        ],
+      };
+
+      const userRole = req.user.currentRole;
+
+      callFactoryService(
+        DownloadType.XLSX,
+        XLSXType.FAP_REVIEWS,
+        {
+          data,
+          meta,
+          userRole,
+        },
+        req,
+        res,
+        next
+      );
+    } catch (e) {
+      next(e);
+    }
+  }
+);
+
 router.get(`/${XLSXType.CALL_FAP}/:call_id`, async (req, res, next) => {
   try {
     if (!req.user) {

apps/backend/src/models/Fap.ts

@@ -72,6 +72,9 @@ export class FapAssignment {
     public reassigned: boolean,
     public dateReassigned: Date | null,
     public emailSent: boolean,
-    public rank: number | null
+    public rank: number | null,
+    public comment: string,
+    public grade: string,
+    public status: number
   ) {}
 }