refactor(core): Move push message types to a new shared package (no-c…

…hangelog) (#10742)

.github/workflows/check-documentation-urls.yml

@@ -26,7 +26,7 @@ jobs:
         run: pnpm install --frozen-lockfile
 
       - name: Build relevant packages
-        run: pnpm --filter @n8n/client-oauth2 --filter @n8n/imap --filter n8n-workflow --filter n8n-core --filter n8n-nodes-base --filter @n8n/n8n-nodes-langchain build
+        run: pnpm build:nodes
 
       - run: npm install --prefix=.github/scripts --no-package-lock
 

packages/@n8n/api-types/.eslintrc.js

@@ -0,0 +1,7 @@
+const sharedOptions = require('@n8n_io/eslint-config/shared');
+
+/** @type {import('@types/eslint').ESLint.ConfigData} */
+module.exports = {
+	extends: ['@n8n_io/eslint-config/base'],
+	...sharedOptions(__dirname),
+};

packages/@n8n/api-types/README.md

@@ -0,0 +1,3 @@
+## @n8n/api-types
+
+This package contains types and schema definitions for the n8n internal API, so that these can be shared between the backend and the frontend code.

packages/@n8n/api-types/jest.config.js

@@ -0,0 +1,2 @@
+/** @type {import('jest').Config} */
+module.exports = require('../../../jest.config');

packages/@n8n/api-types/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@n8n/api-types",
+  "version": "0.1.0",
+  "scripts": {
+    "clean": "rimraf dist .turbo",
+    "dev": "pnpm watch",
+    "typecheck": "tsc --noEmit",
+    "build": "tsc -p tsconfig.build.json",
+    "format": "prettier --write . --ignore-path ../../../.prettierignore",
+    "lint": "eslint .",
+    "lintfix": "eslint . --fix",
+    "watch": "tsc -p tsconfig.build.json --watch",
+    "test": "echo \"No tests yet\" && exit 0"
+  },
+  "main": "dist/index.js",
+  "module": "src/index.ts",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*"
+  ],
+  "devDependencies": {
+    "n8n-workflow": "workspace:*"
+  }
+}

packages/@n8n/api-types/src/datetime.ts

@@ -0,0 +1,2 @@
+/** Date time in the ISO 8601 format, e.g. 2024-10-31T00:00:00.123Z */
+export type Iso8601DateTimeString = string;

packages/@n8n/api-types/src/index.ts

@@ -0,0 +1,7 @@
+export type * from './push';
+export type * from './scaling';
+export type * from './datetime';
+export type * from './user';
+
+export type { Collaborator } from './push/collaboration';
+export type { SendWorkerStatusMessage } from './push/worker';

packages/@n8n/api-types/src/push/collaboration.ts

@@ -0,0 +1,17 @@
+import type { Iso8601DateTimeString } from '../datetime';
+import type { MinimalUser } from '../user';
+
+export type Collaborator = {
+	user: MinimalUser;
+	lastSeen: Iso8601DateTimeString;
+};
+
+type CollaboratorsChanged = {
+	type: 'collaboratorsChanged';
+	data: {
+		workflowId: string;
+		collaborators: Collaborator[];
+	};
+};
+
+export type CollaborationPushMessage = CollaboratorsChanged;

packages/@n8n/api-types/src/push/debug.ts

@@ -0,0 +1,9 @@
+type SendConsoleMessage = {
+	type: 'sendConsoleMessage';
+	data: {
+		source: string;
+		messages: unknown[];
+	};
+};
+
+export type DebugPushMessage = SendConsoleMessage;

packages/@n8n/api-types/src/push/execution.ts

@@ -0,0 +1,53 @@
+import type { IRun, ITaskData, WorkflowExecuteMode } from 'n8n-workflow';
+
+type ExecutionStarted = {
+	type: 'executionStarted';
+	data: {
+		executionId: string;
+		mode: WorkflowExecuteMode;
+		startedAt: Date;
+		workflowId: string;
+		workflowName?: string;
+		retryOf?: string;
+	};
+};
+
+type ExecutionFinished = {
+	type: 'executionFinished';
+	data: {
+		executionId: string;
+		data: IRun;
+		retryOf?: string;
+	};
+};
+
+type ExecutionRecovered = {
+	type: 'executionRecovered';
+	data: {
+		executionId: string;
+	};
+};
+
+type NodeExecuteBefore = {
+	type: 'nodeExecuteBefore';
+	data: {
+		executionId: string;
+		nodeName: string;
+	};
+};
+
+type NodeExecuteAfter = {
+	type: 'nodeExecuteAfter';
+	data: {
+		executionId: string;
+		nodeName: string;
+		data: ITaskData;
+	};
+};
+
+export type ExecutionPushMessage =
+	| ExecutionStarted
+	| ExecutionFinished
+	| ExecutionRecovered
+	| NodeExecuteBefore
+	| NodeExecuteAfter;

packages/@n8n/api-types/src/push/hot-reload.ts

@@ -0,0 +1,21 @@
+type NodeTypeData = {
+	name: string;
+	version: number;
+};
+
+type ReloadNodeType = {
+	type: 'reloadNodeType';
+	data: NodeTypeData;
+};
+
+type RemoveNodeType = {
+	type: 'removeNodeType';
+	data: NodeTypeData;
+};
+
+type NodeDescriptionUpdated = {
+	type: 'nodeDescriptionUpdated';
+	data: {};
+};
+
+export type HotReloadPushMessage = ReloadNodeType | RemoveNodeType | NodeDescriptionUpdated;

packages/@n8n/api-types/src/push/index.ts

@@ -0,0 +1,20 @@
+import type { ExecutionPushMessage } from './execution';
+import type { WorkflowPushMessage } from './workflow';
+import type { HotReloadPushMessage } from './hot-reload';
+import type { WorkerPushMessage } from './worker';
+import type { WebhookPushMessage } from './webhook';
+import type { CollaborationPushMessage } from './collaboration';
+import type { DebugPushMessage } from './debug';
+
+export type PushMessage =
+	| ExecutionPushMessage
+	| WorkflowPushMessage
+	| HotReloadPushMessage
+	| WebhookPushMessage
+	| WorkerPushMessage
+	| CollaborationPushMessage
+	| DebugPushMessage;
+
+export type PushType = PushMessage['type'];
+
+export type PushPayload<T extends PushType> = Extract<PushMessage, { type: T }>['data'];

packages/@n8n/api-types/src/push/webhook.ts

@@ -0,0 +1,17 @@
+type TestWebhookDeleted = {
+	type: 'testWebhookDeleted';
+	data: {
+		executionId?: string;
+		workflowId: string;
+	};
+};
+
+type TestWebhookReceived = {
+	type: 'testWebhookReceived';
+	data: {
+		executionId: string;
+		workflowId: string;
+	};
+};
+
+export type WebhookPushMessage = TestWebhookDeleted | TestWebhookReceived;

packages/@n8n/api-types/src/push/worker.ts

@@ -0,0 +1,11 @@
+import type { WorkerStatus } from '../scaling';
+
+export type SendWorkerStatusMessage = {
+	type: 'sendWorkerStatusMessage';
+	data: {
+		workerId: string;
+		status: WorkerStatus;
+	};
+};
+
+export type WorkerPushMessage = SendWorkerStatusMessage;

packages/@n8n/api-types/src/push/workflow.ts

@@ -0,0 +1,26 @@
+type WorkflowActivated = {
+	type: 'workflowActivated';
+	data: {
+		workflowId: string;
+	};
+};
+
+type WorkflowFailedToActivate = {
+	type: 'workflowFailedToActivate';
+	data: {
+		workflowId: string;
+		errorMessage: string;
+	};
+};
+
+type WorkflowDeactivated = {
+	type: 'workflowDeactivated';
+	data: {
+		workflowId: string;
+	};
+};
+
+export type WorkflowPushMessage =
+	| WorkflowActivated
+	| WorkflowFailedToActivate
+	| WorkflowDeactivated;

packages/@n8n/api-types/src/scaling.ts

@@ -0,0 +1,30 @@
+import type { ExecutionStatus, WorkflowExecuteMode } from 'n8n-workflow';
+
+export type RunningJobSummary = {
+	executionId: string;
+	workflowId: string;
+	workflowName: string;
+	mode: WorkflowExecuteMode;
+	startedAt: Date;
+	retryOf: string;
+	status: ExecutionStatus;
+};
+
+export type WorkerStatus = {
+	workerId: string;
+	runningJobsSummary: RunningJobSummary[];
+	freeMem: number;
+	totalMem: number;
+	uptime: number;
+	loadAvg: number[];
+	cpus: string;
+	arch: string;
+	platform: NodeJS.Platform;
+	hostname: string;
+	interfaces: Array<{
+		family: 'IPv4' | 'IPv6';
+		address: string;
+		internal: boolean;
+	}>;
+	version: string;
+};

packages/@n8n/api-types/src/user.ts

@@ -0,0 +1,6 @@
+export type MinimalUser = {
+	id: string;
+	email: string;
+	firstName: string;
+	lastName: string;
+};

packages/@n8n/api-types/tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+	"extends": ["./tsconfig.json", "../../../tsconfig.build.json"],
+	"compilerOptions": {
+		"composite": true,
+		"rootDir": "src",
+		"outDir": "dist",
+		"tsBuildInfoFile": "dist/build.tsbuildinfo"
+	},
+	"include": ["src/**/*.ts"],
+	"exclude": ["test/**", "src/**/__tests__/**"]
+}

packages/@n8n/api-types/tsconfig.json

@@ -0,0 +1,10 @@
+{
+	"extends": "../../../tsconfig.json",
+	"compilerOptions": {
+		"rootDir": ".",
+		"types": ["node", "jest"],
+		"baseUrl": "src",
+		"tsBuildInfoFile": "dist/typecheck.tsbuildinfo"
+	},
+	"include": ["src/**/*.ts", "test/**/*.ts"]
+}

packages/cli/package.json

@@ -85,6 +85,7 @@
     "@azure/identity": "^4.3.0",
     "@azure/keyvault-secrets": "^4.8.0",
     "@google-cloud/secret-manager": "^5.6.0",
+    "@n8n/api-types": "workspace:*",
     "@n8n/client-oauth2": "workspace:*",
     "@n8n/config": "workspace:*",
     "@n8n/localtunnel": "3.0.0",

packages/cli/src/collaboration/collaboration.service.ts

@@ -1,11 +1,11 @@
+import type { PushPayload } from '@n8n/api-types';
 import type { Workflow } from 'n8n-workflow';
 import { ApplicationError, ErrorReporterProxy } from 'n8n-workflow';
 import { Service } from 'typedi';
 
 import { CollaborationState } from '@/collaboration/collaboration.state';
 import type { User } from '@/databases/entities/user';
 import { UserRepository } from '@/databases/repositories/user.repository';
-import type { ICollaboratorsChanged } from '@/interfaces';
 import { Push } from '@/push';
 import type { OnPushMessage } from '@/push/types';
 import { AccessService } from '@/services/access.service';
@@ -92,7 +92,7 @@ export class CollaborationService {
 			user: user.toIUser(),
 			lastSeen: collaborators.find(({ userId }) => userId === user.id)!.lastSeen,
 		}));
-		const msgData: ICollaboratorsChanged = {
+		const msgData: PushPayload<'collaboratorsChanged'> = {
 			workflowId,
 			collaborators: activeCollaborators,
 		};

packages/cli/src/collaboration/collaboration.state.ts

@@ -1,9 +1,9 @@
+import type { Iso8601DateTimeString } from '@n8n/api-types';
 import type { Workflow } from 'n8n-workflow';
 import { Service } from 'typedi';
 
 import { Time } from '@/constants';
 import type { User } from '@/databases/entities/user';
-import type { Iso8601DateTimeString } from '@/interfaces';
 import { CacheService } from '@/services/cache/cache.service';
 
 type WorkflowCacheHash = Record<User['id'], Iso8601DateTimeString>;

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

@@ -1,3 +1,4 @@
+import type { PushPayload, PushType } from '@n8n/api-types';
 import { Request } from 'express';
 import Container from 'typedi';
 import { v4 as uuid } from 'uuid';
@@ -10,7 +11,7 @@ import { SettingsRepository } from '@/databases/repositories/settings.repository
 import { UserRepository } from '@/databases/repositories/user.repository';
 import { Patch, Post, RestController } from '@/decorators';
 import { MessageEventBus } from '@/eventbus/message-event-bus/message-event-bus';
-import type { BooleanLicenseFeature, IPushDataType, NumericLicenseFeature } from '@/interfaces';
+import type { BooleanLicenseFeature, NumericLicenseFeature } from '@/interfaces';
 import { License } from '@/license';
 import { Logger } from '@/logger';
 import { MfaService } from '@/mfa/mfa.service';
@@ -56,13 +57,13 @@ type ResetRequest = Request<
 	}
 >;
 
-type PushRequest = Request<
+type PushRequest<T extends PushType> = Request<
 	{},
 	{},
 	{
-		type: IPushDataType;
+		type: T;
 		pushRef: string;
-		data: object;
+		data: PushPayload<T>;
 	}
 >;
 
@@ -132,7 +133,7 @@ export class E2EController {
 	}
 
 	@Post('/push', { skipAuth: true })
-	async pushSend(req: PushRequest) {
+	async pushSend(req: PushRequest<any>) {
 		this.push.broadcast(req.body.type, req.body.data);
 	}