Merge pull request #57 from nullinside-development-group/chore/rework

chore: extracting Configuration.Instance to DI

Author: ProgrammingByPermutation

src/TwitchStreamingTools/App.axaml.cs

@@ -9,7 +9,6 @@
 
 using Nullinside.Api.Common.Twitch;
 
-using TwitchStreamingTools.Services;
 using TwitchStreamingTools.ViewModels;
 using TwitchStreamingTools.Views;
 

src/TwitchStreamingTools/Configuration.cs

@@ -16,7 +16,10 @@ namespace TwitchStreamingTools;
 /// <summary>
 ///   The configuration of the application.
 /// </summary>
-public class Configuration {
+public class Configuration : IConfiguration {
+  /// <summary>
+  ///   The location of the configuration file.
+  /// </summary>
   private static readonly string CONFIG_LOCATION =
     Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "nullinside",
       "twitch-streaming-tools", "config.json");
@@ -26,6 +29,12 @@ public class Configuration {
   /// </summary>
   private static Configuration? s_instance;
 
+  /// <summary>
+  ///   Do not allow other people to create instances of our class.
+  /// </summary>
+  protected Configuration() {
+  }
+
   /// <summary>
   ///   The singleton instance of the class.
   /// </summary>
@@ -69,6 +78,23 @@ public static Configuration Instance {
   /// </summary>
   public IDictionary<string, string>? TtsPhoneticUsernames { get; set; }
 
+  /// <summary>
+  ///   Writes the configuration file to disk.
+  /// </summary>
+  /// <returns>True if successful, false otherwise.</returns>
+  public bool WriteConfiguration() {
+    try {
+      Directory.CreateDirectory(Path.GetDirectoryName(CONFIG_LOCATION)!);
+
+      string json = JsonConvert.SerializeObject(this);
+      File.WriteAllText(CONFIG_LOCATION, json);
+      return true;
+    }
+    catch {
+      return false;
+    }
+  }
+
   /// <summary>
   ///   Retrieves the default audio device configured in the application.
   /// </summary>
@@ -105,21 +131,4 @@ public static Configuration Instance {
     }
     catch { return null; }
   }
-
-  /// <summary>
-  ///   Writes the configuration file to disk.
-  /// </summary>
-  /// <returns>True if successful, false otherwise.</returns>
-  public bool WriteConfiguration() {
-    try {
-      Directory.CreateDirectory(Path.GetDirectoryName(CONFIG_LOCATION)!);
-
-      string json = JsonConvert.SerializeObject(this);
-      File.WriteAllText(CONFIG_LOCATION, json);
-      return true;
-    }
-    catch {
-      return false;
-    }
-  }
 }

src/TwitchStreamingTools/IConfiguration.cs

@@ -0,0 +1,48 @@
+using System.Collections.Generic;
+
+using Nullinside.Api.Common.Twitch;
+
+using TwitchStreamingTools.Models;
+
+namespace TwitchStreamingTools;
+
+/// <summary>
+///   The contract for the configuration of the application.
+/// </summary>
+public interface IConfiguration {
+  /// <summary>
+  ///   The username of the user logged in through the <see cref="OAuth" /> token.
+  /// </summary>
+  string? TwitchUsername { get; set; }
+
+  /// <summary>
+  ///   The twitch OAuth token.
+  /// </summary>
+  OAuthResponse? OAuth { get; set; }
+
+  /// <summary>
+  ///   The twitch application configuration for getting OAuth tokens.
+  /// </summary>
+  TwitchAppConfig? TwitchAppConfig { get; set; }
+
+  /// <summary>
+  ///   The collection of twitch chats we should read from.
+  /// </summary>
+  IEnumerable<TwitchChatConfiguration>? TwitchChats { get; set; }
+
+  /// <summary>
+  ///   The collection of usernames to skip reading the messages of.
+  /// </summary>
+  IEnumerable<string>? TtsUsernamesToSkip { get; set; }
+
+  /// <summary>
+  ///   The collection of phonetic pronunciations of words.
+  /// </summary>
+  IDictionary<string, string>? TtsPhoneticUsernames { get; set; }
+
+  /// <summary>
+  ///   Writes the configuration file to disk.
+  /// </summary>
+  /// <returns>True if successful, false otherwise.</returns>
+  bool WriteConfiguration();
+}

src/TwitchStreamingTools/ServiceCollectionExtensions.cs

@@ -22,6 +22,7 @@ public static void AddCommonServices(this IServiceCollection collection) {
     collection.AddSingleton<ITwitchAccountService, TwitchAccountService>();
     collection.AddSingleton<ITwitchClientProxy, TwitchClientProxy>(_ => TwitchClientProxy.Instance);
     collection.AddSingleton<ITwitchTtsService, TwitchTtsService>();
+    collection.AddSingleton<IConfiguration, Configuration>(_ => Configuration.Instance);
 
     collection.AddTransient<MainWindowViewModel>();
     collection.AddTransient<AccountViewModel>();

src/TwitchStreamingTools/Services/TwitchAccountService.cs

@@ -11,9 +11,14 @@
 namespace TwitchStreamingTools.Services;
 
 /// <summary>
-///   Manages the credentials in the application, ensuring credentials are kept up-to-date.
+///   Manages the credentials in the application, ensuring credentials are kept up to date.
 /// </summary>
 public class TwitchAccountService : ITwitchAccountService {
+  /// <summary>
+  ///   The application configuration.
+  /// </summary>
+  private readonly IConfiguration _configuration;
+
   /// <summary>
   ///   The timer used to check the twitch OAuth token against the API.
   /// </summary>
@@ -28,7 +33,9 @@ public class TwitchAccountService : ITwitchAccountService {
   ///   Initializes a new instance of the <see cref="TwitchAccountService" /> class.
   /// </summary>
   /// <param name="twitchClient">The twitch chat client.</param>
-  public TwitchAccountService(ITwitchClientProxy twitchClient) {
+  /// <param name="configuration">The application configuration.</param>
+  public TwitchAccountService(ITwitchClientProxy twitchClient, IConfiguration configuration) {
+    _configuration = configuration;
     _twitchClient = twitchClient;
     _timer = new DispatcherTimer {
       Interval = TimeSpan.FromSeconds(5)
@@ -68,14 +75,14 @@ public async Task UpdateCredentials(string bearer, string refresh, DateTime expi
       // Do nothing
     }
 
-    Configuration.Instance.OAuth = new OAuthResponse {
+    _configuration.OAuth = new OAuthResponse {
       Bearer = bearer,
       Refresh = refresh,
       ExpiresUtc = expires
     };
 
-    Configuration.Instance.TwitchUsername = user?.username;
-    Configuration.Instance.WriteConfiguration();
+    _configuration.TwitchUsername = user?.username;
+    _configuration.WriteConfiguration();
     _twitchClient.TwitchOAuthToken = bearer;
     _twitchClient.TwitchUsername = user?.username;
 
@@ -85,13 +92,13 @@ public async Task UpdateCredentials(string bearer, string refresh, DateTime expi
 
   /// <inheritdoc />
   public void DeleteCredentials() {
-    Configuration.Instance.OAuth = null;
-    Configuration.Instance.TwitchUsername = null;
+    _configuration.OAuth = null;
+    _configuration.TwitchUsername = null;
     _twitchClient.TwitchOAuthToken = null;
     _twitchClient.TwitchUsername = null;
     CredentialsAreValid = false;
     TwitchUsername = null;
-    Configuration.Instance.WriteConfiguration();
+    _configuration.WriteConfiguration();
 
     OnCredentialsChanged?.Invoke(null);
     OnCredentialsStatusChanged?.Invoke(false);
@@ -152,11 +159,11 @@ private async Task DoTokenRefreshIfNearExpiration() {
     await twitchApi.RefreshAccessToken();
 
     // Update the configuration
-    Configuration.Instance.OAuth = new OAuthResponse {
+    _configuration.OAuth = new OAuthResponse {
       Bearer = twitchApi.OAuth.AccessToken,
       Refresh = twitchApi.OAuth.RefreshToken,
       ExpiresUtc = twitchApi.OAuth.ExpiresUtc ?? DateTime.MinValue
     };
-    Configuration.Instance.WriteConfiguration();
+    _configuration.WriteConfiguration();
   }
 }

src/TwitchStreamingTools/Services/TwitchTtsService.cs

@@ -25,6 +25,11 @@ public class TwitchTtsService : ITwitchTtsService {
   /// </summary>
   private readonly IList<TwitchChatTts> _chats = new List<TwitchChatTts>();
 
+  /// <summary>
+  ///   The application configuration.
+  /// </summary>
+  private readonly IConfiguration _configuration;
+
   /// <summary>
   ///   The logger.
   /// </summary>
@@ -44,7 +49,9 @@ public class TwitchTtsService : ITwitchTtsService {
   ///   Initializes a new instance of the <see cref="TwitchTtsService" /> class.
   /// </summary>
   /// <param name="twitchClientProxy">The twitch chat client.</param>
-  public TwitchTtsService(ITwitchClientProxy twitchClientProxy) {
+  /// <param name="configuration">The application configuration.</param>
+  public TwitchTtsService(ITwitchClientProxy twitchClientProxy, IConfiguration configuration) {
+    _configuration = configuration;
     _twitchClientProxy = twitchClientProxy;
     _thread = new Thread(Main) {
       IsBackground = true
@@ -78,7 +85,7 @@ private void Main() {
   ///   Connects to any configuration found in the config file that we are not currently connected to.
   /// </summary>
   private void ConnectChatsInConfig() {
-    List<string?>? missing = Configuration.Instance.TwitchChats?
+    List<string?>? missing = _configuration.TwitchChats?
       .Select(c => c.TwitchChannel)
       .Except(_chats?.Select(c => c.ChatConfig?.TwitchChannel) ?? [])
       .Where(i => !string.IsNullOrWhiteSpace(i))
@@ -89,7 +96,7 @@ private void ConnectChatsInConfig() {
     }
 
     foreach (string? newChat in missing) {
-      var tts = new TwitchChatTts(_twitchClientProxy, Configuration.Instance.TwitchChats?.FirstOrDefault(t => t.TwitchChannel == newChat));
+      var tts = new TwitchChatTts(_configuration, _twitchClientProxy, _configuration.TwitchChats?.FirstOrDefault(t => t.TwitchChannel == newChat));
       tts.Connect();
       _chats?.Add(tts);
     }
@@ -101,7 +108,7 @@ private void ConnectChatsInConfig() {
   private void DisconnectChatsNotInConfig() {
     List<string?>? chatsNotInConfig = _chats?
       .Select(c => c.ChatConfig?.TwitchChannel)
-      .Except(Configuration.Instance.TwitchChats?.Select(c => c?.TwitchChannel) ?? [])
+      .Except(_configuration.TwitchChats?.Select(c => c?.TwitchChannel) ?? [])
       .Where(i => !string.IsNullOrWhiteSpace(i))
       .ToList();
 

src/TwitchStreamingTools/Tts/TtsFilter/CommandFilter.cs

@@ -11,11 +11,12 @@ public class CommandFilter : ITtsFilter {
   /// <summary>
   ///   Handles filtering commands from being spoken in chat.
   /// </summary>
+  /// <param name="configuration">The application configuration.</param>
   /// <param name="twitchInfo">The information on the original chat message.</param>
   /// <param name="username">The username of the twitch chatter for TTS to say.</param>
   /// <param name="currentMessage">The message from twitch chat.</param>
   /// <returns>The new TTS message and username.</returns>
-  public Tuple<string, string> Filter(OnMessageReceivedArgs twitchInfo, string username, string currentMessage) {
+  public Tuple<string, string> Filter(IConfiguration configuration, OnMessageReceivedArgs twitchInfo, string username, string currentMessage) {
     if (currentMessage.StartsWith("!")) {
       currentMessage = "";
     }

src/TwitchStreamingTools/Tts/TtsFilter/EmojiDeduplicationFilter.cs

@@ -21,11 +21,12 @@ public class EmojiDeduplicationFilter : ITtsFilter {
   /// <summary>
   ///   Removes duplicate emotes from a message.
   /// </summary>
+  /// <param name="configuration">The application configuration.</param>
   /// <param name="twitchInfo">The information on the original chat message.</param>
   /// <param name="username">The username of the twitch chatter for TTS to say.</param>
   /// <param name="currentMessage">The message from twitch chat.</param>
   /// <returns>The new TTS message and username.</returns>
-  public Tuple<string, string> Filter(OnMessageReceivedArgs twitchInfo, string username, string currentMessage) {
+  public Tuple<string, string> Filter(IConfiguration configuration, OnMessageReceivedArgs twitchInfo, string username, string currentMessage) {
     // The list of all recognized emotes.
     var emoteText = new HashSet<string>();
 

src/TwitchStreamingTools/Tts/TtsFilter/ITtsFilter.cs

@@ -11,9 +11,10 @@ internal interface ITtsFilter {
   /// <summary>
   ///   Filters a message from TTS.
   /// </summary>
+  /// <param name="configuration">The application configuration.</param>
   /// <param name="twitchInfo">The information on the original chat message.</param>
   /// <param name="username">The username of the twitch chatter for TTS to say.</param>
   /// <param name="currentMessage">The message from twitch chat.</param>
   /// <returns>The new TTS message and username.</returns>
-  Tuple<string, string> Filter(OnMessageReceivedArgs twitchInfo, string username, string currentMessage);
+  Tuple<string, string> Filter(IConfiguration configuration, OnMessageReceivedArgs twitchInfo, string username, string currentMessage);
 }

src/TwitchStreamingTools/Tts/TtsFilter/LinkFilter.cs

@@ -12,11 +12,12 @@ internal class LinkFilter : ITtsFilter {
   /// <summary>
   ///   Filters out links from text to speech.
   /// </summary>
+  /// <param name="configuration">The application configuration.</param>
   /// <param name="twitchInfo">The information on the original chat message.</param>
   /// <param name="username">The username of the twitch chatter for TTS to say.</param>
   /// <param name="currentMessage">The message from twitch chat.</param>
   /// <returns>The new TTS message and username.</returns>
-  public Tuple<string, string> Filter(OnMessageReceivedArgs twitchInfo, string username, string currentMessage) {
+  public Tuple<string, string> Filter(IConfiguration configuration, OnMessageReceivedArgs twitchInfo, string username, string currentMessage) {
     // Protect against removing ellipsis
     MatchCollection matches = Regex.Matches(currentMessage, Constants.REGEX_URL, RegexOptions.CultureInvariant);
     foreach (Match match in matches) {