Added Microsoft.Extensions.Hosting support #18

GerardSmit · 2020-06-25T20:50:33Z

This PR adds Microsoft.Extensions.Hosting support to Miki.Framework. This makes it way easier to set-up a new bot in a console application or even a ASP.NET Core application.

Middlewares

This PR introduces IBotApplicationBuilder which is equal to IApplicationBuilder in ASP.Net Core.

You can define middlewares in ConfigureBot:

HostBuilder.ConfigureBot(app =>
{
    app.Use(async (context, func) =>
    {
        var channel = await context.Message.GetChannelAsync();

        await channel.SendMessageAsync("Hello world!")
    });
})

Command pipeline

To use a command stage in the new middleware, you can use app.UseStage<ClassName>().
To use the CommandPipelineBuilder extensions, you can use app.UsePipeline:

app.UsePipeline(builder =>
{
    builder.UsePrefixes();
    builder.UseArgumentPack();
    builder.UseCommandHandler();
});

Example bot

public static Task Main(string[] args)
{
    return new HostBuilder()
        .ConfigureServices(services =>
        {
            services.AddDiscord("TOKEN");
            services.AddCacheClient<InMemoryCacheClient>();
            services.AddSingleton<ISerializer, ProtobufSerializer>();
        })
        .ConfigureBot(app =>
        {
            app.UseStage<FetchDataStage>();
            app.Use(async (context, next) =>
            {
                var message = context.Message;

                if (message.Content == "ping")
                {
                    await context.GetChannel().SendMessageAsync("Pong");
                }

                await next();
            });
        })
        .RunConsoleAsync();
}

It's now possible to inject scoped services in the module constructor. It's also possible to make a custom parameter provider with IParameterProvider.

velddev

Lets some questions and remarks

velddev · 2020-06-27T13:47:58Z

src/Miki.Framework.Commands/CommandTreeBuilder.cs

-
-		public CommandTree Create(Assembly assembly)
+
+		public IServiceCollection Services { get; }


Why are these public now? they shouldn't be used externally.

So you can easily add services when you make an extension method, e.g.:

public static class CommandExtensions { public static CommandTreeBuilder AddWarningsModule(this CommandTreeBuilder builder) { builder.Services.AddScoped<IWarningService, WarningService>(); builder.AddAssembly(typeof(CommandExtensions).Assembly); return builder; } }

Now you can call the extension method AddWarningsModule and all the required services are added:

services.AddCommands(builder => { builder.AddWarningsModule(); });

velddev · 2020-06-27T13:49:33Z

src/Miki.Framework.Commands/CommandTreeCompiler.cs

+
+namespace Miki.Framework.Commands
+{
+    internal class CommandTreeCompiler


Can we perhaps have any test cases for this?

velddev · 2020-06-27T13:50:45Z

src/Miki.Framework.Commands/Models/Nodes/Node.cs

@@ -16,15 +16,15 @@ public abstract class Node
        public IReadOnlyCollection<Attribute> Attributes => Type.GetCustomAttributes<Attribute>(false)
 				.ToList();

-		private MemberInfo Type { get; }
+		public Type Type { get; }


What's the reasoning for this?

This was needed when the delegate is being compiled, I need the parent type when creating the NodeExecutable:

https://github.com/Mikibot/Miki.Framework/blob/ede6821a96fc622a3e12c308dc2e73797dc816d4/src/Miki.Framework.Commands/CommandTreeCompiler.cs#L101

velddev · 2020-06-27T14:19:57Z

src/Miki.Framework.Discord/Services/DiscordHostedService.cs

+            }
+            catch (Exception e)
+            {
+                Log.Error(e);


Is this before the pipeline?

No, this is after the pipeline. This is called when an exception occurred in the middelware.

Can we add an event then when an exception occurs to fetch the current context state and exception?

velddev · 2020-06-27T14:20:33Z

src/Miki.Framework/ContextObject.cs

@@ -9,6 +12,11 @@
 	/// </summary>
    public interface IContext
 	{
+		/// <summary>
+		/// The message received from discord.


"The message recieved from Discord" is deceiving, it will change into more providers in the future.

velddev · 2020-06-27T14:21:29Z

src/Miki.Framework/Extension/MiddlewareExtensions.cs

+                throw new ArgumentNullException(nameof(handler));
+            }
+
+            app.Use(_ => handler);


The extension method .Run is being used at the end of the pipeline, so you don't need the next middleware. This is the same as ASP.NET Core.

velddev · 2020-06-27T14:22:37Z

src/Miki.Framework/Extension/MiddlewareExtensions.cs

+        /// <returns></returns>
+        public static IBotApplicationBuilder UseWhen(this IBotApplicationBuilder app, Predicate predicate, Action<IBotApplicationBuilder> configuration)
+        {
+            if (app == null)


App can't be null here right? Either way, you can use Required<IBotApplicationBuilder> to automate the process.

App can't be null here right?

Probably not, this is how Microsoft implemented UseWhen as well but I can remove this.

Either way, you can use Required to automate the process.

Required<IBotApplicationBuilder> is not possible because it's an extension method. It would register the extension method to Required<IBotApplicationBuilder> instead of IBotApplicationBuilder.

Fair enough, but the other params could have it set to required.

velddev · 2020-06-27T14:24:22Z

src/Miki.Framework/Extension/ServiceExtensions.cs

+        public static IServiceCollection AddCacheClient<T>(this IServiceCollection services)
+            where T : class, IExtendedCacheClient
+        {
+            services.AddSingleton<ICacheClient>(provider => provider.GetService<IExtendedCacheClient>());


How does this work?

IExtendedCacheClient extends ICacheClient. This registration redirects ICacheClient to IExtendedCacheClient, you could register it two times but that means you have (for example) two Redis connections open.

That doesn't make sense, we already have connection pooling.

Added Microsoft.Extensions.Hosting support

654a09e

GerardSmit requested a review from velddev June 25, 2020 20:50

GerardSmit added 2 commits June 25, 2020 23:13

Fallback to the message context

d02a48a

Moved Discord-related classes to Miki.Framework.Discord

6e21105

GerardSmit marked this pull request as draft June 25, 2020 22:51

GerardSmit added 2 commits June 26, 2020 23:14

Improved module dependency injection

49e9412

It's now possible to inject scoped services in the module constructor. It's also possible to make a custom parameter provider with IParameterProvider.

Added UseStage<> to CommandPipelineBuilder

ede6821

GerardSmit marked this pull request as ready for review June 26, 2020 21:16

GerardSmit mentioned this pull request Jun 26, 2020

Command arguments #19

Draft

2 tasks

velddev reviewed Jun 27, 2020

View reviewed changes


		public CommandTree Create(Assembly assembly)

		public IServiceCollection Services { get; }

Added Microsoft.Extensions.Hosting support #18

Are you sure you want to change the base?

Added Microsoft.Extensions.Hosting support #18

Conversation

GerardSmit commented Jun 25, 2020

Middlewares

Command pipeline

Example bot

Uh oh!

velddev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GerardSmit Jun 27, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

velddev Jun 27, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

GerardSmit Jun 27, 2020 •

edited

Loading

velddev Jun 27, 2020 •

edited

Loading