ci: Expand ESLint to tests in BE packages (no-changelog) (#6147)

* 🔧 Adjust base ESLint config * 🔧 Adjust `lint` and `lintfix` in `nodes-base` * 🔧 Include `test` and `utils` in `nodes-base` * 📘 Convert JS tests to TS * 👕 Apply lintfixes
n8n-io · May 2, 2023 · 06fa6f1 · 06fa6f1
1 parent c63181b
commit 06fa6f1
Show file tree

Hide file tree

Showing 59 changed files with 389 additions and 306 deletions.
diff --git a/packages/@n8n_io/eslint-config/base.js b/packages/@n8n_io/eslint-config/base.js
@@ -6,9 +6,7 @@ const config = (module.exports = {
 		'node_modules/**',
 		'dist/**',
 		// TODO: remove these
-		'test/**',
-		'.eslintrc.js',
-		'jest.config.js',
+		'*.js',
 	],
 
 	plugins: [
@@ -452,6 +450,43 @@ const config = (module.exports = {
 				'@typescript-eslint/no-unused-vars': 'off',
 			},
 		},
+		{
+			files: ['test/**/*.ts'],
+			// TODO: Remove these
+			rules: {
+				'@typescript-eslint/await-thenable': 'off',
+				'@typescript-eslint/ban-ts-comment': 'off',
+				'@typescript-eslint/naming-convention': 'off',
+				'@typescript-eslint/no-duplicate-imports': 'off',
+				'@typescript-eslint/no-empty-function': 'off',
+				'@typescript-eslint/no-floating-promises': 'off',
+				'@typescript-eslint/no-loop-func': 'off',
+				'@typescript-eslint/no-non-null-assertion': 'off',
+				'@typescript-eslint/no-shadow': 'off',
+				'@typescript-eslint/no-throw-literal': 'off',
+				'@typescript-eslint/no-unsafe-argument': 'off',
+				'@typescript-eslint/no-unsafe-assignment': 'off',
+				'@typescript-eslint/no-unsafe-call': 'off',
+				'@typescript-eslint/no-unsafe-member-access': 'off',
+				'@typescript-eslint/no-unsafe-return': 'off',
+				'@typescript-eslint/no-unused-expressions': 'off',
+				'@typescript-eslint/no-unused-vars': 'off',
+				'@typescript-eslint/no-use-before-define': 'off',
+				'@typescript-eslint/no-var-requires': 'off',
+				'@typescript-eslint/prefer-nullish-coalescing': 'off',
+				'@typescript-eslint/prefer-optional-chain': 'off',
+				'@typescript-eslint/restrict-plus-operands': 'off',
+				'@typescript-eslint/restrict-template-expressions': 'off',
+				'@typescript-eslint/unbound-method': 'off',
+				'id-denylist': 'off',
+				'import/no-cycle': 'off',
+				'import/no-default-export': 'off',
+				'import/no-extraneous-dependencies': 'off',
+				'n8n-local-rules/no-uncaught-json-parse': 'off',
+				'prefer-const': 'off',
+				'prefer-spread': 'off',
+			},
+		},
 	],
 });
 

diff --git a/packages/cli/test/integration/commands/import.cmd.test.ts b/packages/cli/test/integration/commands/import.cmd.test.ts
@@ -25,7 +25,7 @@ test('import:workflow should import active workflow and deactivate it', async ()
 		['--separate', '--input=./test/integration/commands/importWorkflows/separate'],
 		config,
 	);
-	const mockExit = jest.spyOn(process, 'exit').mockImplementation((number) => {
+	const mockExit = jest.spyOn(process, 'exit').mockImplementation(() => {
 		throw new Error('process.exit');
 	});
 
@@ -52,7 +52,7 @@ test('import:workflow should import active workflow from combined file and deact
 		['--input=./test/integration/commands/importWorkflows/combined/combined.json'],
 		config,
 	);
-	const mockExit = jest.spyOn(process, 'exit').mockImplementation((number) => {
+	const mockExit = jest.spyOn(process, 'exit').mockImplementation(() => {
 		throw new Error('process.exit');
 	});
 

diff --git a/packages/cli/test/integration/credentials.ee.test.ts b/packages/cli/test/integration/credentials.ee.test.ts
@@ -415,7 +415,7 @@ describe('PUT /credentials/:id/share', () => {
 
 	test('should respond 403 for non-existing credentials', async () => {
 		const response = await authOwnerAgent
-			.put(`/credentials/1234567/share`)
+			.put('/credentials/1234567/share')
 			.send({ shareWithIds: [member.id] });
 
 		expect(response.statusCode).toBe(403);

diff --git a/packages/cli/test/integration/credentials.test.ts b/packages/cli/test/integration/credentials.test.ts
@@ -11,9 +11,8 @@ import type { Role } from '@db/entities/Role';
 import type { User } from '@db/entities/User';
 import { randomCredentialPayload, randomName, randomString } from './shared/random';
 import * as testDb from './shared/testDb';
-import type { SaveCredentialFunction } from './shared/types';
+import type { AuthAgent, SaveCredentialFunction } from './shared/types';
 import * as utils from './shared/utils';
-import type { AuthAgent } from './shared/types';
 
 // mock that credentialsSharing is not enabled
 const mockIsCredentialsSharingEnabled = jest.spyOn(UserManagementHelpers, 'isSharingEnabled');
@@ -124,7 +123,7 @@ describe('POST /credentials', () => {
 
 		expect(credential.name).toBe(payload.name);
 		expect(credential.type).toBe(payload.type);
-		expect(credential.nodesAccess[0].nodeType).toBe(payload.nodesAccess![0].nodeType);
+		expect(credential.nodesAccess[0].nodeType).toBe(payload.nodesAccess[0].nodeType);
 		expect(credential.data).not.toBe(payload.data);
 
 		const sharedCredential = await Db.collections.SharedCredentials.findOneOrFail({
@@ -278,7 +277,7 @@ describe('PATCH /credentials/:id', () => {
 
 		expect(credential.name).toBe(patchPayload.name);
 		expect(credential.type).toBe(patchPayload.type);
-		expect(credential.nodesAccess[0].nodeType).toBe(patchPayload.nodesAccess![0].nodeType);
+		expect(credential.nodesAccess[0].nodeType).toBe(patchPayload.nodesAccess[0].nodeType);
 		expect(credential.data).not.toBe(patchPayload.data);
 
 		const sharedCredential = await Db.collections.SharedCredentials.findOneOrFail({
@@ -315,7 +314,7 @@ describe('PATCH /credentials/:id', () => {
 
 		expect(credential.name).toBe(patchPayload.name);
 		expect(credential.type).toBe(patchPayload.type);
-		expect(credential.nodesAccess[0].nodeType).toBe(patchPayload.nodesAccess![0].nodeType);
+		expect(credential.nodesAccess[0].nodeType).toBe(patchPayload.nodesAccess[0].nodeType);
 		expect(credential.data).not.toBe(patchPayload.data);
 
 		const sharedCredential = await Db.collections.SharedCredentials.findOneOrFail({
@@ -352,7 +351,7 @@ describe('PATCH /credentials/:id', () => {
 
 		expect(credential.name).toBe(patchPayload.name);
 		expect(credential.type).toBe(patchPayload.type);
-		expect(credential.nodesAccess[0].nodeType).toBe(patchPayload.nodesAccess![0].nodeType);
+		expect(credential.nodesAccess[0].nodeType).toBe(patchPayload.nodesAccess[0].nodeType);
 		expect(credential.data).not.toBe(patchPayload.data);
 
 		const sharedCredential = await Db.collections.SharedCredentials.findOneOrFail({

diff --git a/packages/cli/test/integration/eventbus.test.ts b/packages/cli/test/integration/eventbus.test.ts
@@ -1,4 +1,4 @@
-import express from 'express';
+import type express from 'express';
 import config from '@/config';
 import axios from 'axios';
 import syslog from 'syslog-client';
@@ -7,23 +7,25 @@ import { Container } from 'typedi';
 import type { SuperAgentTest } from 'supertest';
 import * as utils from './shared/utils';
 import * as testDb from './shared/testDb';
-import { Role } from '@db/entities/Role';
-import { User } from '@db/entities/User';
+import type { Role } from '@db/entities/Role';
+import type { User } from '@db/entities/User';
+import type {
+	MessageEventBusDestinationSentryOptions,
+	MessageEventBusDestinationSyslogOptions,
+	MessageEventBusDestinationWebhookOptions,
+} from 'n8n-workflow';
 import {
 	defaultMessageEventBusDestinationSentryOptions,
 	defaultMessageEventBusDestinationSyslogOptions,
 	defaultMessageEventBusDestinationWebhookOptions,
-	MessageEventBusDestinationSentryOptions,
-	MessageEventBusDestinationSyslogOptions,
-	MessageEventBusDestinationWebhookOptions,
 } from 'n8n-workflow';
 import { eventBus } from '@/eventbus';
 import { EventMessageGeneric } from '@/eventbus/EventMessageClasses/EventMessageGeneric';
-import { MessageEventBusDestinationSyslog } from '@/eventbus/MessageEventBusDestination/MessageEventBusDestinationSyslog.ee';
-import { MessageEventBusDestinationWebhook } from '@/eventbus/MessageEventBusDestination/MessageEventBusDestinationWebhook.ee';
-import { MessageEventBusDestinationSentry } from '@/eventbus/MessageEventBusDestination/MessageEventBusDestinationSentry.ee';
+import type { MessageEventBusDestinationSyslog } from '@/eventbus/MessageEventBusDestination/MessageEventBusDestinationSyslog.ee';
+import type { MessageEventBusDestinationWebhook } from '@/eventbus/MessageEventBusDestination/MessageEventBusDestinationWebhook.ee';
+import type { MessageEventBusDestinationSentry } from '@/eventbus/MessageEventBusDestination/MessageEventBusDestinationSentry.ee';
 import { EventMessageAudit } from '@/eventbus/EventMessageClasses/EventMessageAudit';
-import { EventNamesTypes } from '@/eventbus/EventMessageClasses';
+import type { EventNamesTypes } from '@/eventbus/EventMessageClasses';
 import { License } from '@/License';
 
 jest.unmock('@/eventbus/MessageEventBus/MessageEventBus');
@@ -51,7 +53,7 @@ const testWebhookDestination: MessageEventBusDestinationWebhookOptions = {
 	...defaultMessageEventBusDestinationWebhookOptions,
 	id: '88be6560-bfb4-455c-8aa1-06971e9e5522',
 	url: 'http://localhost:3456',
-	method: `POST`,
+	method: 'POST',
 	label: 'Test Webhook',
 	enabled: false,
 	subscribedEvents: ['n8n.test.message', 'n8n.audit.user.updated'],

diff --git a/packages/cli/test/integration/ldap/ldap.api.test.ts b/packages/cli/test/integration/ldap/ldap.api.test.ts
@@ -1,4 +1,4 @@
-import express from 'express';
+import type express from 'express';
 import type { Entry as LdapUser } from 'ldapts';
 import { Not } from 'typeorm';
 import { Container } from 'typedi';

diff --git a/packages/cli/test/integration/license.api.test.ts b/packages/cli/test/integration/license.api.test.ts
@@ -1,7 +1,7 @@
 import type { SuperAgentTest } from 'supertest';
 import config from '@/config';
 import type { User } from '@db/entities/User';
-import { ILicensePostResponse, ILicenseReadResponse } from '@/Interfaces';
+import type { ILicensePostResponse, ILicenseReadResponse } from '@/Interfaces';
 import { License } from '@/License';
 import * as testDb from './shared/testDb';
 import * as utils from './shared/utils';

diff --git a/packages/cli/test/integration/passwordReset.api.test.ts b/packages/cli/test/integration/passwordReset.api.test.ts
@@ -23,7 +23,7 @@ let globalOwnerRole: Role;
 let globalMemberRole: Role;
 let owner: User;
 let authlessAgent: SuperAgentTest;
-let externalHooks = utils.mockInstance(ExternalHooks);
+const externalHooks = utils.mockInstance(ExternalHooks);
 
 beforeAll(async () => {
 	const app = await utils.initTestServer({ endpointGroups: ['passwordReset'] });

diff --git a/packages/cli/test/integration/publicApi/executions.test.ts b/packages/cli/test/integration/publicApi/executions.test.ts
@@ -213,7 +213,7 @@ describe('GET /executions', () => {
 
 		await testDb.createErrorExecution(workflow);
 
-		const response = await authOwnerAgent.get(`/executions`).query({
+		const response = await authOwnerAgent.get('/executions').query({
 			status: 'success',
 		});
 
@@ -254,7 +254,7 @@ describe('GET /executions', () => {
 
 		await testDb.createErrorExecution(workflow);
 
-		const firstExecutionResponse = await authOwnerAgent.get(`/executions`).query({
+		const firstExecutionResponse = await authOwnerAgent.get('/executions').query({
 			status: 'success',
 			limit: 1,
 		});
@@ -263,7 +263,7 @@ describe('GET /executions', () => {
 		expect(firstExecutionResponse.body.data.length).toBe(1);
 		expect(firstExecutionResponse.body.nextCursor).toBeDefined();
 
-		const secondExecutionResponse = await authOwnerAgent.get(`/executions`).query({
+		const secondExecutionResponse = await authOwnerAgent.get('/executions').query({
 			status: 'success',
 			limit: 1,
 			cursor: firstExecutionResponse.body.nextCursor,
@@ -308,7 +308,7 @@ describe('GET /executions', () => {
 
 		const errorExecution = await testDb.createErrorExecution(workflow);
 
-		const response = await authOwnerAgent.get(`/executions`).query({
+		const response = await authOwnerAgent.get('/executions').query({
 			status: 'error',
 		});
 
@@ -348,7 +348,7 @@ describe('GET /executions', () => {
 
 		const waitingExecution = await testDb.createWaitingExecution(workflow);
 
-		const response = await authOwnerAgent.get(`/executions`).query({
+		const response = await authOwnerAgent.get('/executions').query({
 			status: 'waiting',
 		});
 
@@ -389,7 +389,7 @@ describe('GET /executions', () => {
 		);
 		await testDb.createManyExecutions(2, workflow2, testDb.createSuccessfulExecution);
 
-		const response = await authOwnerAgent.get(`/executions`).query({
+		const response = await authOwnerAgent.get('/executions').query({
 			workflowId: workflow.id,
 		});
 
@@ -439,7 +439,7 @@ describe('GET /executions', () => {
 		await testDb.createManyExecutions(2, firstWorkflowForUser2, testDb.createSuccessfulExecution);
 		await testDb.createManyExecutions(2, secondWorkflowForUser2, testDb.createSuccessfulExecution);
 
-		const response = await authOwnerAgent.get(`/executions`);
+		const response = await authOwnerAgent.get('/executions');
 
 		expect(response.statusCode).toBe(200);
 		expect(response.body.data.length).toBe(8);
@@ -463,7 +463,7 @@ describe('GET /executions', () => {
 		await testDb.createManyExecutions(2, firstWorkflowForUser2, testDb.createSuccessfulExecution);
 		await testDb.createManyExecutions(2, secondWorkflowForUser2, testDb.createSuccessfulExecution);
 
-		const response = await authUser1Agent.get(`/executions`);
+		const response = await authUser1Agent.get('/executions');
 
 		expect(response.statusCode).toBe(200);
 		expect(response.body.data.length).toBe(4);
@@ -489,7 +489,7 @@ describe('GET /executions', () => {
 
 		await testDb.shareWorkflowWithUsers(firstWorkflowForUser2, [user1]);
 
-		const response = await authUser1Agent.get(`/executions`);
+		const response = await authUser1Agent.get('/executions');
 
 		expect(response.statusCode).toBe(200);
 		expect(response.body.data.length).toBe(6);

diff --git a/packages/cli/test/integration/publicApi/workflows.test.ts b/packages/cli/test/integration/publicApi/workflows.test.ts
@@ -309,7 +309,7 @@ describe('GET /workflows/:id', () => {
 	test('should fail due to invalid API Key', testWithAPIKey('get', '/workflows/2', 'abcXYZ'));
 
 	test('should fail due to non-existing workflow', async () => {
-		const response = await authOwnerAgent.get(`/workflows/2`);
+		const response = await authOwnerAgent.get('/workflows/2');
 		expect(response.statusCode).toBe(404);
 	});
 
@@ -375,7 +375,7 @@ describe('DELETE /workflows/:id', () => {
 	test('should fail due to invalid API Key', testWithAPIKey('delete', '/workflows/2', 'abcXYZ'));
 
 	test('should fail due to non-existing workflow', async () => {
-		const response = await authOwnerAgent.delete(`/workflows/2`);
+		const response = await authOwnerAgent.delete('/workflows/2');
 		expect(response.statusCode).toBe(404);
 	});
 
@@ -447,7 +447,7 @@ describe('POST /workflows/:id/activate', () => {
 	);
 
 	test('should fail due to non-existing workflow', async () => {
-		const response = await authOwnerAgent.post(`/workflows/2/activate`);
+		const response = await authOwnerAgent.post('/workflows/2/activate');
 		expect(response.statusCode).toBe(404);
 	});
 
@@ -549,7 +549,7 @@ describe('POST /workflows/:id/deactivate', () => {
 	);
 
 	test('should fail due to non-existing workflow', async () => {
-		const response = await authOwnerAgent.post(`/workflows/2/deactivate`);
+		const response = await authOwnerAgent.post('/workflows/2/deactivate');
 		expect(response.statusCode).toBe(404);
 	});
 
@@ -709,7 +709,7 @@ describe('PUT /workflows/:id', () => {
 	test('should fail due to invalid API Key', testWithAPIKey('put', '/workflows/1', 'abcXYZ'));
 
 	test('should fail due to non-existing workflow', async () => {
-		const response = await authOwnerAgent.put(`/workflows/1`).send({
+		const response = await authOwnerAgent.put('/workflows/1').send({
 			name: 'testing',
 			nodes: [
 				{
@@ -737,7 +737,7 @@ describe('PUT /workflows/:id', () => {
 	});
 
 	test('should fail due to invalid body', async () => {
-		const response = await authOwnerAgent.put(`/workflows/1`).send({
+		const response = await authOwnerAgent.put('/workflows/1').send({
 			nodes: [
 				{
 					id: 'uuid-1234',

diff --git a/packages/cli/test/integration/saml/saml.api.test.ts b/packages/cli/test/integration/saml/saml.api.test.ts
@@ -11,8 +11,8 @@ import * as utils from '../shared/utils';
 import { sampleConfig } from './sampleMetadata';
 import { InternalHooks } from '@/InternalHooks';
 import { SamlService } from '@/sso/saml/saml.service.ee';
-import { SamlUserAttributes } from '@/sso/saml/types/samlUserAttributes';
-import { AuthenticationMethod } from 'n8n-workflow';
+import type { SamlUserAttributes } from '@/sso/saml/types/samlUserAttributes';
+import type { AuthenticationMethod } from 'n8n-workflow';
 
 let someUser: User;
 let owner: User;

diff --git a/packages/cli/test/integration/shared/constants.ts b/packages/cli/test/integration/shared/constants.ts
@@ -1,8 +1,8 @@
 import config from '@/config';
 
-export const REST_PATH_SEGMENT = config.getEnv('endpoints.rest') as Readonly<string>;
+export const REST_PATH_SEGMENT = config.getEnv('endpoints.rest');
 
-export const PUBLIC_API_REST_PATH_SEGMENT = config.getEnv('publicApi.path') as Readonly<string>;
+export const PUBLIC_API_REST_PATH_SEGMENT = config.getEnv('publicApi.path');
 
 export const AUTHLESS_ENDPOINTS: Readonly<string[]> = [
 	'healthz',

diff --git a/packages/cli/test/integration/shared/testDb.ts b/packages/cli/test/integration/shared/testDb.ts
@@ -1,9 +1,6 @@
 import { UserSettings } from 'n8n-core';
-import {
-	DataSource as Connection,
-	DataSourceOptions as ConnectionOptions,
-	Repository,
-} from 'typeorm';
+import type { DataSourceOptions as ConnectionOptions, Repository } from 'typeorm';
+import { DataSource as Connection } from 'typeorm';
 import { Container } from 'typedi';
 
 import config from '@/config';
@@ -24,7 +21,7 @@ import type { TagEntity } from '@db/entities/TagEntity';
 import type { User } from '@db/entities/User';
 import type { WorkflowEntity } from '@db/entities/WorkflowEntity';
 import { RoleRepository } from '@db/repositories';
-import { ICredentialsDb } from '@/Interfaces';
+import type { ICredentialsDb } from '@/Interfaces';
 
 import { DB_INITIALIZATION_TIMEOUT } from './constants';
 import { randomApiKey, randomEmail, randomName, randomString, randomValidPassword } from './random';
@@ -211,6 +208,7 @@ export async function createManyUsers(
 	amount: number,
 	attributes: Partial<User> = {},
 ): Promise<User[]> {
+	// eslint-disable-next-line prefer-const
 	let { email, password, firstName, lastName, globalRole, ...rest } = attributes;
 	if (!globalRole) {
 		globalRole = await getGlobalMemberRole();