refactor: Enable import/order rule for n8n-core (n8n-io#11016)

alimahdavihormat · Sep 30, 2024 · d2238b9 · d2238b9
1 parent e54a396
commit d2238b9
Show file tree

Hide file tree

Showing 48 changed files with 125 additions and 95 deletions.
diff --git a/packages/core/.eslintrc.js b/packages/core/.eslintrc.js
@@ -18,7 +18,6 @@ module.exports = {
 		complexity: 'error',
 
 		// TODO: Remove this
-		'import/order': 'off',
 		'@typescript-eslint/ban-ts-comment': ['error', { 'ts-ignore': true }],
 	},
 };
diff --git a/packages/core/src/ActiveWorkflows.ts b/packages/core/src/ActiveWorkflows.ts
@@ -1,5 +1,3 @@
-import { Service } from 'typedi';
-
 import type {
 	IGetExecutePollFunctions,
 	IGetExecuteTriggerFunctions,
@@ -20,9 +18,10 @@ import {
 	WorkflowActivationError,
 	WorkflowDeactivationError,
 } from 'n8n-workflow';
+import { Service } from 'typedi';
 
-import { ScheduledTaskManager } from './ScheduledTaskManager';
 import type { IWorkflowData } from './Interfaces';
+import { ScheduledTaskManager } from './ScheduledTaskManager';
 
 @Service()
 export class ActiveWorkflows {

diff --git a/packages/core/src/BinaryData/BinaryData.service.ts b/packages/core/src/BinaryData/BinaryData.service.ts
@@ -1,14 +1,14 @@
+import { BINARY_ENCODING } from 'n8n-workflow';
+import type { INodeExecutionData, IBinaryData } from 'n8n-workflow';
 import { readFile, stat } from 'node:fs/promises';
 import prettyBytes from 'pretty-bytes';
+import type { Readable } from 'stream';
 import Container, { Service } from 'typedi';
-import { BINARY_ENCODING } from 'n8n-workflow';
-import { InvalidModeError } from '../errors/invalid-mode.error';
-import { areConfigModes, binaryToBuffer } from './utils';
 
-import type { Readable } from 'stream';
 import type { BinaryData } from './types';
-import type { INodeExecutionData, IBinaryData } from 'n8n-workflow';
+import { areConfigModes, binaryToBuffer } from './utils';
 import { InvalidManagerError } from '../errors/invalid-manager.error';
+import { InvalidModeError } from '../errors/invalid-mode.error';
 
 @Service()
 export class BinaryDataService {

diff --git a/packages/core/src/BinaryData/FileSystem.manager.ts b/packages/core/src/BinaryData/FileSystem.manager.ts
@@ -1,13 +1,13 @@
+import { jsonParse } from 'n8n-workflow';
 import { createReadStream } from 'node:fs';
 import fs from 'node:fs/promises';
 import path from 'node:path';
+import type { Readable } from 'stream';
 import { v4 as uuid } from 'uuid';
-import { jsonParse } from 'n8n-workflow';
-import { assertDir, doesNotExist } from './utils';
-import { DisallowedFilepathError } from '../errors/disallowed-filepath.error';
 
-import type { Readable } from 'stream';
 import type { BinaryData } from './types';
+import { assertDir, doesNotExist } from './utils';
+import { DisallowedFilepathError } from '../errors/disallowed-filepath.error';
 import { FileNotFoundError } from '../errors/file-not-found.error';
 
 const EXECUTION_ID_EXTRACTOR =

diff --git a/packages/core/src/BinaryData/ObjectStore.manager.ts b/packages/core/src/BinaryData/ObjectStore.manager.ts
@@ -1,11 +1,11 @@
 import fs from 'node:fs/promises';
+import type { Readable } from 'node:stream';
 import { Service } from 'typedi';
 import { v4 as uuid } from 'uuid';
-import { binaryToBuffer } from './utils';
-import { ObjectStoreService } from '../ObjectStore/ObjectStore.service.ee';
 
-import type { Readable } from 'node:stream';
 import type { BinaryData } from './types';
+import { binaryToBuffer } from './utils';
+import { ObjectStoreService } from '../ObjectStore/ObjectStore.service.ee';
 
 @Service()
 export class ObjectStoreManager implements BinaryData.Manager {

diff --git a/packages/core/src/BinaryData/utils.ts b/packages/core/src/BinaryData/utils.ts
@@ -1,7 +1,8 @@
+import concatStream from 'concat-stream';
 import fs from 'node:fs/promises';
 import type { Readable } from 'node:stream';
+
 import type { BinaryData } from './types';
-import concatStream from 'concat-stream';
 
 export const CONFIG_MODES = ['default', 'filesystem', 's3'] as const;
 

diff --git a/packages/core/src/Cipher.ts b/packages/core/src/Cipher.ts
@@ -1,5 +1,6 @@
-import { Service } from 'typedi';
 import { createHash, createCipheriv, createDecipheriv, randomBytes } from 'crypto';
+import { Service } from 'typedi';
+
 import { InstanceSettings } from './InstanceSettings';
 
 // Data encrypted by CryptoJS always starts with these bytes

diff --git a/packages/core/src/Credentials.ts b/packages/core/src/Credentials.ts
@@ -1,6 +1,7 @@
-import { Container } from 'typedi';
 import type { ICredentialDataDecryptedObject, ICredentialsEncrypted } from 'n8n-workflow';
 import { ApplicationError, ICredentials, jsonParse } from 'n8n-workflow';
+import { Container } from 'typedi';
+
 import { Cipher } from './Cipher';
 
 export class Credentials<

diff --git a/packages/core/src/DirectoryLoader.ts b/packages/core/src/DirectoryLoader.ts
@@ -1,6 +1,4 @@
 import glob from 'fast-glob';
-import { readFileSync } from 'node:fs';
-import { readFile } from 'node:fs/promises';
 import type {
 	CodexData,
 	DocumentationLink,
@@ -21,7 +19,10 @@ import {
 	getVersionedNodeTypeAll,
 	jsonParse,
 } from 'n8n-workflow';
+import { readFileSync } from 'node:fs';
+import { readFile } from 'node:fs/promises';
 import * as path from 'path';
+
 import { loadClassInIsolation } from './ClassLoader';
 import { CUSTOM_NODES_CATEGORY } from './Constants';
 import type { n8n } from './Interfaces';

diff --git a/packages/core/src/ExecutionMetadata.ts b/packages/core/src/ExecutionMetadata.ts
@@ -1,5 +1,6 @@
 import type { IRunExecutionData } from 'n8n-workflow';
 import { LoggerProxy as Logger } from 'n8n-workflow';
+
 import { InvalidExecutionMetadataError } from './errors/invalid-execution-metadata.error';
 
 export const KV_LIMIT = 10;

diff --git a/packages/core/src/InstanceSettings.ts b/packages/core/src/InstanceSettings.ts
@@ -1,8 +1,8 @@
-import path from 'path';
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
 import { createHash, randomBytes } from 'crypto';
-import { Service } from 'typedi';
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
 import { ApplicationError, jsonParse } from 'n8n-workflow';
+import path from 'path';
+import { Service } from 'typedi';
 
 interface ReadOnlySettings {
 	encryptionKey: string;

diff --git a/packages/core/src/NodeExecuteFunctions.ts b/packages/core/src/NodeExecuteFunctions.ts
@@ -32,6 +32,7 @@ import { IncomingMessage, type IncomingHttpHeaders } from 'http';
 import { Agent, type AgentOptions } from 'https';
 import get from 'lodash/get';
 import isEmpty from 'lodash/isEmpty';
+import merge from 'lodash/merge';
 import pick from 'lodash/pick';
 import { DateTime } from 'luxon';
 import { extension, lookup } from 'mime-types';
@@ -128,9 +129,12 @@ import clientOAuth1 from 'oauth-1.0a';
 import path from 'path';
 import { stringify } from 'qs';
 import { Readable } from 'stream';
+import Container from 'typedi';
 import url, { URL, URLSearchParams } from 'url';
 
 import { BinaryDataService } from './BinaryData/BinaryData.service';
+import type { BinaryData } from './BinaryData/types';
+import { binaryToBuffer } from './BinaryData/utils';
 import {
 	BINARY_DATA_STORAGE_PATH,
 	BLOCK_FILE_ACCESS_TO_N8N_FILES,
@@ -143,23 +147,19 @@ import {
 	UM_EMAIL_TEMPLATES_INVITE,
 	UM_EMAIL_TEMPLATES_PWRESET,
 } from './Constants';
-import { extractValue } from './ExtractValue';
-import type { ExtendedValidationResult, IResponseError } from './Interfaces';
+import { getNodeAsTool } from './CreateNodeAsTool';
 import {
 	getAllWorkflowExecutionMetadata,
 	getWorkflowExecutionMetadata,
 	setAllWorkflowExecutionMetadata,
 	setWorkflowExecutionMetadata,
 } from './ExecutionMetadata';
-import { getSecretsProxy } from './Secrets';
-import Container from 'typedi';
-import type { BinaryData } from './BinaryData/types';
-import merge from 'lodash/merge';
+import { extractValue } from './ExtractValue';
 import { InstanceSettings } from './InstanceSettings';
+import type { ExtendedValidationResult, IResponseError } from './Interfaces';
 import { ScheduledTaskManager } from './ScheduledTaskManager';
+import { getSecretsProxy } from './Secrets';
 import { SSHClientsManager } from './SSHClientsManager';
-import { binaryToBuffer } from './BinaryData/utils';
-import { getNodeAsTool } from './CreateNodeAsTool';
 
 axios.defaults.timeout = 300000;
 // Prevent axios from adding x-form-www-urlencoded headers by default

diff --git a/packages/core/src/ObjectStore/ObjectStore.service.ee.ts b/packages/core/src/ObjectStore/ObjectStore.service.ee.ts
@@ -1,12 +1,12 @@
-import { createHash } from 'node:crypto';
-import axios from 'axios';
-import { Service } from 'typedi';
 import { sign } from 'aws4';
-import { isStream, parseXml, writeBlockedMessage } from './utils';
+import type { Request as Aws4Options, Credentials as Aws4Credentials } from 'aws4';
+import axios from 'axios';
+import type { AxiosRequestConfig, AxiosResponse, InternalAxiosRequestConfig, Method } from 'axios';
 import { ApplicationError, LoggerProxy as Logger } from 'n8n-workflow';
+import { createHash } from 'node:crypto';
+import type { Readable } from 'stream';
+import { Service } from 'typedi';
 
-import type { AxiosRequestConfig, AxiosResponse, InternalAxiosRequestConfig, Method } from 'axios';
-import type { Request as Aws4Options, Credentials as Aws4Credentials } from 'aws4';
 import type {
 	Bucket,
 	ConfigSchemaCredentials,
@@ -15,7 +15,7 @@ import type {
 	RawListPage,
 	RequestOptions,
 } from './types';
-import type { Readable } from 'stream';
+import { isStream, parseXml, writeBlockedMessage } from './utils';
 import type { BinaryData } from '../BinaryData/types';
 
 @Service()

diff --git a/packages/core/src/ObjectStore/types.ts b/packages/core/src/ObjectStore/types.ts
@@ -1,4 +1,5 @@
 import type { AxiosResponseHeaders, ResponseType } from 'axios';
+
 import type { BinaryData } from '../BinaryData/types';
 
 export type RawListPage = {

diff --git a/packages/core/src/PartialExecutionUtils/__tests__/DirectedGraph.test.ts b/packages/core/src/PartialExecutionUtils/__tests__/DirectedGraph.test.ts
@@ -9,8 +9,8 @@
 // XX denotes that the node is disabled
 // PD denotes that the node has pinned data
 
-import { DirectedGraph } from '../DirectedGraph';
 import { createNodeData, defaultWorkflowParameter } from './helpers';
+import { DirectedGraph } from '../DirectedGraph';
 
 describe('DirectedGraph', () => {
 	//     ┌─────┐    ┌─────┐   ┌─────┐

diff --git a/packages/core/src/PartialExecutionUtils/__tests__/cleanRunData.test.ts b/packages/core/src/PartialExecutionUtils/__tests__/cleanRunData.test.ts
@@ -1,7 +1,8 @@
 import type { IRunData } from 'n8n-workflow';
+
+import { createNodeData, toITaskData } from './helpers';
 import { cleanRunData } from '../cleanRunData';
 import { DirectedGraph } from '../DirectedGraph';
-import { createNodeData, toITaskData } from './helpers';
 
 describe('cleanRunData', () => {
 	// ┌─────┐    ┌─────┐   ┌─────┐

diff --git a/packages/core/src/PartialExecutionUtils/__tests__/findStartNodes.test.ts b/packages/core/src/PartialExecutionUtils/__tests__/findStartNodes.test.ts
@@ -10,9 +10,10 @@
 // PD denotes that the node has pinned data
 
 import { type IPinData, type IRunData } from 'n8n-workflow';
+
 import { createNodeData, toITaskData } from './helpers';
-import { findStartNodes, isDirty } from '../findStartNodes';
 import { DirectedGraph } from '../DirectedGraph';
+import { findStartNodes, isDirty } from '../findStartNodes';
 
 describe('isDirty', () => {
 	test("if the node has pinned data it's not dirty", () => {

diff --git a/packages/core/src/PartialExecutionUtils/__tests__/findSubgraph.test.ts b/packages/core/src/PartialExecutionUtils/__tests__/findSubgraph.test.ts
@@ -9,9 +9,9 @@
 // XX denotes that the node is disabled
 // PD denotes that the node has pinned data
 
+import { createNodeData } from './helpers';
 import { DirectedGraph } from '../DirectedGraph';
 import { findSubgraph } from '../findSubgraph';
-import { createNodeData } from './helpers';
 
 describe('findSubgraph2', () => {
 	//                 ►►

diff --git a/packages/core/src/PartialExecutionUtils/__tests__/getSourceDataGroups.test.ts b/packages/core/src/PartialExecutionUtils/__tests__/getSourceDataGroups.test.ts
@@ -9,8 +9,9 @@
 
 import type { IPinData } from 'n8n-workflow';
 import { NodeConnectionType, type IRunData } from 'n8n-workflow';
-import { DirectedGraph } from '../DirectedGraph';
+
 import { createNodeData, toITaskData } from './helpers';
+import { DirectedGraph } from '../DirectedGraph';
 import { getSourceDataGroups } from '../getSourceDataGroups';
 
 describe('getSourceDataGroups', () => {

diff --git a/packages/core/src/PartialExecutionUtils/__tests__/recreateNodeExecutionStack.test.ts b/packages/core/src/PartialExecutionUtils/__tests__/recreateNodeExecutionStack.test.ts
@@ -9,12 +9,14 @@
 // XX denotes that the node is disabled
 // PD denotes that the node has pinned data
 
-import { recreateNodeExecutionStack } from '@/PartialExecutionUtils/recreateNodeExecutionStack';
-import { type IPinData, type IRunData } from 'n8n-workflow';
 import { AssertionError } from 'assert';
+import { type IPinData, type IRunData } from 'n8n-workflow';
+
+import { recreateNodeExecutionStack } from '@/PartialExecutionUtils/recreateNodeExecutionStack';
+
+import { createNodeData, toITaskData } from './helpers';
 import { DirectedGraph } from '../DirectedGraph';
 import { findSubgraph } from '../findSubgraph';
-import { createNodeData, toITaskData } from './helpers';
 
 describe('recreateNodeExecutionStack', () => {
 	//                   ►►

diff --git a/packages/core/src/PartialExecutionUtils/__tests__/toIConnections.test.ts b/packages/core/src/PartialExecutionUtils/__tests__/toIConnections.test.ts
@@ -1,4 +1,5 @@
 import { NodeConnectionType } from 'n8n-workflow';
+
 import { createNodeData, toIConnections } from './helpers';
 
 test('toIConnections', () => {

diff --git a/packages/core/src/PartialExecutionUtils/__tests__/toITaskData.test.ts b/packages/core/src/PartialExecutionUtils/__tests__/toITaskData.test.ts
@@ -1,4 +1,5 @@
 import { NodeConnectionType } from 'n8n-workflow';
+
 import { toITaskData } from './helpers';
 
 test('toITaskData', function () {

diff --git a/packages/core/src/PartialExecutionUtils/cleanRunData.ts b/packages/core/src/PartialExecutionUtils/cleanRunData.ts
@@ -1,4 +1,5 @@
 import type { INode, IRunData } from 'n8n-workflow';
+
 import type { DirectedGraph } from './DirectedGraph';
 
 /**

diff --git a/packages/core/src/PartialExecutionUtils/findStartNodes.ts b/packages/core/src/PartialExecutionUtils/findStartNodes.ts
@@ -1,4 +1,5 @@
 import type { INode, IPinData, IRunData } from 'n8n-workflow';
+
 import type { DirectedGraph } from './DirectedGraph';
 import { getIncomingData } from './getIncomingData';
 

diff --git a/packages/core/src/PartialExecutionUtils/findSubgraph.ts b/packages/core/src/PartialExecutionUtils/findSubgraph.ts
@@ -1,4 +1,5 @@
 import type { INode } from 'n8n-workflow';
+
 import type { GraphConnection } from './DirectedGraph';
 import { DirectedGraph } from './DirectedGraph';
 

diff --git a/packages/core/src/PartialExecutionUtils/findTriggerForPartialExecution.ts b/packages/core/src/PartialExecutionUtils/findTriggerForPartialExecution.ts
@@ -1,5 +1,5 @@
-import type { INode, Workflow } from 'n8n-workflow';
 import * as assert from 'assert/strict';
+import type { INode, Workflow } from 'n8n-workflow';
 
 function findAllParentTriggers(workflow: Workflow, destinationNodeName: string) {
 	const parentNodes = workflow

diff --git a/packages/core/src/PartialExecutionUtils/recreateNodeExecutionStack.ts b/packages/core/src/PartialExecutionUtils/recreateNodeExecutionStack.ts
@@ -1,3 +1,4 @@
+import * as a from 'assert/strict';
 import {
 	NodeConnectionType,
 	type IExecuteData,
@@ -11,7 +12,6 @@ import {
 	type IWaitingForExecutionSource,
 } from 'n8n-workflow';
 
-import * as a from 'assert/strict';
 import type { DirectedGraph } from './DirectedGraph';
 import { getIncomingData } from './getIncomingData';
 import { getSourceDataGroups } from './getSourceDataGroups';

diff --git a/packages/core/src/SSHClientsManager.ts b/packages/core/src/SSHClientsManager.ts
@@ -1,7 +1,7 @@
-import { Service } from 'typedi';
-import { Client, type ConnectConfig } from 'ssh2';
-import { createHash } from 'node:crypto';
 import type { SSHCredentials } from 'n8n-workflow';
+import { createHash } from 'node:crypto';
+import { Client, type ConnectConfig } from 'ssh2';
+import { Service } from 'typedi';
 
 @Service()
 export class SSHClientsManager {

diff --git a/packages/core/src/ScheduledTaskManager.ts b/packages/core/src/ScheduledTaskManager.ts
@@ -1,6 +1,7 @@
-import { Service } from 'typedi';
 import { CronJob } from 'cron';
 import type { CronExpression, Workflow } from 'n8n-workflow';
+import { Service } from 'typedi';
+
 import { InstanceSettings } from './InstanceSettings';
 
 @Service()