feat: updated documentation to include remote config

Author: dcoric

.gitignore

@@ -117,6 +117,9 @@ dist
 # Stores VSCode versions used for testing VSCode extensions
 .vscode-test
 
+# Jetbrains
+.idea
+
 # yarn v2
 
 .yarn/cache

src/config/index.js

@@ -1,6 +1,5 @@
 const fs = require('fs');
 const ConfigLoader = require('./ConfigLoader');
-const proxy = require('../proxy');
 const { validate } = require('./file'); // Import the validate function
 
 const defaultSettings = require('../../proxy.config.json');
@@ -17,43 +16,6 @@ let _config = { ...defaultSettings, ...(_userSettings || {}) };
 // Create config loader instance
 const configLoader = new ConfigLoader(_config);
 
-// Handle configuration updates
-configLoader.on('configurationChanged', async (newConfig) => {
-  console.log('Configuration updated from external source');
-  try {
-    // 1. Stop existing services
-    await proxy.stop();
-
-    // 2. Update config
-    _config = newConfig;
-
-    // 3. Validate new configuration
-    validate(); // Use the imported validate function
-
-    // 4. Restart services with new config
-    await proxy.start();
-
-    console.log('Services restarted with new configuration');
-  } catch (error) {
-    console.error('Failed to apply new configuration:', error);
-    // Attempt to restart with previous config
-    try {
-      await proxy.start();
-    } catch (startError) {
-      console.error('Failed to restart services:', startError);
-    }
-  }
-});
-
-configLoader.on('configurationError', (error) => {
-  console.error('Error loading external configuration:', error);
-});
-
-// Start the config loader if external sources are enabled
-configLoader.start().catch((error) => {
-  console.error('Failed to start configuration loader:', error);
-});
-
 // Helper function to get current config value
 const getConfig = (key) => {
   return _config[key];
@@ -109,6 +71,50 @@ const logConfiguration = () => {
   console.log(`authentication = ${JSON.stringify(getAuthentication())}`);
 };
 
+// Function to handle configuration updates
+const handleConfigUpdate = async (newConfig) => {
+  console.log('Configuration updated from external source');
+  try {
+    // 1. Get proxy module dynamically to avoid circular dependency
+    const proxy = require('../proxy');
+
+    // 2. Stop existing services
+    await proxy.stop();
+
+    // 3. Update config
+    _config = newConfig;
+
+    // 4. Validate new configuration
+    validate();
+
+    // 5. Restart services with new config
+    await proxy.start();
+
+    console.log('Services restarted with new configuration');
+  } catch (error) {
+    console.error('Failed to apply new configuration:', error);
+    // Attempt to restart with previous config
+    try {
+      const proxy = require('../proxy');
+      await proxy.start();
+    } catch (startError) {
+      console.error('Failed to restart services:', startError);
+    }
+  }
+};
+
+// Handle configuration updates
+configLoader.on('configurationChanged', handleConfigUpdate);
+
+configLoader.on('configurationError', (error) => {
+  console.error('Error loading external configuration:', error);
+});
+
+// Start the config loader if external sources are enabled
+configLoader.start().catch((error) => {
+  console.error('Failed to start configuration loader:', error);
+});
+
 // Force reload of configuration
 const reloadConfiguration = async () => {
   await configLoader.reloadConfiguration();