refactor(core): Move curl endpoint to its own controller (no-changelog) (#9605)

packages/cli/src/ResponseHelper.ts

@@ -167,13 +167,3 @@ export function send<T, R extends Request, S extends Response>(
 		}
 	};
 }
-
-export const flattenObject = (obj: { [x: string]: any }, prefix = '') =>
-	Object.keys(obj).reduce((acc, k) => {
-		const pre = prefix.length ? prefix + '.' : '';
-		// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-		if (typeof obj[k] === 'object') Object.assign(acc, flattenObject(obj[k], pre + k));
-		//@ts-ignore
-		else acc[pre + k] = obj[k];
-		return acc;
-	}, {});

packages/cli/src/Server.ts

@@ -22,10 +22,11 @@ import { Queue } from '@/Queue';
 import { WorkflowsController } from '@/workflows/workflows.controller';
 import { EDITOR_UI_DIST_DIR, inDevelopment, inE2ETests, N8N_VERSION, Time } from '@/constants';
 import { CredentialsController } from '@/credentials/credentials.controller';
-import type { APIRequest, CurlHelper } from '@/requests';
+import type { APIRequest } from '@/requests';
 import { registerController } from '@/decorators';
 import { AuthController } from '@/controllers/auth.controller';
 import { BinaryDataController } from '@/controllers/binaryData.controller';
+import { CurlController } from '@/controllers/curl.controller';
 import { DynamicNodeParametersController } from '@/controllers/dynamicNodeParameters.controller';
 import { MeController } from '@/controllers/me.controller';
 import { MFAController } from '@/controllers/mfa.controller';
@@ -45,7 +46,6 @@ import type { ICredentialsOverwrite } from '@/Interfaces';
 import { CredentialsOverwrites } from '@/CredentialsOverwrites';
 import { LoadNodesAndCredentials } from '@/LoadNodesAndCredentials';
 import * as ResponseHelper from '@/ResponseHelper';
-import { toHttpNodeParameters } from '@/CurlConverterHelper';
 import { EventBusController } from '@/eventbus/eventBus.controller';
 import { EventBusControllerEE } from '@/eventbus/eventBus.controller.ee';
 import { LicenseController } from '@/license/license.controller';
@@ -69,7 +69,6 @@ import { OrchestrationController } from './controllers/orchestration.controller'
 import { WorkflowHistoryController } from './workflows/workflowHistory/workflowHistory.controller.ee';
 import { InvitationController } from './controllers/invitation.controller';
 // import { CollaborationService } from './collaboration/collaboration.service';
-import { BadRequestError } from './errors/response-errors/bad-request.error';
 import { OrchestrationService } from '@/services/orchestration.service';
 import { ProjectController } from './controllers/project.controller';
 import { RoleController } from './controllers/role.controller';
@@ -150,6 +149,7 @@ export class Server extends AbstractServer {
 			AIController,
 			ProjectController,
 			RoleController,
+			CurlController,
 		];
 
 		if (
@@ -266,23 +266,6 @@ export class Server extends AbstractServer {
 			this.logger.warn(`Source Control initialization failed: ${error.message}`);
 		}
 
-		// ----------------------------------------
-		// curl-converter
-		// ----------------------------------------
-		this.app.post(
-			`/${this.restEndpoint}/curl-to-json`,
-			ResponseHelper.send(async (req: CurlHelper.ToJson) => {
-				const curlCommand = req.body.curlCommand ?? '';
-
-				try {
-					const parameters = toHttpNodeParameters(curlCommand);
-					return ResponseHelper.flattenObject(parameters, 'parameters');
-				} catch (e) {
-					throw new BadRequestError('Invalid cURL command');
-				}
-			}),
-		);
-
 		// ----------------------------------------
 		// Options
 		// ----------------------------------------

packages/cli/src/controllers/curl.controller.ts

@@ -0,0 +1,19 @@
+import { Request } from 'express';
+import { Post, RestController } from '@/decorators';
+import { BadRequestError } from '@/errors/response-errors/bad-request.error';
+import { CurlService, flattenObject } from '@/services/curl.service';
+
+@RestController('/curl')
+export class CurlController {
+	constructor(private readonly curlService: CurlService) {}
+
+	@Post('/to-json')
+	toJson(req: Request<{}, {}, { curlCommand: string }>) {
+		try {
+			const parameters = this.curlService.toHttpNodeParameters(req.body.curlCommand);
+			return flattenObject(parameters, 'parameters');
+		} catch (e) {
+			throw new BadRequestError('Invalid cURL command');
+		}
+	}
+}

packages/cli/src/requests.ts

@@ -456,14 +456,6 @@ export declare namespace NodeRequest {
 	type Update = Post;
 }
 
-// ----------------------------------
-//           /curl-to-json
-// ----------------------------------
-
-export declare namespace CurlHelper {
-	type ToJson = AuthenticatedRequest<{}, {}, { curlCommand?: string }>;
-}
-
 // ----------------------------------
 //           /license
 // ----------------------------------

packages/cli/src/services/curl.service.ts

@@ -1,3 +1,4 @@
+import { Service } from 'typedi';
 import curlconverter from 'curlconverter';
 import get from 'lodash/get';
 import type { IDataObject } from 'n8n-workflow';
@@ -35,7 +36,7 @@ interface Parameter {
 	value: string;
 }
 
-export interface HttpNodeParameters {
+interface HttpNodeParameters {
 	url?: string;
 	method: string;
 	sendBody?: boolean;
@@ -109,10 +110,6 @@ const DOWNLOAD_FILE_FLAGS = ['-O', '-o'];
 
 const IGNORE_SSL_ISSUES_FLAGS = ['-k', '--insecure'];
 
-const curlToJson = (curlCommand: string): CurlJson => {
-	return jsonParse(curlconverter.toJsonString(curlCommand));
-};
-
 const isContentType = (headers: CurlJson['headers'], contentType: ContentTypes): boolean => {
 	return get(headers, CONTENT_TYPE_KEY) === contentType;
 };
@@ -154,7 +151,7 @@ const isBinaryRequest = (curlJson: CurlJson): boolean => {
 	return false;
 };
 
-const sanatizeCurlCommand = (curlCommand: string) =>
+const sanitizeCurlCommand = (curlCommand: string) =>
 	curlCommand
 		.replace(/\r\n/g, ' ')
 		.replace(/\n/g, ' ')
@@ -262,9 +259,22 @@ const mapCookies = (cookies: CurlJson['cookies']): { cookie: string } | {} => {
 	};
 };
 
+export const flattenObject = (obj: { [x: string]: any }, prefix = '') =>
+	Object.keys(obj).reduce((acc, k) => {
+		const pre = prefix.length ? prefix + '.' : '';
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+		if (typeof obj[k] === 'object') Object.assign(acc, flattenObject(obj[k], pre + k));
+		//@ts-ignore
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+		else acc[pre + k] = obj[k];
+		return acc;
+	}, {});
+
+@Service()
+export class CurlService {
 	// eslint-disable-next-line complexity
-export const toHttpNodeParameters = (curlCommand: string): HttpNodeParameters => {
-	const curlJson = curlToJson(curlCommand);
+	toHttpNodeParameters(curlCommand: string): HttpNodeParameters {
+		const curlJson = jsonParse<CurlJson>(curlconverter.toJsonString(curlCommand));
 
 		if (!curlJson.headers) curlJson.headers = {};
 
@@ -295,7 +305,7 @@ export const toHttpNodeParameters = (curlCommand: string): HttpNodeParameters =>
 		};
 
 		//attempt to get the curl flags not supported by the library
-	const curl = sanatizeCurlCommand(curlCommand);
+		const curl = sanitizeCurlCommand(curlCommand);
 
 		//check for follow redirect flags
 		if (FOLLOW_REDIRECT_FLAGS.some((flag) => curl.includes(` ${flag}`))) {
@@ -464,4 +474,5 @@ export const toHttpNodeParameters = (curlCommand: string): HttpNodeParameters =>
 		}
 
 		return httpNodeParameters;
-};
+	}
+}

packages/cli/test/unit/controllers/curl.controller.test.ts

@@ -0,0 +1,51 @@
+import type { Request } from 'express';
+import { mock } from 'jest-mock-extended';
+import { BadRequestError } from '@/errors/response-errors/bad-request.error';
+import { CurlController } from '@/controllers/curl.controller';
+import type { CurlService } from '@/services/curl.service';
+
+describe('CurlController', () => {
+	const service = mock<CurlService>();
+	const controller = new CurlController(service);
+
+	beforeEach(() => jest.clearAllMocks());
+
+	describe('toJson', () => {
+		it('should throw BadRequestError when invalid cURL command is provided', () => {
+			const req = mock<Request>();
+			service.toHttpNodeParameters.mockImplementation(() => {
+				throw new Error();
+			});
+
+			expect(() => controller.toJson(req)).toThrow(BadRequestError);
+		});
+
+		it('should return flattened parameters when valid cURL command is provided', () => {
+			const curlCommand = 'curl -v -X GET https://test.n8n.berlin/users';
+			const req = mock<Request>();
+			req.body = { curlCommand };
+			service.toHttpNodeParameters.mockReturnValue({
+				url: 'https://test.n8n.berlin/users',
+				authentication: 'none',
+				method: 'GET',
+				sendHeaders: false,
+				sendQuery: false,
+				options: {
+					redirect: { redirect: {} },
+					response: { response: {} },
+				},
+				sendBody: false,
+			});
+
+			const result = controller.toJson(req);
+			expect(result).toEqual({
+				'parameters.method': 'GET',
+				'parameters.url': 'https://test.n8n.berlin/users',
+				'parameters.authentication': 'none',
+				'parameters.sendBody': false,
+				'parameters.sendHeaders': false,
+				'parameters.sendQuery': false,
+			});
+		});
+	});
+});

packages/cli/test/unit/services/curl.service.test.ts

@@ -1,10 +1,12 @@
-import { toHttpNodeParameters } from '@/CurlConverterHelper';
+import { CurlService } from '@/services/curl.service';
+
+describe('CurlService', () => {
+	const service = new CurlService();
 
-describe('CurlConverterHelper', () => {
 	test('Should parse form-urlencoded content type correctly', () => {
 		const curl =
 			'curl -X POST https://reqbin.com/echo/post/form -H "Content-Type: application/x-www-form-urlencoded" -d "param1=value1&param2=value2"';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo/post/form');
 		expect(parameters.sendBody).toBe(true);
 		expect(parameters.bodyParameters?.parameters[0].name).toBe('param1');
@@ -19,7 +21,7 @@ describe('CurlConverterHelper', () => {
 	test('Should parse JSON content type correctly', () => {
 		const curl =
 			'curl -X POST https://reqbin.com/echo/post/json -H \'Content-Type: application/json\' -d \'{"login":"my_login","password":"my_password"}\'';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo/post/json');
 		expect(parameters.sendBody).toBe(true);
 		expect(parameters.bodyParameters?.parameters[0].name).toBe('login');
@@ -34,7 +36,7 @@ describe('CurlConverterHelper', () => {
 	test('Should parse multipart-form-data content type correctly', () => {
 		const curl =
 			'curl -X POST https://reqbin.com/echo/post/json -v -F key1=value1 -F upload=@localfilename';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo/post/json');
 		expect(parameters.sendBody).toBe(true);
 		expect(parameters.bodyParameters?.parameters[0].parameterType).toBe('formData');
@@ -50,7 +52,7 @@ describe('CurlConverterHelper', () => {
 	test('Should parse binary request correctly', () => {
 		const curl =
 			"curl --location --request POST 'https://www.website.com' --header 'Content-Type: image/png' --data-binary '@/Users/image.png";
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://www.website.com');
 		expect(parameters.method).toBe('POST');
 		expect(parameters.sendBody).toBe(true);
@@ -64,7 +66,7 @@ describe('CurlConverterHelper', () => {
 		-H "Content-Type: application/xml"
 		-H "Accept: application/xml"
 		-d "<Request><Login>my_login</Login><Password>my_password</Password></Request>"`;
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo/post/xml');
 		expect(parameters.method).toBe('POST');
 		expect(parameters.sendBody).toBe(true);
@@ -79,7 +81,7 @@ describe('CurlConverterHelper', () => {
 	test('Should parse header properties and keep the original case', () => {
 		const curl =
 			'curl -X POST https://reqbin.com/echo/post/json -v -F key1=value1 -F upload=@localfilename -H "ACCEPT: text/javascript" -H "content-type: multipart/form-data"';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo/post/json');
 		expect(parameters.sendBody).toBe(true);
 		expect(parameters.bodyParameters?.parameters[0].parameterType).toBe('formData');
@@ -96,7 +98,7 @@ describe('CurlConverterHelper', () => {
 
 	test('Should parse querystring properties', () => {
 		const curl = "curl -G -d 'q=kitties' -d 'count=20' https://google.com/search";
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://google.com/search');
 		expect(parameters.sendBody).toBe(false);
 		expect(parameters.contentType).toBeUndefined();
@@ -110,7 +112,7 @@ describe('CurlConverterHelper', () => {
 
 	test('Should parse basic authentication property and keep the original case', () => {
 		const curl = 'curl https://reqbin.com/echo -u "login:password"';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.sendBody).toBe(false);
 		expect(parameters.contentType).toBeUndefined();
@@ -124,7 +126,7 @@ describe('CurlConverterHelper', () => {
 
 	test('Should parse location flag with --location', () => {
 		const curl = 'curl https://reqbin.com/echo -u "login:password" --location';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.sendBody).toBe(false);
 		expect(parameters.contentType).toBeUndefined();
@@ -139,7 +141,7 @@ describe('CurlConverterHelper', () => {
 
 	test('Should parse location flag with --L', () => {
 		const curl = 'curl https://reqbin.com/echo -u "login:password" -L';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.sendBody).toBe(false);
 		expect(parameters.contentType).toBeUndefined();
@@ -154,7 +156,7 @@ describe('CurlConverterHelper', () => {
 
 	test('Should parse location and max redirects flags with --location and --max-redirs 10', () => {
 		const curl = 'curl https://reqbin.com/echo -u "login:password" --location --max-redirs 10';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.sendBody).toBe(false);
 		expect(parameters.contentType).toBeUndefined();
@@ -170,7 +172,7 @@ describe('CurlConverterHelper', () => {
 
 	test('Should parse proxy flag -x', () => {
 		const curl = 'curl https://reqbin.com/echo -u "login:password" -x https://google.com';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.sendBody).toBe(false);
 		expect(parameters.contentType).toBeUndefined();
@@ -185,7 +187,7 @@ describe('CurlConverterHelper', () => {
 
 	test('Should parse proxy flag --proxy', () => {
 		const curl = 'curl https://reqbin.com/echo -u "login:password" -x https://google.com';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.sendBody).toBe(false);
 		expect(parameters.contentType).toBeUndefined();
@@ -200,7 +202,7 @@ describe('CurlConverterHelper', () => {
 
 	test('Should parse include headers on output flag --include', () => {
 		const curl = 'curl https://reqbin.com/echo -u "login:password" --include -x https://google.com';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.sendBody).toBe(false);
 		expect(parameters.contentType).toBeUndefined();
@@ -215,7 +217,7 @@ describe('CurlConverterHelper', () => {
 
 	test('Should parse include headers on output flag -i', () => {
 		const curl = 'curl https://reqbin.com/echo -u "login:password" -x https://google.com -i';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.sendBody).toBe(false);
 		expect(parameters.contentType).toBeUndefined();
@@ -230,7 +232,7 @@ describe('CurlConverterHelper', () => {
 
 	test('Should parse include request flag -X', () => {
 		const curl = 'curl -X POST https://reqbin.com/echo -u "login:password" -x https://google.com';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.method).toBe('POST');
 		expect(parameters.sendBody).toBe(false);
@@ -239,7 +241,7 @@ describe('CurlConverterHelper', () => {
 	test('Should parse include request flag --request', () => {
 		const curl =
 			'curl --request POST https://reqbin.com/echo -u "login:password" -x https://google.com';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.method).toBe('POST');
 		expect(parameters.sendBody).toBe(false);
@@ -248,7 +250,7 @@ describe('CurlConverterHelper', () => {
 	test('Should parse include timeout flag --connect-timeout', () => {
 		const curl =
 			'curl --request POST https://reqbin.com/echo -u "login:password" --connect-timeout 20';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.method).toBe('POST');
 		expect(parameters.sendBody).toBe(false);
@@ -257,7 +259,7 @@ describe('CurlConverterHelper', () => {
 
 	test('Should parse download file flag -O', () => {
 		const curl = 'curl --request POST https://reqbin.com/echo -u "login:password" -O';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.method).toBe('POST');
 		expect(parameters.sendBody).toBe(false);
@@ -267,7 +269,7 @@ describe('CurlConverterHelper', () => {
 
 	test('Should parse download file flag -o', () => {
 		const curl = 'curl --request POST https://reqbin.com/echo -u "login:password" -o';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.method).toBe('POST');
 		expect(parameters.sendBody).toBe(false);
@@ -277,7 +279,7 @@ describe('CurlConverterHelper', () => {
 
 	test('Should parse ignore SSL flag -k', () => {
 		const curl = 'curl --request POST https://reqbin.com/echo -u "login:password" -k';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.method).toBe('POST');
 		expect(parameters.sendBody).toBe(false);
@@ -286,7 +288,7 @@ describe('CurlConverterHelper', () => {
 
 	test('Should parse ignore SSL flag --insecure', () => {
 		const curl = 'curl --request POST https://reqbin.com/echo -u "login:password" --insecure';
-		const parameters = toHttpNodeParameters(curl);
+		const parameters = service.toHttpNodeParameters(curl);
 		expect(parameters.url).toBe('https://reqbin.com/echo');
 		expect(parameters.method).toBe('POST');
 		expect(parameters.sendBody).toBe(false);

packages/editor-ui/src/api/curlHelper.ts

@@ -5,5 +5,5 @@ export async function getCurlToJson(
 	context: IRestApiContext,
 	curlCommand: string,
 ): Promise<CurlToJSONResponse> {
-	return await makeRestApiRequest(context, 'POST', '/curl-to-json', { curlCommand });
+	return await makeRestApiRequest(context, 'POST', '/curl/to-json', { curlCommand });
 }