ultravisor 1.0.3 → 1.0.8

package/source/beacon/Ultravisor-Beacon-Client.cjs

@@ -0,0 +1,568 @@
+/**
+ * Ultravisor Beacon Client
+ *
+ * A lightweight worker node that connects to an Ultravisor server,
+ * registers its capabilities, polls for work, executes tasks locally,
+ * and reports results back to the orchestrator.
+ *
+ * Capabilities are provided by pluggable CapabilityProviders loaded
+ * via the ProviderRegistry. The beacon advertises the aggregate set
+ * of capabilities from all loaded providers.
+ *
+ * Communication is HTTP-based (transport-agnostic design means this
+ * can be swapped for WebSocket, MQTT, etc. in the future).
+ */
+
+const libHTTP = require('http');
+
+const libBeaconExecutor = require('./Ultravisor-Beacon-Executor.cjs');
+
+class UltravisorBeaconClient
+{
+	constructor(pConfig)
+	{
+		this._Config = Object.assign({
+			ServerURL: 'http://localhost:54321',
+			Name: 'beacon-worker',
+			Password: '',
+			Capabilities: ['Shell'],
+			MaxConcurrent: 1,
+			PollIntervalMs: 5000,
+			HeartbeatIntervalMs: 30000,
+			StagingPath: process.cwd(),
+			Tags: {}
+		}, pConfig || {});
+
+		this._BeaconID = null;
+		this._PollInterval = null;
+		this._HeartbeatInterval = null;
+		this._Running = false;
+		this._ActiveWorkItems = 0;
+		this._SessionCookie = null;
+		this._Authenticating = false;
+
+		this._Executor = new libBeaconExecutor({
+			StagingPath: this._Config.StagingPath
+		});
+
+		// Load capability providers
+		this._loadProviders();
+	}
+
+	// ================================================================
+	// Provider Loading
+	// ================================================================
+
+	_loadProviders()
+	{
+		let tmpProviders = this._Config.Providers;
+
+		if (!tmpProviders)
+		{
+			// Backward compatibility: convert Capabilities array to Provider descriptors
+			let tmpCapabilities = this._Config.Capabilities || ['Shell'];
+			tmpProviders = tmpCapabilities.map(function (pCap)
+			{
+				return { Source: pCap, Config: {} };
+			});
+		}
+
+		let tmpCount = this._Executor.providerRegistry.loadProviders(tmpProviders);
+		console.log(`[Beacon] Loaded ${tmpCount} capability provider(s).`);
+	}
+
+	// ================================================================
+	// Lifecycle
+	// ================================================================
+
+	/**
+	 * Start the Beacon client: initialize providers, register, then begin polling.
+	 */
+	start(fCallback)
+	{
+		console.log(`[Beacon] Starting "${this._Config.Name}"...`);
+		console.log(`[Beacon] Server: ${this._Config.ServerURL}`);
+
+		// Initialize all providers before registering
+		this._Executor.providerRegistry.initializeAll((pInitError) =>
+		{
+			if (pInitError)
+			{
+				console.error(`[Beacon] Provider initialization failed: ${pInitError.message}`);
+				return fCallback(pInitError);
+			}
+
+			let tmpCapabilities = this._Executor.providerRegistry.getCapabilities();
+			console.log(`[Beacon] Capabilities: ${tmpCapabilities.join(', ')}`);
+
+			// Authenticate before registering
+			this._authenticate((pAuthError) =>
+			{
+				if (pAuthError)
+				{
+					console.error(`[Beacon] Authentication failed: ${pAuthError.message}`);
+					return fCallback(pAuthError);
+				}
+
+				console.log(`[Beacon] Authenticated successfully.`);
+
+				this._register((pError, pBeacon) =>
+				{
+					if (pError)
+					{
+						console.error(`[Beacon] Registration failed: ${pError.message}`);
+						return fCallback(pError);
+					}
+
+					this._BeaconID = pBeacon.BeaconID;
+					this._Running = true;
+
+					console.log(`[Beacon] Registered as ${this._BeaconID}`);
+
+					// Start polling for work
+					this._PollInterval = setInterval(() =>
+					{
+						this._poll();
+					}, this._Config.PollIntervalMs);
+
+					// Start heartbeat
+					this._HeartbeatInterval = setInterval(() =>
+					{
+						this._heartbeat();
+					}, this._Config.HeartbeatIntervalMs);
+
+					// Do an immediate poll
+					this._poll();
+
+					return fCallback(null, pBeacon);
+				});
+			});
+		});
+	}
+
+	/**
+	 * Stop the Beacon client: stop polling, shutdown providers, deregister.
+	 */
+	stop(fCallback)
+	{
+		console.log(`[Beacon] Stopping...`);
+		this._Running = false;
+
+		if (this._PollInterval)
+		{
+			clearInterval(this._PollInterval);
+			this._PollInterval = null;
+		}
+
+		if (this._HeartbeatInterval)
+		{
+			clearInterval(this._HeartbeatInterval);
+			this._HeartbeatInterval = null;
+		}
+
+		// Clean up affinity staging directories
+		this._Executor.cleanupAffinityDirs();
+
+		// Shutdown providers
+		this._Executor.providerRegistry.shutdownAll((pShutdownError) =>
+		{
+			if (pShutdownError)
+			{
+				console.warn(`[Beacon] Provider shutdown warning: ${pShutdownError.message}`);
+			}
+
+			if (this._BeaconID)
+			{
+				this._deregister((pError) =>
+				{
+					if (pError)
+					{
+						console.warn(`[Beacon] Deregistration warning: ${pError.message}`);
+					}
+					console.log(`[Beacon] Stopped.`);
+					if (fCallback) return fCallback(null);
+				});
+			}
+			else
+			{
+				console.log(`[Beacon] Stopped.`);
+				if (fCallback) return fCallback(null);
+			}
+		});
+	}
+
+	// ================================================================
+	// Authentication
+	// ================================================================
+
+	_authenticate(fCallback)
+	{
+		let tmpBody = {
+			UserName: this._Config.Name,
+			Password: this._Config.Password || ''
+		};
+
+		let tmpBodyString = JSON.stringify(tmpBody);
+		let tmpParsedURL = new URL(this._Config.ServerURL);
+		let tmpOptions = {
+			hostname: tmpParsedURL.hostname,
+			port: tmpParsedURL.port || 80,
+			path: '/1.0/Authenticate',
+			method: 'POST',
+			headers: {
+				'Content-Type': 'application/json',
+				'Content-Length': Buffer.byteLength(tmpBodyString)
+			}
+		};
+
+		let tmpReq = libHTTP.request(tmpOptions, (pResponse) =>
+		{
+			let tmpData = '';
+			pResponse.on('data', (pChunk) => { tmpData += pChunk; });
+			pResponse.on('end', () =>
+			{
+				if (pResponse.statusCode >= 400)
+				{
+					return fCallback(new Error(`Authentication failed with HTTP ${pResponse.statusCode}`));
+				}
+
+				// Extract session cookie from Set-Cookie headers
+				let tmpSetCookieHeaders = pResponse.headers['set-cookie'];
+				if (tmpSetCookieHeaders && tmpSetCookieHeaders.length > 0)
+				{
+					// Take the name=value portion (before the first semicolon)
+					let tmpCookieParts = tmpSetCookieHeaders[0].split(';');
+					this._SessionCookie = tmpCookieParts[0].trim();
+					console.log(`[Beacon] Session cookie acquired.`);
+				}
+
+				try
+				{
+					let tmpParsed = JSON.parse(tmpData);
+					return fCallback(null, tmpParsed);
+				}
+				catch (pParseError)
+				{
+					return fCallback(new Error(`Invalid JSON in auth response: ${tmpData.substring(0, 200)}`));
+				}
+			});
+		});
+
+		tmpReq.on('error', (pError) =>
+		{
+			return fCallback(pError);
+		});
+
+		tmpReq.write(tmpBodyString);
+		tmpReq.end();
+	}
+
+	// ================================================================
+	// Reconnection
+	// ================================================================
+
+	_reconnect()
+	{
+		if (this._Authenticating)
+		{
+			return;
+		}
+		this._Authenticating = true;
+
+		// Clear existing intervals
+		if (this._PollInterval)
+		{
+			clearInterval(this._PollInterval);
+			this._PollInterval = null;
+		}
+		if (this._HeartbeatInterval)
+		{
+			clearInterval(this._HeartbeatInterval);
+			this._HeartbeatInterval = null;
+		}
+
+		this._SessionCookie = null;
+
+		console.log(`[Beacon] Reconnecting — re-authenticating...`);
+
+		this._authenticate((pAuthError) =>
+		{
+			if (pAuthError)
+			{
+				console.error(`[Beacon] Re-authentication failed: ${pAuthError.message}`);
+				this._Authenticating = false;
+				setTimeout(() => { this._reconnect(); }, 10000);
+				return;
+			}
+
+			console.log(`[Beacon] Re-authenticated, re-registering...`);
+
+			this._register((pRegError, pBeacon) =>
+			{
+				if (pRegError)
+				{
+					console.error(`[Beacon] Re-registration failed: ${pRegError.message}`);
+					this._Authenticating = false;
+					setTimeout(() => { this._reconnect(); }, 10000);
+					return;
+				}
+
+				this._BeaconID = pBeacon.BeaconID;
+				this._Authenticating = false;
+
+				console.log(`[Beacon] Reconnected as ${this._BeaconID}`);
+
+				// Restart polling
+				this._PollInterval = setInterval(() =>
+				{
+					this._poll();
+				}, this._Config.PollIntervalMs);
+
+				// Restart heartbeat
+				this._HeartbeatInterval = setInterval(() =>
+				{
+					this._heartbeat();
+				}, this._Config.HeartbeatIntervalMs);
+
+				// Immediate poll
+				this._poll();
+			});
+		});
+	}
+
+	// ================================================================
+	// Registration
+	// ================================================================
+
+	_register(fCallback)
+	{
+		let tmpBody = {
+			Name: this._Config.Name,
+			Capabilities: this._Executor.providerRegistry.getCapabilities(),
+			MaxConcurrent: this._Config.MaxConcurrent,
+			Tags: this._Config.Tags
+		};
+
+		this._httpRequest('POST', '/Beacon/Register', tmpBody, fCallback);
+	}
+
+	_deregister(fCallback)
+	{
+		this._httpRequest('DELETE', `/Beacon/${this._BeaconID}`, null, fCallback);
+	}
+
+	// ================================================================
+	// Polling
+	// ================================================================
+
+	_poll()
+	{
+		if (!this._Running || !this._BeaconID)
+		{
+			return;
+		}
+
+		if (this._ActiveWorkItems >= this._Config.MaxConcurrent)
+		{
+			return;
+		}
+
+		this._httpRequest('POST', '/Beacon/Work/Poll', { BeaconID: this._BeaconID },
+			(pError, pResponse) =>
+			{
+				if (pError)
+				{
+					// Silent on poll errors — just retry next interval
+					return;
+				}
+
+				if (!pResponse || !pResponse.WorkItem)
+				{
+					// No work available
+					return;
+				}
+
+				// Execute the work item
+				this._executeWorkItem(pResponse.WorkItem);
+			});
+	}
+
+	// ================================================================
+	// Work Execution
+	// ================================================================
+
+	_executeWorkItem(pWorkItem)
+	{
+		this._ActiveWorkItems++;
+		console.log(`[Beacon] Executing work item [${pWorkItem.WorkItemHash}] (${pWorkItem.Capability}/${pWorkItem.Action})`);
+
+		// Create a progress callback that sends updates to the server
+		let tmpWorkItemHash = pWorkItem.WorkItemHash;
+		let fReportProgress = (pProgressData) =>
+		{
+			this._reportProgress(tmpWorkItemHash, pProgressData);
+		};
+
+		this._Executor.execute(pWorkItem, (pError, pResult) =>
+		{
+			this._ActiveWorkItems--;
+
+			if (pError)
+			{
+				console.error(`[Beacon] Execution error for [${pWorkItem.WorkItemHash}]: ${pError.message}`);
+				this._reportError(pWorkItem.WorkItemHash, pError.message, []);
+				return;
+			}
+
+			// Check if the result indicates an error (non-zero exit code)
+			let tmpOutputs = pResult.Outputs || {};
+			if (tmpOutputs.ExitCode && tmpOutputs.ExitCode !== 0)
+			{
+				console.warn(`[Beacon] Work item [${pWorkItem.WorkItemHash}] completed with exit code ${tmpOutputs.ExitCode}`);
+			}
+			else
+			{
+				console.log(`[Beacon] Work item [${pWorkItem.WorkItemHash}] completed successfully.`);
+			}
+
+			this._reportComplete(pWorkItem.WorkItemHash, tmpOutputs, pResult.Log || []);
+		}, fReportProgress);
+	}
+
+	// ================================================================
+	// Reporting
+	// ================================================================
+
+	_reportComplete(pWorkItemHash, pOutputs, pLog)
+	{
+		this._httpRequest('POST', `/Beacon/Work/${pWorkItemHash}/Complete`,
+			{ Outputs: pOutputs, Log: pLog },
+			(pError) =>
+			{
+				if (pError)
+				{
+					console.error(`[Beacon] Failed to report completion for [${pWorkItemHash}]: ${pError.message}`);
+				}
+			});
+	}
+
+	_reportError(pWorkItemHash, pErrorMessage, pLog)
+	{
+		this._httpRequest('POST', `/Beacon/Work/${pWorkItemHash}/Error`,
+			{ ErrorMessage: pErrorMessage, Log: pLog },
+			(pError) =>
+			{
+				if (pError)
+				{
+					console.error(`[Beacon] Failed to report error for [${pWorkItemHash}]: ${pError.message}`);
+				}
+			});
+	}
+
+	_reportProgress(pWorkItemHash, pProgressData)
+	{
+		if (!pProgressData || !this._Running)
+		{
+			return;
+		}
+
+		this._httpRequest('POST', `/Beacon/Work/${pWorkItemHash}/Progress`,
+			pProgressData,
+			(pError) =>
+			{
+				if (pError)
+				{
+					// Fire-and-forget — log but don't affect execution
+					console.warn(`[Beacon] Failed to report progress for [${pWorkItemHash}]: ${pError.message}`);
+				}
+			});
+	}
+
+	// ================================================================
+	// Heartbeat
+	// ================================================================
+
+	_heartbeat()
+	{
+		if (!this._Running || !this._BeaconID)
+		{
+			return;
+		}
+
+		this._httpRequest('POST', `/Beacon/${this._BeaconID}/Heartbeat`, {},
+			(pError) =>
+			{
+				if (pError)
+				{
+					console.warn(`[Beacon] Heartbeat failed: ${pError.message}`);
+				}
+			});
+	}
+
+	// ================================================================
+	// HTTP Transport
+	// ================================================================
+
+	_httpRequest(pMethod, pPath, pBody, fCallback)
+	{
+		let tmpParsedURL = new URL(this._Config.ServerURL);
+		let tmpOptions = {
+			hostname: tmpParsedURL.hostname,
+			port: tmpParsedURL.port || 80,
+			path: pPath,
+			method: pMethod,
+			headers: {
+				'Content-Type': 'application/json'
+			}
+		};
+
+		// Attach session cookie if available
+		if (this._SessionCookie)
+		{
+			tmpOptions.headers['Cookie'] = this._SessionCookie;
+		}
+
+		let tmpReq = libHTTP.request(tmpOptions, (pResponse) =>
+		{
+			let tmpData = '';
+			pResponse.on('data', (pChunk) => { tmpData += pChunk; });
+			pResponse.on('end', () =>
+			{
+				// Detect 401 and trigger reconnection
+				if (pResponse.statusCode === 401)
+				{
+					this._reconnect();
+					return fCallback(new Error('Unauthorized — reconnecting'));
+				}
+
+				try
+				{
+					let tmpParsed = JSON.parse(tmpData);
+					if (pResponse.statusCode >= 400)
+					{
+						return fCallback(new Error(tmpParsed.Error || `HTTP ${pResponse.statusCode}`));
+					}
+					return fCallback(null, tmpParsed);
+				}
+				catch (pParseError)
+				{
+					return fCallback(new Error(`Invalid JSON response: ${tmpData.substring(0, 200)}`));
+				}
+			});
+		});
+
+		tmpReq.on('error', (pError) =>
+		{
+			return fCallback(pError);
+		});
+
+		if (pBody && (pMethod === 'POST' || pMethod === 'PUT'))
+		{
+			tmpReq.write(JSON.stringify(pBody));
+		}
+
+		tmpReq.end();
+	}
+}
+
+module.exports = UltravisorBeaconClient;