Format report name in report service and controller

Author: eieimon

Servers/controllers/reporting.ctrl.ts

@@ -1,8 +1,7 @@
 import { Request, Response } from "express";
 import { STATUS_CODE } from "../utils/statusCode.utils";
 import { uploadFile } from "../utils/fileUpload.utils";
-import { DefaultReportName } from "../models/reporting.model";
-import { getReportData, isAuthorizedUser } from '../services/reportService';
+import { getReportData, isAuthorizedUser, getFormattedReportName } from '../services/reportService';
 
 import marked from 'marked';
 const htmlDocx = require("html-to-docx");
@@ -31,28 +30,7 @@ export async function generateReports(
       const markdownDoc = await marked.parse(await markdownData); // markdown file             
       const generatedDoc = await htmlDocx(markdownDoc); // convert markdown to docx                
 
-      let defaultFileName;
-      if (req.body.reportName === ''){
-        switch(req.body.reportType) {
-          case "Project risks report":
-            defaultFileName = DefaultReportName.PROJECTRISK_REPORT;
-            break;
-          case "Vendors and risks report":
-            defaultFileName = DefaultReportName.VENDOR_REPORT;
-            break;
-          case "Assessment tracker report":
-            defaultFileName = DefaultReportName.ASSESSMENT_REPORT;
-            break;
-          case "Compliance tracker report":
-            defaultFileName = DefaultReportName.COMPLIANCE_REPORT;
-            break;
-          default:
-            defaultFileName = DefaultReportName.ALL_REPORT;
-        }
-      }else {
-        defaultFileName = req.body.reportName;
-      }
-
+      let defaultFileName = getFormattedReportName(req.body.reportName, req.body.reportType);   
       const docFile = {
         originalname: `${defaultFileName}.docx`,
         buffer: generatedDoc,

Servers/services/reportService.ts

@@ -1,11 +1,52 @@
 import { getProjectRisksReportQuery, getMembersByProjectIdQuery } from "../utils/reporting.utils";
-import { ReportType } from "../models/reporting.model";
+import { DefaultReportName, ReportType } from "../models/reporting.model";
 
 interface reportBodyData {
   projectTitle: string,
   projectOwner: string
 }
 
+/** 
+ * Format the report name
+ * if request body includes report name, return the report name as user requested
+ * If not, return as {type}_{YYYYMMDD}_{HHMMSS}
+*/
+export function getFormattedReportName(name: string, type: string) {
+  let reportType;
+  switch(type) {
+    case ReportType.PROJECTRISK_REPORT:
+      reportType = DefaultReportName.PROJECTRISK_REPORT;
+      break;
+    case ReportType.VENDOR_REPORT:
+      reportType = DefaultReportName.VENDOR_REPORT;
+      break;
+    case ReportType.ASSESSMENT_REPORT:
+      reportType = DefaultReportName.ASSESSMENT_REPORT;
+      break;
+    case ReportType.COMPLIANCE_REPORT:
+      reportType = DefaultReportName.COMPLIANCE_REPORT;
+      break;
+    default:
+      reportType = DefaultReportName.ALL_REPORT;
+  }
+
+  const date = new Date();
+  
+  const year = date.getFullYear();
+  const month = String(date.getMonth() + 1).padStart(2, '0');
+  const day = String(date.getDate()).padStart(2, '0');
+
+  const hour = String(date.getHours()).padStart(2, '0');
+  const minute = String(date.getMinutes()).padStart(2, '0');
+  const second = String(date.getSeconds()).padStart(2, '0');
+
+  if(name.length === 0 ) {
+    return `${type}_${year}${month}${day}_${hour}${minute}${second}`;
+  } else {
+    return `${name}`;
+  }
+}
+
 /*
   Get member lists by projectId
   Check whether the user belongs to current project
@@ -63,16 +104,16 @@ export async function getProjectRiskMarkdown (
   }
 
   const projectRiskMD = `
-VerifyWise Project Risk Report
+VerifyWise project risk report
 ========================
 
 This report is generated by the VeriftyWise Project Risk. It aims to provide a way to demonstrate their claims about the risks of their AI systems.
   
-- **Report Date :** ${new Date().toLocaleDateString()}
-- **Project :** ${data.projectTitle}
-- **Owner :** ${data.projectOwner}
+- **Report Date ** ${new Date().toLocaleDateString()}
+- **Project ** ${data.projectTitle}
+- **Owner ** ${data.projectOwner}
 
-Project Risk Table
+Project risk table
 -------------
 | Risk Name | Owner | Severity | Likelihood | Mitigation Status	| Risk Level | Target Date | 
 |----|----|----|----|----|----|----|