feat: license add-ons (external modules)

.changeset/three-crews-allow.md

@@ -0,0 +1,8 @@
+---
+'@rocket.chat/core-typings': minor
+'@rocket.chat/apps-engine': minor
+'@rocket.chat/license': minor
+'@rocket.chat/meteor': minor
+---
+
+Added support for interacting with add-ons issued in the license

apps/meteor/client/NavBarV2/NavBarPagesToolbar/hooks/useAuditMenu.spec.tsx

@@ -32,7 +32,6 @@ it('should return an empty array of items if have license and not have permissio
 						// @ts-expect-error: just for testing
 						grantedModules: [{ module: 'auditing' }],
 					},
-					// @ts-expect-error: just for testing
 					activeModules: ['auditing'],
 				},
 			}))
@@ -54,7 +53,6 @@ it('should return auditItems if have license and permissions', async () => {
 						// @ts-expect-error: just for testing
 						grantedModules: [{ module: 'auditing' }],
 					},
-					// @ts-expect-error: just for testing
 					activeModules: ['auditing'],
 				},
 			}))
@@ -89,7 +87,6 @@ it('should return auditMessages item if have license and can-audit permission',
 						// @ts-expect-error: just for testing
 						grantedModules: [{ module: 'auditing' }],
 					},
-					// @ts-expect-error: just for testing
 					activeModules: ['auditing'],
 				},
 			}))
@@ -117,7 +114,6 @@ it('should return audiLogs item if have license and can-audit-log permission', a
 						// @ts-expect-error: just for testing
 						grantedModules: [{ module: 'auditing' }],
 					},
-					// @ts-expect-error: just for testing
 					activeModules: ['auditing'],
 				},
 			}))

apps/meteor/client/sidebar/header/actions/hooks/useAuditItems.spec.tsx

@@ -32,7 +32,6 @@ it('should return an empty array if have license and not have permissions', asyn
 						// @ts-expect-error: just for testing
 						grantedModules: [{ module: 'auditing' }],
 					},
-					// @ts-expect-error: just for testing
 					activeModules: ['auditing'],
 				},
 			}))
@@ -54,7 +53,6 @@ it('should return auditItems if have license and permissions', async () => {
 						// @ts-expect-error: just for testing
 						grantedModules: [{ module: 'auditing' }],
 					},
-					// @ts-expect-error: just for testing
 					activeModules: ['auditing'],
 				},
 			}))
@@ -89,7 +87,6 @@ it('should return auditMessages item if have license and can-audit permission',
 						// @ts-expect-error: just for testing
 						grantedModules: [{ module: 'auditing' }],
 					},
-					// @ts-expect-error: just for testing
 					activeModules: ['auditing'],
 				},
 			}))
@@ -117,7 +114,6 @@ it('should return audiLogs item if have license and can-audit-log permission', a
 						// @ts-expect-error: just for testing
 						grantedModules: [{ module: 'auditing' }],
 					},
-					// @ts-expect-error: just for testing
 					activeModules: ['auditing'],
 				},
 			}))

apps/meteor/ee/app/license/server/canEnableApp.ts

@@ -4,22 +4,38 @@ import { License } from '@rocket.chat/license';
 
 import { getInstallationSourceFromAppStorageItem } from '../../../../lib/apps/getInstallationSourceFromAppStorageItem';
 
-export const canEnableApp = async (app: IAppStorageItem): Promise<boolean> => {
+export const canEnableApp = async (app: IAppStorageItem): Promise<void> => {
 	if (!(await Apps.isInitialized())) {
-		return false;
+		throw new Error('apps-engine-not-initialized');
 	}
 
 	// Migrated apps were installed before the validation was implemented
 	// so they're always allowed to be enabled
 	if (app.migrated) {
-		return true;
+		return;
+	}
+
+	if (app.info.addon && !License.hasModule(app.info.addon)) {
+		throw new Error('app-addon-not-valid');
 	}
 
 	const source = getInstallationSourceFromAppStorageItem(app);
 	switch (source) {
 		case 'private':
-			return !(await License.shouldPreventAction('privateApps'));
+			if (await License.shouldPreventAction('privateApps')) {
+				throw new Error('license-prevented');
+			}
+
+			break;
 		default:
-			return !(await License.shouldPreventAction('marketplaceApps'));
+			if (await License.shouldPreventAction('marketplaceApps')) {
+				throw new Error('license-prevented');
+			}
+
+			if (app.marketplaceInfo?.isEnterpriseOnly && !License.hasValidLicense()) {
+				throw new Error('invalid-license');
+			}
+
+			break;
 	}
 };

apps/meteor/ee/server/apps/communication/rest.ts

@@ -1,9 +1,7 @@
 import { AppStatus, AppStatusUtils } from '@rocket.chat/apps-engine/definition/AppStatus';
 import type { IAppInfo } from '@rocket.chat/apps-engine/definition/metadata';
 import type { AppManager } from '@rocket.chat/apps-engine/server/AppManager';
-import { AppInstallationSource } from '@rocket.chat/apps-engine/server/storage';
 import type { IUser, IMessage } from '@rocket.chat/core-typings';
-import { License } from '@rocket.chat/license';
 import { Settings, Users } from '@rocket.chat/models';
 import { serverFetch as fetch } from '@rocket.chat/server-fetch';
 import { Meteor } from 'meteor/meteor';
@@ -20,7 +18,6 @@ import { i18n } from '../../../../server/lib/i18n';
 import { sendMessagesToAdmins } from '../../../../server/lib/sendMessagesToAdmins';
 import { canEnableApp } from '../../../app/license/server/canEnableApp';
 import { formatAppInstanceForRest } from '../../../lib/misc/formatAppInstanceForRest';
-import { appEnableCheck } from '../marketplace/appEnableCheck';
 import { notifyAppInstall } from '../marketplace/appInstall';
 import type { AppServerOrchestrator } from '../orchestrator';
 import { Apps } from '../orchestrator';
@@ -418,9 +415,13 @@ export class AppsRestApi {
 
 					void notifyAppInstall(orchestrator.getMarketplaceUrl() as string, 'install', info);
 
-					if (await canEnableApp(aff.getApp().getStorageItem())) {
+					try {
+						await canEnableApp(aff.getApp().getStorageItem());
+
 						const success = await manager.enable(info.id);
 						info.status = success ? AppStatus.AUTO_ENABLED : info.status;
+					} catch (error) {
+						// should report the error?
 					}
 
 					void orchestrator.getNotifier().appAdded(info.id);
@@ -1157,33 +1158,14 @@ export class AppsRestApi {
 						return API.v1.notFound(`No App found by the id of: ${appId}`);
 					}
 
-					const storedApp = prl.getStorageItem();
-					const { installationSource, marketplaceInfo } = storedApp;
-
-					if (!License.hasValidLicense() && installationSource === AppInstallationSource.MARKETPLACE) {
+					if (AppStatusUtils.isEnabled(status)) {
 						try {
-							const baseUrl = orchestrator.getMarketplaceUrl() as string;
-							const headers = getDefaultHeaders();
-							const { version } = prl.getInfo();
-
-							await appEnableCheck({
-								baseUrl,
-								headers,
-								appId,
-								version,
-								marketplaceInfo,
-								status,
-								logger: orchestrator.getRocketChatLogger(),
-							});
-						} catch (error: any) {
-							return API.v1.failure(error.message);
+							await canEnableApp(prl.getStorageItem());
+						} catch (error: unknown) {
+							return API.v1.failure((error as Error).message);
 						}
 					}
 
-					if (AppStatusUtils.isEnabled(status) && !(await canEnableApp(storedApp))) {
-						return API.v1.failure('Enabled apps have been maxed out');
-					}
-
 					const result = await manager.changeStatus(prl.getID(), status);
 					return API.v1.success({ status: result.getStatus() });
 				},

apps/meteor/ee/server/apps/orchestrator.js

@@ -177,16 +177,13 @@ export class AppServerOrchestrator {
 		/* eslint-disable no-await-in-loop */
 		// This needs to happen sequentially to keep track of app limits
 		for (const app of apps) {
-			const canEnable = await canEnableApp(app.getStorageItem());
+			try {
+				await canEnableApp(app.getStorageItem());
 
-			if (!canEnable) {
-				this._rocketchatLogger.warn(`App "${app.getInfo().name}" can't be enabled due to CE limits.`);
-				// We need to continue as the limits are applied depending on the app installation source
-				// i.e. if one limit is hit, we can't break the loop as the following apps might still be valid
-				continue;
+				await this.getManager().loadOne(app.getID());
+			} catch (error) {
+				this._rocketchatLogger.warn(`App "${app.getInfo().name}" could not be enabled: `, error.message);
 			}
-
-			await this.getManager().loadOne(app.getID());
 		}
 		/* eslint-enable no-await-in-loop */
 

apps/meteor/ee/server/startup/apps.ts

@@ -0,0 +1,30 @@
+import { AppStatus } from '@rocket.chat/apps-engine/definition/AppStatus';
+import { License } from '@rocket.chat/license';
+import { Meteor } from 'meteor/meteor';
+
+import { Apps } from '../apps';
+
+Meteor.startup(() => {
+	async function disableAppsCallback() {
+		void Apps.disableApps();
+	}
+
+	License.onInvalidateLicense(disableAppsCallback);
+	License.onRemoveLicense(disableAppsCallback);
+	// Disable apps that depend on add-ons (external modules) if they are invalidated
+	License.onModule(async ({ module, external, valid }) => {
+		if (!external || valid) return;
+
+		const enabledApps = await Apps.installedApps({ enabled: true });
+
+		if (!enabledApps) return;
+
+		await Promise.all(
+			enabledApps.map(async (app) => {
+				if (app.getInfo().addon !== module) return;
+
+				await Apps.getManager()?.disable(app.getID(), AppStatus.DISABLED, false);
+			}),
+		);
+	});
+});

ee/packages/license/__tests__/setLicense.spec.ts

@@ -140,16 +140,18 @@ describe('License set license procedures', () => {
 			const mocked = new MockedLicenseBuilder();
 			const oldToken = await mocked.sign();
 
-			const newToken = await mocked.withGratedModules(['livechat-enterprise']).sign();
+			const newToken = await mocked.withGratedModules(['livechat-enterprise', 'chat.rocket.test-addon']).sign();
 
 			await expect(license.setLicense(oldToken)).resolves.toBe(true);
 			expect(license.hasValidLicense()).toBe(true);
 
 			expect(license.hasModule('livechat-enterprise')).toBe(false);
+			expect(license.hasModule('chat.rocket.test-addon')).toBe(false);
 
 			await expect(license.setLicense(newToken)).resolves.toBe(true);
 			expect(license.hasValidLicense()).toBe(true);
 			expect(license.hasModule('livechat-enterprise')).toBe(true);
+			expect(license.hasModule('chat.rocket.test-addon')).toBe(true);
 		});
 
 		it('should call a validated event after set a valid license', async () => {

ee/packages/license/src/MockedLicenseBuilder.ts

@@ -1,4 +1,13 @@
-import type { ILicenseTag, ILicenseV3, LicenseLimit, LicenseModule, LicensePeriod, Timestamp } from '@rocket.chat/core-typings';
+import {
+	CoreModules,
+	type GrantedModules,
+	type ILicenseTag,
+	type ILicenseV3,
+	type LicenseLimit,
+	type LicenseModule,
+	type LicensePeriod,
+	type Timestamp,
+} from '@rocket.chat/core-typings';
 
 import { encrypt } from './token';
 
@@ -163,9 +172,7 @@ export class MockedLicenseBuilder {
 		return this;
 	}
 
-	grantedModules: {
-		module: LicenseModule;
-	}[] = [];
+	grantedModules: GrantedModules = [];
 
 	limits: {
 		activeUsers?: LicenseLimit[];
@@ -190,13 +197,17 @@ export class MockedLicenseBuilder {
 		return this;
 	}
 
-	public withGratedModules(modules: LicenseModule[]): this {
+	public withGratedModules(modules: string[]): this {
 		this.grantedModules = this.grantedModules ?? [];
-		this.grantedModules.push(...modules.map((module) => ({ module })));
+		this.grantedModules.push(
+			...(modules.map((module) =>
+				CoreModules.includes(module as LicenseModule) ? { module } : { module, external: true },
+			) as GrantedModules),
+		);
 		return this;
 	}
 
-	withNoGratedModules(modules: LicenseModule[]): this {
+	withNoGratedModules(modules: string[]): this {
 		this.grantedModules = this.grantedModules ?? [];
 		this.grantedModules = this.grantedModules.filter(({ module }) => !modules.includes(module));
 		return this;