Refresh server connection when MI server settings change (#24649)

app/lib/server/startup/settings.ts

@@ -3160,7 +3160,7 @@ settingsRegistry.addGroup('Call_Center', function () {
 		});
 		this.section('Server_Configuration', function () {
 			this.add('VoIP_Server_Host', '', {
-				type: 'password',
+				type: 'string',
 				public: true,
 				enableQuery: {
 					_id: 'VoIP_Enabled',
@@ -3176,7 +3176,7 @@ settingsRegistry.addGroup('Call_Center', function () {
 				},
 			});
 			this.add('VoIP_Server_Name', '', {
-				type: 'int',
+				type: 'string',
 				public: true,
 				enableQuery: {
 					_id: 'VoIP_Enabled',

app/voip/server/startup.ts

@@ -1,6 +1,19 @@
+import debounce from 'lodash.debounce';
+
 import { settings } from '../../settings/server';
 import { Voip } from '../../../server/sdk';
 
+const debouncedRefresh = debounce(Voip.refresh, 1000);
+
 settings.watch('VoIP_Enabled', (value: boolean) => {
 	return value ? Voip.init() : Voip.stop();
 });
+
+settings.changeMultiple(
+	['VoIP_Management_Server_Host', 'VoIP_Management_Server_Port', 'VoIP_Management_Server_Username', 'VoIP_Management_Server_Password'],
+	(_values) => {
+		// Here, if 4 settings are changed at once, we're getting 4 diff callbacks. The good part is that all callbacks are fired almost instantly
+		// So to avoid stopping/starting voip too often, we debounce the call and restart 1 second after the last setting has reached us.
+		return debouncedRefresh();
+	},
+);

server/sdk/types/IVoipService.ts

@@ -19,4 +19,5 @@ export interface IVoipService {
 	cachedQueueDetails(): () => Promise<{ name: string; members: string[] }[]>;
 	init(): Promise<void>;
 	stop(): Promise<void>;
+	refresh(): Promise<void>;
 }

server/services/voip/connector/asterisk/CommandHandler.ts

@@ -151,6 +151,11 @@ export class CommandHandler {
 	}
 
 	stop(): void {
+		if (!this.continuousMonitor) {
+			// service is already stopped or was never initialized
+			return;
+		}
+
 		this.continuousMonitor.cleanMonitor();
 		for (const connection of this.connections.values()) {
 			connection.closeConnection();

server/services/voip/service.ts

@@ -51,7 +51,7 @@ export class VoipService extends ServiceClassInternal implements IVoipService {
 			await this.commandHandler.initConnection(CommandType.AMI);
 			this.logger.info('VoIP service started');
 		} catch (err) {
-			this.logger.error('Error initializing VOIP service', err);
+			this.logger.error({ msg: 'Error initializing VOIP service', err });
 		}
 	}
 
@@ -61,10 +61,16 @@ export class VoipService extends ServiceClassInternal implements IVoipService {
 			this.commandHandler.stop();
 			this.logger.info('VoIP service stopped');
 		} catch (err) {
-			this.logger.error('Error stopping VoIP service', err);
+			this.logger.error({ msg: 'Error stopping VoIP service', err });
 		}
 	}
 
+	async refresh(): Promise<void> {
+		this.logger.info('Restarting VoIP service due to settings changes');
+		await this.stop();
+		await this.init();
+	}
+
 	getServerConfigData(type: ServerType): IVoipCallServerConfig | IVoipManagementServerConfig {
 		return getServerConfigDataFromSettings(type);
 	}