admin/n8n-enterprise-unlocked
1
0
Fork 0
mirror of https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git synced 2025-12-19 11:01:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(core): Show deprecation warning if task runners are disabled (#13189)

Browse Source
This commit is contained in:
Iván Ovejero
2025-02-13 11:30:50 +01:00
committed by GitHub
parent 0c6eb6eaef
commit 4f8dd3d7a8
2 changed files with 55 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
packages/cli/src/deprecation/deprecation.service.ts
View File

@@ -12,12 +12,15 @@ type Deprecation = {
message: string;
/** Function to identify the specific value in the env var that is deprecated. */
checkValue?: (value: string) => boolean;
checkValue?: (value?: string) => boolean;
/** Whether to show a deprecation warning if the env var is missing. */
warnIfMissing?: boolean;
};
const SAFE_TO_REMOVE = 'Remove this environment variable; it is no longer needed.';
/** Responsible for warning about use of deprecated env vars. */
/** Responsible for warning about deprecations related to env vars. */
@Service()
export class DeprecationService {
private readonly deprecations: Deprecation[] = [
@@ -39,10 +42,17 @@ export class DeprecationService {
envVar: 'N8N_SKIP_WEBHOOK_DEREGISTRATION_SHUTDOWN',
message: `n8n no longer deregisters webhooks at startup and shutdown. ${SAFE_TO_REMOVE}`,
},
{
envVar: 'N8N_RUNNERS_ENABLED',
message:
'Running n8n without task runners is deprecated. Task runners will be turned on by default in a future version. Please set `N8N_RUNNERS_ENABLED=true` to enable task runners now and avoid potential issues in the future. Learn more: https://docs.n8n.io/hosting/configuration/task-runners/',
checkValue: (value?: string) => value?.toLowerCase() !== 'true' && value !== '1',
warnIfMissing: true,
},
];
/** Runtime state of deprecated env vars. */
private readonly state: Record<EnvVarName, { inUse: boolean }> = {};
/** Runtime state of deprecation-related env vars. */
private readonly state: Record<EnvVarName, { mustWarn: boolean }> = {};
constructor(private readonly logger: Logger) {}
@@ -50,14 +60,14 @@ export class DeprecationService {
this.deprecations.forEach((d) => {
const envValue = process.env[d.envVar];
this.state[d.envVar] = {
inUse: d.checkValue
? envValue !== undefined && d.checkValue(envValue)
: envValue !== undefined,
mustWarn:
(d.warnIfMissing !== undefined && envValue === undefined) ||
(d.checkValue ? d.checkValue(envValue) : envValue !== undefined),
};
});
const inUse = Object.entries(this.state)
.filter(([, d]) => d.inUse)
const mustWarn = Object.entries(this.state)
.filter(([, d]) => d.mustWarn)
.map(([envVar]) => {
const deprecation = this.deprecations.find((d) => d.envVar === envVar);
if (!deprecation) {
@@ -66,19 +76,19 @@ export class DeprecationService {
return deprecation;
});
if (inUse.length === 0) return;
if (mustWarn.length === 0) return;
const header = `The following environment variable${
inUse.length === 1 ? ' is' : 's are'
} deprecated and will be removed in an upcoming version of n8n. Please take the recommended actions to update your configuration`;
const deprecations = inUse
const header = `There ${
mustWarn.length === 1 ? 'is a deprecation' : 'are deprecations'
} related to your environment variables. Please take the recommended actions to update your configuration`;
const deprecations = mustWarn
.map(({ envVar, message }) => ` - ${envVar} -> ${message}\n`)
.join('');
this.logger.warn(`\n${header}:\n${deprecations}`);
}
isInUse(envVar: string) {
return this.state[envVar]?.inUse ?? false;
mustWarn(envVar: string) {
return this.state[envVar]?.mustWarn ?? false;
}
}