n8n/packages/nodes-base/nodes/SpreadsheetFile/test/fromFile.operation.test.ts
Elias Meire 9be76c5372
fix(Extract from File Node): Skip empty lines in CSV parsing to prevent errors (#26511)
Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com>
2026-03-23 08:16:36 +00:00

1003 lines
34 KiB
TypeScript

import { mockDeep } from 'jest-mock-extended';
import type { IBinaryData, IExecuteFunctions, INode, INodeExecutionData } from 'n8n-workflow';
import { BINARY_ENCODING, NodeOperationError } from 'n8n-workflow';
import { Readable } from 'stream';
jest.mock('xlsx', () => ({
read: jest.fn(),
utils: {
sheet_to_json: jest.fn(),
},
}));
import { read as xlsxRead, utils as xlsxUtils } from 'xlsx';
import { execute } from '../v2/fromFile.operation';
describe('fromFile.operation - xlsx parsing logic', () => {
const mockExecuteFunctions = mockDeep<IExecuteFunctions>();
const mockBinaryDataInMemory: IBinaryData = {
data: 'dGVzdCBkYXRh',
mimeType: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
fileExtension: 'xlsx',
fileName: 'test.xlsx',
};
const mockBinaryDataWithId: IBinaryData = {
id: 'binary-data-id-123',
mimeType: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
fileExtension: 'xlsx',
fileName: 'test.xlsx',
data: '',
};
const mockWorkbook = {
SheetNames: ['Sheet1', 'Sheet2'],
Sheets: {
Sheet1: {
A1: { t: 's', v: 'Name' },
B1: { t: 's', v: 'Age' },
C1: { t: 's', v: 'City' },
A2: { t: 's', v: 'John' },
B2: { t: 'n', v: 25 },
C2: { t: 's', v: 'NYC' },
A3: { t: 's', v: 'Jane' },
B3: { t: 'n', v: 30 },
C3: { t: 's', v: 'LA' },
},
Sheet2: {
A1: { t: 's', v: 'Product' },
B1: { t: 'n', v: 100 },
},
},
};
const mockParsedData = [
{ Name: 'John', Age: 25, City: 'NYC' },
{ Name: 'Jane', Age: 30, City: 'LA' },
];
beforeEach(() => {
jest.clearAllMocks();
mockExecuteFunctions.getNodeParameter.mockImplementation(
(paramName, _itemIndex, defaultValue) => {
switch (paramName) {
case 'fileFormat':
return 'xlsx';
case 'binaryPropertyName':
return 'data';
case 'options':
return {};
default:
return defaultValue;
}
},
);
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(mockBinaryDataInMemory);
mockExecuteFunctions.getNode.mockReturnValue({
name: 'SpreadsheetFile',
type: 'n8n-nodes-base.spreadsheetFile',
id: 'test-node-id',
} as INode);
mockExecuteFunctions.continueOnFail.mockReturnValue(false);
(xlsxRead as jest.Mock).mockReturnValue(mockWorkbook);
(xlsxUtils.sheet_to_json as jest.Mock).mockReturnValue(mockParsedData);
});
describe('Basic xlsx parsing', () => {
it('should parse xlsx file from in-memory binary data', async () => {
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
expect(result).toHaveLength(2);
expect(result[0].json).toEqual({ Name: 'John', Age: 25, City: 'NYC' });
expect(result[1].json).toEqual({ Name: 'Jane', Age: 30, City: 'LA' });
expect(result[0].pairedItem).toEqual({ item: 0 });
expect(result[1].pairedItem).toEqual({ item: 0 });
expect(xlsxRead).toHaveBeenCalledWith(
Buffer.from(mockBinaryDataInMemory.data, BINARY_ENCODING),
{ raw: undefined },
);
expect(xlsxUtils.sheet_to_json).toHaveBeenCalledWith(mockWorkbook.Sheets.Sheet1, {});
});
it('should parse xlsx file from filesystem binary data', async () => {
const mockStream = new Readable();
mockStream.push(Buffer.from('test xlsx content'));
mockStream.push(null);
const mockBuffer = Buffer.from('test xlsx content');
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(mockBinaryDataWithId);
mockExecuteFunctions.helpers.getBinaryStream.mockResolvedValue(mockStream);
mockExecuteFunctions.helpers.binaryToBuffer.mockResolvedValue(mockBuffer);
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
expect(result).toHaveLength(2);
expect(mockExecuteFunctions.helpers.getBinaryStream).toHaveBeenCalledWith(
'binary-data-id-123',
262144,
);
expect(mockExecuteFunctions.helpers.binaryToBuffer).toHaveBeenCalledWith(mockStream);
expect(xlsxRead).toHaveBeenCalledWith(mockBuffer, { raw: undefined });
});
});
describe('Options handling', () => {
it('should respect rawData option', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { rawData: true };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
await execute.call(mockExecuteFunctions, items);
expect(xlsxRead).toHaveBeenCalledWith(expect.any(Buffer), { raw: true });
});
it('should respect readAsString option', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { readAsString: true };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
await execute.call(mockExecuteFunctions, items);
expect(xlsxRead).toHaveBeenCalledWith(expect.any(String), { raw: undefined, type: 'binary' });
});
it('should use specified sheet name', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { sheetName: 'Sheet2' };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
await execute.call(mockExecuteFunctions, items);
expect(xlsxUtils.sheet_to_json).toHaveBeenCalledWith(mockWorkbook.Sheets.Sheet2, {});
});
it('should handle range option as string', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { range: 'A1:B2' };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
await execute.call(mockExecuteFunctions, items);
expect(xlsxUtils.sheet_to_json).toHaveBeenCalledWith(mockWorkbook.Sheets.Sheet1, {
range: 'A1:B2',
});
});
it('should handle range option as number', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { range: '2' };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
await execute.call(mockExecuteFunctions, items);
expect(xlsxUtils.sheet_to_json).toHaveBeenCalledWith(mockWorkbook.Sheets.Sheet1, {
range: 2,
});
});
it('should include empty cells when option is set', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { includeEmptyCells: true };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
await execute.call(mockExecuteFunctions, items);
expect(xlsxUtils.sheet_to_json).toHaveBeenCalledWith(mockWorkbook.Sheets.Sheet1, {
defval: '',
});
});
it('should handle headerRow=false option', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { headerRow: false };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
const mockArrayData = [
['Name', 'Age'],
['John', 25],
['Jane', 30],
];
(xlsxUtils.sheet_to_json as jest.Mock).mockReturnValue(mockArrayData);
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
expect(xlsxUtils.sheet_to_json).toHaveBeenCalledWith(mockWorkbook.Sheets.Sheet1, {
header: 1,
});
expect(result).toHaveLength(3);
expect(result[0].json).toEqual({ row: ['Name', 'Age'] });
expect(result[1].json).toEqual({ row: ['John', 25] });
expect(result[2].json).toEqual({ row: ['Jane', 30] });
});
});
describe('Error handling', () => {
it('should throw error when workbook has no sheets', async () => {
const emptyWorkbook = { SheetNames: [], Sheets: {} };
(xlsxRead as jest.Mock).mockReturnValue(emptyWorkbook);
const items: INodeExecutionData[] = [{ json: {} }];
await expect(execute.call(mockExecuteFunctions, items)).rejects.toThrow(NodeOperationError);
});
it('should throw error when specified sheet does not exist', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { sheetName: 'NonExistentSheet' };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
await expect(execute.call(mockExecuteFunctions, items)).rejects.toThrow(NodeOperationError);
});
it('should handle continueOnFail gracefully', async () => {
mockExecuteFunctions.continueOnFail.mockReturnValue(true);
(xlsxRead as jest.Mock).mockImplementation(() => {
throw new Error('Invalid file format');
});
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
expect(result).toHaveLength(1);
expect(result[0].json.error).toContain('Invalid file format');
expect(result[0].pairedItem).toEqual({ item: 0 });
});
it('should enhance error message when file extension does not match format', async () => {
mockExecuteFunctions.continueOnFail.mockReturnValue(true);
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue({
...mockBinaryDataInMemory,
fileExtension: 'pdf',
});
(xlsxRead as jest.Mock).mockImplementation(() => {
throw new Error('Parse error');
});
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
expect(result[0].json.error).toContain('not in xlsx format');
});
});
describe('Multiple items processing', () => {
it('should process multiple items correctly', async () => {
const items: INodeExecutionData[] = [{ json: { id: 1 } }, { json: { id: 2 } }];
mockExecuteFunctions.helpers.assertBinaryData
.mockReturnValueOnce(mockBinaryDataInMemory)
.mockReturnValueOnce({
...mockBinaryDataInMemory,
fileName: 'test2.xlsx',
});
const result = await execute.call(mockExecuteFunctions, items);
expect(result).toHaveLength(4);
expect(result[0].pairedItem).toEqual({ item: 0 });
expect(result[1].pairedItem).toEqual({ item: 0 });
expect(result[2].pairedItem).toEqual({ item: 1 });
expect(result[3].pairedItem).toEqual({ item: 1 });
});
});
describe('File format detection', () => {
it('should handle autodetect for xlsx files', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'fileFormat') return 'autodetect';
if (paramName === 'binaryPropertyName') return 'data';
if (paramName === 'options') return {};
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
expect(result).toHaveLength(2);
expect(xlsxRead).toHaveBeenCalled();
});
});
describe('Additional edge cases', () => {
it('should handle mixed file formats with autodetect', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'fileFormat') return 'autodetect';
if (paramName === 'binaryPropertyName') return 'data';
if (paramName === 'options') return {};
return undefined;
});
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue({
...mockBinaryDataInMemory,
mimeType: 'application/octet-stream',
fileExtension: 'xlsx',
});
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
expect(result).toHaveLength(2);
expect(xlsxRead).toHaveBeenCalled();
});
it('should handle custom binary property name correctly', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'binaryPropertyName') return 'customBinaryField';
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'options') return {};
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
await execute.call(mockExecuteFunctions, items);
expect(mockExecuteFunctions.helpers.assertBinaryData).toHaveBeenCalledWith(
0,
'customBinaryField',
);
});
it('should handle binary data stream errors gracefully', async () => {
mockExecuteFunctions.continueOnFail.mockReturnValue(true);
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(mockBinaryDataWithId);
mockExecuteFunctions.helpers.getBinaryStream.mockRejectedValue(new Error('Stream error'));
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
expect(result).toHaveLength(1);
expect(result[0].json.error).toContain('Stream error');
});
});
describe('Binary string conversion', () => {
it('should convert buffer to binary string when readAsString is true', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { readAsString: true };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
await execute.call(mockExecuteFunctions, items);
expect(xlsxRead).toHaveBeenCalledWith(expect.any(String), { raw: undefined, type: 'binary' });
const callArgs = (xlsxRead as jest.Mock).mock.calls[0];
const passedData = callArgs[0];
const expectedBinaryString = Buffer.from(
mockBinaryDataInMemory.data,
BINARY_ENCODING,
).toString('binary');
expect(passedData).toBe(expectedBinaryString);
});
it('should use buffer directly when readAsString is false', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { readAsString: false };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
await execute.call(mockExecuteFunctions, items);
// Verify that xlsxRead was called with a Buffer (no type specified)
expect(xlsxRead).toHaveBeenCalledWith(expect.any(Buffer), { raw: undefined });
});
it('should handle readAsString with filesystem binary data', async () => {
const mockStream = new Readable();
mockStream.push(Buffer.from('test xlsx content'));
mockStream.push(null);
const mockBuffer = Buffer.from('test xlsx content');
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { readAsString: true };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(mockBinaryDataWithId);
mockExecuteFunctions.helpers.getBinaryStream.mockResolvedValue(mockStream);
mockExecuteFunctions.helpers.binaryToBuffer.mockResolvedValue(mockBuffer);
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
expect(result).toHaveLength(2);
expect(mockExecuteFunctions.helpers.getBinaryStream).toHaveBeenCalledWith(
'binary-data-id-123',
262144,
);
expect(mockExecuteFunctions.helpers.binaryToBuffer).toHaveBeenCalledWith(mockStream);
// Verify that xlsxRead was called with binary string
expect(xlsxRead).toHaveBeenCalledWith(expect.any(String), { raw: undefined, type: 'binary' });
// Verify the string is the result of buffer.toString('binary')
const callArgs = (xlsxRead as jest.Mock).mock.calls[0];
const passedData = callArgs[0];
const expectedBinaryString = mockBuffer.toString('binary');
expect(passedData).toBe(expectedBinaryString);
});
it('should combine readAsString with other options correctly', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options')
return { readAsString: true, rawData: true, sheetName: 'Sheet2' };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
await execute.call(mockExecuteFunctions, items);
// Verify that xlsxRead was called with binary string and rawData option
expect(xlsxRead).toHaveBeenCalledWith(expect.any(String), { raw: true, type: 'binary' });
// Verify that the correct sheet was used
expect(xlsxUtils.sheet_to_json).toHaveBeenCalledWith(mockWorkbook.Sheets.Sheet2, {});
});
});
describe('Special character handling', () => {
it('should handle special characters correctly when readAsString is true', async () => {
// Mock binary data that contains special characters (e.g., accented characters, emojis)
const specialCharBinaryData: IBinaryData = {
data: Buffer.from('Special chars: àáâãäåæçèéêë 🚀 ñöü', 'utf8').toString(BINARY_ENCODING),
mimeType: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
fileExtension: 'xlsx',
fileName: 'special-chars.xlsx',
};
const mockWorkbookWithSpecialChars = {
SheetNames: ['Sheet1'],
Sheets: {
Sheet1: {
A1: { t: 's', v: 'Special chars: àáâãäåæçèéêë 🚀 ñöü' },
A2: { t: 's', v: 'Café' },
A3: { t: 's', v: 'Naïve résumé' },
},
},
};
const mockSpecialCharData = [
{ text: 'Special chars: àáâãäåæçèéêë 🚀 ñöü' },
{ text: 'Café' },
{ text: 'Naïve résumé' },
];
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { readAsString: true };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(specialCharBinaryData);
(xlsxRead as jest.Mock).mockReturnValue(mockWorkbookWithSpecialChars);
(xlsxUtils.sheet_to_json as jest.Mock).mockReturnValue(mockSpecialCharData);
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
// Verify that xlsxRead was called with binary string type for proper character handling
expect(xlsxRead).toHaveBeenCalledWith(expect.any(String), { raw: undefined, type: 'binary' });
// Verify that special characters are preserved in the output
expect(result).toHaveLength(3);
expect(result[0].json.text).toBe('Special chars: àáâãäåæçèéêë 🚀 ñöü');
expect(result[1].json.text).toBe('Café');
expect(result[2].json.text).toBe('Naïve résumé');
});
it('should demonstrate the difference between readAsString true vs false for character encoding', async () => {
// Test data with potential encoding issues
const encodingTestData: IBinaryData = {
data: Buffer.from('Encoding test: café naïve résumé', 'utf8').toString(BINARY_ENCODING),
mimeType: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
fileExtension: 'xlsx',
fileName: 'encoding-test.xlsx',
};
const mockWorkbookEncoding = {
SheetNames: ['Sheet1'],
Sheets: {
Sheet1: {
A1: { t: 's', v: 'Encoding test: café naïve résumé' },
},
},
};
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(encodingTestData);
(xlsxRead as jest.Mock).mockReturnValue(mockWorkbookEncoding);
(xlsxUtils.sheet_to_json as jest.Mock).mockReturnValue([
{ text: 'Encoding test: café naïve résumé' },
]);
// Test with readAsString: true
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { readAsString: true };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
await execute.call(mockExecuteFunctions, items);
// Verify that when readAsString is true, we use binary type for proper character handling
expect(xlsxRead).toHaveBeenCalledWith(expect.any(String), { raw: undefined, type: 'binary' });
// Reset mocks for second test
jest.clearAllMocks();
(xlsxRead as jest.Mock).mockReturnValue(mockWorkbookEncoding);
(xlsxUtils.sheet_to_json as jest.Mock).mockReturnValue([
{ text: 'Encoding test: café naïve résumé' },
]);
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(encodingTestData);
// Test with readAsString: false (default)
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { readAsString: false };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
await execute.call(mockExecuteFunctions, items);
// Verify that when readAsString is false, we use buffer directly (no type specified)
expect(xlsxRead).toHaveBeenCalledWith(expect.any(Buffer), { raw: undefined });
});
it('should handle various international characters when readAsString is enabled', async () => {
// Test with various international characters that might cause encoding issues
const internationalChars = [
'Chinese: 你好世界',
'Japanese: こんにちは',
'Korean: 안녕하세요',
'Arabic: مرحبا',
'Russian: Привет',
'Greek: Γεια σας',
'Hebrew: שלום',
'Thai: สวัสดี',
];
const internationalBinaryData: IBinaryData = {
data: Buffer.from(internationalChars.join('\n'), 'utf8').toString(BINARY_ENCODING),
mimeType: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
fileExtension: 'xlsx',
fileName: 'international.xlsx',
};
const mockInternationalWorkbook = {
SheetNames: ['Sheet1'],
Sheets: {
Sheet1: internationalChars.reduce((acc, char, index) => {
acc[`A${index + 1}`] = { t: 's', v: char };
return acc;
}, {} as any),
},
};
const mockInternationalData = internationalChars.map((char) => ({ text: char }));
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'options') return { readAsString: true };
if (paramName === 'fileFormat') return 'xlsx';
if (paramName === 'binaryPropertyName') return 'data';
return undefined;
});
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(internationalBinaryData);
(xlsxRead as jest.Mock).mockReturnValue(mockInternationalWorkbook);
(xlsxUtils.sheet_to_json as jest.Mock).mockReturnValue(mockInternationalData);
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
// Verify that xlsxRead was called with binary string type
expect(xlsxRead).toHaveBeenCalledWith(expect.any(String), { raw: undefined, type: 'binary' });
// Verify that all international characters are preserved
expect(result).toHaveLength(8);
internationalChars.forEach((expectedChar, index) => {
expect(result[index].json.text).toBe(expectedChar);
});
});
});
describe('CSV parsing with skipRecordsWithErrors', () => {
const invalidCsvData = 'id,name\n3,"John"\n1,"Alice\n2,"Bob"';
const mockBinaryDataCSV: IBinaryData = {
data: Buffer.from(invalidCsvData, 'utf8').toString(BINARY_ENCODING),
mimeType: 'text/csv',
fileExtension: 'csv',
fileName: 'test.csv',
};
beforeEach(() => {
jest.clearAllMocks();
mockExecuteFunctions.getNodeParameter.mockImplementation(
(paramName: string, _itemIndex: number, defaultValue?: any) => {
switch (paramName) {
case 'fileFormat':
return 'csv';
case 'binaryPropertyName':
return 'data';
case 'options':
return {};
default:
return defaultValue;
}
},
);
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(mockBinaryDataCSV);
mockExecuteFunctions.getNode.mockReturnValue({
name: 'SpreadsheetFile',
type: 'n8n-nodes-base.spreadsheetFile',
id: 'test-node-id',
} as INode);
mockExecuteFunctions.continueOnFail.mockReturnValue(false);
});
it('should skip records with errors when skipRecordsWithErrors is enabled with limit -1', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'fileFormat') return 'csv';
if (paramName === 'binaryPropertyName') return 'data';
if (paramName === 'options')
return {
skipRecordsWithErrors: { value: { enabled: true, maxSkippedRecords: -1 } },
columns: true,
};
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
// Should have 1 valid record (John), Bob and Alice is considered a single record with error
expect(result).toHaveLength(1);
expect(result[0].json).toEqual({ id: '3', name: 'John' });
});
it('should skip records with errors when skipRecordsWithErrors is enabled with limit 1', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'fileFormat') return 'csv';
if (paramName === 'binaryPropertyName') return 'data';
if (paramName === 'options')
return {
skipRecordsWithErrors: { value: { enabled: true, maxSkippedRecords: 1 } },
columns: true,
};
return undefined;
});
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
expect(result).toHaveLength(1);
expect(result[0].json).toEqual({ id: '3', name: 'John' });
expect(result[0].pairedItem).toEqual({ item: 0 });
});
it('should throw error when skipped records exceed maxSkippedRecords limit', async () => {
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'fileFormat') return 'csv';
if (paramName === 'binaryPropertyName') return 'data';
if (paramName === 'options')
return {
skipRecordsWithErrors: { value: { enabled: true, maxSkippedRecords: 1 } },
columns: true,
};
return undefined;
});
const csvWithThreeErrors =
'id,name\n3,"John"\n1,"Alice\n2,"Bob"\n4,"Charlie\n5,"Eve\n6,"David';
const mockBinaryDataThreeErrors: IBinaryData = {
data: Buffer.from(csvWithThreeErrors, 'utf8').toString(BINARY_ENCODING),
mimeType: 'text/csv',
fileExtension: 'csv',
fileName: 'test-three-errors.csv',
};
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(mockBinaryDataThreeErrors);
const items: INodeExecutionData[] = [{ json: {} }];
mockExecuteFunctions.getNodeParameter.mockImplementation((paramName: string) => {
if (paramName === 'fileFormat') return 'csv';
if (paramName === 'binaryPropertyName') return 'data';
if (paramName === 'options')
return {
skipRecordsWithErrors: { value: { enabled: true, maxSkippedRecords: 1 } },
columns: true,
};
return undefined;
});
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(mockBinaryDataThreeErrors);
await expect(execute.call(mockExecuteFunctions, items)).rejects.toThrow(
'Max number of skipped records exceeded',
);
});
});
describe('CSV parsing with empty lines', () => {
beforeEach(() => {
jest.clearAllMocks();
mockExecuteFunctions.getNodeParameter.mockImplementation(
(paramName: string, _itemIndex: number, defaultValue?: any) => {
switch (paramName) {
case 'fileFormat':
return 'csv';
case 'binaryPropertyName':
return 'data';
case 'options':
return {};
default:
return defaultValue;
}
},
);
mockExecuteFunctions.getNode.mockReturnValue({
name: 'SpreadsheetFile',
type: 'n8n-nodes-base.spreadsheetFile',
id: 'test-node-id',
} as INode);
mockExecuteFunctions.continueOnFail.mockReturnValue(false);
});
it('should handle CSV with trailing empty lines when failOnCsvBufferError is enabled', async () => {
const csvData = 'id,name\n1,"Alice"\n2,"Bob"\n\n\n';
const binaryData: IBinaryData = {
data: Buffer.from(csvData, 'utf8').toString(BINARY_ENCODING),
mimeType: 'text/csv',
fileExtension: 'csv',
fileName: 'test.csv',
};
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(binaryData);
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items, 'fileFormat', {
failOnCsvBufferError: true,
});
expect(result).toHaveLength(2);
expect(result[0].json).toEqual({ id: '1', name: 'Alice' });
expect(result[1].json).toEqual({ id: '2', name: 'Bob' });
});
it('should handle CSV with trailing empty lines without failOnCsvBufferError', async () => {
const csvData = 'id,name\n1,"Alice"\n2,"Bob"\n\n\n';
const binaryData: IBinaryData = {
data: Buffer.from(csvData, 'utf8').toString(BINARY_ENCODING),
mimeType: 'text/csv',
fileExtension: 'csv',
fileName: 'test.csv',
};
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(binaryData);
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
expect(result).toHaveLength(2);
expect(result[0].json).toEqual({ id: '1', name: 'Alice' });
expect(result[1].json).toEqual({ id: '2', name: 'Bob' });
});
it('should handle CSV with empty lines in the middle of the file', async () => {
const csvData = 'id,name\n1,"Alice"\n\n2,"Bob"\n';
const binaryData: IBinaryData = {
data: Buffer.from(csvData, 'utf8').toString(BINARY_ENCODING),
mimeType: 'text/csv',
fileExtension: 'csv',
fileName: 'test.csv',
};
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(binaryData);
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items, 'fileFormat', {
failOnCsvBufferError: true,
});
expect(result).toHaveLength(2);
expect(result[0].json).toEqual({ id: '1', name: 'Alice' });
expect(result[1].json).toEqual({ id: '2', name: 'Bob' });
});
it('should return empty results for CSV with only empty lines after header', async () => {
const csvData = 'id,name\n\n\n';
const binaryData: IBinaryData = {
data: Buffer.from(csvData, 'utf8').toString(BINARY_ENCODING),
mimeType: 'text/csv',
fileExtension: 'csv',
fileName: 'test.csv',
};
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(binaryData);
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items, 'fileFormat', {
failOnCsvBufferError: true,
});
expect(result).toHaveLength(0);
});
});
describe('CSV parsing with empty lines (stream path)', () => {
beforeEach(() => {
jest.clearAllMocks();
mockExecuteFunctions.getNodeParameter.mockImplementation(
(paramName, _itemIndex, defaultValue) => {
switch (paramName) {
case 'fileFormat':
return 'csv';
case 'binaryPropertyName':
return 'data';
case 'options':
return {};
default:
return defaultValue;
}
},
);
mockExecuteFunctions.getNode.mockReturnValue({
name: 'SpreadsheetFile',
type: 'n8n-nodes-base.spreadsheetFile',
id: 'test-node-id',
} as INode);
mockExecuteFunctions.continueOnFail.mockReturnValue(false);
});
it('should handle CSV with trailing empty lines via stream', async () => {
const csvData = 'id,name\n1,"Alice"\n2,"Bob"\n\n\n';
const mockStream = new Readable();
mockStream.push(Buffer.from(csvData, 'utf8'));
mockStream.push(null);
const binaryData: IBinaryData = {
id: 'binary-data-id-csv',
data: '',
mimeType: 'text/csv',
fileExtension: 'csv',
fileName: 'test.csv',
};
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(binaryData);
mockExecuteFunctions.helpers.getBinaryStream.mockResolvedValue(mockStream);
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
expect(result).toHaveLength(2);
expect(result[0].json).toEqual({ id: '1', name: 'Alice' });
expect(result[1].json).toEqual({ id: '2', name: 'Bob' });
expect(mockExecuteFunctions.helpers.getBinaryStream).toHaveBeenCalledWith(
'binary-data-id-csv',
);
});
it('should handle CSV with empty lines in the middle via stream', async () => {
const csvData = 'id,name\n1,"Alice"\n\n2,"Bob"\n';
const mockStream = new Readable();
mockStream.push(Buffer.from(csvData, 'utf8'));
mockStream.push(null);
const binaryData: IBinaryData = {
id: 'binary-data-id-csv',
data: '',
mimeType: 'text/csv',
fileExtension: 'csv',
fileName: 'test.csv',
};
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(binaryData);
mockExecuteFunctions.helpers.getBinaryStream.mockResolvedValue(mockStream);
const items: INodeExecutionData[] = [{ json: {} }];
const result = await execute.call(mockExecuteFunctions, items);
expect(result).toHaveLength(2);
expect(result[0].json).toEqual({ id: '1', name: 'Alice' });
expect(result[1].json).toEqual({ id: '2', name: 'Bob' });
});
it('should reject when source stream errors', async () => {
const mockStream = new Readable({
read() {
process.nextTick(() => this.destroy(new Error('stream read failure')));
},
});
const binaryData: IBinaryData = {
id: 'binary-data-id-csv',
data: '',
mimeType: 'text/csv',
fileExtension: 'csv',
fileName: 'test.csv',
};
mockExecuteFunctions.helpers.assertBinaryData.mockReturnValue(binaryData);
mockExecuteFunctions.helpers.getBinaryStream.mockResolvedValue(mockStream);
const items: INodeExecutionData[] = [{ json: {} }];
await expect(execute.call(mockExecuteFunctions, items)).rejects.toThrow(
'stream read failure',
);
});
});
});