n8n 1.61.0 → 1.62.1

package/dist/runners/auth/task-runner-auth.service.d.ts

@@ -0,0 +1,13 @@
+import { GlobalConfig } from '@n8n/config';
+import { CacheService } from '../../services/cache/cache.service';
+export declare class TaskRunnerAuthService {
+    private readonly globalConfig;
+    private readonly cacheService;
+    private readonly grantTokenTtl;
+    constructor(globalConfig: GlobalConfig, cacheService: CacheService, grantTokenTtl?: number);
+    isValidAuthToken(token: string): boolean;
+    createGrantToken(): Promise<string>;
+    tryConsumeGrantToken(grantToken: string): Promise<boolean>;
+    private generateGrantToken;
+    private cacheKeyForGrantToken;
+}

package/dist/runners/auth/task-runner-auth.service.js

@@ -0,0 +1,55 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaskRunnerAuthService = void 0;
+const config_1 = require("@n8n/config");
+const crypto_1 = require("crypto");
+const typedi_1 = require("typedi");
+const constants_1 = require("../../constants");
+const cache_service_1 = require("../../services/cache/cache.service");
+const GRANT_TOKEN_TTL = 15 * constants_1.Time.seconds.toMilliseconds;
+let TaskRunnerAuthService = class TaskRunnerAuthService {
+    constructor(globalConfig, cacheService, grantTokenTtl = GRANT_TOKEN_TTL) {
+        this.globalConfig = globalConfig;
+        this.cacheService = cacheService;
+        this.grantTokenTtl = grantTokenTtl;
+    }
+    isValidAuthToken(token) {
+        return token === this.globalConfig.taskRunners.authToken;
+    }
+    async createGrantToken() {
+        const grantToken = this.generateGrantToken();
+        const key = this.cacheKeyForGrantToken(grantToken);
+        await this.cacheService.set(key, '1', this.grantTokenTtl);
+        return grantToken;
+    }
+    async tryConsumeGrantToken(grantToken) {
+        const key = this.cacheKeyForGrantToken(grantToken);
+        const consumed = await this.cacheService.get(key);
+        if (consumed === undefined)
+            return false;
+        await this.cacheService.delete(key);
+        return true;
+    }
+    generateGrantToken() {
+        return (0, crypto_1.randomBytes)(32).toString('hex');
+    }
+    cacheKeyForGrantToken(grantToken) {
+        return `grant-token:${grantToken}`;
+    }
+};
+exports.TaskRunnerAuthService = TaskRunnerAuthService;
+exports.TaskRunnerAuthService = TaskRunnerAuthService = __decorate([
+    (0, typedi_1.Service)(),
+    __metadata("design:paramtypes", [config_1.GlobalConfig,
+        cache_service_1.CacheService, Object])
+], TaskRunnerAuthService);
+//# sourceMappingURL=task-runner-auth.service.js.map

package/dist/runners/auth/task-runner-auth.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"task-runner-auth.service.js","sourceRoot":"","sources":["../../../src/runners/auth/task-runner-auth.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wCAA2C;AAC3C,mCAAqC;AACrC,mCAAiC;AAEjC,2CAAmC;AACnC,kEAA8D;AAE9D,MAAM,eAAe,GAAG,EAAE,GAAG,gBAAI,CAAC,OAAO,CAAC,cAAc,CAAC;AAGlD,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;IACjC,YACkB,YAA0B,EAC1B,YAA0B,EAE1B,gBAAgB,eAAe;QAH/B,iBAAY,GAAZ,YAAY,CAAc;QAC1B,iBAAY,GAAZ,YAAY,CAAc;QAE1B,kBAAa,GAAb,aAAa,CAAkB;IAC9C,CAAC;IAEJ,gBAAgB,CAAC,KAAa;QAC7B,OAAO,KAAK,KAAK,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,SAAS,CAAC;IAC1D,CAAC;IAKD,KAAK,CAAC,gBAAgB;QACrB,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE7C,MAAM,GAAG,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QACnD,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAE1D,OAAO,UAAU,CAAC;IACnB,CAAC;IAMD,KAAK,CAAC,oBAAoB,CAAC,UAAkB;QAC5C,MAAM,GAAG,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAS,GAAG,CAAC,CAAC;QAE1D,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO,KAAK,CAAC;QAEzC,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IACb,CAAC;IAEO,kBAAkB;QACzB,OAAO,IAAA,oBAAW,EAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAEO,qBAAqB,CAAC,UAAkB;QAC/C,OAAO,eAAe,UAAU,EAAE,CAAC;IACpC,CAAC;CACD,CAAA;AA7CY,sDAAqB;gCAArB,qBAAqB;IADjC,IAAA,gBAAO,GAAE;qCAGuB,qBAAY;QACZ,4BAAY;GAHhC,qBAAqB,CA6CjC"}

package/dist/runners/errors.d.ts

@@ -0,0 +1,7 @@
+import { ApplicationError } from 'n8n-workflow';
+export declare class TaskRejectError extends ApplicationError {
+    reason: string;
+    constructor(reason: string);
+}
+export declare class TaskError extends ApplicationError {
+}

package/dist/runners/errors.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaskError = exports.TaskRejectError = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+class TaskRejectError extends n8n_workflow_1.ApplicationError {
+    constructor(reason) {
+        super(`Task rejected with reason: ${reason}`, { level: 'info' });
+        this.reason = reason;
+    }
+}
+exports.TaskRejectError = TaskRejectError;
+class TaskError extends n8n_workflow_1.ApplicationError {
+}
+exports.TaskError = TaskError;
+//# sourceMappingURL=errors.js.map

package/dist/runners/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/runners/errors.ts"],"names":[],"mappings":";;;AAAA,+CAAgD;AAEhD,MAAa,eAAgB,SAAQ,+BAAgB;IACpD,YAAmB,MAAc;QAChC,KAAK,CAAC,8BAA8B,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QAD/C,WAAM,GAAN,MAAM,CAAQ;IAEjC,CAAC;CACD;AAJD,0CAIC;AAED,MAAa,SAAU,SAAQ,+BAAgB;CAAG;AAAlD,8BAAkD"}

package/dist/runners/runner-types.d.ts

@@ -0,0 +1,173 @@
+import type { Response } from 'express';
+import type { INodeExecutionData } from 'n8n-workflow';
+import type WebSocket from 'ws';
+import type { TaskRunner } from './task-broker.service';
+import type { AuthlessRequest } from '../requests';
+export type DataRequestType = 'input' | 'node' | 'all';
+export interface TaskResultData {
+    result: INodeExecutionData[];
+    customData?: Record<string, string>;
+}
+export interface TaskRunnerServerInitRequest extends AuthlessRequest<{}, {}, {}, {
+    id: TaskRunner['id'];
+    token?: string;
+}> {
+    ws: WebSocket;
+}
+export type TaskRunnerServerInitResponse = Response & {
+    req: TaskRunnerServerInitRequest;
+};
+export declare namespace N8nMessage {
+    namespace ToRunner {
+        interface InfoRequest {
+            type: 'broker:inforequest';
+        }
+        interface RunnerRegistered {
+            type: 'broker:runnerregistered';
+        }
+        interface TaskOfferAccept {
+            type: 'broker:taskofferaccept';
+            taskId: string;
+            offerId: string;
+        }
+        interface TaskCancel {
+            type: 'broker:taskcancel';
+            taskId: string;
+            reason: string;
+        }
+        interface TaskSettings {
+            type: 'broker:tasksettings';
+            taskId: string;
+            settings: unknown;
+        }
+        interface RPCResponse {
+            type: 'broker:rpcresponse';
+            callId: string;
+            taskId: string;
+            status: 'success' | 'error';
+            data: unknown;
+        }
+        interface TaskDataResponse {
+            type: 'broker:taskdataresponse';
+            taskId: string;
+            requestId: string;
+            data: unknown;
+        }
+        type All = InfoRequest | TaskOfferAccept | TaskCancel | TaskSettings | RunnerRegistered | RPCResponse | TaskDataResponse;
+    }
+    namespace ToRequester {
+        interface TaskReady {
+            type: 'broker:taskready';
+            requestId: string;
+            taskId: string;
+        }
+        interface TaskDone {
+            type: 'broker:taskdone';
+            taskId: string;
+            data: TaskResultData;
+        }
+        interface TaskError {
+            type: 'broker:taskerror';
+            taskId: string;
+            error: unknown;
+        }
+        interface TaskDataRequest {
+            type: 'broker:taskdatarequest';
+            taskId: string;
+            requestId: string;
+            requestType: DataRequestType;
+            param?: string;
+        }
+        interface RPC {
+            type: 'broker:rpc';
+            callId: string;
+            taskId: string;
+            name: (typeof RPC_ALLOW_LIST)[number];
+            params: unknown[];
+        }
+        type All = TaskReady | TaskDone | TaskError | TaskDataRequest | RPC;
+    }
+}
+export declare namespace RequesterMessage {
+    namespace ToN8n {
+        interface TaskSettings {
+            type: 'requester:tasksettings';
+            taskId: string;
+            settings: unknown;
+        }
+        interface TaskCancel {
+            type: 'requester:taskcancel';
+            taskId: string;
+            reason: string;
+        }
+        interface TaskDataResponse {
+            type: 'requester:taskdataresponse';
+            taskId: string;
+            requestId: string;
+            data: unknown;
+        }
+        interface RPCResponse {
+            type: 'requester:rpcresponse';
+            taskId: string;
+            callId: string;
+            status: 'success' | 'error';
+            data: unknown;
+        }
+        interface TaskRequest {
+            type: 'requester:taskrequest';
+            requestId: string;
+            taskType: string;
+        }
+        type All = TaskSettings | TaskCancel | RPCResponse | TaskDataResponse | TaskRequest;
+    }
+}
+export declare namespace RunnerMessage {
+    namespace ToN8n {
+        interface Info {
+            type: 'runner:info';
+            name: string;
+            types: string[];
+        }
+        interface TaskAccepted {
+            type: 'runner:taskaccepted';
+            taskId: string;
+        }
+        interface TaskRejected {
+            type: 'runner:taskrejected';
+            taskId: string;
+            reason: string;
+        }
+        interface TaskDone {
+            type: 'runner:taskdone';
+            taskId: string;
+            data: TaskResultData;
+        }
+        interface TaskError {
+            type: 'runner:taskerror';
+            taskId: string;
+            error: unknown;
+        }
+        interface TaskOffer {
+            type: 'runner:taskoffer';
+            offerId: string;
+            taskType: string;
+            validFor: number;
+        }
+        interface TaskDataRequest {
+            type: 'runner:taskdatarequest';
+            taskId: string;
+            requestId: string;
+            requestType: DataRequestType;
+            param?: string;
+        }
+        interface RPC {
+            type: 'runner:rpc';
+            callId: string;
+            taskId: string;
+            name: (typeof RPC_ALLOW_LIST)[number];
+            params: unknown[];
+        }
+        type All = Info | TaskDone | TaskError | TaskAccepted | TaskRejected | TaskOffer | RPC | TaskDataRequest;
+    }
+}
+export declare const RPC_ALLOW_LIST: readonly ["logNodeOutput", "helpers.httpRequestWithAuthentication", "helpers.requestWithAuthenticationPaginated", "helpers.getBinaryDataBuffer", "helpers.getSSHClient", "helpers.createReadStream", "helpers.writeContentToFile", "helpers.prepareBinaryData", "helpers.setBinaryDataBuffer", "helpers.copyBinaryFile", "helpers.binaryToBuffer", "helpers.getBinaryStream", "helpers.getBinaryMetadata", "helpers.createDeferredPromise", "helpers.httpRequest"];

package/dist/runners/runner-types.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RPC_ALLOW_LIST = void 0;
+exports.RPC_ALLOW_LIST = [
+    'logNodeOutput',
+    'helpers.httpRequestWithAuthentication',
+    'helpers.requestWithAuthenticationPaginated',
+    'helpers.getBinaryDataBuffer',
+    'helpers.getSSHClient',
+    'helpers.createReadStream',
+    'helpers.writeContentToFile',
+    'helpers.prepareBinaryData',
+    'helpers.setBinaryDataBuffer',
+    'helpers.copyBinaryFile',
+    'helpers.binaryToBuffer',
+    'helpers.getBinaryStream',
+    'helpers.getBinaryMetadata',
+    'helpers.createDeferredPromise',
+    'helpers.httpRequest',
+];
+//# sourceMappingURL=runner-types.js.map

package/dist/runners/runner-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runner-types.js","sourceRoot":"","sources":["../../src/runners/runner-types.ts"],"names":[],"mappings":";;;AA0Na,QAAA,cAAc,GAAG;IAC7B,eAAe;IACf,uCAAuC;IACvC,4CAA4C;IAI5C,6BAA6B;IAG7B,sBAAsB;IACtB,0BAA0B;IAE1B,4BAA4B;IAC5B,2BAA2B;IAC3B,6BAA6B;IAC7B,wBAAwB;IACxB,wBAAwB;IAGxB,yBAAyB;IACzB,2BAA2B;IAC3B,+BAA+B;IAC/B,qBAAqB;CACZ,CAAC"}

package/dist/runners/runner-ws-server.d.ts

@@ -0,0 +1,18 @@
+import type { Application } from 'express';
+import { type Server } from 'http';
+import type WebSocket from 'ws';
+import { Logger } from '../logging/logger.service';
+import type { N8nMessage, TaskRunnerServerInitRequest, TaskRunnerServerInitResponse } from './runner-types';
+import { TaskBroker, type TaskRunner } from './task-broker.service';
+export declare class TaskRunnerService {
+    private readonly logger;
+    private readonly taskBroker;
+    runnerConnections: Map<TaskRunner['id'], WebSocket>;
+    constructor(logger: Logger, taskBroker: TaskBroker);
+    sendMessage(id: TaskRunner['id'], message: N8nMessage.ToRunner.All): void;
+    add(id: TaskRunner['id'], connection: WebSocket): void;
+    removeConnection(id: TaskRunner['id']): void;
+    handleRequest(req: TaskRunnerServerInitRequest, _res: TaskRunnerServerInitResponse): void;
+}
+export declare const setupRunnerServer: (restEndpoint: string, server: Server, app: Application) => void;
+export declare const setupRunnerHandler: (restEndpoint: string, app: Application) => void;

package/dist/runners/runner-ws-server.js

@@ -0,0 +1,167 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupRunnerHandler = exports.setupRunnerServer = exports.TaskRunnerService = void 0;
+const config_1 = require("@n8n/config");
+const http_1 = require("http");
+const n8n_workflow_1 = require("n8n-workflow");
+const typedi_1 = __importStar(require("typedi"));
+const url_1 = require("url");
+const ws_1 = require("ws");
+const logger_service_1 = require("../logging/logger.service");
+const response_helper_1 = require("../response-helper");
+const task_runner_auth_controller_1 = require("../runners/auth/task-runner-auth.controller");
+const task_broker_service_1 = require("./task-broker.service");
+function heartbeat() {
+    this.isAlive = true;
+}
+function getEndpointBasePath(restEndpoint) {
+    const globalConfig = typedi_1.default.get(config_1.GlobalConfig);
+    let path = globalConfig.taskRunners.path;
+    if (path.startsWith('/')) {
+        path = path.slice(1);
+    }
+    if (path.endsWith('/')) {
+        path = path.slice(-1);
+    }
+    return `/${restEndpoint}/${path}`;
+}
+function getWsEndpoint(restEndpoint) {
+    return `${getEndpointBasePath(restEndpoint)}/_ws`;
+}
+let TaskRunnerService = class TaskRunnerService {
+    constructor(logger, taskBroker) {
+        this.logger = logger;
+        this.taskBroker = taskBroker;
+        this.runnerConnections = new Map();
+    }
+    sendMessage(id, message) {
+        this.runnerConnections.get(id)?.send(JSON.stringify(message));
+    }
+    add(id, connection) {
+        connection.isAlive = true;
+        connection.on('pong', heartbeat);
+        let isConnected = false;
+        const onMessage = (data) => {
+            try {
+                const buffer = Array.isArray(data) ? Buffer.concat(data) : Buffer.from(data);
+                const message = JSON.parse(buffer.toString('utf8'));
+                if (!isConnected && message.type !== 'runner:info') {
+                    return;
+                }
+                else if (!isConnected && message.type === 'runner:info') {
+                    this.removeConnection(id);
+                    isConnected = true;
+                    this.runnerConnections.set(id, connection);
+                    this.taskBroker.registerRunner({
+                        id,
+                        taskTypes: message.types,
+                        lastSeen: new Date(),
+                        name: message.name,
+                    }, this.sendMessage.bind(this, id));
+                    this.sendMessage(id, { type: 'broker:runnerregistered' });
+                    this.logger.info(`Runner "${message.name}"(${id}) has been registered`);
+                    return;
+                }
+                void this.taskBroker.onRunnerMessage(id, message);
+            }
+            catch (error) {
+                this.logger.error(`Couldn't parse message from runner "${id}"`, {
+                    error: error,
+                    id,
+                    data,
+                });
+            }
+        };
+        connection.once('close', () => {
+            connection.off('pong', heartbeat);
+            connection.off('message', onMessage);
+            this.removeConnection(id);
+        });
+        connection.on('message', onMessage);
+        connection.send(JSON.stringify({ type: 'broker:inforequest' }));
+    }
+    removeConnection(id) {
+        const connection = this.runnerConnections.get(id);
+        if (connection) {
+            this.taskBroker.deregisterRunner(id);
+            connection.close();
+            this.runnerConnections.delete(id);
+        }
+    }
+    handleRequest(req, _res) {
+        this.add(req.query.id, req.ws);
+    }
+};
+exports.TaskRunnerService = TaskRunnerService;
+exports.TaskRunnerService = TaskRunnerService = __decorate([
+    (0, typedi_1.Service)(),
+    __metadata("design:paramtypes", [logger_service_1.Logger,
+        task_broker_service_1.TaskBroker])
+], TaskRunnerService);
+const setupRunnerServer = (restEndpoint, server, app) => {
+    const globalConfig = typedi_1.default.get(config_1.GlobalConfig);
+    const { authToken } = globalConfig.taskRunners;
+    if (!authToken) {
+        throw new n8n_workflow_1.ApplicationError('Authentication token must be configured when task runners are enabled. Use N8N_RUNNERS_AUTH_TOKEN environment variable to set it.');
+    }
+    const endpoint = getWsEndpoint(restEndpoint);
+    const wsServer = new ws_1.Server({ noServer: true });
+    server.on('upgrade', (request, socket, head) => {
+        if ((0, url_1.parse)(request.url).pathname !== endpoint) {
+            return;
+        }
+        wsServer.handleUpgrade(request, socket, head, (ws) => {
+            request.ws = ws;
+            const response = new http_1.ServerResponse(request);
+            response.writeHead = (statusCode) => {
+                if (statusCode > 200)
+                    ws.close();
+                return response;
+            };
+            app.handle(request, response);
+        });
+    });
+};
+exports.setupRunnerServer = setupRunnerServer;
+const setupRunnerHandler = (restEndpoint, app) => {
+    const wsEndpoint = getWsEndpoint(restEndpoint);
+    const authEndpoint = `${getEndpointBasePath(restEndpoint)}/auth`;
+    const taskRunnerAuthController = typedi_1.default.get(task_runner_auth_controller_1.TaskRunnerAuthController);
+    const taskRunnerService = typedi_1.default.get(TaskRunnerService);
+    app.use(wsEndpoint, taskRunnerAuthController.authMiddleware, (req, res) => taskRunnerService.handleRequest(req, res));
+    app.post(authEndpoint, (0, response_helper_1.send)(async (req) => await taskRunnerAuthController.createGrantToken(req)));
+};
+exports.setupRunnerHandler = setupRunnerHandler;
+//# sourceMappingURL=runner-ws-server.js.map

package/dist/runners/runner-ws-server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runner-ws-server.js","sourceRoot":"","sources":["../../src/runners/runner-ws-server.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wCAA2C;AAE3C,+BAAmD;AACnD,+CAAgD;AAEhD,iDAA4C;AAC5C,6BAAwC;AACxC,2BAAwC;AAGxC,6DAAkD;AAClD,uDAAyC;AACzC,4FAAsF;AAQtF,+DAA0F;AAE1F,SAAS,SAAS;IACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;AACrB,CAAC;AAED,SAAS,mBAAmB,CAAC,YAAoB;IAChD,MAAM,YAAY,GAAG,gBAAS,CAAC,GAAG,CAAC,qBAAY,CAAC,CAAC;IAEjD,IAAI,IAAI,GAAG,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC;IACzC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC;IACD,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IAED,OAAO,IAAI,YAAY,IAAI,IAAI,EAAE,CAAC;AACnC,CAAC;AAED,SAAS,aAAa,CAAC,YAAoB;IAC1C,OAAO,GAAG,mBAAmB,CAAC,YAAY,CAAC,MAAM,CAAC;AACnD,CAAC;AAGM,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;IAG7B,YACkB,MAAc,EACd,UAAsB;QADtB,WAAM,GAAN,MAAM,CAAQ;QACd,eAAU,GAAV,UAAU,CAAY;QAJxC,sBAAiB,GAAqC,IAAI,GAAG,EAAE,CAAC;IAK7D,CAAC;IAEJ,WAAW,CAAC,EAAoB,EAAE,OAAgC;QACjE,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,GAAG,CAAC,EAAoB,EAAE,UAAqB;QAC9C,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC;QAC1B,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAEjC,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,MAAM,SAAS,GAAG,CAAC,IAAuB,EAAE,EAAE;YAC7C,IAAI,CAAC;gBACJ,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAE7E,MAAM,OAAO,GAA4B,IAAI,CAAC,KAAK,CAClD,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CACI,CAAC;gBAE7B,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;oBACpD,OAAO;gBACR,CAAC;qBAAM,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;oBAC3D,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;oBAC1B,WAAW,GAAG,IAAI,CAAC;oBAEnB,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;oBAE3C,IAAI,CAAC,UAAU,CAAC,cAAc,CAC7B;wBACC,EAAE;wBACF,SAAS,EAAE,OAAO,CAAC,KAAK;wBACxB,QAAQ,EAAE,IAAI,IAAI,EAAE;wBACpB,IAAI,EAAE,OAAO,CAAC,IAAI;qBAClB,EACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAoB,CAClD,CAAC;oBAEF,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC,CAAC;oBAE1D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,OAAO,CAAC,IAAI,KAAK,EAAE,uBAAuB,CAAC,CAAC;oBACxE,OAAO;gBACR,CAAC;gBAED,KAAK,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;YACnD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uCAAuC,EAAE,GAAG,EAAE;oBAC/D,KAAK,EAAE,KAAgB;oBACvB,EAAE;oBACF,IAAI;iBACJ,CAAC,CAAC;YACJ,CAAC;QACF,CAAC,CAAC;QAGF,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;YAC7B,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAClC,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YACrC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACpC,UAAU,CAAC,IAAI,CACd,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAqC,CAAC,CACjF,CAAC;IACH,CAAC;IAED,gBAAgB,CAAC,EAAoB;QACpC,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAClD,IAAI,UAAU,EAAE,CAAC;YAChB,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;YACrC,UAAU,CAAC,KAAK,EAAE,CAAC;YACnB,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACnC,CAAC;IACF,CAAC;IAED,aAAa,CAAC,GAAgC,EAAE,IAAkC;QACjF,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC;CACD,CAAA;AArFY,8CAAiB;4BAAjB,iBAAiB;IAD7B,IAAA,gBAAO,GAAE;qCAKiB,uBAAM;QACF,gCAAU;GAL5B,iBAAiB,CAqF7B;AAIM,MAAM,iBAAiB,GAAG,CAAC,YAAoB,EAAE,MAAc,EAAE,GAAgB,EAAE,EAAE;IAC3F,MAAM,YAAY,GAAG,gBAAS,CAAC,GAAG,CAAC,qBAAY,CAAC,CAAC;IACjD,MAAM,EAAE,SAAS,EAAE,GAAG,YAAY,CAAC,WAAW,CAAC;IAE/C,IAAI,CAAC,SAAS,EAAE,CAAC;QAChB,MAAM,IAAI,+BAAgB,CACzB,mIAAmI,CACnI,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,IAAI,WAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAClD,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAoC,EAAE,MAAc,EAAE,IAAI,EAAE,EAAE;QACnF,IAAI,IAAA,WAAQ,EAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAIjD,OAAO;QACR,CAAC;QAED,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE;YACpD,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;YAEhB,MAAM,QAAQ,GAAG,IAAI,qBAAc,CAAC,OAAO,CAAC,CAAC;YAC7C,QAAQ,CAAC,SAAS,GAAG,CAAC,UAAU,EAAE,EAAE;gBACnC,IAAI,UAAU,GAAG,GAAG;oBAAE,EAAE,CAAC,KAAK,EAAE,CAAC;gBACjC,OAAO,QAAQ,CAAC;YACjB,CAAC,CAAC;YAIF,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAlCW,QAAA,iBAAiB,qBAkC5B;AAEK,MAAM,kBAAkB,GAAG,CAAC,YAAoB,EAAE,GAAgB,EAAE,EAAE;IAC5E,MAAM,UAAU,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IAC/C,MAAM,YAAY,GAAG,GAAG,mBAAmB,CAAC,YAAY,CAAC,OAAO,CAAC;IAEjE,MAAM,wBAAwB,GAAG,gBAAS,CAAC,GAAG,CAAC,sDAAwB,CAAC,CAAC;IACzE,MAAM,iBAAiB,GAAG,gBAAS,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAC3D,GAAG,CAAC,GAAG,CACN,UAAU,EAEV,wBAAwB,CAAC,cAAc,EACvC,CAAC,GAAgC,EAAE,GAAiC,EAAE,EAAE,CACvE,iBAAiB,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAC1C,CAAC;IAEF,GAAG,CAAC,IAAI,CACP,YAAY,EACZ,IAAA,sBAAI,EAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,MAAM,wBAAwB,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CACzE,CAAC;AACH,CAAC,CAAC;AAlBW,QAAA,kBAAkB,sBAkB7B"}

package/dist/runners/task-broker.service.d.ts

@@ -0,0 +1,91 @@
+import { Logger } from '../logging/logger.service';
+import { TaskRejectError } from './errors';
+import type { N8nMessage, RunnerMessage, RequesterMessage, TaskResultData } from './runner-types';
+export interface TaskRunner {
+    id: string;
+    name?: string;
+    taskTypes: string[];
+    lastSeen: Date;
+}
+export interface Task {
+    id: string;
+    runnerId: TaskRunner['id'];
+    requesterId: string;
+    taskType: string;
+}
+export interface TaskOffer {
+    offerId: string;
+    runnerId: TaskRunner['id'];
+    taskType: string;
+    validFor: number;
+    validUntil: bigint;
+}
+export interface TaskRequest {
+    requestId: string;
+    requesterId: string;
+    taskType: string;
+    acceptInProgress?: boolean;
+}
+export type MessageCallback = (message: N8nMessage.ToRunner.All) => Promise<void> | void;
+export type RequesterMessageCallback = (message: N8nMessage.ToRequester.All) => Promise<void> | void;
+type RunnerAcceptCallback = () => void;
+type TaskRejectCallback = (reason: TaskRejectError) => void;
+export declare class TaskBroker {
+    private readonly logger;
+    private knownRunners;
+    private requesters;
+    private tasks;
+    private runnerAcceptRejects;
+    private requesterAcceptRejects;
+    private pendingTaskOffers;
+    private pendingTaskRequests;
+    constructor(logger: Logger);
+    expireTasks(): void;
+    registerRunner(runner: TaskRunner, messageCallback: MessageCallback): void;
+    deregisterRunner(runnerId: string): void;
+    registerRequester(requesterId: string, messageCallback: RequesterMessageCallback): void;
+    deregisterRequester(requesterId: string): void;
+    private messageRunner;
+    private messageRequester;
+    onRunnerMessage(runnerId: TaskRunner['id'], message: RunnerMessage.ToN8n.All): Promise<void>;
+    handleRpcRequest(taskId: Task['id'], callId: string, name: RunnerMessage.ToN8n.RPC['name'], params: unknown[]): Promise<void>;
+    handleRunnerAccept(taskId: Task['id']): void;
+    handleRunnerReject(taskId: Task['id'], reason: string): void;
+    handleDataRequest(taskId: Task['id'], requestId: RunnerMessage.ToN8n.TaskDataRequest['requestId'], requestType: RunnerMessage.ToN8n.TaskDataRequest['requestType'], param?: string): Promise<void>;
+    handleResponse(taskId: Task['id'], requestId: RunnerMessage.ToN8n.TaskDataRequest['requestId'], data: unknown): Promise<void>;
+    onRequesterMessage(requesterId: string, message: RequesterMessage.ToN8n.All): Promise<void>;
+    handleRequesterRpcResponse(taskId: string, callId: string, status: RequesterMessage.ToN8n.RPCResponse['status'], data: unknown): Promise<void>;
+    handleRequesterDataResponse(taskId: Task['id'], requestId: string, data: unknown): Promise<void>;
+    handleRequesterAccept(taskId: Task['id'], settings: RequesterMessage.ToN8n.TaskSettings['settings']): void;
+    handleRequesterReject(taskId: Task['id'], reason: string): void;
+    private cancelTask;
+    private failTask;
+    private getRunnerOrFailTask;
+    sendTaskSettings(taskId: Task['id'], settings: unknown): Promise<void>;
+    taskDoneHandler(taskId: Task['id'], data: TaskResultData): Promise<void>;
+    taskErrorHandler(taskId: Task['id'], error: unknown): Promise<void>;
+    acceptOffer(offer: TaskOffer, request: TaskRequest): Promise<void>;
+    settleTasks(): void;
+    taskRequested(request: TaskRequest): void;
+    taskOffered(offer: TaskOffer): void;
+    getTasks(): Map<string, Task>;
+    getPendingTaskOffers(): TaskOffer[];
+    getPendingTaskRequests(): TaskRequest[];
+    getKnownRunners(): Map<string, {
+        runner: TaskRunner;
+        messageCallback: MessageCallback;
+    }>;
+    getKnownRequesters(): Map<string, RequesterMessageCallback>;
+    getRunnerAcceptRejects(): Map<string, {
+        accept: RunnerAcceptCallback;
+        reject: TaskRejectCallback;
+    }>;
+    setTasks(tasks: Record<string, Task>): void;
+    setPendingTaskOffers(pendingTaskOffers: TaskOffer[]): void;
+    setPendingTaskRequests(pendingTaskRequests: TaskRequest[]): void;
+    setRunnerAcceptRejects(runnerAcceptRejects: Record<string, {
+        accept: RunnerAcceptCallback;
+        reject: TaskRejectCallback;
+    }>): void;
+}
+export {};