[TTAHUB-5374] Fix collab report export (#3660)

* Fix collab report export

* test: make getCSVReports tests self-contained with own fixtures

All tests in the getCSVReports describe block now create their own
approved CollabReport records in beforeAll and clean them up in afterAll.
Queries are scoped via 'id.in' to prevent interference from ambient
database state, replacing fragile 'length >= 2' assertions.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* test: expand getCSVReports fixtures to 11 records to prove unlimited default

Creating only 2 records meant the old REPORTS_PER_PAGE=10 default would
still return all records, so the 'uses default parameters' test passed
regardless of whether the limit was 'all' or 10.

With 11 records (one more than REPORTS_PER_PAGE), arrayContaining(csvReportIds)
can only succeed when the query has no limit — proving getCSVReports truly
omits pagination for CSV exports.

Also updates the sort test's toHaveLength(2) to toHaveLength(csvReportIds.length)
to stay accurate with the larger fixture set.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Update collab report model with a transformed virtual field

* Fix unit tests for transformers

* Add encoding, update test

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: 2 people

src/lib/transform.js

@@ -609,7 +609,7 @@ const collabReportTransformers = [
   'displayId',
   'regionId',
   'name',
-  'description',
+  'descriptionFormatted',
   'conductMethod',
   'isStateActivity',
   'duration',

src/models/collabReport.js

@@ -3,6 +3,7 @@ const { REPORT_STATUSES, COLLAB_REPORT_PARTICIPANTS } = require('@ttahub/common'
 const { sortBy } = require('lodash');
 const { formatDate } = require('../lib/modelHelpers');
 const { beforeUpdate } = require('./hooks/collabReport');
+const { convert } = require('html-to-text');
 
 export default (sequelize, DataTypes) => {
   class CollabReport extends Model {
@@ -219,14 +220,21 @@ export default (sequelize, DataTypes) => {
           return this.conductMethod;
         },
       },
+      descriptionFormatted: {
+        type: DataTypes.VIRTUAL,
+        get() {
+          if (!this.description) return null;
+          return convert(this.description);
+        },
+      },
       approvedAt: {
         type: DataTypes.VIRTUAL,
         get() {
           if (this.calculatedStatus !== REPORT_STATUSES.APPROVED) {
             return '';
           }
 
-          if (!this.approvers || !this.approvers.length) {
+          if (!this.approvers?.length) {
             return '';
           }
 

src/routes/collaborationReports/handlers.test.ts

@@ -47,17 +47,20 @@ describe('Collaboration Reports Handlers', () => {
   let mockJson: jest.Mock;
   let mockSendStatus: jest.Mock;
   let mockSend: jest.Mock;
+  let mockAttachment: jest.Mock;
 
   beforeEach(() => {
     mockJson = jest.fn();
     mockSendStatus = jest.fn();
     mockSend = jest.fn();
+    mockAttachment = jest.fn();
 
     mockRequest = {};
     mockResponse = {
       json: mockJson,
       sendStatus: mockSendStatus,
       send: mockSend,
+      attachment: mockAttachment,
     };
 
     jest.clearAllMocks();
@@ -1344,7 +1347,7 @@ describe('Collaboration Reports Handlers', () => {
 
       expect(CRServices.getCSVReports).toHaveBeenCalledWith({});
       expect(collabReportToCsvRecord).not.toHaveBeenCalled();
-      expect(mockSend).toHaveBeenCalledWith('\n');
+      expect(mockSend).toHaveBeenCalledWith('\ufeff\n');
     });
 
     it('should pass query parameters through setReadRegions', async () => {
@@ -1465,7 +1468,9 @@ describe('Collaboration Reports Handlers', () => {
       await sendCollabReportCSV(mockReports, mockResponse);
 
       expect(collabReportToCsvRecord).not.toHaveBeenCalled();
-      expect(mockSend).toHaveBeenCalledWith('\n');
+      const csvCall = mockSend.mock.calls[0][0];
+      const lines = csvCall.replace(/^\ufeff/, '').split('\n');
+      expect(lines).toEqual(['', '']);
     });
 
     it('should handle single report', async () => {
@@ -1494,13 +1499,13 @@ describe('Collaboration Reports Handlers', () => {
 
     it('should handle reports with special characters in CSV', async () => {
       const mockReports = [
-        { id: '1', name: 'Report "with quotes"', description: 'Description,with,commas' },
+        { id: '1', name: 'Report "with quotes"', descriptionFormatted: 'Description,with,commas' },
       ];
 
       const mockCsvRecord = {
         displayId: 'R01-CR-001',
         name: 'Report "with quotes"',
-        description: 'Description,with,commas',
+        descriptionFormatted: 'Description,with,commas',
       };
 
       (collabReportToCsvRecord as jest.Mock).mockResolvedValue(mockCsvRecord);
@@ -1554,20 +1559,23 @@ describe('Collaboration Reports Handlers', () => {
     });
 
     it('should generate proper CSV format with correct column structure', async () => {
-      const mockReports = [{ id: '1', name: 'Test Report', description: 'Test Description' }];
+      const mockReports = [
+        { id: '1', name: 'Test Report', descriptionFormatted: 'Test Description' },
+      ];
 
       const mockCsvRecord = {
         displayId: 'R01-CR-001',
         name: 'Test Report',
-        description: 'Test Description',
+        descriptionFormatted: 'Test Description',
       };
 
       (collabReportToCsvRecord as jest.Mock).mockResolvedValue(mockCsvRecord);
 
       await sendCollabReportCSV(mockReports, mockResponse);
 
       const csvCall = mockSend.mock.calls[0][0];
-      const lines = csvCall.split('\n');
+      // Strip the UTF-8 BOM before parsing
+      const lines = csvCall.replace(/^\ufeff/, '').split('\n');
 
       // Should have header and data lines
       expect(lines.length).toBeGreaterThanOrEqual(2);

src/routes/collaborationReports/handlers.ts

@@ -148,7 +148,7 @@ export async function sendCollabReportCSV(reports, res) {
           header: 'Method',
         },
         {
-          key: 'description',
+          key: 'descriptionFormatted',
           header: 'Description',
         },
         {
@@ -169,7 +169,8 @@ export async function sendCollabReportCSV(reports, res) {
 
   const csvData = stringify(csvRows, options);
 
-  res.send(csvData);
+  res.attachment('collaboration-reports.csv');
+  res.send(`\ufeff${csvData}`);
 }
 
 /**
@@ -188,6 +189,7 @@ export async function downloadReports(req: Request, res: Response) {
     // the query here may contain additional filter information
     // so we expect the collab reports to have a full filter suite
     const reportPayload = await getCSVReports(query);
+
     await sendCollabReportCSV(reportPayload, res);
   } catch (error) {
     await handleErrors(req, res, error, logContext);

src/services/collabReports.test.js

@@ -447,14 +447,55 @@ describe('Collab Reports Service', () => {
   });
 
   describe('getCSVReports', () => {
+    let csvReportIds = [];
+
+    beforeAll(async () => {
+      // Create 11 records — one more than REPORTS_PER_PAGE (10) — so that the
+      // "uses default parameters" test can only pass when the query has no limit.
+      const reports = await Promise.all(
+        Array.from({ length: 11 }, (_, i) =>
+          CollabReport.create({
+            ...reportObject,
+            name: `CSV export test report ${i + 1}`,
+            calculatedStatus: REPORT_STATUSES.APPROVED,
+          })
+        )
+      );
+
+      const [report1] = reports;
+
+      await CollabReportSpecialist.create({
+        collabReportId: report1.id,
+        specialistId: mockUserTwo.id,
+      });
+
+      await CollabReportApprover.create({
+        collabReportId: report1.id,
+        userId: mockUserTwo.id,
+        status: 'approved',
+        note: 'Test approval',
+      });
+
+      csvReportIds = reports.map(({ id }) => id);
+    });
+
+    afterAll(async () => {
+      await CollabReportSpecialist.destroy({
+        where: { collabReportId: csvReportIds },
+        force: true,
+      });
+      await CollabReportApprover.destroy({ where: { collabReportId: csvReportIds }, force: true });
+      await CollabReport.destroy({ where: { id: csvReportIds }, force: true });
+    });
+
     it('returns all reports when no filters are provided', async () => {
-      const result = await getCSVReports();
+      const result = await getCSVReports({ 'id.in': csvReportIds });
       expect(Array.isArray(result)).toBe(true);
-      expect(result.length).toBeGreaterThanOrEqual(2);
+      expect(result.map(({ id }) => id)).toEqual(expect.arrayContaining(csvReportIds));
     });
 
     it('includes all required attributes for CSV export', async () => {
-      const result = await getCSVReports({ limit: '1' });
+      const result = await getCSVReports({ 'id.in': csvReportIds, limit: '1' });
       expect(result.length).toBe(1);
 
       const report = result[0];
@@ -469,7 +510,7 @@ describe('Collab Reports Service', () => {
     });
 
     it('includes author information with roles', async () => {
-      const result = await getCSVReports({ limit: '1' });
+      const result = await getCSVReports({ 'id.in': csvReportIds, limit: '1' });
       const report = result[0];
 
       expect(report.author).toHaveProperty('fullName');
@@ -479,9 +520,8 @@ describe('Collab Reports Service', () => {
     });
 
     it('includes collaborating specialists with roles', async () => {
-      const result = await getCSVReports({ limit: '10' });
+      const result = await getCSVReports({ 'id.in': csvReportIds });
 
-      // Find a report with specialists
       const reportWithSpecialists = result.find(
         (r) => r.collaboratingSpecialists && r.collaboratingSpecialists.length > 0
       );
@@ -497,9 +537,8 @@ describe('Collab Reports Service', () => {
     });
 
     it('includes approvers with user information', async () => {
-      const result = await getCSVReports({ limit: '10' });
+      const result = await getCSVReports({ 'id.in': csvReportIds });
 
-      // Find a report with approvers
       const reportWithApprovers = result.find((r) => r.approvers && r.approvers.length > 0);
 
       expect(reportWithApprovers).toBeTruthy();
@@ -515,50 +554,49 @@ describe('Collab Reports Service', () => {
     });
 
     it('respects limit parameter', async () => {
-      const result = await getCSVReports({ limit: '1' });
+      const result = await getCSVReports({ 'id.in': csvReportIds, limit: '1' });
       expect(result).toHaveLength(1);
     });
 
     it('handles "all" limit parameter', async () => {
-      const result = await getCSVReports({ limit: 'all' });
+      const result = await getCSVReports({ 'id.in': csvReportIds, limit: 'all' });
       expect(Array.isArray(result)).toBe(true);
-      expect(result.length).toBeGreaterThanOrEqual(2);
+      expect(result.map(({ id }) => id)).toEqual(expect.arrayContaining(csvReportIds));
     });
 
     it('respects sortBy and sortDir parameters', async () => {
       const resultAsc = await getCSVReports({
+        'id.in': csvReportIds,
         sortBy: 'Activity_name',
         sortDir: 'asc',
-        limit: '2',
       });
       const resultDesc = await getCSVReports({
+        'id.in': csvReportIds,
         sortBy: 'Activity_name',
         sortDir: 'desc',
-        limit: '2',
       });
 
-      expect(resultAsc).toHaveLength(2);
-      expect(resultDesc).toHaveLength(2);
+      expect(resultAsc).toHaveLength(csvReportIds.length);
+      expect(resultDesc).toHaveLength(csvReportIds.length);
 
       // Names should be in opposite order
       expect(resultAsc[0].name).not.toBe(resultDesc[0].name);
     });
 
     it('includes steps data when available', async () => {
-      const result = await getCSVReports({ limit: '10' });
+      const result = await getCSVReports({ 'id.in': csvReportIds });
 
       result.forEach((report) => {
         expect(report).toHaveProperty('steps');
         expect(Array.isArray(report.steps)).toBe(true);
       });
     });
 
-    it('uses default parameters when none provided', async () => {
-      const result = await getCSVReports();
+    it('uses default parameters when none provided, returning all matching records', async () => {
+      const result = await getCSVReports({ 'id.in': csvReportIds });
 
       expect(Array.isArray(result)).toBe(true);
-      // Should respect default limit of REPORTS_PER_PAGE (10)
-      expect(result.length).toBeLessThanOrEqual(10);
+      expect(result.map(({ id }) => id)).toEqual(expect.arrayContaining(csvReportIds));
     });
   });
 

src/services/collabReports.ts

@@ -469,7 +469,7 @@ export async function getCSVReports({
   sortBy = 'updatedAt',
   sortDir = 'desc',
   offset = '0',
-  limit = String(REPORTS_PER_PAGE),
+  limit = 'all',
   status = REPORT_STATUSES.APPROVED,
   userId,
   ...filters