first commit

packages/nodes-base/nodes/Google/Sheet/test/v2/node/update.test.ts

@@ -0,0 +1,468 @@
+import type { MockProxy } from 'jest-mock-extended';
+import { mock } from 'jest-mock-extended';
+import type { IExecuteFunctions, INode } from 'n8n-workflow';
+
+import { execute } from '../../../v2/actions/sheet/update.operation';
+import type { GoogleSheet } from '../../../v2/helpers/GoogleSheet';
+
+describe('Google Sheet - Update', () => {
+	let mockExecuteFunctions: MockProxy<IExecuteFunctions>;
+	let mockGoogleSheet: MockProxy<GoogleSheet>;
+
+	beforeEach(() => {
+		mockExecuteFunctions = mock<IExecuteFunctions>();
+		mockGoogleSheet = mock<GoogleSheet>();
+
+		mockExecuteFunctions.getNode.mockReturnValueOnce(mock<INode>({ typeVersion: 4.5 }));
+
+		mockGoogleSheet.batchUpdate.mockResolvedValueOnce([]);
+	});
+
+	afterEach(() => {
+		jest.resetAllMocks();
+	});
+
+	it('should update by row_number and not insert it as a new column', async () => {
+		mockExecuteFunctions.getInputData.mockReturnValueOnce([
+			{
+				json: {
+					row_number: 3,
+					name: 'NEW NAME',
+					text: 'NEW TEXT',
+				},
+				pairedItem: {
+					item: 0,
+					input: undefined,
+				},
+			},
+		]);
+
+		mockExecuteFunctions.getNodeParameter
+			.mockReturnValueOnce('USER_ENTERED') // valueInputMode
+			.mockReturnValueOnce({}); // options
+		mockExecuteFunctions.getNodeParameter.mockReturnValueOnce(['row_number']); // columnsToMatchOn
+		mockExecuteFunctions.getNodeParameter.mockReturnValueOnce('autoMapInputData'); // dataMode
+
+		mockGoogleSheet.getData.mockResolvedValueOnce([
+			['id', 'name', 'text'],
+			['1', 'a', 'a'],
+			['2', 'x', 'x'],
+			['3', 'b', 'b'],
+		]);
+
+		mockGoogleSheet.getColumnValues.mockResolvedValueOnce([]);
+
+		mockGoogleSheet.prepareDataForUpdatingByRowNumber.mockReturnValueOnce({
+			updateData: [
+				{
+					range: 'Sheet1!B3',
+					values: [['NEW NAME']],
+				},
+				{
+					range: 'Sheet1!C3',
+					values: [['NEW TEXT']],
+				},
+			],
+		});
+
+		await execute.call(mockExecuteFunctions, mockGoogleSheet, 'Sheet1');
+
+		expect(mockGoogleSheet.getData).toHaveBeenCalledWith('Sheet1', 'FORMATTED_VALUE');
+		expect(mockGoogleSheet.getColumnValues).toHaveBeenCalledWith({
+			range: 'Sheet1!A:Z',
+			keyIndex: -1,
+			dataStartRowIndex: 1,
+			valueRenderMode: 'UNFORMATTED_VALUE',
+			sheetData: [
+				['id', 'name', 'text'],
+				['1', 'a', 'a'],
+				['2', 'x', 'x'],
+				['3', 'b', 'b'],
+			],
+		});
+		expect(mockGoogleSheet.prepareDataForUpdatingByRowNumber).toHaveBeenCalledWith(
+			[
+				{
+					row_number: 3,
+					name: 'NEW NAME',
+					text: 'NEW TEXT',
+				},
+			],
+			'Sheet1!A:Z',
+			[['id', 'name', 'text']],
+		);
+
+		expect(mockGoogleSheet.batchUpdate).toHaveBeenCalledWith(
+			[
+				{
+					range: 'Sheet1!B3',
+					values: [['NEW NAME']],
+				},
+				{
+					range: 'Sheet1!C3',
+					values: [['NEW TEXT']],
+				},
+			],
+			'USER_ENTERED',
+		);
+	});
+
+	it('should update rows by column values with special character', async () => {
+		mockExecuteFunctions.getInputData.mockReturnValueOnce([
+			{
+				json: {
+					row_number: 3,
+					name: '** δ$% " []',
+					text: 'δ$% " []',
+				},
+				pairedItem: {
+					item: 0,
+					input: undefined,
+				},
+			},
+		]);
+
+		mockExecuteFunctions.getNodeParameter.mockImplementation((parameterName: string) => {
+			const params: { [key: string]: string | object } = {
+				options: {},
+				'options.cellFormat': 'USER_ENTERED',
+				'columns.matchingColumns': ['row_number'],
+				'columns.value': {
+					'ha []': 'kayyyy$',
+					macarena: 'baile',
+					'Real.1': 't&c',
+					'21 "': 'Σ',
+				},
+				dataMode: 'autoMapInputData',
+			};
+			return params[parameterName];
+		});
+
+		mockGoogleSheet.getData.mockResolvedValueOnce([
+			['Real.1', '21 "', 'dfd', 'ha []', 'macarena'],
+			['aye.2', '"book"', 'ee', 'dd', 'dance'],
+			['t&c', 'Σ', 'baz', 'kayyyy$', 'baile'],
+			['fudge.2', '9080', 'live', 'dog', 'brazil'],
+		]);
+
+		mockGoogleSheet.getColumnValues.mockResolvedValueOnce([]);
+
+		mockGoogleSheet.prepareDataForUpdatingByRowNumber.mockReturnValueOnce({
+			updateData: [
+				{
+					range: 'Sheet1!B3',
+					values: [['** δ$% " []']],
+				},
+				{
+					range: 'Sheet1!C3',
+					values: [['δ$% " []']],
+				},
+			],
+		});
+
+		await execute.call(mockExecuteFunctions, mockGoogleSheet, 'Sheet1');
+
+		expect(mockGoogleSheet.getData).toHaveBeenCalledWith('Sheet1', 'FORMATTED_VALUE');
+
+		expect(mockGoogleSheet.getColumnValues).toHaveBeenCalledWith({
+			range: 'Sheet1!A:Z',
+			keyIndex: -1,
+			dataStartRowIndex: 1,
+			valueRenderMode: 'UNFORMATTED_VALUE',
+			sheetData: [
+				['Real.1', '21 "', 'dfd', 'ha []', 'macarena'],
+				['aye.2', '"book"', 'ee', 'dd', 'dance'],
+				['t&c', 'Σ', 'baz', 'kayyyy$', 'baile'],
+				['fudge.2', '9080', 'live', 'dog', 'brazil'],
+			],
+		});
+
+		expect(mockGoogleSheet.prepareDataForUpdatingByRowNumber).toHaveBeenCalledWith(
+			[
+				{
+					'21 "': 'Σ',
+					'Real.1': 't&c',
+					'ha []': 'kayyyy$',
+					macarena: 'baile',
+				},
+			],
+			'Sheet1!A:Z',
+			[['Real.1', '21 "', 'dfd', 'ha []', 'macarena']],
+		);
+
+		expect(mockGoogleSheet.batchUpdate).toHaveBeenCalledWith(
+			[
+				{
+					range: 'Sheet1!B3',
+					values: [['** δ$% " []']],
+				},
+				{
+					range: 'Sheet1!C3',
+					values: [['δ$% " []']],
+				},
+			],
+			'USER_ENTERED',
+		);
+	});
+});
+
+describe('Google Sheet - Update 4.6', () => {
+	let mockExecuteFunctions: MockProxy<IExecuteFunctions>;
+	let mockGoogleSheet: MockProxy<GoogleSheet>;
+
+	beforeEach(() => {
+		mockExecuteFunctions = mock<IExecuteFunctions>();
+		mockGoogleSheet = mock<GoogleSheet>();
+
+		mockExecuteFunctions.getNode.mockReturnValueOnce(mock<INode>({ typeVersion: 4.6 }));
+
+		mockGoogleSheet.batchUpdate.mockResolvedValueOnce([]);
+	});
+
+	afterEach(() => {
+		jest.resetAllMocks();
+	});
+
+	describe('row_number input error', () => {
+		it.each([{ rowNumber: undefined }])(
+			'displays a helpful error message when row_number is $rowNumber',
+			async ({ rowNumber }) => {
+				mockExecuteFunctions.getInputData.mockReturnValueOnce([
+					{
+						json: {
+							row_number: rowNumber,
+							name: 'name',
+							text: 'txt',
+						},
+						pairedItem: {
+							item: 0,
+							input: undefined,
+						},
+					},
+				]);
+
+				mockExecuteFunctions.getNodeParameter.mockImplementation((parameterName: string) => {
+					const params: { [key: string]: string | object } = {
+						options: {},
+						'options.cellFormat': 'USER_ENTERED',
+						'columns.matchingColumns': ['row_number'],
+						'columns.value': {
+							row_number: rowNumber, // TODO: Test for undefined
+						},
+						dataMode: 'defineBelow',
+					};
+					return params[parameterName];
+				});
+
+				mockGoogleSheet.getData.mockResolvedValueOnce([['macarena'], ['boomboom']]);
+
+				mockGoogleSheet.getColumnValues.mockResolvedValueOnce([]);
+
+				await expect(execute.call(mockExecuteFunctions, mockGoogleSheet, 'Sheet1')).rejects.toEqual(
+					expect.objectContaining({
+						message: 'row_number is null or undefined',
+						description:
+							"Since it's being used to determine the row to update, it cannot be null or undefined",
+					}),
+				);
+			},
+		);
+	});
+
+	describe('non-row_number undefined', () => {
+		it.each([{ nonRowNumber: undefined }])(
+			'displays a helpful error message when row_number is $rowNumber',
+			async ({ nonRowNumber }) => {
+				mockExecuteFunctions.getInputData.mockReturnValueOnce([
+					{
+						json: {
+							row_number: 2,
+							nonRowNumber: 'name',
+							text: 'txt',
+						},
+						pairedItem: {
+							item: 0,
+							input: undefined,
+						},
+					},
+				]);
+
+				mockExecuteFunctions.getNodeParameter.mockImplementation((parameterName: string) => {
+					const params: { [key: string]: string | object } = {
+						options: {},
+						'options.cellFormat': 'USER_ENTERED',
+						'columns.matchingColumns': ['nonRowNumber'],
+						'columns.value': {
+							nonRowNumber,
+						},
+						dataMode: 'defineBelow',
+					};
+					return params[parameterName];
+				});
+
+				mockGoogleSheet.getData.mockResolvedValueOnce([['macarena'], ['boomboom']]);
+
+				mockGoogleSheet.getColumnValues.mockResolvedValueOnce([]);
+
+				mockGoogleSheet.prepareDataForUpdateOrUpsert.mockResolvedValueOnce({
+					updateData: [],
+					appendData: [],
+				});
+
+				await execute.call(mockExecuteFunctions, mockGoogleSheet, 'Sheet1');
+
+				expect(mockExecuteFunctions.addExecutionHints).toHaveBeenCalledWith({
+					message: 'Warning: The value of column to match is null or undefined',
+					location: 'outputPane',
+				});
+			},
+		);
+	});
+});
+
+describe('Google Sheet - Update v4.6 vs v4.7 Behavior', () => {
+	let mockExecuteFunctions: MockProxy<IExecuteFunctions>;
+	let mockGoogleSheet: MockProxy<GoogleSheet>;
+
+	afterEach(() => {
+		jest.resetAllMocks();
+	});
+
+	it('v4.6: empty string in UI gets filtered out, field not sent to backend', async () => {
+		mockExecuteFunctions = mock<IExecuteFunctions>();
+		mockGoogleSheet = mock<GoogleSheet>();
+		mockExecuteFunctions.getNode.mockReturnValueOnce(mock<INode>({ typeVersion: 4.6 }));
+		mockGoogleSheet.batchUpdate.mockResolvedValueOnce([]);
+
+		mockExecuteFunctions.getInputData.mockReturnValueOnce([
+			{
+				json: {},
+				pairedItem: { item: 0, input: undefined },
+			},
+		]);
+
+		mockExecuteFunctions.getNodeParameter.mockImplementation((parameterName: string) => {
+			const params: { [key: string]: string | object } = {
+				options: {},
+				'options.cellFormat': 'USER_ENTERED',
+				'columns.matchingColumns': ['id'],
+				'columns.mappingMode': 'defineBelow',
+				'columns.value': {
+					id: 1,
+					name: 'John',
+					// email field is NOT present here because user typed '' in UI
+					// and v4.6 frontend filtered it out (allowEmptyStrings: false)
+				},
+			};
+			return params[parameterName];
+		});
+
+		mockGoogleSheet.getData.mockResolvedValueOnce([
+			['id', 'name', 'email'],
+			['1', 'Old Name', 'old@email.com'],
+		]);
+
+		mockGoogleSheet.getColumnValues.mockResolvedValueOnce(['1']);
+
+		mockGoogleSheet.prepareDataForUpdateOrUpsert.mockResolvedValueOnce({
+			updateData: [
+				{
+					range: 'Sheet1!B2',
+					values: [['John']],
+				},
+				// No update for email column - it keeps its old value
+			],
+			appendData: [],
+		});
+
+		await execute.call(mockExecuteFunctions, mockGoogleSheet, 'Sheet1');
+
+		// v4.6: Only name field is updated, email is not included in the update
+		expect(mockGoogleSheet.prepareDataForUpdateOrUpsert).toHaveBeenCalledWith({
+			inputData: [
+				{
+					id: 1,
+					name: 'John',
+					// email is NOT in the inputData, so cell keeps old value
+				},
+			],
+			indexKey: 'id',
+			range: 'Sheet1!A:Z',
+			keyRowIndex: 0,
+			dataStartRowIndex: 1,
+			valueRenderMode: 'UNFORMATTED_VALUE',
+			columnNamesList: [['id', 'name', 'email']],
+			columnValuesList: ['1'],
+		});
+	});
+
+	it('v4.7: empty string in UI is preserved and sent to backend to clear cell', async () => {
+		mockExecuteFunctions = mock<IExecuteFunctions>();
+		mockGoogleSheet = mock<GoogleSheet>();
+		mockExecuteFunctions.getNode.mockReturnValueOnce(mock<INode>({ typeVersion: 4.7 }));
+		mockGoogleSheet.batchUpdate.mockResolvedValueOnce([]);
+
+		mockExecuteFunctions.getInputData.mockReturnValueOnce([
+			{
+				json: {},
+				pairedItem: { item: 0, input: undefined },
+			},
+		]);
+
+		mockExecuteFunctions.getNodeParameter.mockImplementation((parameterName: string) => {
+			const params: { [key: string]: string | object } = {
+				options: {},
+				'options.cellFormat': 'USER_ENTERED',
+				'columns.matchingColumns': ['id'],
+				'columns.mappingMode': 'defineBelow',
+				'columns.value': {
+					id: 1,
+					name: 'John',
+					email: '', // Empty string is preserved in v4.7 (allowEmptyStrings: true)
+				},
+			};
+			return params[parameterName];
+		});
+
+		mockGoogleSheet.getData.mockResolvedValueOnce([
+			['id', 'name', 'email'],
+			['1', 'Old Name', 'old@email.com'],
+		]);
+
+		mockGoogleSheet.getColumnValues.mockResolvedValueOnce(['1']);
+
+		mockGoogleSheet.prepareDataForUpdateOrUpsert.mockResolvedValueOnce({
+			updateData: [
+				{
+					range: 'Sheet1!B2',
+					values: [['John']],
+				},
+				{
+					range: 'Sheet1!C2',
+					values: [['']],
+				},
+			],
+			appendData: [],
+		});
+
+		await execute.call(mockExecuteFunctions, mockGoogleSheet, 'Sheet1');
+
+		// v4.7: Both name and email fields are updated, email is cleared with empty string
+		expect(mockGoogleSheet.prepareDataForUpdateOrUpsert).toHaveBeenCalledWith({
+			inputData: [
+				{
+					id: 1,
+					name: 'John',
+					email: '', // Empty string is preserved and will clear the cell
+				},
+			],
+			indexKey: 'id',
+			range: 'Sheet1!A:Z',
+			keyRowIndex: 0,
+			dataStartRowIndex: 1,
+			valueRenderMode: 'UNFORMATTED_VALUE',
+			columnNamesList: [['id', 'name', 'email']],
+			columnValuesList: ['1'],
+		});
+	});
+});