All async scheduling done

Author: Splamy

README.md

@@ -50,7 +50,7 @@ Download either one of the latest builds from our [nightly server](https://splam
 #### Linux
 1. dotnet core: Get the latest `dotnet core 3.1` version by following [this tutorial](https://dotnet.microsoft.com/download/linux-package-manager/ubuntu16-04/sdk-current) and follow the steps after choosing your platform
 1. Other dependencies:
-* on **Ubuntu**:  
+* on **Ubuntu**/**Debian**:  
 Run `sudo apt-get install libopus-dev ffmpeg`
 * on **Arch Linux**:  
 Run `sudo pacman -S opus ffmpeg`

TS3AudioBot/Bot.cs

@@ -41,7 +41,7 @@ public sealed class Bot
 		private readonly ConfBot config;
 		private readonly TickWorker idleTickWorker;
 
-		internal bool IsDisposed { get; private set; }
+		private bool isClosed;
 		internal BotInjector Injector { get; }
 		internal DedicatedTaskScheduler Scheduler { get; }
 
@@ -76,15 +76,17 @@ public Bot(Id id, ConfBot config, BotInjector injector)
 			config.Events.OnIdle.Changed += (s, e) => EnableIdleTickWorker();
 
 			var builder = new DependencyBuilder(Injector);
-			builder.AddModule(this);
-			builder.AddModule(config);
-			builder.AddModule(Injector);
-			builder.AddModule(config.Playlists);
+			Injector.HideParentModule<CommandManager>();
+			Injector.HideParentModule<DedicatedTaskScheduler>();
+			Injector.AddModule(this);
+			Injector.AddModule(config);
+			Injector.AddModule(Injector);
+			Injector.AddModule(config.Playlists);
+			Injector.AddModule(config.History);
+			Injector.AddModule(Id);
 			builder.RequestModule<PlaylistIO>();
 			builder.RequestModule<PlaylistManager>();
-			builder.AddModule(Id);
 			builder.RequestModule<DedicatedTaskScheduler>();
-			builder.RequestModule<TaskScheduler, DedicatedTaskScheduler>();
 			builder.RequestModule<TsFullClient>();
 			builder.RequestModule<TsBaseFunctions, TsFullClient>();
 			builder.RequestModule<Ts3Client>();
@@ -93,12 +95,9 @@ public Bot(Id id, ConfBot config, BotInjector injector)
 			builder.RequestModule<IVoiceTarget, CustomTargetPipe>();
 			builder.RequestModule<SessionManager>();
 			builder.RequestModule<ResolveContext>();
-			if (!builder.TryCreate<CommandManager>(out var commandManager))
-				throw new Exception("Failed to create commandManager");
-			builder.AddModule(commandManager);
+			builder.RequestModule<CommandManager>();
 			if (config.History.Enabled)
 			{
-				builder.AddModule(config.History);
 				builder.RequestModule<HistoryManager>();
 			}
 			builder.RequestModule<PlayManager>();
@@ -108,6 +107,7 @@ public Bot(Id id, ConfBot config, BotInjector injector)
 				Log.Error("Missing bot module dependency");
 				throw new Exception("Could not load all bot modules");
 			}
+			Injector.ClearHiddenParentModules();
 
 			resourceResolver = Injector.GetModuleOrThrow<ResolveContext>();
 			ts3FullClient = Injector.GetModuleOrThrow<TsFullClient>();
@@ -121,6 +121,7 @@ public Bot(Id id, ConfBot config, BotInjector injector)
 			targetManager = Injector.GetModuleOrThrow<IVoiceTarget>();
 			sessionManager = Injector.GetModuleOrThrow<SessionManager>();
 			stats = Injector.GetModuleOrThrow<Stats>();
+			var commandManager = Injector.GetModuleOrThrow<CommandManager>();
 
 			idleTickWorker = Scheduler.Invoke(() => Scheduler.CreateTimer(OnIdle, TimeSpan.MaxValue, false)).Result;
 
@@ -152,10 +153,12 @@ public Bot(Id id, ConfBot config, BotInjector injector)
 			ts3client.OnMessageReceived += OnMessageReceived;
 			// Register callback to remove open private sessions, when user disconnects
 			ts3FullClient.OnEachClientLeftView += OnClientLeftView;
-			ts3client.OnBotDisconnect += OnBotDisconnect;
+			ts3client.OnBotConnected += OnBotConnected;
+			ts3client.OnBotDisconnected += OnBotDisconnected;
+			ts3client.OnBotStoppedReconnecting += OnBotStoppedReconnecting;
 			// Alone mode
 			ts3client.OnAloneChanged += OnAloneChanged;
-			ts3client.OnAloneChanged += (s, e) => customTarget.Alone = e.Alone;
+			ts3client.OnAloneChanged += (s, e) => { customTarget.Alone = e.Alone; return Task.CompletedTask; };
 			// Whisper stall
 			ts3client.OnWhisperNoTarget += (s, e) => player.SetStall();
 
@@ -170,36 +173,21 @@ public Bot(Id id, ConfBot config, BotInjector injector)
 				commandManager.RegisterAlias(alias.Key, alias.Value).UnwrapToLog(Log);
 		}
 
-		public async Task<E<string>> Run()
+		public Task<E<string>> Run()
 		{
-			Log.Info("Bot \"{0}\" connecting to \"{1}\"", config.Name, config.Connect.Address);
-			var result = await ts3client.Connect();
-			if (!result.Ok)
-				return result;
-
-			EnableIdleTickWorker();
-
-			var badges = config.Connect.Badges.Value;
-			if (!string.IsNullOrEmpty(badges))
-				ts3client?.ChangeBadges(badges);
+			Scheduler.VerifyOwnThread();
 
-			var onStart = config.Events.OnConnect.Value;
-			if (!string.IsNullOrEmpty(onStart))
-			{
-				var info = CreateExecInfo();
-				await CallScript(info, onStart, false, true);
-			}
-
-			return R.Ok;
+			Log.Info("Bot \"{0}\" connecting to \"{1}\"", config.Name, config.Connect.Address);
+			return Task.FromResult(ts3client.Connect());
 		}
 
 		public async Task Stop()
 		{
-			ValidateScheduler();
+			Scheduler.VerifyOwnThread();
 
 			Injector.GetModule<BotManager>()?.RemoveBot(this);
 
-			if (!IsDisposed) IsDisposed = true;
+			if (!isClosed) isClosed = true;
 			else return;
 
 			Log.Info("Bot ({0}) disconnecting.", Id);
@@ -216,7 +204,23 @@ public async Task Stop()
 			config.ClearEvents();
 		}
 
-		private async void OnBotDisconnect(object? sender, DisconnectEventArgs e)
+		private async Task OnBotConnected(object? sender, EventArgs e)
+		{
+			EnableIdleTickWorker();
+
+			var badges = config.Connect.Badges.Value;
+			if (!string.IsNullOrEmpty(badges))
+				ts3client?.ChangeBadges(badges);
+
+			var onStart = config.Events.OnConnect.Value;
+			if (!string.IsNullOrEmpty(onStart))
+			{
+				var info = CreateExecInfo();
+				await CallScript(info, onStart, false, true);
+			}
+		}
+
+		private async Task OnBotDisconnected(object? sender, DisconnectEventArgs e)
 		{
 			DisableIdleTickWorker();
 
@@ -226,11 +230,14 @@ private async void OnBotDisconnect(object? sender, DisconnectEventArgs e)
 				var info = CreateExecInfo();
 				await CallScript(info, onStop, false, true);
 			}
+		}
 
-			await Stop();
+		private Task OnBotStoppedReconnecting(object? sender, EventArgs e)
+		{
+			return Stop();
 		}
 
-		private async void OnMessageReceived(object? sender, TextMessage textMessage)
+		private async Task OnMessageReceived(object? sender, TextMessage textMessage)
 		{
 			if (textMessage?.Message == null)
 			{
@@ -332,9 +339,9 @@ public Task UpdateBotStatus()
 
 		public async Task UpdateBotStatusInternal()
 		{
-			ValidateScheduler();
+			Scheduler.VerifyOwnThread();
 
-			if (IsDisposed)
+			if (isClosed)
 				return;
 
 			if (!config.SetStatusDescription)
@@ -362,9 +369,9 @@ public Task GenerateStatusImage(bool playing, PlayInfoEventArgs? startEvent)
 
 		public async Task GenerateStatusImageInternal(bool playing, PlayInfoEventArgs? startEvent)
 		{
-			ValidateScheduler();
+			Scheduler.VerifyOwnThread();
 
-			if (!config.GenerateStatusAvatar || IsDisposed)
+			if (!config.GenerateStatusAvatar || isClosed)
 				return;
 
 			static Stream? GetRandomFile(string? basePath, string prefix)
@@ -524,9 +531,9 @@ private void EnableIdleTickWorker()
 
 		#region Event: Alone/Party
 
-		private async void OnAloneChanged(object? sender, AloneChanged e)
+		private async Task OnAloneChanged(object? sender, AloneChanged e)
 		{
-			ValidateScheduler();
+			Scheduler.VerifyOwnThread();
 
 			string script;
 			TimeSpan delay;
@@ -579,19 +586,6 @@ await info.Write(TextMod.Format(config.Commands.Color, strings.error_call_unexpe
 			}
 		}
 
-		private void ValidateScheduler()
-		{
-			if (TaskScheduler.Current != Scheduler)
-			{
-				var stack = new System.Diagnostics.StackTrace();
-				Log.Error("Current call is not scheduled correctly. Sched: {0}, Own: {1}. Stack: {2}",
-					TaskScheduler.Current.Id,
-					Scheduler.Id,
-					stack
-				);
-			}
-		}
-
 		public BotInfo GetInfo() => new BotInfo
 		{
 			Id = Id,

TS3AudioBot/BotManager.cs

@@ -132,7 +132,7 @@ public async Task<R<BotInfo, string>> RunBot(ConfBot config)
 				if (!initializeResult.Ok)
 				{
 					await StopBot(bot);
-					return $"Bot failed to connect ({initializeResult.Error})";
+					return $"Bot failed to initialize ({initializeResult.Error})";
 				}
 				return bot.GetInfo();
 			});

TS3AudioBot/Config/ConfigStructs.cs

@@ -342,7 +342,7 @@ public static class ConfTimeExtensions
 			var value = conf.Value;
 			if (value.Count == 0)
 				return null;
-			var last = value[value.Count - 1];
+			var last = value[^1];
 			var repeat = last == "repeat" || last == "repeat last"; // "repeat" might get removed for other loops, but for now keep as hidden alternative
 			var max = repeat ? value.Count - 2 : value.Count - 1;
 			if (index <= max)
@@ -355,7 +355,7 @@ public static E<string> ValidateTime(IReadOnlyList<string> value)
 		{
 			if (value.Count == 0)
 				return R.Ok;
-			var last = value[value.Count - 1];
+			var last = value[^1];
 			var repeat = last == "repeat" || last == "repeat last";
 			if (repeat && value.Count == 1)
 				return $"Specified 'repeat' without any previous value.";

TS3AudioBot/Core.cs

@@ -20,6 +20,7 @@
 using TS3AudioBot.Rights;
 using TS3AudioBot.Sessions;
 using TS3AudioBot.Web;
+using TSLib.Scheduler;
 
 namespace TS3AudioBot
 {
@@ -28,71 +29,72 @@ public sealed class Core
 		private static readonly Logger Log = LogManager.GetCurrentClassLogger();
 		private readonly string configFilePath;
 		private bool forceNextExit;
+		private readonly DedicatedTaskScheduler scheduler;
 		private readonly CoreInjector injector;
 
-		public Core(string? configFilePath = null)
+		public Core(DedicatedTaskScheduler scheduler, string? configFilePath = null)
 		{
+			this.scheduler = scheduler;
 			// setting defaults
 			this.configFilePath = configFilePath ?? FilesConst.CoreConfig;
 
 			injector = new CoreInjector();
 		}
 
-		public async Task<E<string>> Run(ParameterData setup)
+		public async Task Run(ParameterData setup)
 		{
-			AppDomain.CurrentDomain.UnhandledException += ExceptionHandler;
+			scheduler.VerifyOwnThread();
+
+			AppDomain.CurrentDomain.UnhandledException += UnhandledExceptionHandler;
 			TaskScheduler.UnobservedTaskException += UnobservedTaskExceptionHandler;
 			Console.CancelKeyPress += ConsoleInterruptHandler;
 
 			var config = ConfRoot.OpenOrCreate(configFilePath);
 			if (config is null)
-				return "Could not create config";
+				throw new Exception("Could not create config");
 			ConfigUpgrade2.Upgrade(config.Configs.BotsPath.Value);
 			config.Save();
 
 			var builder = new DependencyBuilder(injector);
 
-			builder.AddModule(this);
-			builder.AddModule(config);
-			builder.AddModule(injector);
-			builder.AddModule(config.Db);
+			injector.AddModule(this);
+			injector.AddModule(scheduler);
+			injector.AddModule(injector);
+			injector.AddModule(config);
+			injector.AddModule(config.Db);
+			injector.AddModule(config.Plugins);
+			injector.AddModule(config.Web);
+			injector.AddModule(config.Web.Interface);
+			injector.AddModule(config.Web.Api);
+			injector.AddModule(config.Rights);
+			injector.AddModule(config.Factories);
 			builder.RequestModule<SystemMonitor>();
 			builder.RequestModule<DbStore>();
-			builder.AddModule(config.Plugins);
 			builder.RequestModule<PluginManager>();
-			builder.AddModule(config.Web);
-			builder.AddModule(config.Web.Interface);
-			builder.AddModule(config.Web.Api);
 			builder.RequestModule<WebServer>();
-			builder.AddModule(config.Rights);
 			builder.RequestModule<RightsManager>();
 			builder.RequestModule<BotManager>();
 			builder.RequestModule<TokenManager>();
 			builder.RequestModule<CommandManager>();
-			builder.AddModule(config.Factories);
 			builder.RequestModule<ResourceResolver>();
 			builder.RequestModule<Stats>();
 
 			if (!builder.Build())
-				return "Could not load all core modules";
+				throw new Exception("Could not load all core modules");
 
 			YoutubeDlHelper.DataObj = config.Tools.YoutubeDl;
 
-			builder.GetModuleOrThrow<SystemMonitor>().StartTimedSnapshots();
-			builder.GetModuleOrThrow<CommandManager>().RegisterCollection(MainCommands.Bag);
-			builder.GetModuleOrThrow<RightsManager>().CreateConfigIfNotExists(setup.Interactive);
-			builder.GetModuleOrThrow<WebServer>().StartWebServer();
-			builder.GetModuleOrThrow<Stats>().StartTimer(setup.SendStats);
-			await builder.GetModuleOrThrow<BotManager>().RunBots(setup.Interactive);
-
-			return R.Ok;
+			injector.GetModuleOrThrow<CommandManager>().RegisterCollection(MainCommands.Bag);
+			injector.GetModuleOrThrow<RightsManager>().CreateConfigIfNotExists(setup.Interactive);
+			injector.GetModuleOrThrow<WebServer>().StartWebServer();
+			injector.GetModuleOrThrow<Stats>().StartTimer(setup.SendStats);
+			await injector.GetModuleOrThrow<BotManager>().RunBots(setup.Interactive);
 		}
 
-		public void ExceptionHandler(object sender, UnhandledExceptionEventArgs e)
+		public void UnhandledExceptionHandler(object sender, UnhandledExceptionEventArgs e)
 		{
 			Log.Fatal(e.ExceptionObject as Exception, "Critical program failure!");
-			Stop().Wait();
-			System.Environment.Exit(-1);
+			StopAsync().RunSynchronously();
 		}
 
 		public static void UnobservedTaskExceptionHandler(object? sender, UnobservedTaskExceptionEventArgs e)
@@ -109,7 +111,7 @@ public void ConsoleInterruptHandler(object sender, ConsoleCancelEventArgs e)
 					Log.Info("Got interrupt signal, trying to soft-exit.");
 					e.Cancel = true;
 					forceNextExit = true;
-					Stop().Wait();
+					Stop();
 				}
 				else
 				{
@@ -119,7 +121,9 @@ public void ConsoleInterruptHandler(object sender, ConsoleCancelEventArgs e)
 			}
 		}
 
-		public async Task Stop()
+		public void Stop() => _ = scheduler.InvokeAsync(StopAsync);
+
+		private async Task StopAsync()
 		{
 			Log.Info("TS3AudioBot shutting down.");
 
@@ -130,6 +134,9 @@ public async Task Stop()
 			injector.GetModule<WebServer>()?.Dispose();
 			injector.GetModule<DbStore>()?.Dispose();
 			injector.GetModule<ResourceResolver>()?.Dispose();
+			injector.GetModule<DedicatedTaskScheduler>()?.Dispose();
+
+			Log.Info("Bye");
 		}
 	}
 }