refactor(core): Separate license state from license service (#15097)

packages/@n8n/backend-common/package.json

@@ -21,6 +21,9 @@
     "dist/**/*"
   ],
   "dependencies": {
+    "@n8n/constants": "workspace:^",
+    "@n8n/di": "workspace:^",
+    "n8n-workflow": "workspace:^",
     "reflect-metadata": "catalog:"
   },
   "devDependencies": {

packages/@n8n/backend-common/src/index.ts

@@ -1 +1,2 @@
-export {};
+export * from './license-state';
+export * from './types';

packages/@n8n/backend-common/src/license-state.ts

@@ -0,0 +1,192 @@
+import { UNLIMITED_LICENSE_QUOTA, type BooleanLicenseFeature } from '@n8n/constants';
+import { Service } from '@n8n/di';
+import { UnexpectedError } from 'n8n-workflow';
+
+import type { FeatureReturnType, LicenseProvider } from './types';
+
+class ProviderNotSetError extends UnexpectedError {
+	constructor() {
+		super('Cannot query license state because license provider has not been set');
+	}
+}
+
+@Service()
+export class LicenseState {
+	licenseProvider: LicenseProvider | null = null;
+
+	setLicenseProvider(provider: LicenseProvider) {
+		this.licenseProvider = provider;
+	}
+
+	private assertProvider(): asserts this is { licenseProvider: LicenseProvider } {
+		if (!this.licenseProvider) throw new ProviderNotSetError();
+	}
+
+	// --------------------
+	//     core queries
+	// --------------------
+
+	isLicensed(feature: BooleanLicenseFeature) {
+		this.assertProvider();
+
+		return this.licenseProvider.isLicensed(feature);
+	}
+
+	getValue<T extends keyof FeatureReturnType>(feature: T): FeatureReturnType[T] {
+		this.assertProvider();
+
+		return this.licenseProvider.getValue(feature);
+	}
+
+	// --------------------
+	//      booleans
+	// --------------------
+
+	isSharingLicensed() {
+		return this.isLicensed('feat:sharing');
+	}
+
+	isLogStreamingLicensed() {
+		return this.isLicensed('feat:logStreaming');
+	}
+
+	isLdapLicensed() {
+		return this.isLicensed('feat:ldap');
+	}
+
+	isSamlLicensed() {
+		return this.isLicensed('feat:saml');
+	}
+
+	isApiKeyScopesLicensed() {
+		return this.isLicensed('feat:apiKeyScopes');
+	}
+
+	isAiAssistantLicensed() {
+		return this.isLicensed('feat:aiAssistant');
+	}
+
+	isAskAiLicensed() {
+		return this.isLicensed('feat:askAi');
+	}
+
+	isAiCreditsLicensed() {
+		return this.isLicensed('feat:aiCredits');
+	}
+
+	isAdvancedExecutionFiltersLicensed() {
+		return this.isLicensed('feat:advancedExecutionFilters');
+	}
+
+	isAdvancedPermissionsLicensed() {
+		return this.isLicensed('feat:advancedPermissions');
+	}
+
+	isDebugInEditorLicensed() {
+		return this.isLicensed('feat:debugInEditor');
+	}
+
+	isBinaryDataS3Licensed() {
+		return this.isLicensed('feat:binaryDataS3');
+	}
+
+	isMultiMainLicensed() {
+		return this.isLicensed('feat:multipleMainInstances');
+	}
+
+	isVariablesLicensed() {
+		return this.isLicensed('feat:variables');
+	}
+
+	isSourceControlLicensed() {
+		return this.isLicensed('feat:sourceControl');
+	}
+
+	isExternalSecretsLicensed() {
+		return this.isLicensed('feat:externalSecrets');
+	}
+
+	isWorkflowHistoryLicensed() {
+		return this.isLicensed('feat:workflowHistory');
+	}
+
+	isAPIDisabled() {
+		return this.isLicensed('feat:apiDisabled');
+	}
+
+	isWorkerViewLicensed() {
+		return this.isLicensed('feat:workerView');
+	}
+
+	isProjectRoleAdminLicensed() {
+		return this.isLicensed('feat:projectRole:admin');
+	}
+
+	isProjectRoleEditorLicensed() {
+		return this.isLicensed('feat:projectRole:editor');
+	}
+
+	isProjectRoleViewerLicensed() {
+		return this.isLicensed('feat:projectRole:viewer');
+	}
+
+	isCustomNpmRegistryLicensed() {
+		return this.isLicensed('feat:communityNodes:customRegistry');
+	}
+
+	isFoldersLicensed() {
+		return this.isLicensed('feat:folders');
+	}
+
+	isInsightsSummaryLicensed() {
+		return this.isLicensed('feat:insights:viewSummary');
+	}
+
+	isInsightsDashboardLicensed() {
+		return this.isLicensed('feat:insights:viewDashboard');
+	}
+
+	isInsightsHourlyDataLicensed() {
+		return this.isLicensed('feat:insights:viewHourlyData');
+	}
+
+	// --------------------
+	//      integers
+	// --------------------
+
+	getMaxUsers() {
+		return this.getValue('quota:users') ?? UNLIMITED_LICENSE_QUOTA;
+	}
+
+	getMaxActiveWorkflows() {
+		return this.getValue('quota:activeWorkflows') ?? UNLIMITED_LICENSE_QUOTA;
+	}
+
+	getMaxVariables() {
+		return this.getValue('quota:maxVariables') ?? UNLIMITED_LICENSE_QUOTA;
+	}
+
+	getMaxAiCredits() {
+		return this.getValue('quota:aiCredits') ?? 0;
+	}
+
+	getWorkflowHistoryPruneQuota() {
+		return this.getValue('quota:workflowHistoryPrune') ?? UNLIMITED_LICENSE_QUOTA;
+	}
+
+	getInsightsMaxHistory() {
+		return this.getValue('quota:insights:maxHistoryDays') ?? 7;
+	}
+
+	getInsightsRetentionMaxAge() {
+		return this.getValue('quota:insights:retention:maxAgeDays') ?? 180;
+	}
+
+	getInsightsRetentionPruneInterval() {
+		return this.getValue('quota:insights:retention:pruneIntervalDays') ?? 24;
+	}
+
+	getMaxTeamProjects() {
+		return this.getValue('quota:maxTeamProjects') ?? 0;
+	}
+}

packages/@n8n/backend-common/src/types.ts

@@ -0,0 +1,15 @@
+import type { BooleanLicenseFeature, NumericLicenseFeature } from '@n8n/constants';
+
+export type FeatureReturnType = Partial<
+	{
+		planName: string;
+	} & { [K in NumericLicenseFeature]: number } & { [K in BooleanLicenseFeature]: boolean }
+>;
+
+export interface LicenseProvider {
+	/** Returns whether a feature is included in the user's license plan. */
+	isLicensed(feature: BooleanLicenseFeature): boolean;
+
+	/** Returns the value of a feature in the user's license plan, typically a boolean or integer. */
+	getValue<T extends keyof FeatureReturnType>(feature: T): FeatureReturnType[T];
+}