Skip to content

Prepend UTF-8 BOM to generated CSV files #749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joshuali925-osdbot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Prepend UTF-8 BOM to generated CSV files #749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion server/routes/utils/__tests__/dataReportHelpers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* SPDX-License-Identifier: Apache-2.0
*/

import { getOpenSearchData } from '../dataReportHelpers';
import { getOpenSearchData, convertToCSV } from '../dataReportHelpers';

jest.mock('../excelBuilder', () => ({
ExcelBuilder: jest.fn().mockImplementation(() => ({
Expand Down Expand Up @@ -361,3 +361,21 @@ describe('test traverse preserves selected field order', () => {
expect(keys2).toEqual(['field_b', 'field_a', 'field_c']);
});
});

describe('convertToCSV', () => {
test('should prepend UTF-8 BOM to CSV output', async () => {
const dataset = [[{ name: 'test', value: 'hello' }]];
const result = await convertToCSV(dataset, ',');
expect(result.charCodeAt(0)).toBe(0xfeff);
expect(result.startsWith('\uFEFF')).toBe(true);
});

test('should contain correct CSV content after BOM', async () => {
const dataset = [[{ name: "it's", city: 'Zürich' }]];
const result = await convertToCSV(dataset, ',');
const csvContent = result.substring(1); // skip BOM
expect(csvContent).toContain('name');
expect(csvContent).toContain("it's");
expect(csvContent).toContain('Zürich');
});
});
3 changes: 2 additions & 1 deletion server/routes/utils/dataReportHelpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,8 @@ export const convertToCSV = async (dataset, csvSeparator) => {
await converter.json2csvAsync(dataset[0], options).then((csv) => {
convertedData = csv;
});
return convertedData;
// Prepend UTF-8 BOM so Excel correctly detects encoding
return '\uFEFF' + convertedData;
};

function flattenHits(
Expand Down