v3.1.0 (#12)

* Multi-target .NET 5 * Add build.yml * Remove azure pipelines * Update build pipeline * Minor readme edit * Add additional badges * Formatting
Hawxy · Nov 15, 2020 · 63c8ca1 · 63c8ca1
1 parent cc65ef9
commit 63c8ca1
Show file tree

Hide file tree

Showing 15 changed files with 72 additions and 77 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,23 @@
+name: .NET Core Build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup .NET Core
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: '5.0.x'
+    - name: Install dependencies
+      run: dotnet restore
+    - name: Build
+      run: dotnet build --configuration Release --no-restore
diff --git a/Discord.Addons.Hosting/Discord.Addons.Hosting.csproj b/Discord.Addons.Hosting/Discord.Addons.Hosting.csproj
@@ -1,9 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netstandard2.0;netstandard2.1</TargetFrameworks>
+    <TargetFrameworks>netstandard2.1;net5</TargetFrameworks>
     <PackageId>Discord.Addons.Hosting</PackageId>
-    <Version>3.0.0</Version>
+    <Version>3.1.0</Version>
     <Authors>Hawxy</Authors>
     <Description>Simplifying Discord.Net hosting with .NET Generic Host (Microsoft.Extensions.Hosting)</Description>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
@@ -12,16 +12,22 @@
     <RepositoryUrl>https://github.com/Hawxy/Discord.Addons.Hosting</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <PackageIcon>icon.png</PackageIcon>
-    <Copyright>Hawxy 2018-2020</Copyright>
+    <Copyright>Hawxy 2018-2021</Copyright>
     <PackageTags>discord,discord.net,addon,hosting,microsoft.extensions.hosting</PackageTags>
     <Nullable>Enable</Nullable>
-    <LangVersion>8.0</LangVersion>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Discord.Net.Commands" Version="2.2.0" />
     <PackageReference Include="Discord.Net.WebSocket" Version="2.2.0" />
-    <PackageReference Include="Microsoft.Extensions.Hosting" Version="3.1.5" />
+  </ItemGroup>
+
+  <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard2.1' ">
+    <PackageReference Include="Microsoft.Extensions.Hosting" Version="3.1.10" />
+  </ItemGroup>
+
+  <ItemGroup Condition=" '$(TargetFramework)' == 'net5' ">
+    <PackageReference Include="Microsoft.Extensions.Hosting" Version="5.0.0" />
   </ItemGroup>
 
   <ItemGroup>    

diff --git a/Discord.Addons.Hosting/DiscordHostBuilderExtensions.cs b/Discord.Addons.Hosting/DiscordHostBuilderExtensions.cs
@@ -54,7 +54,7 @@ public static IHostBuilder ConfigureDiscordHost<T>(this IHostBuilder builder, Ac
                 if (config != null)
                     collection.Configure<DiscordHostConfiguration>(x => config(context, x));
 
-                collection.AddSingleton(x=> (T)Activator.CreateInstance(typeof(T), x.GetService<IOptions<DiscordHostConfiguration>>().Value.SocketConfig));
+                collection.AddSingleton(x=> (T)Activator.CreateInstance(typeof(T), x.GetRequiredService<IOptions<DiscordHostConfiguration>>().Value.SocketConfig)!);
                 if(typeof(T) != typeof(DiscordSocketClient))
                     collection.AddSingleton<DiscordSocketClient>(x => x.GetRequiredService<T>());
 
@@ -110,7 +110,7 @@ public static IHostBuilder UseCommandService(this IHostBuilder builder, Action<H
 
                 collection.Configure<CommandServiceConfig>(x => config(context, x));
 
-                collection.AddSingleton(x=> new CommandService(x.GetService<IOptions<CommandServiceConfig>>().Value));
+                collection.AddSingleton(x=> new CommandService(x.GetRequiredService<IOptions<CommandServiceConfig>>().Value));
                 collection.AddHostedService<CommandServiceInitializerHost>();
             });
 

diff --git a/Discord.Addons.Hosting/DiscordHostedService.cs b/Discord.Addons.Hosting/DiscordHostedService.cs
@@ -43,7 +43,7 @@ public DiscordHostedService(ILogger<DiscordHostedService> logger, IOptions<Disco
 
         public async Task StartAsync(CancellationToken cancellationToken)
         {
-            _logger.LogInformation("Discord.Net hosted service is starting");
+            _logger.LogInformation("Discord.NET hosted service is starting");
 
             try
             {
@@ -58,7 +58,7 @@ public async Task StartAsync(CancellationToken cancellationToken)
 
         public async Task StopAsync(CancellationToken cancellationToken)
         {
-            _logger.LogInformation("Discord.Net hosted service is stopping");
+            _logger.LogInformation("Discord.NET hosted service is stopping");
             try
             {
                 await _client.StopAsync().WithCancellation(cancellationToken);

diff --git a/Discord.Addons.Hosting/Util/TaskExtensions.cs b/Discord.Addons.Hosting/Util/TaskExtensions.cs
@@ -10,9 +10,9 @@ public static async Task WithCancellation(this Task task, CancellationToken canc
         {
             var tcs = new TaskCompletionSource<object>(TaskCreationOptions.RunContinuationsAsynchronously);
 
-            using (cancellationToken.Register(state =>
+            await using (cancellationToken.Register(state =>
                 {
-                    ((TaskCompletionSource<object>)state).TrySetResult(null!);
+                    ((TaskCompletionSource<object>)state!).TrySetResult(null!);
                 },
                 tcs))
             {

diff --git a/README.md b/README.md
@@ -1,11 +1,12 @@
 # Discord.Addons.Hosting 
-[![Build Status](https://dev.azure.com/GithubHawxy/Discord.Addons.Hosting/_apis/build/status/Hawxy.Discord.Addons.Hosting)](https://dev.azure.com/GithubHawxy/Discord.Addons.Hosting/_build/latest?definitionId=2)
+![.NET Core Build](https://github.com/Hawxy/Discord.Addons.Hosting/workflows/.NET%20Core%20Build/badge.svg)
 [![NuGet](https://img.shields.io/nuget/v/Discord.Addons.Hosting.svg?style=flat-square)](https://www.nuget.org/packages/Discord.Addons.Hosting)
+![Nuget](https://img.shields.io/nuget/dt/Discord.Addons.Hosting?style=flat-square)
 
 [Discord.Net](https://github.com/RogueException/Discord.Net) hosting with [Microsoft.Extensions.Hosting](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/host/generic-host). 
 This package provides extensions to a .NET Generic Host (IHostBuilder) that will run a Discord.Net socket/sharded client as a controllable IHostedService. This simplifies initial bot creation and moves the usual boilerplate to a convenient builder pattern.
 
-Discord.Net 2.2.0+ & .NET Core 2.1+ is required.
+Discord.Net 2.2.0+ & .NET Core 3.1+ is required.
 
 ```csharp
 var builder = new HostBuilder()               
@@ -58,6 +59,8 @@ If you want something more advanced, one of my bots CitizenEnforcer uses this ex
 
 ### Serilog
 
+I highly recommend using Serilog instead of the standard Microsoft logging. 
+
 Serilog should be added to the host with ```Serilog.Extensions.Hosting```. 
 
 See the Serilog [example](https://github.com/Hawxy/Discord.Addons.Hosting/tree/master/Samples/SampleBotSerilog) for usage.
@@ -106,7 +109,7 @@ public class CommandHandler : InitializedService
 
 When shutdown is requested, the host will wait a maximum of 5 seconds for services to stop before timing out.
 
-If you're finding that this isn't enough time, you can modify the shutdown timeout via the [ShutdownTimeout host setting](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/host/generic-host?view=aspnetcore-3.0#shutdowntimeout).
+If you're finding that this isn't enough time, you can modify the shutdown timeout via the [ShutdownTimeout host setting](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/host/generic-host?view=aspnetcore-5.0#shutdowntimeout).
 
 ### IOptions
 

diff --git a/Samples/SampleBotSerilog/CommandHandler.cs b/Samples/SampleBotSerilog/CommandHandler.cs
@@ -33,7 +33,7 @@ public override async Task InitializeAsync(CancellationToken cancellationToken)
 
         private async Task HandleMessage(SocketMessage incomingMessage)
         {
-            if (!(incomingMessage is SocketUserMessage message)) return;
+            if (incomingMessage is not SocketUserMessage message) return;
             if (message.Source != MessageSource.User) return;
 
             int argPos = 0;

diff --git a/Samples/SampleBotSerilog/Program.cs b/Samples/SampleBotSerilog/Program.cs
@@ -63,19 +63,11 @@ static async Task Main()
                 })
                 .UseConsoleLifetime();
 
-            //Stop just by hitting enter
-            //See https://github.com/aspnet/Hosting/blob/master/samples/GenericHostSample for other control patterns
             var host = builder.Build();
             using (host)
             {
-                Log.Information("Starting!");
-                await host.StartAsync();
-                Log.Information("Started! Press <enter> to stop.");
-                Console.ReadLine();
-
-                Log.Information("Stopping!");
-                await host.StopAsync();
-                Log.Information("Stopped!");
+                //Fire and forget. Will run until console is closed or the service is stopped. Basically the same as normally running the bot.
+                await host.RunAsync();
             }
         }
     }

diff --git a/Samples/SampleBotSerilog/PublicModule.cs b/Samples/SampleBotSerilog/PublicModule.cs
@@ -28,13 +28,14 @@ public async Task PingAsync()
         }
 
         [Command("shutdown")]
-        public async Task Stop()
+        public Task Stop()
         {
             _ = _host.StopAsync();
+            return Task.CompletedTask;
         }
 
         [Command("log")]
-        public async Task TestLogs()
+        public Task TestLogs()
         {
             _logger.LogTrace("This is a trace log");
             _logger.LogDebug("This is a debug log");
@@ -45,6 +46,8 @@ public async Task TestLogs()
 
             _logger.Log(GetLogLevel(LogSeverity.Error), "Error logged from a Discord LogSeverity.Error");
             _logger.Log(GetLogLevel(LogSeverity.Info), "Information logged from Discord LogSeverity.Info ");
+
+            return Task.CompletedTask;
         }
 
         private static LogLevel GetLogLevel(LogSeverity severity)

diff --git a/Samples/SampleBotSerilog/Sample.Serilog.csproj b/Samples/SampleBotSerilog/Sample.Serilog.csproj
@@ -2,17 +2,16 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>netcoreapp3.1</TargetFramework>
-    <LangVersion>latest</LangVersion>
+    <TargetFramework>net5</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Discord.Net.Commands" Version="2.2.0" />
     <PackageReference Include="Discord.Net.WebSocket" Version="2.2.0" />
-    <PackageReference Include="Microsoft.Extensions.Configuration" Version="3.1.5" />
-    <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="3.1.5" />
-    <PackageReference Include="Microsoft.Extensions.Hosting" Version="3.1.5" />
-    <PackageReference Include="Serilog" Version="2.9.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration" Version="5.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="5.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Hosting" Version="5.0.0" />
+    <PackageReference Include="Serilog" Version="2.10.0" />
     <PackageReference Include="Serilog.Extensions.Hosting" Version="3.1.0" />
     <PackageReference Include="Serilog.Sinks.Console" Version="3.1.1" />
   </ItemGroup>

diff --git a/Samples/SampleBotSimple/CommandHandler.cs b/Samples/SampleBotSimple/CommandHandler.cs
@@ -33,7 +33,7 @@ public override async Task InitializeAsync(CancellationToken cancellationToken)
 
         private async Task HandleMessage(SocketMessage incomingMessage)
         {
-            if (!(incomingMessage is SocketUserMessage message)) return;
+            if (incomingMessage is not SocketUserMessage message) return;
             if (message.Source != MessageSource.User) return;
 
             int argPos = 0;

diff --git a/Samples/SampleBotSimple/Program.cs b/Samples/SampleBotSimple/Program.cs
@@ -7,6 +7,8 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
+using Microsoft.Extensions.Logging.Console;
 
 namespace Sample.Simple
 {

diff --git a/Samples/SampleBotSimple/PublicModule.cs b/Samples/SampleBotSimple/PublicModule.cs
@@ -28,13 +28,14 @@ public async Task PingAsync()
         }
 
         [Command("shutdown")]
-        public async Task Stop()
+        public Task Stop()
         {
             _ = _host.StopAsync();
+            return Task.CompletedTask;
         }
 
         [Command("log")]
-        public async Task TestLogs()
+        public Task TestLogs()
         {
             _logger.LogTrace("This is a trace log");
             _logger.LogDebug("This is a debug log");
@@ -45,6 +46,8 @@ public async Task TestLogs()
 
             _logger.Log(GetLogLevel(LogSeverity.Error), "Error logged from a Discord LogSeverity.Error");
             _logger.Log(GetLogLevel(LogSeverity.Info), "Information logged from Discord LogSeverity.Info ");
+
+            return Task.CompletedTask;
         }
 
         private static LogLevel GetLogLevel(LogSeverity severity)

diff --git a/Samples/SampleBotSimple/Sample.Simple.csproj b/Samples/SampleBotSimple/Sample.Simple.csproj
@@ -2,17 +2,16 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>netcoreapp3.1</TargetFramework>
-    <LangVersion>latest</LangVersion>
+    <TargetFramework>net5</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Discord.Net.Commands" Version="2.2.0" />
     <PackageReference Include="Discord.Net.WebSocket" Version="2.2.0" />
-    <PackageReference Include="Microsoft.Extensions.Configuration" Version="3.1.5" />
-    <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="3.1.5" />
-    <PackageReference Include="Microsoft.Extensions.Hosting" Version="3.1.5" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="3.1.5" />
+    <PackageReference Include="Microsoft.Extensions.Configuration" Version="5.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="5.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Hosting" Version="5.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="5.0.0" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/azure-pipelines.yml b/azure-pipelines.yml