Rocket.Chat/packages/apps-engine/tests/server/managers/AppSettingsManager.spec.ts

import { Any, AsyncTest, Expect, SetupFixture, SpyOn, Test } from 'alsatian';

import { AppMethod } from '../../../src/definition/metadata';
import type { ISetting } from '../../../src/definition/settings';
import type { AppManager } from '../../../src/server/AppManager';
import type { ProxiedApp } from '../../../src/server/ProxiedApp';
import type { AppBridges } from '../../../src/server/bridges';
import type {
	AppApiManager,
	AppExternalComponentManager,
	AppSchedulerManager,
	AppSlashCommandManager,
	AppVideoConfProviderManager,
} from '../../../src/server/managers';
import { AppAccessorManager, AppSettingsManager } from '../../../src/server/managers';
import type { UIActionButtonManager } from '../../../src/server/managers/UIActionButtonManager';
import type { AppMetadataStorage, IAppStorageItem } from '../../../src/server/storage';
import { TestsAppBridges } from '../../test-data/bridges/appBridges';
import { TestData } from '../../test-data/utilities';

export class AppSettingsManagerTestFixture {
	private mockStorageItem: IAppStorageItem;

	private mockApp: ProxiedApp;

	private mockBridges: AppBridges;

	private mockAccessors: AppAccessorManager;

	private mockStorage: AppMetadataStorage;

	private mockManager: AppManager;

	@SetupFixture
	public setupFixture() {
		this.mockStorageItem = {
			_id: 'test_underscore_id',
			settings: {},
		} as IAppStorageItem;

		this.mockStorageItem.settings.testing = TestData.getSetting('testing');

		const si = this.mockStorageItem;
		this.mockApp = {
			getID() {
				return 'testing';
			},
			getStorageItem() {
				return si;
			},
			setStorageItem(item: IAppStorageItem) {},
			call(method: AppMethod, ...args: Array<any>): Promise<any> {
				return Promise.resolve();
			},
		} as ProxiedApp;

		this.mockBridges = new TestsAppBridges();

		this.mockStorage = {
			updateSetting(appId: string, setting: ISetting): Promise<boolean> {
				return Promise.resolve(true);
			},
		} as AppMetadataStorage;

		const st = this.mockStorage;
		const bri = this.mockBridges;
		const app = this.mockApp;
		this.mockManager = {
			getOneById(appId: string): ProxiedApp {
				return appId === 'testing' ? app : undefined;
			},
			getBridges(): AppBridges {
				return bri;
			},
			getStorage(): AppMetadataStorage {
				return st;
			},
			getCommandManager(): AppSlashCommandManager {
				return {} as AppSlashCommandManager;
			},
			getExternalComponentManager(): AppExternalComponentManager {
				return {} as AppExternalComponentManager;
			},
			getApiManager(): AppApiManager {
				return {} as AppApiManager;
			},
			getSchedulerManager() {
				return {} as AppSchedulerManager;
			},
			getUIActionButtonManager() {
				return {} as UIActionButtonManager;
			},
			getVideoConfProviderManager() {
				return {} as AppVideoConfProviderManager;
			},
		} as AppManager;

		this.mockAccessors = new AppAccessorManager(this.mockManager);
		const ac = this.mockAccessors;
		this.mockManager.getAccessorManager = function _getAccessorManager(): AppAccessorManager {
			return ac;
		};
	}

	@Test()
	public basicAppSettingsManager() {
		Expect(() => new AppSettingsManager(this.mockManager)).not.toThrow();

		const asm = new AppSettingsManager(this.mockManager);
		Expect(asm.getAppSettings('testing')).not.toBe(this.mockStorageItem.settings);
		Expect(asm.getAppSettings('testing')).toEqual(this.mockStorageItem.settings);
		Expect(() => asm.getAppSettings('fake')).toThrowError(Error, 'No App found by the provided id.');
		Expect(() => {
			asm.getAppSettings('testing').testing.value = 'testing';
		}).toThrow();

		Expect(asm.getAppSetting('testing', 'testing')).not.toBe(this.mockStorageItem.settings.testing);
		Expect(asm.getAppSetting('testing', 'testing')).toEqual(this.mockStorageItem.settings.testing);
		Expect(() => asm.getAppSetting('fake', 'testing')).toThrowError(Error, 'No App found by the provided id.');
		Expect(() => asm.getAppSetting('testing', 'fake')).toThrowError(Error, 'No setting found for the App by the provided id.');
		Expect(() => {
			asm.getAppSetting('testing', 'testing').value = 'testing';
		}).toThrow();
	}

	@AsyncTest()
	public async updatingSettingViaAppSettingsManager() {
		const asm = new AppSettingsManager(this.mockManager);

		SpyOn(this.mockStorage, 'updateSetting');
		SpyOn(this.mockApp, 'call');
		SpyOn(this.mockBridges.getAppDetailChangesBridge(), 'doOnAppSettingsChange');

		await Expect(() => asm.updateAppSetting('fake', TestData.getSetting())).toThrowErrorAsync(Error, 'No App found by the provided id.');
		await Expect(() => asm.updateAppSetting('testing', TestData.getSetting('fake'))).toThrowErrorAsync(
			Error,
			'No setting found for the App by the provided id.',
		);

		const set = TestData.getSetting('testing');
		await Expect(() => asm.updateAppSetting('testing', set)).not.toThrowAsync();

		Expect(this.mockStorage.updateSetting).toHaveBeenCalledWith('test_underscore_id', Any(Object).thatMatches(set)).exactly(1);

		Expect(this.mockBridges.getAppDetailChangesBridge().doOnAppSettingsChange).toHaveBeenCalledWith('testing', set).exactly(1);

		Expect(this.mockApp.call).toHaveBeenCalledWith(AppMethod.ONSETTINGUPDATED, set).exactly(1);
	}
}