Extract interfaces from all agent services. Replace use of static Log…

…ger.
immense · Jun 24, 2023 · 7459f2f · 7459f2f
1 parent 402d5b0
commit 7459f2f
Show file tree

Hide file tree

Showing 14 changed files with 182 additions and 106 deletions.
diff --git a/Agent/Program.cs b/Agent/Program.cs
@@ -94,12 +94,12 @@ private static void RegisterServices(IServiceCollection services)
         services.AddSingleton<ICpuUtilizationSampler, CpuUtilizationSampler>();
         services.AddSingleton<IWakeOnLanService, WakeOnLanService>();
         services.AddHostedService(services => services.GetRequiredService<ICpuUtilizationSampler>());
-        services.AddScoped<ChatClientService>();
-        services.AddTransient<PSCore>();
-        services.AddTransient<ExternalScriptingShell>();
-        services.AddScoped<ConfigService>();
-        services.AddScoped<Uninstaller>();
-        services.AddScoped<ScriptExecutor>();
+        services.AddScoped<IChatClientService, ChatClientService>();
+        services.AddTransient<IPSCore, PSCore>();
+        services.AddTransient<IExternalScriptingShell, ExternalScriptingShell>();
+        services.AddScoped<IConfigService, ConfigService>();
+        services.AddScoped<IUninstaller, Uninstaller>();
+        services.AddScoped<IScriptExecutor, ScriptExecutor>();
         services.AddScoped<IProcessInvoker, ProcessInvoker>();
         services.AddScoped<IUpdateDownloader, UpdateDownloader>();
 

diff --git a/Agent/Services/AgentHubConnection.cs b/Agent/Services/AgentHubConnection.cs
@@ -29,31 +29,27 @@ public interface IAgentHubConnection
     public class AgentHubConnection : IAgentHubConnection, IDisposable
     {
         private readonly IAppLauncher _appLauncher;
-
-        private readonly ChatClientService _chatService;
-
-        private readonly ConfigService _configService;
-
+        private readonly IChatClientService _chatService;
+        private readonly IConfigService _configService;
         private readonly IDeviceInformationService _deviceInfoService;
         private readonly IHttpClientFactory _httpFactory;
         private readonly IWakeOnLanService _wakeOnLanService;
         private readonly ILogger<AgentHubConnection> _logger;
         private readonly ILogger _fileLogger;
-        private readonly ScriptExecutor _scriptExecutor;
-
-        private readonly Uninstaller _uninstaller;
-
+        private readonly IScriptExecutor _scriptExecutor;
+        private readonly IUninstaller _uninstaller;
         private readonly IUpdater _updater;
 
         private ConnectionInfo _connectionInfo;
         private HubConnection _hubConnection;
         private Timer _heartbeatTimer;
         private bool _isServerVerified;
 
-        public AgentHubConnection(ConfigService configService,
-            Uninstaller uninstaller,
-            ScriptExecutor scriptExecutor,
-            ChatClientService chatService,
+        public AgentHubConnection(
+            IConfigService configService,
+            IUninstaller uninstaller,
+            IScriptExecutor scriptExecutor,
+            IChatClientService chatService,
             IAppLauncher appLauncher,
             IUpdater updater,
             IDeviceInformationService deviceInfoService,

diff --git a/Agent/Services/ChatClientService.cs b/Agent/Services/ChatClientService.cs
@@ -1,5 +1,6 @@
 using Immense.RemoteControl.Shared.Models;
 using Microsoft.AspNetCore.SignalR.Client;
+using Microsoft.Extensions.Logging;
 using Remotely.Agent.Interfaces;
 using Remotely.Agent.Models;
 using Remotely.Shared.Models;
@@ -15,18 +16,19 @@
 
 namespace Remotely.Agent.Services
 {
-    public class ChatClientService
+    public interface IChatClientService
+    {
+        Task SendMessage(string senderName, string message, string orgName, string orgId, bool disconnected, string senderConnectionID, HubConnection hubConnection);
+    }
+
+    public class ChatClientService : IChatClientService
     {
         private readonly IAppLauncher _appLauncher;
+        private readonly ILogger<ChatClientService> _logger;
         private readonly MemoryCache _chatClients = new("ChatClients");
-        private readonly SemaphoreSlim _messageLock = new(1,1);
-
-        public ChatClientService(IAppLauncher appLauncher)
-        {
-            _appLauncher = appLauncher;
-        }
+        private readonly SemaphoreSlim _messageLock = new(1, 1);
 
-        private CacheItemPolicy CacheItemPolicy { get; } = new()
+        private readonly CacheItemPolicy _cacheItemPolicy = new()
         {
             SlidingExpiration = TimeSpan.FromMinutes(10),
             RemovedCallback = new CacheEntryRemovedCallback(args =>
@@ -48,6 +50,13 @@ public ChatClientService(IAppLauncher appLauncher)
             })
         };
 
+        public ChatClientService(
+            IAppLauncher appLauncher,
+            ILogger<ChatClientService> logger)
+        {
+            _appLauncher = appLauncher;
+            _logger = logger;
+        }
 
         public async Task SendMessage(
             string senderName,
@@ -60,7 +69,7 @@ public async Task SendMessage(
         {
             if (!await _messageLock.WaitAsync(30000))
             {
-                Logger.Write("Timed out waiting for chat message lock.", Shared.Enums.EventType.Warning);
+                _logger.LogWarning("Timed out waiting for chat message lock.");
                 return;
             }
 
@@ -80,24 +89,24 @@ public async Task SendMessage(
 
                     if (procID > 0)
                     {
-                        Logger.Write($"Chat app started.  Process ID: {procID}");
+                        _logger.LogInformation("Chat app started.  Process ID: {procID}", procID);
                     }
                     else
                     {
-                        Logger.Write($"Chat app did not start successfully.");
+                        _logger.LogError($"Chat app did not start successfully.");
                         return;
                     }
 
                     var clientPipe = new NamedPipeClientStream(".", pipeName, PipeDirection.InOut, PipeOptions.Asynchronous);
                     clientPipe.Connect(15000);
                     if (!clientPipe.IsConnected)
                     {
-                        Logger.Write("Failed to connect to chat host.");
+                        _logger.LogError("Failed to connect to chat host.");
                         return;
                     }
                     chatSession = new ChatSession() { PipeStream = clientPipe, ProcessID = procID };
                     _ = Task.Run(async () => { await ReadFromStream(chatSession.PipeStream, senderConnectionID, hubConnection); });
-                    _chatClients.Add(senderConnectionID, chatSession, CacheItemPolicy);
+                    _chatClients.Add(senderConnectionID, chatSession, _cacheItemPolicy);
                 }
 
                 chatSession = (ChatSession)_chatClients.Get(senderConnectionID);
@@ -116,7 +125,7 @@ public async Task SendMessage(
             }
             catch (Exception ex)
             {
-                Logger.Write(ex);
+                _logger.LogError(ex, "Error while sending chat message.");
             }
             finally
             {

diff --git a/Agent/Services/ConfigService.cs b/Agent/Services/ConfigService.cs
@@ -1,4 +1,5 @@
-using Remotely.Shared.Models;
+using Microsoft.Extensions.Logging;
+using Remotely.Shared.Models;
 using Remotely.Shared.Utilities;
 using System;
 using System.Collections.Generic;
@@ -8,11 +9,23 @@
 
 namespace Remotely.Agent.Services
 {
-    public class ConfigService
+    public interface IConfigService
+    {
+        ConnectionInfo GetConnectionInfo();
+        void SaveConnectionInfo(ConnectionInfo connectionInfo);
+    }
+
+    public class ConfigService : IConfigService
     {
         private static readonly object _fileLock = new();
         private ConnectionInfo _connectionInfo;
         private readonly string _debugGuid = "f2b0a595-5ea8-471b-975f-12e70e0f3497";
+        private readonly ILogger<ConfigService> _logger;
+
+        public ConfigService(ILogger<ConfigService> logger)
+        {
+            _logger = logger;
+        }
 
         private Dictionary<string, string> _commandLineArgs;
         private Dictionary<string, string> CommandLineArgs
@@ -74,7 +87,7 @@ public ConnectionInfo GetConnectionInfo()
                 {
                     if (!File.Exists("ConnectionInfo.json"))
                     {
-                        Logger.Write(new Exception("No connection info available.  Please create ConnectionInfo.json file with appropriate values."));
+                        _logger.LogError("No connection info available.  Please create ConnectionInfo.json file with appropriate values.");
                         return null;
                     }
                     _connectionInfo = JsonSerializer.Deserialize<ConnectionInfo>(File.ReadAllText("ConnectionInfo.json"));

diff --git a/Agent/Services/DeviceInfoGeneratorBase.cs b/Agent/Services/DeviceInfoGeneratorBase.cs
@@ -13,7 +13,7 @@
 
 namespace Remotely.Agent.Services
 {
-    public class DeviceInfoGeneratorBase
+    public abstract class DeviceInfoGeneratorBase
     {
         protected readonly ILogger<DeviceInfoGeneratorBase> _logger;
 

diff --git a/Agent/Services/ExternalScriptingShell.cs b/Agent/Services/ExternalScriptingShell.cs
@@ -1,4 +1,5 @@
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
 using Remotely.Shared.Enums;
 using Remotely.Shared.Models;
 using Remotely.Shared.Utilities;
@@ -15,19 +16,23 @@ namespace Remotely.Agent.Services
 {
     public interface IExternalScriptingShell
     {
-
+        ScriptResult WriteInput(string input, TimeSpan timeout);
     }
 
     public class ExternalScriptingShell : IExternalScriptingShell
     {
         private static readonly ConcurrentDictionary<string, ExternalScriptingShell> _sessions = new();
-        private readonly ConfigService _configService;
+        private readonly IConfigService _configService;
+        private readonly ILogger<ExternalScriptingShell> _logger;
         private string _lineEnding;
         private ScriptingShell _shell;
 
-        public ExternalScriptingShell(ConfigService configService)
+        public ExternalScriptingShell(
+            IConfigService configService,
+            ILogger<ExternalScriptingShell> logger)
         {
             _configService = configService;
+            _logger = logger;
         }
 
         private string ErrorOut { get; set; }
@@ -46,6 +51,7 @@ public ExternalScriptingShell(ConfigService configService)
 
         private Stopwatch Stopwatch { get; set; }
 
+        // TODO: Turn into cache and factory.
         public static ExternalScriptingShell GetCurrent(ScriptingShell shell, string senderConnectionId)
         {
             if (_sessions.TryGetValue($"{shell}-{senderConnectionId}", out var session) &&
@@ -112,7 +118,7 @@ public ScriptResult WriteInput(string input, TimeSpan timeout)
             }
             catch (Exception ex)
             {
-                Logger.Write(ex);
+                _logger.LogError(ex, "Error while writing input to scripting shell.");
                 ErrorOut += Environment.NewLine + ex.Message;
 
                 // Something's wrong.  Let the next command start a new session.

diff --git a/Agent/Services/Linux/AppLauncherLinux.cs b/Agent/Services/Linux/AppLauncherLinux.cs
@@ -24,7 +24,7 @@ public class AppLauncherLinux : IAppLauncher
         private readonly ILogger<AppLauncherLinux> _logger;
 
         public AppLauncherLinux(
-            ConfigService configService,
+            IConfigService configService,
             IProcessInvoker processInvoker,
             ILogger<AppLauncherLinux> logger)
         {

diff --git a/Agent/Services/Linux/UpdaterLinux.cs b/Agent/Services/Linux/UpdaterLinux.cs
@@ -20,7 +20,7 @@ namespace Remotely.Agent.Services.Linux
     public class UpdaterLinux : IUpdater
     {
         private readonly SemaphoreSlim _checkForUpdatesLock = new(1, 1);
-        private readonly ConfigService _configService;
+        private readonly IConfigService _configService;
         private readonly IUpdateDownloader _updateDownloader;
         private readonly IHttpClientFactory _httpClientFactory;
         private readonly ILogger<UpdaterLinux> _logger;
@@ -29,7 +29,7 @@ public class UpdaterLinux : IUpdater
         private DateTimeOffset _lastUpdateFailure;
 
         public UpdaterLinux(
-            ConfigService configService,
+            IConfigService configService,
             IUpdateDownloader updateDownloader,
             IHttpClientFactory httpClientFactory,
             ILogger<UpdaterLinux> logger)

diff --git a/Agent/Services/MacOS/UpdaterMac.cs b/Agent/Services/MacOS/UpdaterMac.cs
@@ -21,7 +21,7 @@ public class UpdaterMac : IUpdater
     {
         private readonly string _achitecture = RuntimeInformation.OSArchitecture.ToString().ToLower();
         private readonly SemaphoreSlim _checkForUpdatesLock = new(1, 1);
-        private readonly ConfigService _configService;
+        private readonly IConfigService _configService;
         private readonly IHttpClientFactory _httpClientFactory;
         private readonly IUpdateDownloader _updateDownloader;
         private readonly ILogger<UpdaterMac> _logger;
@@ -30,7 +30,7 @@ public class UpdaterMac : IUpdater
         private readonly System.Timers.Timer _updateTimer = new(TimeSpan.FromHours(6).TotalMilliseconds);
 
         public UpdaterMac(
-            ConfigService configService,
+            IConfigService configService,
             IUpdateDownloader updateDownloader,
             IHttpClientFactory httpClientFactory,
             ILogger<UpdaterMac> logger)