n8n/dist/deprecation/deprecation.service.js

n8n Workflow Automation Tool

"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.DeprecationService = void 0;
const backend_common_1 = require("@n8n/backend-common");
const config_1 = require("@n8n/config");
const di_1 = require("@n8n/di");
const n8n_core_1 = require("n8n-core");
const SAFE_TO_REMOVE = 'Remove this environment variable; it is no longer needed.';
let DeprecationService = class DeprecationService {
    constructor(logger, globalConfig, instanceSettings) {
        this.logger = logger;
        this.globalConfig = globalConfig;
        this.instanceSettings = instanceSettings;
        this.deprecations = [
            {
                envVar: 'N8N_BINARY_DATA_STORAGE_PATH',
                message: 'Use N8N_STORAGE_PATH instead.',
            },
            { envVar: 'N8N_BINARY_DATA_TTL', message: SAFE_TO_REMOVE },
            { envVar: 'N8N_PERSISTED_BINARY_DATA_TTL', message: SAFE_TO_REMOVE },
            { envVar: 'EXECUTIONS_DATA_PRUNE_TIMEOUT', message: SAFE_TO_REMOVE },
            { envVar: 'N8N_AVAILABLE_BINARY_DATA_MODES', message: SAFE_TO_REMOVE },
            { envVar: 'N8N_CONFIG_FILES', message: 'Please use .env files or *_FILE env vars instead.' },
            { envVar: 'N8N_RUNNERS_ENABLED', message: SAFE_TO_REMOVE },
            {
                envVar: 'N8N_SKIP_WEBHOOK_DEREGISTRATION_SHUTDOWN',
                message: `n8n no longer deregisters webhooks at startup and shutdown. ${SAFE_TO_REMOVE}`,
            },
            {
                envVar: 'OFFLOAD_MANUAL_EXECUTIONS_TO_WORKERS',
                message: 'Running manual executions in the main instance in scaling mode is deprecated. Manual executions will be routed to workers in a future version. Please set `OFFLOAD_MANUAL_EXECUTIONS_TO_WORKERS=true` to offload manual executions to workers and avoid potential issues in the future. Consider increasing memory available to workers and reducing memory available to main.',
                checkValue: (value) => value?.toLowerCase() !== 'true' && value !== '1',
                warnIfMissing: true,
                matchConfig: this.globalConfig.executions.mode === 'queue',
                disableIf: () => this.instanceSettings.instanceType !== 'main',
            },
            {
                envVar: 'N8N_EXPRESSION_EVALUATOR',
                message: `n8n has replaced \`tmpl\` with \`tournament\` as expression evaluator. ${SAFE_TO_REMOVE}`,
            },
            {
                envVar: 'N8N_EXPRESSION_REPORT_DIFFERENCE',
                message: `n8n has replaced \`tmpl\` with \`tournament\` as expression evaluator. ${SAFE_TO_REMOVE}`,
            },
            {
                envVar: 'WEBHOOK_URL',
                message: 'Use N8N_WEBHOOK_URL instead, which sets the base URL for both test and production webhooks.',
            },
            {
                envVar: 'N8N_UNVERIFIED_PACKAGES_ENABLED',
                message: 'The default for this variable will change to `false` in a future version. Set it to `true` explicitly to keep installing unverified community packages.',
                checkValue: (value) => value === undefined,
            },
            {
                envVar: 'N8N_RUNNERS_TASK_TIMEOUT',
                message: 'The default for this variable will be reduced from 300 (5 minutes) to 60 (1 minute) in a future version. Set it explicitly to keep your current task timeout.',
                checkValue: (value) => value === undefined,
            },
            {
                envVar: 'N8N_COMPRESSION_NODE_MAX_DECOMPRESSED_SIZE_BYTES',
                message: 'The default for this variable will be reduced from 2 GiB to 256 MiB in a future version. Set it explicitly to keep your current limit.',
                checkValue: (value) => value === undefined,
            },
            {
                envVar: 'N8N_COMPRESSION_NODE_MAX_ZIP_ENTRIES',
                message: 'The default for this variable will be reduced from 5000 to 1000 in a future version. Set it explicitly to keep your current limit.',
                checkValue: (value) => value === undefined,
            },
            {
                envVar: 'N8N_EXPRESSION_ENGINE',
                message: 'The `legacy` expression engine runs expressions without isolation, is no longer considered secure, and will be removed in a future version. Remove this environment variable to use the default `vm` engine.',
                checkValue: (value) => value === 'legacy',
            },
            {
                envVar: 'N8N_DEFAULT_BINARY_DATA_MODE',
                message: 'In-memory binary data storage (`default` mode) will be removed in a future version. Switch to `filesystem`, `s3`, or `database`.',
                checkValue: (value) => value === 'default',
            },
            {
                envVar: 'EXECUTIONS_PROCESS',
                message: SAFE_TO_REMOVE,
                checkValue: (value) => value !== undefined && value !== 'own',
            },
            {
                envVar: 'EXECUTIONS_PROCESS',
                message: 'n8n does not support `own` mode since May 2023. Please remove this environment variable to allow n8n to start. If you need the isolation and performance gains, please consider queue mode: https://docs.n8n.io/hosting/scaling/queue-mode/',
                checkValue: (value) => value === 'own',
            },
        ];
        this.state = new Map();
    }
    warn() {
        this.deprecations.forEach((d) => {
            if (d.disableIf?.()) {
                this.state.set(d, { mustWarn: false });
                return;
            }
            const envValue = process.env[d.envVar];
            const matchConfig = d.matchConfig === true || d.matchConfig === undefined;
            const warnIfMissing = d.warnIfMissing !== undefined && envValue === undefined;
            const checkValue = d.checkValue ? d.checkValue(envValue) : envValue !== undefined;
            this.state.set(d, {
                mustWarn: matchConfig && (warnIfMissing || checkValue),
            });
        });
        const mustWarn = [];
        for (const [deprecation, metadata] of this.state.entries()) {
            if (!metadata.mustWarn) {
                continue;
            }
            mustWarn.push(` - ${deprecation.envVar} -> ${deprecation.message}\n`);
        }
        if (!this.instanceSettings.isDocker) {
            mustWarn.push(' - Running n8n outside a container is deprecated. Future versions will require running n8n via the official Docker image. See https://docs.n8n.io/deploy/host-n8n/install-options/install-with-docker\n');
        }
        if (mustWarn.length === 0)
            return;
        const header = `There ${mustWarn.length === 1 ? 'is a deprecation' : 'are deprecations'} related to your n8n setup. Please take the recommended actions to update your configuration`;
        this.logger.warn(`\n${header}:\n${mustWarn.join('')}`);
    }
};
exports.DeprecationService = DeprecationService;
exports.DeprecationService = DeprecationService = __decorate([
    (0, di_1.Service)(),
    __metadata("design:paramtypes", [backend_common_1.Logger, config_1.GlobalConfig, n8n_core_1.InstanceSettings])
], DeprecationService);
//# sourceMappingURL=deprecation.service.js.map