Make IApplicationTask async, registered as keyed service (#1331)

* Rename project Steeltoe.Management.Task to Steeltoe.Management.Tasks, to avoid naming clash with System.Threading.Task.

* Make IApplicationTask async, registered as keyed service

* Fixed: dispose the host after running the application task, because host.RunAsync does that too.

Author: bart-vmware

src/Common/src/Common/IApplicationTask.cs

@@ -10,12 +10,10 @@ namespace Steeltoe.Common;
 public interface IApplicationTask
 {
     /// <summary>
-    /// Gets globally unique name for the task.
+    /// Executes this task.
     /// </summary>
-    string Name { get; }
-
-    /// <summary>
-    /// Action which to run.
-    /// </summary>
-    void Run();
+    /// <param name="cancellationToken">
+    /// The token to monitor for cancellation requests.
+    /// </param>
+    Task RunAsync(CancellationToken cancellationToken);
 }

src/Common/src/Common/Properties/AssemblyInfo.cs

@@ -28,7 +28,7 @@
 [assembly: InternalsVisibleTo("Steeltoe.Management.Endpoint")]
 [assembly: InternalsVisibleTo("Steeltoe.Management.Endpoint.Test")]
 [assembly: InternalsVisibleTo("Steeltoe.Management.Prometheus")]
-[assembly: InternalsVisibleTo("Steeltoe.Management.Task")]
+[assembly: InternalsVisibleTo("Steeltoe.Management.Tasks")]
 [assembly: InternalsVisibleTo("Steeltoe.Management.Tracing")]
 [assembly: InternalsVisibleTo("Steeltoe.Management.Tracing.Test")]
 [assembly: InternalsVisibleTo("Steeltoe.Management.Wavefront")]

src/Connectors/src/EntityFrameworkCore/MigrateDbContextTask.cs

@@ -9,54 +9,56 @@
 namespace Steeltoe.Connectors.EntityFrameworkCore;
 
 /// <summary>
-/// Applies code first migrations for the specified Entity Framework DB Context This task name is "migrate".
+/// Applies code-first database migrations for the specified Entity Framework Core <see cref="DbContext" />.
 /// </summary>
-/// <example>
-/// dotnet run runtask=migrate.
+/// <example><![CDATA[
+/// dotnet run RunTask=migrate
+/// ]]>
 /// </example>
-/// <typeparam name="T">
-/// The DBContext which to migrate.
+/// <typeparam name="TDbContext">
+/// The <see cref="DbContext" /> to run migrations from.
 /// </typeparam>
-public class MigrateDbContextTask<T> : IApplicationTask
-    where T : DbContext
+public sealed class MigrateDbContextTask<TDbContext> : IApplicationTask
+    where TDbContext : DbContext
 {
-    private readonly T _db;
-    private readonly ILogger _logger;
+    public const string Name = "migrate";
 
-    public string Name => "migrate";
+    private readonly TDbContext _dbContext;
+    private readonly ILogger _logger;
 
-    public MigrateDbContextTask(T db, ILogger<MigrateDbContextTask<T>> logger)
+    public MigrateDbContextTask(TDbContext dbContext, ILogger<MigrateDbContextTask<TDbContext>> logger)
     {
-        ArgumentGuard.NotNull(db);
+        ArgumentGuard.NotNull(dbContext);
         ArgumentGuard.NotNull(logger);
 
-        _db = db;
+        _dbContext = dbContext;
         _logger = logger;
     }
 
-    public void Run()
+    public async Task RunAsync(CancellationToken cancellationToken)
     {
-        bool isNewDb = false;
+        bool isNewDatabase = false;
         var migrations = new List<string>();
 
         try
         {
-            migrations = _db.Database.GetPendingMigrations().ToList();
+            migrations = (await _dbContext.Database.GetPendingMigrationsAsync(cancellationToken)).ToList();
         }
         catch
         {
-            isNewDb = true; // might not be true source of the error, but we'll catch real cause as part of Migrate call
+            // This might not be the true source of the error, but we'll catch the real cause as part of the MigrateAsync call.
+            isNewDatabase = true;
         }
 
         _logger.LogInformation("Starting database migration...");
-        _db.Database.Migrate();
+        await _dbContext.Database.MigrateAsync(cancellationToken);
 
-        if (isNewDb)
+        if (isNewDatabase)
         {
-            migrations = _db.Database.GetAppliedMigrations().ToList();
+            migrations = (await _dbContext.Database.GetAppliedMigrationsAsync(cancellationToken)).ToList();
         }
 
-        if (migrations.Any())
+        if (migrations.Count > 0)
         {
             _logger.LogInformation("The following migrations have been successfully applied:");
 
@@ -67,7 +69,7 @@ public void Run()
         }
         else
         {
-            _logger.LogInformation("Database is already up to date");
+            _logger.LogInformation("Database is already up to date.");
         }
     }
 }

src/Connectors/src/EntityFrameworkCore/PublicAPI.Unshipped.txt

@@ -1,4 +1,5 @@
 #nullable enable
+const Steeltoe.Connectors.EntityFrameworkCore.MigrateDbContextTask<TDbContext>.Name = "migrate" -> string!
 static Steeltoe.Connectors.EntityFrameworkCore.MySql.MySqlDbContextOptionsBuilderExtensions.UseMySql(this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder! optionsBuilder, System.IServiceProvider! serviceProvider) -> Microsoft.EntityFrameworkCore.DbContextOptionsBuilder!
 static Steeltoe.Connectors.EntityFrameworkCore.MySql.MySqlDbContextOptionsBuilderExtensions.UseMySql(this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder! optionsBuilder, System.IServiceProvider! serviceProvider, string? serviceBindingName) -> Microsoft.EntityFrameworkCore.DbContextOptionsBuilder!
 static Steeltoe.Connectors.EntityFrameworkCore.MySql.MySqlDbContextOptionsBuilderExtensions.UseMySql(this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder! optionsBuilder, System.IServiceProvider! serviceProvider, string? serviceBindingName, object? serverVersion, System.Action<object!>? mySqlOptionsAction) -> Microsoft.EntityFrameworkCore.DbContextOptionsBuilder!
@@ -8,10 +9,9 @@ static Steeltoe.Connectors.EntityFrameworkCore.PostgreSql.PostgreSqlDbContextOpt
 static Steeltoe.Connectors.EntityFrameworkCore.SqlServer.SqlServerDbContextOptionsBuilderExtensions.UseSqlServer(this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder! optionsBuilder, System.IServiceProvider! serviceProvider) -> Microsoft.EntityFrameworkCore.DbContextOptionsBuilder!
 static Steeltoe.Connectors.EntityFrameworkCore.SqlServer.SqlServerDbContextOptionsBuilderExtensions.UseSqlServer(this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder! optionsBuilder, System.IServiceProvider! serviceProvider, string? serviceBindingName) -> Microsoft.EntityFrameworkCore.DbContextOptionsBuilder!
 static Steeltoe.Connectors.EntityFrameworkCore.SqlServer.SqlServerDbContextOptionsBuilderExtensions.UseSqlServer(this Microsoft.EntityFrameworkCore.DbContextOptionsBuilder! optionsBuilder, System.IServiceProvider! serviceProvider, string? serviceBindingName, System.Action<object!>? sqlServerOptionsAction) -> Microsoft.EntityFrameworkCore.DbContextOptionsBuilder!
-Steeltoe.Connectors.EntityFrameworkCore.MigrateDbContextTask<T>
-Steeltoe.Connectors.EntityFrameworkCore.MigrateDbContextTask<T>.MigrateDbContextTask(T! db, Microsoft.Extensions.Logging.ILogger<Steeltoe.Connectors.EntityFrameworkCore.MigrateDbContextTask<T!>!>! logger) -> void
-Steeltoe.Connectors.EntityFrameworkCore.MigrateDbContextTask<T>.Name.get -> string!
-Steeltoe.Connectors.EntityFrameworkCore.MigrateDbContextTask<T>.Run() -> void
+Steeltoe.Connectors.EntityFrameworkCore.MigrateDbContextTask<TDbContext>
+Steeltoe.Connectors.EntityFrameworkCore.MigrateDbContextTask<TDbContext>.MigrateDbContextTask(TDbContext! dbContext, Microsoft.Extensions.Logging.ILogger<Steeltoe.Connectors.EntityFrameworkCore.MigrateDbContextTask<TDbContext!>!>! logger) -> void
+Steeltoe.Connectors.EntityFrameworkCore.MigrateDbContextTask<TDbContext>.RunAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task!
 Steeltoe.Connectors.EntityFrameworkCore.MySql.MySqlDbContextOptionsBuilderExtensions
 Steeltoe.Connectors.EntityFrameworkCore.PostgreSql.PostgreSqlDbContextOptionsBuilderExtensions
 Steeltoe.Connectors.EntityFrameworkCore.SqlServer.SqlServerDbContextOptionsBuilderExtensions

src/Connectors/test/EntityFrameworkCore.Test/MigrateDbContextTaskTest.cs

@@ -0,0 +1,64 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information.
+
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Migrations;
+using Microsoft.Extensions.DependencyInjection;
+using Steeltoe.Management.Tasks;
+
+namespace Steeltoe.Connectors.EntityFrameworkCore.Test;
+
+public sealed class MigrateDbContextTaskTest
+{
+    [Fact]
+    public async Task WebApplication_ExecutesMigrateTask()
+    {
+        const string taskName = MigrateDbContextTask<TestMigrateDbContext>.Name;
+        string[] args = [$"RunTask={taskName}"];
+
+        WebApplicationBuilder builder = WebApplication.CreateBuilder(args);
+        builder.WebHost.UseDefaultServiceProvider(options => options.ValidateScopes = true);
+
+        builder.Services.AddDbContext<TestMigrateDbContext>(options => options.UseSqlite("Data Source=Test.db"));
+        builder.Services.AddTask<MigrateDbContextTask<TestMigrateDbContext>>(taskName);
+
+        WebApplication app = builder.Build();
+
+        await app.RunWithTasksAsync(CancellationToken.None);
+
+        TestMigrator.HasMigrated.Should().BeTrue();
+    }
+
+    private sealed class TestMigrateDbContext(DbContextOptions options) : DbContext(options)
+    {
+        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
+        {
+            optionsBuilder.ReplaceService<IMigrator, TestMigrator>();
+        }
+    }
+
+    private sealed class TestMigrator : IMigrator
+    {
+        public static bool HasMigrated { get; private set; }
+
+        public void Migrate(string? targetMigration = null)
+        {
+            throw new NotImplementedException();
+        }
+
+        public Task MigrateAsync(string? targetMigration = null, CancellationToken cancellationToken = default)
+        {
+            HasMigrated = true;
+            return Task.CompletedTask;
+        }
+
+        public string GenerateScript(string? fromMigration = null, string? toMigration = null,
+            MigrationsSqlGenerationOptions options = MigrationsSqlGenerationOptions.Default)
+        {
+            throw new NotImplementedException();
+        }
+    }
+}

src/Connectors/test/EntityFrameworkCore.Test/Steeltoe.Connectors.EntityFrameworkCore.Test.csproj

@@ -7,13 +7,15 @@
   <Import Project="..\..\..\..\shared.props" />
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="$(EntityFrameworkCoreTestVersion)" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="$(EntityFrameworkCoreTestVersion)" />
     <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="$(EntityFrameworkCoreTestVersion)" />
     <PackageReference Include="MySql.EntityFrameworkCore" Version="$(EntityFrameworkCoreTestVersion)" />
     <PackageReference Include="Pomelo.EntityFrameworkCore.MySql" Version="$(EntityFrameworkCoreTestVersion)" />
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\..\Management\src\Tasks\Steeltoe.Management.Tasks.csproj" />
     <ProjectReference Include="..\..\src\EntityFrameworkCore\Steeltoe.Connectors.EntityFrameworkCore.csproj" />
   </ItemGroup>
 </Project>