fix(Microsoft Excel 365 Node): Better error and description on unsupported range in upsert, update, getRange operations (#8452)

packages/nodes-base/nodes/Microsoft/Excel/test/v2/utils/utils.test.ts

@@ -3,6 +3,7 @@ import { mock } from 'jest-mock-extended';
 import type { IDataObject, IExecuteFunctions, IGetNodeParameterOptions, INode } from 'n8n-workflow';
 import { constructExecutionMetaData } from 'n8n-core';
 import {
+	checkRange,
 	prepareOutput,
 	updateByAutoMaping,
 	updateByDefinedValues,
@@ -491,7 +492,7 @@ describe('Test MicrosoftExcelV2, updateByAutoMaping', () => {
 		expect(updateSummary.updatedData[4][1]).toEqual('Ismael'); // updated value
 	});
 
-	it('should update all occurances', () => {
+	it('should update all occurrences', () => {
 		const items = [
 			{
 				json: {
@@ -556,3 +557,19 @@ describe('Test MicrosoftExcelV2, updateByAutoMaping', () => {
 		expect(updateSummary.appendData[1]).toEqual({ id: 5, name: 'Victor', age: 67, data: 'data 5' });
 	});
 });
+
+describe('Test MicrosoftExcelV2, checkRange', () => {
+	it('should not throw error', () => {
+		const range = 'A1:D4';
+		expect(() => {
+			checkRange(node, range);
+		}).not.toThrow();
+	});
+
+	it('should throw error', () => {
+		const range = 'A:D';
+		expect(() => {
+			checkRange(node, range);
+		}).toThrow();
+	});
+});

packages/nodes-base/nodes/Microsoft/Excel/v2/actions/worksheet/readRows.operation.ts

@@ -5,7 +5,7 @@ import type {
 	INodeProperties,
 } from 'n8n-workflow';
 import type { ExcelResponse } from '../../helpers/interfaces';
-import { prepareOutput } from '../../helpers/utils';
+import { checkRange, prepareOutput } from '../../helpers/utils';
 import { microsoftApiRequest } from '../../transport';
 import { workbookRLC, worksheetRLC } from '../common.descriptions';
 import { updateDisplayOptions } from '@utils/utilities';
@@ -25,7 +25,8 @@ const properties: INodeProperties[] = [
 		type: 'string',
 		placeholder: 'e.g. A1:B2',
 		default: '',
-		description: 'The sheet range to read the data from specified using a A1-style notation',
+		description:
+			'The sheet range to read the data from specified using a A1-style notation, has to be specific e.g A1:B5, generic ranges like A:B are not supported',
 		hint: 'Leave blank to return entire sheet',
 		displayOptions: {
 			show: {
@@ -140,6 +141,7 @@ export async function execute(
 			const options = this.getNodeParameter('options', i, {});
 
 			const range = this.getNodeParameter('range', i, '') as string;
+			checkRange(this.getNode(), range);
 
 			const rawData = (options.rawData as boolean) || false;
 

packages/nodes-base/nodes/Microsoft/Excel/v2/actions/worksheet/update.operation.ts

@@ -6,7 +6,12 @@ import type {
 } from 'n8n-workflow';
 import { NodeOperationError } from 'n8n-workflow';
 import type { ExcelResponse, UpdateSummary } from '../../helpers/interfaces';
-import { prepareOutput, updateByAutoMaping, updateByDefinedValues } from '../../helpers/utils';
+import {
+	checkRange,
+	prepareOutput,
+	updateByAutoMaping,
+	updateByDefinedValues,
+} from '../../helpers/utils';
 import { microsoftApiRequest } from '../../transport';
 import { workbookRLC, worksheetRLC } from '../common.descriptions';
 import { generatePairedItemData, processJsonInput, updateDisplayOptions } from '@utils/utilities';
@@ -33,7 +38,7 @@ const properties: INodeProperties[] = [
 		placeholder: 'e.g. A1:B2',
 		default: '',
 		description:
-			'The sheet range to read the data from specified using a A1-style notation. Leave blank to use whole used range in the sheet.',
+			'The sheet range to read the data from specified using a A1-style notation, has to be specific e.g A1:B5, generic ranges like A:B are not supported. Leave blank to use whole used range in the sheet.',
 		hint: 'First row must contain column names',
 	},
 	{
@@ -254,6 +259,8 @@ export async function execute(
 		}) as string;
 
 		let range = this.getNodeParameter('range', 0, '') as string;
+		checkRange(this.getNode(), range);
+
 		const dataMode = this.getNodeParameter('dataMode', 0) as string;
 
 		let worksheetData: IDataObject = {};

packages/nodes-base/nodes/Microsoft/Excel/v2/actions/worksheet/upsert.operation.ts

@@ -6,7 +6,12 @@ import type {
 } from 'n8n-workflow';
 import { NodeOperationError } from 'n8n-workflow';
 import type { ExcelResponse, UpdateSummary } from '../../helpers/interfaces';
-import { prepareOutput, updateByAutoMaping, updateByDefinedValues } from '../../helpers/utils';
+import {
+	checkRange,
+	prepareOutput,
+	updateByAutoMaping,
+	updateByDefinedValues,
+} from '../../helpers/utils';
 import { microsoftApiRequest } from '../../transport';
 import { workbookRLC, worksheetRLC } from '../common.descriptions';
 import { generatePairedItemData, processJsonInput, updateDisplayOptions } from '@utils/utilities';
@@ -33,7 +38,7 @@ const properties: INodeProperties[] = [
 		placeholder: 'e.g. A1:B2',
 		default: '',
 		description:
-			'The sheet range to read the data from specified using a A1-style notation. Leave blank to use whole used range in the sheet.',
+			'The sheet range to read the data from specified using a A1-style notation, has to be specific e.g A1:B5, generic ranges like A:B are not supported. Leave blank to use whole used range in the sheet.',
 		hint: 'First row must contain column names',
 	},
 	{
@@ -191,6 +196,8 @@ export async function execute(
 		}) as string;
 
 		let range = this.getNodeParameter('range', 0, '') as string;
+		checkRange(this.getNode(), range);
+
 		const dataMode = this.getNodeParameter('dataMode', 0) as string;
 
 		let worksheetData: IDataObject = {};

packages/nodes-base/nodes/Microsoft/Excel/v2/helpers/utils.ts

@@ -206,3 +206,14 @@ export function updateByAutoMaping(
 
 	return summary;
 }
+
+export const checkRange = (node: INode, range: string) => {
+	const rangeRegex = /^[A-Z]+:[A-Z]+$/i;
+
+	if (rangeRegex.test(range)) {
+		throw new NodeOperationError(
+			node,
+			`Specify the range more precisely e.g. A1:B5, generic ranges like ${range} are not supported`,
+		);
+	}
+};