n8n/dist/task-runners/task-runner-process-base.d.ts

n8n Workflow Automation Tool

import { Logger } from '@n8n/backend-common';
import { LogScope, TaskRunnersConfig } from '@n8n/config';
import { spawn } from 'node:child_process';
import { TypedEmitter } from '../typed-emitter';
import { TaskBrokerAuthService } from './task-broker/auth/task-broker-auth.service';
import { TaskRunnerLifecycleEvents } from './task-runner-lifecycle-events';
export type ChildProcess = ReturnType<typeof spawn>;
export type ExitReason = 'unknown' | 'oom';
export type TaskRunnerProcessEventMap = {
    exit: {
        reason: ExitReason;
    };
};
export declare abstract class TaskRunnerProcessBase extends TypedEmitter<TaskRunnerProcessEventMap> {
    protected readonly logger: Logger;
    protected readonly runnerConfig: TaskRunnersConfig;
    protected readonly authService: TaskBrokerAuthService;
    protected readonly runnerLifecycleEvents: TaskRunnerLifecycleEvents;
    protected readonly name: string;
    protected readonly loggerScope: LogScope;
    protected process: ChildProcess | null;
    protected _runPromise: Promise<void> | null;
    protected isShuttingDown: boolean;
    constructor(logger: Logger, runnerConfig: TaskRunnersConfig, authService: TaskBrokerAuthService, runnerLifecycleEvents: TaskRunnerLifecycleEvents);
    get isRunning(): boolean;
    get pid(): number | undefined;
    get runPromise(): Promise<void> | null;
    get isInternal(): boolean;
    start(): Promise<void>;
    stop(): Promise<void>;
    protected forceRestart(): Promise<void>;
    protected onProcessExit(code: number | null, resolveFn: () => void): void;
    protected monitorProcess(taskRunnerProcess: ChildProcess): void;
    abstract startProcess(grantToken: string, taskBrokerUri: string): Promise<ChildProcess>;
    setupProcessMonitoring?(process: ChildProcess): void;
    analyzeExitReason?(code: number | null): {
        reason: ExitReason;
    };
}