Rework the database structure (#112)

* Change Database Provider to PostgreSQL

* Rework the check if the database is online

* Modify docker-compose to use the correct image

* Fix default port

* Fix AzuraCast update command not working

* Fix update check if instance is online again

* Rework DbActions.cs

* Adjust .editorconfig

* Fix all build errors

* Simplify checks

* Fix small bug

* Fix database stuff not working and formatting

* Expand some more stuff

* Dead code removal

* Fix remaining commands

* Fix the last stuff

* Whatever

* Fix wrong json property type

* Fix checks not working
The wrong id was selected

* Add documentation to prevent errors

* Do eager loading when possible

* Fix analyzers

* Update EFCore

* Add indexing and restructure linq queries to improve database performance

* Add AsNoTracking()

Author: Sella-GH

.editorconfig

@@ -17,7 +17,7 @@ end_of_line = crlf
 [*{_AssemblyInfo.cs,.notsupported.cs,AsmOffsets.cs}]
 generated_code = true
 
-[/AzzyBot-Next/Migrations/**]
+[src/AzzyBot-Next/Migrations/**]
 generated_code = true
 
 # C# files

.vscode/launch.json

@@ -17,6 +17,7 @@
             },
             "console": "externalTerminal",
             "stopAtEntry": false,
+            "enableStepFiltering": false
         },
         {
             "name": "Process attacher",

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
     "csharp.debug.sourceFileMap":
     {
-        "./": "${workspaceFolder}/AzzyBot-Next/"
+        "./": "${workspaceFolder}/src/AzzyBot-Next/"
     }
 }

.vscode/tasks.json

@@ -7,7 +7,7 @@
             "type": "process",
             "args": [
                 "build",
-                "${workspaceFolder}/AzzyBot/AzzyBot.csproj"
+                "${workspaceFolder}/src/AzzyBot/AzzyBot.csproj"
             ],
             "problemMatcher": "$msCompile"
         },
@@ -17,7 +17,7 @@
             "type": "process",
             "args": [
                 "build",
-                "${workspaceFolder}/AzzyBot-Next/AzzyBot-Next.csproj"
+                "${workspaceFolder}/src/AzzyBot-Next/AzzyBot-Next.csproj"
             ],
             "problemMatcher": "$msCompile"
         }

CHANGELOG.md

@@ -1,3 +1,18 @@
+## 2.0.0-preview3
+### Breaking Changes
+- The database has switched from MariaDB to PostgreSQL
+  - You already know what that means (DATA DELETION)
+  - Please clean your docker system too after you shut down the bot
+    - docker system prune -a -f --volumes
+    - docker volume prune -a -f
+
+### General
+- Reworked the whole background database structure to make it easier, faster and less ressource-consuming
+
+### Fixes
+- `azuracast update-instace` says the station is already up-to-date but it's not
+- `admin debug-servers remove-servers` autocomplete not working
+
 ## 2.0.0-preview2
 ### Breaking Changes
 - Your Database needs a complete reset, please DROP it and start from scratch

docker-compose.dev.yml

@@ -20,20 +20,19 @@ services:
 
   AzzyBot-Db:
     container_name: AzzyBot-Db
-    image: mariadb:lts
+    image: postgres:16-alpine
     pull_policy: always
     restart: unless-stopped
     environment:
-      - MYSQL_ROOT_PASSWORD=thisIsR00!P@ssw0rd
-      - MYSQL_DATABASE=azzybot
-      - MYSQL_USER=azzybot
-      - MYSQL_PASSWORD=thisIsAzzyB0!P@ssw0rd
+      - POSTGRES_DB=azzybot
+      - POSTGRES_USER=azzybot
+      - POSTGRES_PASSWORD=thisIsAzzyB0!P@ssw0rd
       - TZ=Europe/Berlin
     networks:
       - AzzyBot-Db-Nw
     hostname: AzzyBot-Db
     volumes:
-      - azzybot_data:/var/lib/mysql
+      - azzybot_data:/var/lib/postgresql/data
 
 networks:
   AzzyBot-Db-Nw:

src/AzzyBot-Next/AzzyBot-Next.csproj

@@ -100,13 +100,12 @@
     <PackageReference Include="DSharpPlus" Version="5.0.0-nightly-02271" />
     <PackageReference Include="DSharpPlus.Commands" Version="5.0.0-nightly-02271" />
     <PackageReference Include="DSharpPlus.Interactivity" Version="5.0.0-nightly-02271" />
-    <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="8.0.6">
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="8.0.7">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
-	  <PackageReference Include="MySqlConnector" Version="2.3.7" />
-    <PackageReference Include="Pomelo.EntityFrameworkCore.MySql" Version="8.0.2" />
+	  <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="8.0.4" />
     <PackageReference Include="Roslynator.Analyzers" Version="4.12.4">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

src/AzzyBot-Next/Commands/AdminCommands.cs

@@ -67,7 +67,7 @@ public sealed class AdminDebugServers(DbActions dbActions, DiscordBotService bot
             private readonly ILogger<AdminDebugServers> _logger = logger;
 
             [Command("add-server"), Description("Adds the permission to execute debug commands to a server.")]
-            public async ValueTask AddDebugGuildsAsync(CommandContext context, [Description("Select the server you want to add."), SlashAutoCompleteProvider<GuildsAutocomplete>] string serverId = "")
+            public async ValueTask AddDebugGuildsAsync(CommandContext context, [Description("Select the server you want to add."), SlashAutoCompleteProvider<GuildsAutocomplete>] string serverId)
             {
                 ArgumentNullException.ThrowIfNull(context, nameof(context));
 
@@ -108,7 +108,7 @@ public async ValueTask GetDebugGuildsAsync(CommandContext context)
 
                 await context.DeferResponseAsync();
 
-                List<GuildsEntity> dbGuilds = await _dbActions.GetGuildsWithDebugAsync();
+                IReadOnlyList<GuildsEntity> dbGuilds = await _dbActions.GetGuildsWithDebugAsync();
                 if (dbGuilds.Count == 0)
                 {
                     await context.EditResponseAsync("No debug servers found.");
@@ -127,7 +127,7 @@ public async ValueTask GetDebugGuildsAsync(CommandContext context)
             }
 
             [Command("remove-server"), Description("Removes the permission to execute debug commands from a server.")]
-            public async ValueTask RemoveDebugGuildsAsync(CommandContext context, [Description("Select the server you want to remove."), SlashAutoCompleteProvider<GuildsAutocomplete>] string serverId = "")
+            public async ValueTask RemoveDebugGuildsAsync(CommandContext context, [Description("Select the server you want to remove."), SlashAutoCompleteProvider<GuildsAutocomplete>] string serverId)
             {
                 ArgumentNullException.ThrowIfNull(context, nameof(context));
 

src/AzzyBot-Next/Commands/Autocompletes/AzuraCastMountAutocomplete.cs

@@ -20,13 +20,13 @@ public async ValueTask<IReadOnlyDictionary<string, object>> AutoCompleteAsync(Au
         ArgumentNullException.ThrowIfNull(context, nameof(context));
         ArgumentNullException.ThrowIfNull(context.Guild, nameof(context.Guild));
 
+        Dictionary<string, object> results = [];
         int stationId = Convert.ToInt32(context.Options.Single(o => o.Name is "station" && o.Value is not null).Value, CultureInfo.InvariantCulture);
         if (stationId == 0)
-            return new Dictionary<string, object>();
+            return results;
 
         // TODO Solve this more clean and nicer when it's possible
-        Dictionary<string, object> results = [];
-        List<AzuraCastStationMountEntity> mountsInDb;
+        IReadOnlyList<AzuraCastStationMountEntity> mountsInDb;
         try
         {
             mountsInDb = await _dbActions.GetAzuraCastStationMountsAsync(context.Guild.Id, stationId);

src/AzzyBot-Next/Commands/Autocompletes/AzuraCastPlaylistAutocomplete.cs

@@ -25,13 +25,12 @@ public async ValueTask<IReadOnlyDictionary<string, object>> AutoCompleteAsync(Au
         ArgumentNullException.ThrowIfNull(context, nameof(context));
         ArgumentNullException.ThrowIfNull(context.Guild, nameof(context.Guild));
 
+        Dictionary<string, object> results = [];
         int stationId = Convert.ToInt32(context.Options.Single(o => o.Name is "station_id" && o.Value is not null).Value, CultureInfo.InvariantCulture);
         if (stationId == 0)
-            return new Dictionary<string, object>();
+            return results;
 
-        Dictionary<string, object> results = [];
         string search = context.UserInput;
-
         AzuraCastStationEntity? station;
         try
         {

src/AzzyBot-Next/Commands/Autocompletes/AzuraCastRequestAutocomplete.cs

@@ -24,11 +24,11 @@ public async ValueTask<IReadOnlyDictionary<string, object>> AutoCompleteAsync(Au
         ArgumentNullException.ThrowIfNull(context, nameof(context));
         ArgumentNullException.ThrowIfNull(context.Guild, nameof(context.Guild));
 
+        Dictionary<string, object> results = [];
         int stationId = Convert.ToInt32(context.Options.Single(o => o.Name is "station_id" && o.Value is not null).Value, CultureInfo.InvariantCulture);
         if (stationId == 0)
-            return new Dictionary<string, object>();
+            return results;
 
-        Dictionary<string, object> results = [];
         string search = context.UserInput;
         AzuraCastStationEntity? station;
         try

src/AzzyBot-Next/Commands/Autocompletes/AzuraCastStationsAutocomplete.cs

@@ -13,9 +13,9 @@
 
 namespace AzzyBot.Commands.Autocompletes;
 
-public sealed class AzuraCastStationsAutocomplete(AzuraCastApiService azuraCast, DbActions dbActions) : IAutoCompleteProvider
+public sealed class AzuraCastStationsAutocomplete(AzuraCastApiService azuraCastApi, DbActions dbActions) : IAutoCompleteProvider
 {
-    private readonly AzuraCastApiService _azuraCast = azuraCast;
+    private readonly AzuraCastApiService _azuraCast = azuraCastApi;
     private readonly DbActions _dbActions = dbActions;
 
     public async ValueTask<IReadOnlyDictionary<string, object>> AutoCompleteAsync(AutoCompleteContext context)
@@ -25,7 +25,11 @@ public async ValueTask<IReadOnlyDictionary<string, object>> AutoCompleteAsync(Au
 
         // TODO Solve this more clean and nicer when it's possible
         Dictionary<string, object> results = [];
-        List<AzuraCastStationEntity> stationsInDb;
+        AzuraCastEntity? azuraCast = await _dbActions.GetAzuraCastAsync(context.Guild.Id);
+        if (azuraCast is null)
+            return results;
+
+        IReadOnlyList<AzuraCastStationEntity> stationsInDb;
         try
         {
             stationsInDb = await _dbActions.GetAzuraCastStationsAsync(context.Guild.Id);
@@ -37,14 +41,13 @@ public async ValueTask<IReadOnlyDictionary<string, object>> AutoCompleteAsync(Au
             return results;
         }
 
-        Uri baseUrl = new(Crypto.Decrypt(stationsInDb[0].AzuraCast.BaseUrl));
-        string apiKey = Crypto.Decrypt(stationsInDb[0].AzuraCast.AdminApiKey);
-        string command = context.Command.Name;
+        Uri baseUrl = new(Crypto.Decrypt(azuraCast.BaseUrl));
+        string apiKey = Crypto.Decrypt(azuraCast.AdminApiKey);
         foreach (AzuraCastStationEntity station in stationsInDb)
         {
             AzuraAdminStationConfigRecord config = await _azuraCast.GetStationAdminConfigAsync(baseUrl, apiKey, station.StationId);
 
-            switch (command)
+            switch (context.Command.Name)
             {
                 case "start-station" when config.IsEnabled:
                 case "stop-station" when !config.IsEnabled:

src/AzzyBot-Next/Commands/Autocompletes/AzzyHelpAutocomplete.cs

@@ -21,13 +21,16 @@ public sealed class AzzyHelpAutocomplete(AzzyBotSettingsRecord settings, DbActio
     public async ValueTask<IReadOnlyDictionary<string, object>> AutoCompleteAsync(AutoCompleteContext context)
     {
         ArgumentNullException.ThrowIfNull(context, nameof(context));
+        ArgumentNullException.ThrowIfNull(context.Client.CurrentApplication.Owners, nameof(context.Client.CurrentApplication.Owners));
+        ArgumentNullException.ThrowIfNull(context.Guild, nameof(context.Guild));
+        ArgumentNullException.ThrowIfNull(context.Member, nameof(context.Member));
 
         Dictionary<string, object> results = [];
         string search = context.UserInput;
 
-        IEnumerable<DiscordUser> botOwners = context.Client.CurrentApplication.Owners ?? throw new InvalidOperationException("Invalid bot owners");
-        ulong guildId = context.Guild?.Id ?? throw new InvalidOperationException("Invalid guild id");
-        DiscordMember member = context.Member ?? throw new InvalidOperationException("Invalid member");
+        IEnumerable<DiscordUser> botOwners = context.Client.CurrentApplication.Owners;
+        ulong guildId = context.Guild.Id;
+        DiscordMember member = context.Member;
         GuildsEntity? guild = await _dbActions.GetGuildAsync(guildId);
         if (guild is null)
             return results;

src/AzzyBot-Next/Commands/Autocompletes/GuildsAutocomplete.cs

@@ -21,16 +21,15 @@ public async ValueTask<IReadOnlyDictionary<string, object>> AutoCompleteAsync(Au
     {
         ArgumentNullException.ThrowIfNull(context, nameof(context));
 
-        List<GuildsEntity> guildsInDb = [];
+        IReadOnlyList<GuildsEntity> guildsInDb = [];
         IReadOnlyDictionary<ulong, DiscordGuild> guilds = _botService.GetDiscordGuilds;
-
         switch (context.Command.FullName)
         {
             case "admin debug-servers add-server":
                 guildsInDb = await _dbActions.GetGuildsWithDebugAsync(false);
                 break;
 
-            case "admin debug-server remove-server":
+            case "admin debug-servers remove-server":
                 guildsInDb = await _dbActions.GetGuildsWithDebugAsync(true);
                 break;
         }