Skip to content

The open alternative to Salesforce, designed for AI.

fix: prepend UTF-8 BOM to fix non-Latin characters in csv (#19246)

BugIsGod43baf7b91c72
diff --git a/packages/twenty-front/src/modules/object-record/record-index/export/hooks/__tests__/useRecordIndexExportRecords.test.ts b/packages/twenty-front/src/modules/object-record/record-index/export/hooks/__tests__/useRecordIndexExportRecords.test.ts
index 6ce08f5cf4e..b357391930e 100644
--- a/packages/twenty-front/src/modules/object-record/record-index/export/hooks/__tests__/useRecordIndexExportRecords.test.ts
+++ b/packages/twenty-front/src/modules/object-record/record-index/export/hooks/__tests__/useRecordIndexExportRecords.test.ts
@@ -2,11 +2,17 @@ import { type FieldMetadata } from '@/object-record/record-field/ui/types/FieldM
import { type ColumnDefinition } from '@/object-record/record-table/types/ColumnDefinition';
import { CSV_INJECTION_PREVENTION_ZWJ } from '@/spreadsheet-import/constants/CsvInjectionPreventionZwj';
-import { FieldMetadataType, RelationType } from '~/generated-metadata/graphql';
import {
+ csvDownloader,
displayedExportProgress,
generateCsv,
} from '@/object-record/record-index/export/hooks/useRecordIndexExportRecords';
+import { saveAs } from 'file-saver';
+import { FieldMetadataType, RelationType } from '~/generated-metadata/graphql';
+
+jest.mock('file-saver', () => ({
+ saveAs: jest.fn(),
+}));
jest.useFakeTimers();
@@ -63,7 +69,7 @@ describe('generateCsv', () => {
];
const csv = generateCsv({ columns, rows });
expect(csv)
- .toEqual(`Id,Foo,Empty,Nested link field / Link URL,Nested link field / Secondary Links,Relation
+ .toEqual(`\uFEFFId,Foo,Empty,Nested link field / Link URL,Nested link field / Secondary Links,Relation
1,some field,,https://www.test.com,"[{""label"":""secondary link 1"",""url"":""https://www.test.com""},{""label"":""secondary link 2"",""url"":""https://www.test.com""}]",a relation`);
});
@@ -436,6 +442,62 @@ describe('generateCsv', () => {
});
});
+describe('csvDownloader', () => {
+ const mockSaveAs = saveAs as jest.MockedFunction<typeof saveAs>;
+
+ beforeEach(() => {
+ mockSaveAs.mockClear();
+ });
+
+ const readBlob = async (blob: Blob): Promise<ArrayBuffer> =>
+ new Promise<ArrayBuffer>((resolve, reject) => {
+ const reader = new FileReader();
+ reader.onload = () => resolve(reader.result as ArrayBuffer);
+ reader.onerror = reject;
+ reader.readAsArrayBuffer(blob);
+ });
+
+ const columns: Pick<
+ ColumnDefinition<FieldMetadata>,
+ 'size' | 'label' | 'type' | 'metadata'
+ >[] = [
+ {
+ label: 'Name',
+ size: 100,
+ type: FieldMetadataType.TEXT,
+ metadata: { fieldName: 'name' },
+ },
+ ];
+
+ it('prepends UTF-8 BOM (EF BB BF) as first three bytes', async () => {
+ csvDownloader('export.csv', {
+ columns,
+ rows: [{ id: '1', name: 'test' }],
+ });
+
+ const blob = mockSaveAs.mock.calls[0][0] as Blob;
+ const bytes = new Uint8Array(await readBlob(blob));
+
+ expect(bytes[0]).toBe(0xef);
+ expect(bytes[1]).toBe(0xbb);
+ expect(bytes[2]).toBe(0xbf);
+ });
+
+ it.each([
+ ['Arabic', 'مرحبا'],
+ ['Chinese', '你好'],
+ ['Japanese', 'こんにちは'],
+ ['Korean', '안녕하세요'],
+ ])('preserves %s characters in exported content', async (_, name) => {
+ csvDownloader('export.csv', { columns, rows: [{ id: '1', name }] });
+
+ const blob = mockSaveAs.mock.calls[0][0] as Blob;
+ const text = Buffer.from(await readBlob(blob)).toString('utf-8');
+
+ expect(text).toContain(name);
+ });
+});
+
describe('displayedExportProgress', () => {
it.each([
[undefined, undefined, 'percentage', 'Export'],
diff --git a/packages/twenty-front/src/modules/object-record/record-index/export/hooks/useRecordIndexExportRecords.ts b/packages/twenty-front/src/modules/object-record/record-index/export/hooks/useRecordIndexExportRecords.ts
index f194d8f4c54..fbfbda3f058 100644
--- a/packages/twenty-front/src/modules/object-record/record-index/export/hooks/useRecordIndexExportRecords.ts
+++ b/packages/twenty-front/src/modules/object-record/record-index/export/hooks/useRecordIndexExportRecords.ts
@@ -114,6 +114,7 @@ export const generateCsv: GenerateExport = ({
return json2csv(sanitizedRows, {
keys,
emptyFieldValue: '',
+ excelBOM: true,
// Note: We handle CSV injection prevention manually with ZWJ approach above
// This preserves original which the csvSecurity option does not do
});