fix: Set '@typescript-eslint/return-await' rule to 'always' for node …

…code (no-changelog) (#8363)

Co-authored-by: कारतोफ्फेलस्क्रिप्ट™ <[email protected]>

packages/@n8n/nodes-langchain/nodes/agents/Agent/Agent.node.ts

@@ -252,15 +252,15 @@ export class Agent implements INodeType {
 		const agentType = this.getNodeParameter('agent', 0, '') as string;
 
 		if (agentType === 'conversationalAgent') {
-			return conversationalAgentExecute.call(this);
+			return await conversationalAgentExecute.call(this);
 		} else if (agentType === 'openAiFunctionsAgent') {
-			return openAiFunctionsAgentExecute.call(this);
+			return await openAiFunctionsAgentExecute.call(this);
 		} else if (agentType === 'reActAgent') {
-			return reActAgentAgentExecute.call(this);
+			return await reActAgentAgentExecute.call(this);
 		} else if (agentType === 'sqlAgent') {
-			return sqlAgentAgentExecute.call(this);
+			return await sqlAgentAgentExecute.call(this);
 		} else if (agentType === 'planAndExecuteAgent') {
-			return planAndExecuteAgentExecute.call(this);
+			return await planAndExecuteAgentExecute.call(this);
 		}
 
 		throw new NodeOperationError(this.getNode(), `The agent type "${agentType}" is not supported`);

packages/@n8n/nodes-langchain/nodes/agents/Agent/agents/ConversationalAgent/execute.ts

@@ -102,5 +102,5 @@ export async function conversationalAgentExecute(
 		returnData.push({ json: response });
 	}
 
-	return this.prepareOutputData(returnData);
+	return await this.prepareOutputData(returnData);
 }

packages/@n8n/nodes-langchain/nodes/agents/Agent/agents/OpenAiFunctionsAgent/execute.ts

@@ -101,5 +101,5 @@ export async function openAiFunctionsAgentExecute(
 		returnData.push({ json: response });
 	}
 
-	return this.prepareOutputData(returnData);
+	return await this.prepareOutputData(returnData);
 }

packages/@n8n/nodes-langchain/nodes/agents/Agent/agents/PlanAndExecuteAgent/execute.ts

@@ -76,5 +76,5 @@ export async function planAndExecuteAgentExecute(
 		returnData.push({ json: response });
 	}
 
-	return this.prepareOutputData(returnData);
+	return await this.prepareOutputData(returnData);
 }

packages/@n8n/nodes-langchain/nodes/agents/Agent/agents/ReActAgent/execute.ts

@@ -94,5 +94,5 @@ export async function reActAgentAgentExecute(
 		returnData.push({ json: response });
 	}
 
-	return this.prepareOutputData(returnData);
+	return await this.prepareOutputData(returnData);
 }

packages/@n8n/nodes-langchain/nodes/agents/Agent/agents/SqlAgent/execute.ts

@@ -101,5 +101,5 @@ export async function sqlAgentAgentExecute(
 		returnData.push({ json: response });
 	}
 
-	return this.prepareOutputData(returnData);
+	return await this.prepareOutputData(returnData);
 }

packages/@n8n/nodes-langchain/nodes/agents/OpenAiAssistant/OpenAiAssistant.node.ts

@@ -380,6 +380,6 @@ export class OpenAiAssistant implements INodeType {
 			returnData.push({ json: response });
 		}
 
-		return this.prepareOutputData(returnData);
+		return await this.prepareOutputData(returnData);
 	}
 }

packages/@n8n/nodes-langchain/nodes/chains/ChainLLM/ChainLlm.node.ts

@@ -166,7 +166,7 @@ async function getChain(
 
 	// If there are no output parsers, create a simple LLM chain and execute the query
 	if (!outputParsers.length) {
-		return createSimpleLLMChain(context, llm, query, chatTemplate);
+		return await createSimpleLLMChain(context, llm, query, chatTemplate);
 	}
 
 	// If there's only one output parser, use it; otherwise, create a combined output parser

packages/@n8n/nodes-langchain/nodes/chains/ChainRetrievalQA/ChainRetrievalQa.node.ts

@@ -126,6 +126,6 @@ export class ChainRetrievalQa implements INodeType {
 			const response = await chain.call({ query });
 			returnData.push({ json: { response } });
 		}
-		return this.prepareOutputData(returnData);
+		return await this.prepareOutputData(returnData);
 	}
 }

packages/@n8n/nodes-langchain/nodes/chains/ChainSummarization/V1/ChainSummarizationV1.node.ts

@@ -258,6 +258,6 @@ export class ChainSummarizationV1 implements INodeType {
 			returnData.push({ json: { response } });
 		}
 
-		return this.prepareOutputData(returnData);
+		return await this.prepareOutputData(returnData);
 	}
 }

packages/@n8n/nodes-langchain/nodes/chains/ChainSummarization/V2/ChainSummarizationV2.node.ts

@@ -415,6 +415,6 @@ export class ChainSummarizationV2 implements INodeType {
 			}
 		}
 
-		return this.prepareOutputData(returnData);
+		return await this.prepareOutputData(returnData);
 	}
 }

packages/@n8n/nodes-langchain/nodes/memory/MemoryChatRetriever/MemoryChatRetriever.node.ts

@@ -98,7 +98,7 @@ export class MemoryChatRetriever implements INodeType {
 		const messages = await memory?.chatHistory.getMessages();
 
 		if (simplifyOutput && messages) {
-			return this.prepareOutputData(simplifyMessages(messages));
+			return await this.prepareOutputData(simplifyMessages(messages));
 		}
 
 		const serializedMessages =
@@ -107,6 +107,6 @@ export class MemoryChatRetriever implements INodeType {
 				return { json: serializedMessage as unknown as IDataObject };
 			}) ?? [];
 
-		return this.prepareOutputData(serializedMessages);
+		return await this.prepareOutputData(serializedMessages);
 	}
 }

packages/@n8n/nodes-langchain/nodes/memory/MemoryManager/MemoryManager.node.ts

@@ -324,6 +324,6 @@ export class MemoryManager implements INodeType {
 			result.push(...executionData);
 		}
 
-		return this.prepareOutputData(result);
+		return await this.prepareOutputData(result);
 	}
 }

packages/@n8n/nodes-langchain/nodes/tools/ToolCode/ToolCode.node.ts

@@ -163,7 +163,7 @@ export class ToolCode implements INodeType {
 
 		const runFunction = async (query: string): Promise<string> => {
 			const sandbox = getSandbox(query, itemIndex);
-			return sandbox.runCode() as Promise<string>;
+			return await (sandbox.runCode() as Promise<string>);
 		};
 
 		return {

packages/@n8n/nodes-langchain/nodes/vector_store/VectorStoreInMemory/VectorStoreInMemory.node.ts

@@ -46,7 +46,7 @@ export const VectorStoreInMemory = createVectorStoreNode({
 		const memoryKey = context.getNodeParameter('memoryKey', itemIndex) as string;
 		const vectorStoreSingleton = MemoryVectorStoreManager.getInstance(embeddings);
 
-		return vectorStoreSingleton.getVectorStore(`${workflowId}__${memoryKey}`);
+		return await vectorStoreSingleton.getVectorStore(`${workflowId}__${memoryKey}`);
 	},
 	async populateVectorStore(context, embeddings, documents, itemIndex) {
 		const memoryKey = context.getNodeParameter('memoryKey', itemIndex) as string;

packages/@n8n/nodes-langchain/nodes/vector_store/VectorStoreInMemoryInsert/VectorStoreInMemoryInsert.node.ts

@@ -108,6 +108,6 @@ export class VectorStoreInMemoryInsert implements INodeType {
 			clearStore,
 		);
 
-		return this.prepareOutputData(serializedDocuments);
+		return await this.prepareOutputData(serializedDocuments);
 	}
 }

packages/@n8n/nodes-langchain/nodes/vector_store/VectorStorePinecone/VectorStorePinecone.node.ts

@@ -97,7 +97,7 @@ export const VectorStorePinecone = createVectorStoreNode({
 			filter,
 		};
 
-		return PineconeStore.fromExistingIndex(embeddings, config);
+		return await PineconeStore.fromExistingIndex(embeddings, config);
 	},
 	async populateVectorStore(context, embeddings, documents, itemIndex) {
 		const index = context.getNodeParameter('pineconeIndex', itemIndex, '', {

packages/@n8n/nodes-langchain/nodes/vector_store/VectorStorePineconeInsert/VectorStorePineconeInsert.node.ts

@@ -134,6 +134,6 @@ export class VectorStorePineconeInsert implements INodeType {
 			pineconeIndex,
 		});
 
-		return this.prepareOutputData(serializedDocuments);
+		return await this.prepareOutputData(serializedDocuments);
 	}
 }

packages/@n8n/nodes-langchain/nodes/vector_store/VectorStoreQdrant/VectorStoreQdrant.node.ts

@@ -59,7 +59,7 @@ export const VectorStoreQdrant = createVectorStoreNode({
 			collectionName: collection,
 		};
 
-		return QdrantVectorStore.fromExistingCollection(embeddings, config);
+		return await QdrantVectorStore.fromExistingCollection(embeddings, config);
 	},
 	async populateVectorStore(context, embeddings, documents, itemIndex) {
 		const collectionName = context.getNodeParameter('qdrantCollection', itemIndex, '', {

packages/@n8n/nodes-langchain/nodes/vector_store/VectorStoreSupabase/VectorStoreSupabase.node.ts

@@ -76,7 +76,7 @@ export const VectorStoreSupabase = createVectorStoreNode({
 		const credentials = await context.getCredentials('supabaseApi');
 		const client = createClient(credentials.host as string, credentials.serviceRole as string);
 
-		return SupabaseVectorStore.fromExistingIndex(embeddings, {
+		return await SupabaseVectorStore.fromExistingIndex(embeddings, {
 			client,
 			tableName,
 			queryName: options.queryName ?? 'match_documents',

packages/@n8n/nodes-langchain/nodes/vector_store/VectorStoreSupabaseInsert/VectorStoreSupabaseInsert.node.ts

@@ -122,6 +122,6 @@ export class VectorStoreSupabaseInsert implements INodeType {
 			queryName,
 		});
 
-		return this.prepareOutputData(serializedDocuments);
+		return await this.prepareOutputData(serializedDocuments);
 	}
 }

packages/@n8n/nodes-langchain/nodes/vector_store/VectorStoreZepInsert/VectorStoreZepInsert.node.ts

@@ -139,6 +139,6 @@ export class VectorStoreZepInsert implements INodeType {
 
 		await ZepVectorStore.fromDocuments(processedDocuments, embeddings, zepConfig);
 
-		return this.prepareOutputData(serializedDocuments);
+		return await this.prepareOutputData(serializedDocuments);
 	}
 }

packages/@n8n/nodes-langchain/nodes/vector_store/shared/createVectorStoreNode.ts

@@ -239,7 +239,7 @@ export const createVectorStoreNode = (args: VectorStoreNodeConstructorArgs) =>
 					resultData.push(...serializedDocs);
 				}
 
-				return this.prepareOutputData(resultData);
+				return await this.prepareOutputData(resultData);
 			}
 
 			if (mode === 'insert') {
@@ -267,7 +267,7 @@ export const createVectorStoreNode = (args: VectorStoreNodeConstructorArgs) =>
 					}
 				}
 
-				return this.prepareOutputData(resultData);
+				return await this.prepareOutputData(resultData);
 			}
 
 			throw new NodeOperationError(

packages/@n8n_io/eslint-config/node.js

@@ -8,4 +8,11 @@ module.exports = {
 		es6: true,
 		node: true,
 	},
+
+	rules: {
+		/**
+		 * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/return-await.md
+		 */
+		'@typescript-eslint/return-await': ['error', 'always'],
+	},
 };

packages/cli/src/AbstractServer.ts

@@ -208,7 +208,7 @@ export abstract class AbstractServer {
 			// TODO UM: check if this needs validation with user management.
 			this.app.delete(
 				`/${this.restEndpoint}/test-webhook/:id`,
-				send(async (req) => testWebhooks.cancelWebhook(req.params.id)),
+				send(async (req) => await testWebhooks.cancelWebhook(req.params.id)),
 			);
 		}
 

packages/cli/src/ActiveExecutions.ts

@@ -178,7 +178,7 @@ export class ActiveExecutions {
 			this.activeExecutions[executionId].workflowExecution!.cancel();
 		}
 
-		return this.getPostExecutePromise(executionId);
+		return await this.getPostExecutePromise(executionId);
 	}
 
 	/**
@@ -197,7 +197,7 @@ export class ActiveExecutions {
 
 		this.activeExecutions[executionId].postExecutePromises.push(waitPromise);
 
-		return waitPromise.promise();
+		return await waitPromise.promise();
 	}
 
 	/**

packages/cli/src/ActiveWebhooks.ts

@@ -30,7 +30,7 @@ export class ActiveWebhooks implements IWebhookManager {
 	) {}
 
 	async getWebhookMethods(path: string) {
-		return this.webhookService.getWebhookMethods(path);
+		return await this.webhookService.getWebhookMethods(path);
 	}
 
 	async findAccessControlOptions(path: string, httpMethod: IHttpRequestMethods) {
@@ -120,7 +120,7 @@ export class ActiveWebhooks implements IWebhookManager {
 			throw new NotFoundError('Could not find node to process webhook.');
 		}
 
-		return new Promise((resolve, reject) => {
+		return await new Promise((resolve, reject) => {
 			const executionMode = 'webhook';
 			void WebhookHelpers.executeWebhook(
 				workflow,

packages/cli/src/ActiveWorkflowRunner.ts

@@ -89,7 +89,7 @@ export class ActiveWorkflowRunner {
 	}
 
 	async getAllWorkflowActivationErrors() {
-		return this.activationErrorsService.getAll();
+		return await this.activationErrorsService.getAll();
 	}
 
 	/**
@@ -305,7 +305,7 @@ export class ActiveWorkflowRunner {
 		};
 
 		const workflowRunner = new WorkflowRunner();
-		return workflowRunner.run(runData, true, undefined, undefined, responsePromise);
+		return await workflowRunner.run(runData, true, undefined, undefined, responsePromise);
 	}
 
 	/**

packages/cli/src/CredentialsHelper.ts

@@ -121,7 +121,10 @@ export class CredentialsHelper extends ICredentialsHelper {
 			if (typeof credentialType.authenticate === 'function') {
 				// Special authentication function is defined
 
-				return credentialType.authenticate(credentials, requestOptions as IHttpRequestOptions);
+				return await credentialType.authenticate(
+					credentials,
+					requestOptions as IHttpRequestOptions,
+				);
 			}
 
 			if (typeof credentialType.authenticate === 'object') {

packages/cli/src/Db.ts

@@ -54,7 +54,7 @@ if (!inTest) {
 }
 
 export async function transaction<T>(fn: (entityManager: EntityManager) => Promise<T>): Promise<T> {
-	return connection.transaction(fn);
+	return await connection.transaction(fn);
 }
 
 export function getConnectionOptions(dbType: DatabaseType): ConnectionOptions {

packages/cli/src/ExternalSecrets/ExternalSecrets.controller.ee.ts

@@ -13,7 +13,7 @@ export class ExternalSecretsController {
 	@Get('/providers')
 	@RequireGlobalScope('externalSecretsProvider:list')
 	async getProviders() {
-		return this.secretsService.getProviders();
+		return await this.secretsService.getProviders();
 	}
 
 	@Get('/providers/:provider')

packages/cli/src/ExternalSecrets/ExternalSecrets.service.ee.ts

@@ -134,7 +134,7 @@ export class ExternalSecretsService {
 		}
 		const { settings } = providerAndSettings;
 		const newData = this.unredact(data, settings.settings);
-		return Container.get(ExternalSecretsManager).testProviderSettings(providerName, newData);
+		return await Container.get(ExternalSecretsManager).testProviderSettings(providerName, newData);
 	}
 
 	async updateProvider(providerName: string) {
@@ -143,6 +143,6 @@ export class ExternalSecretsService {
 		if (!providerAndSettings) {
 			throw new ExternalSecretsProviderNotFoundError(providerName);
 		}
-		return Container.get(ExternalSecretsManager).updateProvider(providerName);
+		return await Container.get(ExternalSecretsManager).updateProvider(providerName);
 	}
 }

packages/cli/src/ExternalSecrets/ExternalSecretsManager.ee.ts

@@ -48,10 +48,13 @@ export class ExternalSecretsManager {
 					this.initialized = true;
 					resolve();
 					this.initializingPromise = undefined;
-					this.updateInterval = setInterval(async () => this.updateSecrets(), updateIntervalTime());
+					this.updateInterval = setInterval(
+						async () => await this.updateSecrets(),
+						updateIntervalTime(),
+					);
 				});
 			}
-			return this.initializingPromise;
+			return await this.initializingPromise;
 		}
 	}
 
@@ -107,8 +110,8 @@ export class ExternalSecretsManager {
 		}
 		const providers: Array<SecretsProvider | null> = (
 			await Promise.allSettled(
-				Object.entries(settings).map(async ([name, providerSettings]) =>
-					this.initProvider(name, providerSettings),
+				Object.entries(settings).map(
+					async ([name, providerSettings]) => await this.initProvider(name, providerSettings),
 				),
 			)
 		).map((i) => (i.status === 'rejected' ? null : i.value));

packages/cli/src/ExternalSecrets/providers/vault.ts

@@ -436,7 +436,7 @@ export class VaultProvider extends SecretsProvider {
 				await Promise.allSettled(
 					listResp.data.data.keys.map(async (key): Promise<[string, IDataObject] | null> => {
 						if (key.endsWith('/')) {
-							return this.getKVSecrets(mountPath, kvVersion, path + key);
+							return await this.getKVSecrets(mountPath, kvVersion, path + key);
 						}
 						let secretPath = mountPath;
 						if (kvVersion === '2') {