Merge branch 'master' into ADO-2028-better-pin-data-error-messages

* master: refactor(core): Move curl endpoint to its own controller (no-changelog) (#9605) refactor(core): Restore test for execution pagination in Public API (no-changelog) (#9621) ci: Consistent tsconfig setup for backend packages and fix pnpm typecheck for composite packages (no-changelog) (#9604)
n8n-io · Jun 5, 2024 · 93e7f14 · 93e7f14
2 parents 51b68b1 + 1563bf5
commit 93e7f14
Show file tree

Hide file tree

Showing 38 changed files with 382 additions and 295 deletions.
diff --git a/.github/workflows/ci-pull-requests.yml b/.github/workflows/ci-pull-requests.yml
@@ -24,6 +24,9 @@ jobs:
       - name: Build
         run: pnpm build
 
+      - name: Run typecheck
+        run: pnpm typecheck
+
       - name: Cache build artifacts
         uses: actions/cache/save@v4.0.0
         with:

diff --git a/package.json b/package.json
@@ -13,7 +13,7 @@
     "build": "turbo run build",
     "build:backend": "pnpm --filter=!@n8n/chat --filter=!@n8n/codemirror-lang --filter=!n8n-design-system --filter=!n8n-editor-ui build",
     "build:frontend": "pnpm --filter=@n8n/chat --filter=@n8n/codemirror-lang --filter=n8n-design-system --filter=n8n-editor-ui build",
-    "typecheck": "turbo run typecheck",
+    "typecheck": "pnpm --filter=!@n8n/chat --filter=!@n8n/storybook --filter=!n8n-core --filter=!n8n-editor-ui --filter=!n8n-workflow --filter=!n8n typecheck",
     "dev": "turbo run dev --parallel --filter=!n8n-design-system --filter=!@n8n/chat",
     "dev:ai": "turbo run dev --parallel --filter=@n8n/nodes-langchain --filter=n8n --filter=n8n-core",
     "clean": "turbo run clean --parallel",
@@ -26,7 +26,7 @@
     "start:tunnel": "./packages/cli/bin/n8n start --tunnel",
     "start:windows": "cd packages/cli/bin && n8n",
     "test": "turbo run test",
-    "test:backend": "pnpm --filter=!@n8n/chat --filter=!@n8n/codemirror-lang --filter=!n8n-design-system --filter=!n8n-editor-ui  --filter=!n8n-nodes-base test --filter=!@n8n/n8n-nodes-langchain test",
+    "test:backend": "pnpm --filter=!@n8n/chat --filter=!@n8n/codemirror-lang --filter=!n8n-design-system --filter=!n8n-editor-ui --filter=!n8n-nodes-base --filter=!@n8n/n8n-nodes-langchain test",
     "test:nodes": "pnpm --filter=n8n-nodes-base --filter=@n8n/n8n-nodes-langchain test",
     "test:frontend": "pnpm --filter=@n8n/chat --filter=@n8n/codemirror-lang --filter=n8n-design-system --filter=n8n-editor-ui test",
     "watch": "turbo run watch --parallel",

diff --git a/packages/@n8n/client-oauth2/package.json b/packages/@n8n/client-oauth2/package.json
@@ -4,7 +4,7 @@
   "scripts": {
     "clean": "rimraf dist .turbo",
     "dev": "pnpm watch",
-    "typecheck": "tsc",
+    "typecheck": "tsc --noEmit",
     "build": "tsc -p tsconfig.build.json",
     "format": "prettier --write . --ignore-path ../../../.prettierignore",
     "lint": "eslint . --quiet",

diff --git a/packages/@n8n/client-oauth2/tsconfig.build.json b/packages/@n8n/client-oauth2/tsconfig.build.json
@@ -1,6 +1,7 @@
 {
 	"extends": ["./tsconfig.json", "../../../tsconfig.build.json"],
 	"compilerOptions": {
+		"composite": true,
 		"rootDir": "src",
 		"outDir": "dist",
 		"tsBuildInfoFile": "dist/build.tsbuildinfo"

diff --git a/packages/@n8n/client-oauth2/tsconfig.json b/packages/@n8n/client-oauth2/tsconfig.json
@@ -3,8 +3,6 @@
 	"compilerOptions": {
 		"rootDir": ".",
 		"types": ["node", "jest"],
-		"composite": true,
-		"noEmit": true,
 		"baseUrl": "src",
 		"paths": {
 			"@/*": ["./*"]

diff --git a/packages/@n8n/codemirror-lang/tsconfig.json b/packages/@n8n/codemirror-lang/tsconfig.json
@@ -2,8 +2,7 @@
 	"extends": "../../../tsconfig.json",
 	"compilerOptions": {
 		"rootDir": ".",
-		"tsBuildInfoFile": "dist/typecheck.tsbuildinfo",
-		"strict": true
+		"tsBuildInfoFile": "dist/typecheck.tsbuildinfo"
 	},
 	"include": ["src/**/*.ts", "test/**/*.ts"]
 }
diff --git a/packages/@n8n/imap/package.json b/packages/@n8n/imap/package.json
@@ -4,7 +4,7 @@
   "scripts": {
     "clean": "rimraf dist .turbo",
     "dev": "pnpm watch",
-    "typecheck": "tsc",
+    "typecheck": "tsc --noEmit",
     "build": "tsc -p tsconfig.build.json",
     "format": "prettier --write . --ignore-path ../../../.prettierignore",
     "lint": "eslint . --quiet",

diff --git a/packages/@n8n/imap/tsconfig.build.json b/packages/@n8n/imap/tsconfig.build.json
@@ -1,6 +1,7 @@
 {
 	"extends": ["./tsconfig.json", "../../../tsconfig.build.json"],
 	"compilerOptions": {
+		"composite": true,
 		"rootDir": "src",
 		"outDir": "dist",
 		"tsBuildInfoFile": "dist/build.tsbuildinfo"

diff --git a/packages/@n8n/imap/tsconfig.json b/packages/@n8n/imap/tsconfig.json
@@ -3,8 +3,6 @@
 	"compilerOptions": {
 		"rootDir": ".",
 		"types": ["node", "jest"],
-		"composite": true,
-		"noEmit": true,
 		"baseUrl": "src",
 		"tsBuildInfoFile": "dist/typecheck.tsbuildinfo"
 	},

diff --git a/packages/@n8n/nodes-langchain/package.json b/packages/@n8n/nodes-langchain/package.json
@@ -12,7 +12,7 @@
   "scripts": {
     "clean": "rimraf dist .turbo",
     "dev": "pnpm run watch",
-    "typecheck": "tsc",
+    "typecheck": "tsc --noEmit",
     "build": "tsc -p tsconfig.build.json && pnpm n8n-copy-icons && pnpm build:metadata",
     "build:metadata": "pnpm n8n-generate-known && pnpm n8n-generate-ui-types",
     "format": "prettier nodes credentials --write",

diff --git a/packages/@n8n/nodes-langchain/tsconfig.build.json b/packages/@n8n/nodes-langchain/tsconfig.build.json
@@ -1,9 +1,6 @@
 {
-	"extends": ["./tsconfig.json"],
+	"extends": ["./tsconfig.json", "../../../tsconfig.build.json"],
 	"compilerOptions": {
-		"types": ["node"],
-		"noEmit": false,
-		"declaration": true,
 		"outDir": "dist",
 		"tsBuildInfoFile": "dist/build.tsbuildinfo"
 	},

diff --git a/packages/@n8n/nodes-langchain/tsconfig.json b/packages/@n8n/nodes-langchain/tsconfig.json
@@ -1,24 +1,14 @@
 {
+	"extends": ["../../../tsconfig.json", "../../../tsconfig.backend.json"],
 	"compilerOptions": {
-		"strict": true,
-		"module": "commonjs",
-		"moduleResolution": "node",
-		"target": "es2019",
-		"lib": ["es2019", "es2020", "es2022.error"],
-		"removeComments": true,
-		"useUnknownInCatchVariables": false,
-		"forceConsistentCasingInFileNames": true,
-		"noImplicitAny": true,
-		"noImplicitReturns": true,
-		"strictNullChecks": true,
-		"preserveConstEnums": true,
-		"esModuleInterop": true,
-		"resolveJsonModule": true,
-		"incremental": true,
-		"declaration": true,
-		"sourceMap": true,
-		"skipLibCheck": true,
-		"outDir": "./dist/"
+		"lib": ["es2020", "es2022.error"],
+		"tsBuildInfoFile": "dist/typecheck.tsbuildinfo",
+		// TODO: remove all options below this line
+		"useUnknownInCatchVariables": false
 	},
-	"include": ["credentials/**/*", "nodes/**/*", "utils/**/*.ts", "nodes/**/*.json", "types/*.ts"]
+	"include": ["credentials/**/*", "nodes/**/*", "utils/**/*.ts", "nodes/**/*.json", "types/*.ts"],
+	"references": [
+		{ "path": "../../workflow/tsconfig.build.json" },
+		{ "path": "../../core/tsconfig.build.json" }
+	]
 }
diff --git a/packages/@n8n/permissions/package.json b/packages/@n8n/permissions/package.json
@@ -4,7 +4,7 @@
   "scripts": {
     "clean": "rimraf dist .turbo",
     "dev": "pnpm watch",
-    "typecheck": "tsc",
+    "typecheck": "tsc --noEmit",
     "build": "tsc -p tsconfig.build.json",
     "format": "prettier --write . --ignore-path ../../../.prettierignore",
     "lint": "eslint . --quiet",

diff --git a/packages/@n8n/permissions/tsconfig.build.json b/packages/@n8n/permissions/tsconfig.build.json
@@ -1,6 +1,7 @@
 {
 	"extends": ["./tsconfig.json", "../../../tsconfig.build.json"],
 	"compilerOptions": {
+		"composite": true,
 		"rootDir": "src",
 		"outDir": "dist",
 		"tsBuildInfoFile": "dist/build.tsbuildinfo"

diff --git a/packages/@n8n/permissions/tsconfig.json b/packages/@n8n/permissions/tsconfig.json
@@ -3,8 +3,6 @@
 	"compilerOptions": {
 		"rootDir": ".",
 		"types": ["node", "jest"],
-		"composite": true,
-		"noEmit": true,
 		"baseUrl": "src",
 		"paths": {
 			"@/*": ["./*"]

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -21,7 +21,7 @@
   },
   "scripts": {
     "clean": "rimraf dist .turbo",
-    "typecheck": "tsc",
+    "typecheck": "tsc --noEmit",
     "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json && node scripts/build.mjs",
     "buildAndDev": "pnpm run build && pnpm run dev",
     "dev": "concurrently -k -n \"TypeScript,Node\" -c \"yellow.bold,cyan.bold\" \"npm run watch\" \"nodemon\"",

diff --git a/packages/cli/src/ResponseHelper.ts b/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;
-	}, {});
diff --git a/packages/cli/src/Server.ts b/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
 		// ----------------------------------------

diff --git a/packages/cli/src/controllers/curl.controller.ts b/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');
+		}
+	}
+}
diff --git a/packages/cli/src/requests.ts b/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
 // ----------------------------------