Merge pull request #8 from abpframework/EngincanV/add-migration-logic

Engincan v/add migration logic

Author: skoc10

.gitignore

@@ -396,3 +396,4 @@ FodyWeavers.xsd
 
 # JetBrains Rider
 *.sln.iml
+.idea/*

README.md

@@ -8,7 +8,13 @@ This is a sample application designed to demonstrate the capabilities of the [AB
 
 ## How to run?
 
-This application uses SQLite as the database and the database can be found in the solution folder. Therefore, you don't need to create the database and instead, you can directly run the `CmsKitDemo` project to see the application.
+Before running the application, you should run the following command in the `CmsKitDemo` folder to install all NPM packages for the application:
+
+```bash
+abp install-libs
+```
+
+After installing the NPM packages, you can directly run the `CmsKitDemo` project to see the application. This application uses SQLite as the database and the database can be found in the solution folder. Therefore, you don't need to create the database manually.
 
 > Default credentials: `admin` as username and `1q2w3E*` as the password.
 

src/CmsKitDemo/CmsKitDemo.csproj

@@ -102,6 +102,9 @@
     <Content Remove="Logs\**" />
     <EmbeddedResource Remove="Logs\**" />
     <None Remove="Logs\**" />
+    <None Update="CmsKitDemoDb\CmsKitDemo.db">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
   </ItemGroup>
 
   <ItemGroup>

src/CmsKitDemo/CmsKitDemoConsts.cs

@@ -9,5 +9,7 @@ public class CmsKitDemoConsts
         public const string ImageGalleryEntityType = "Image";
 
         public const int MaxDescriptionLength = 512;
+        
+        public static readonly List<string> IgnoredUserAgents = new();
     }
 }

src/CmsKitDemo.db renamed to src/CmsKitDemo/CmsKitDemoDb/CmsKitDemo.db

@@ -55,6 +55,8 @@
 using Volo.CmsKit.Web;
 using Volo.Abp.Threading;
 using Microsoft.AspNetCore.Mvc.RazorPages;
+using Volo.Abp.Data;
+using Volo.Abp.IO;
 using Volo.CmsKit.Reactions;
 using Volo.CmsKit.Comments;
 using Microsoft.EntityFrameworkCore.Query;
@@ -360,6 +362,13 @@ private void ConfigureCmsKit(ServiceConfigurationContext context)
         });
     }
 
+    public override async Task OnPreApplicationInitializationAsync(ApplicationInitializationContext context)
+    {
+        DirectoryHelper.CreateIfNotExists(context.GetConfiguration()["App:DbFolderName"] ?? "CmsKitDemoDb");
+        var connString = await context.ServiceProvider.GetRequiredService<IConnectionStringResolver>().ResolveAsync();
+        await context.ServiceProvider.GetRequiredService<CmsKitDemoDbMigrationService>().MigrateAsync(connString);
+    }
+
     public override void OnApplicationInitialization(ApplicationInitializationContext context)
     {
         var app = context.GetApplicationBuilder();
@@ -377,6 +386,8 @@ public override void OnApplicationInitialization(ApplicationInitializationContex
             app.UseErrorPage();
         }
 
+        app.UseMiddleware<DbMigrationMiddleware>();
+
         app.UseCorrelationId();
         app.UseStaticFiles();
         app.UseRouting();

src/CmsKitDemo/CmsKitDemoModule.cs

@@ -0,0 +1,50 @@
+using Microsoft.Extensions.Options;
+using Volo.Abp.Data;
+using Volo.Abp.DependencyInjection;
+using Volo.Abp.Threading;
+
+namespace CmsKitDemo.Data;
+
+[Dependency(ReplaceServices = true)]
+public class CmsKitConnectionStringResolver : DefaultConnectionStringResolver
+{
+    private readonly CmsKitDemoUserIdResolver _demoNameResolver;
+    private readonly IConfiguration _configuration;
+    
+    public CmsKitConnectionStringResolver(
+        IOptionsMonitor<AbpDbConnectionOptions> options,
+        CmsKitDemoUserIdResolver demoNameResolver,
+        IConfiguration configuration)
+        : base(options)
+    {
+        _demoNameResolver = demoNameResolver;
+        _configuration = configuration;
+    }
+    
+    [Obsolete("Use ResolveAsync method.")]
+    public override string Resolve(string connectionStringName = null)
+    {
+        return AsyncHelper.RunSync(() => ResolveInternalAsync(connectionStringName));
+    }
+
+    public async override Task<string> ResolveAsync(string connectionStringName = null)
+    {
+        return await ResolveInternalAsync(connectionStringName);
+    }
+
+    private async Task<string> ResolveInternalAsync(string connectionStringName = null)
+    {
+        var dbFolder = _configuration["App:DbFolderName"]?.EnsureEndsWith(Path.DirectorySeparatorChar);
+        if (dbFolder.IsNullOrWhiteSpace())
+        {
+            return await base.ResolveAsync(connectionStringName);
+        }
+
+        var demoUserId = _demoNameResolver.GetDemoUserIdOrNull() ?? _configuration["App:DefaultDbName"];
+
+        var dbFilePath = $"{dbFolder}{demoUserId}.db";
+        var connString = $"Data Source={dbFilePath};Cache=Shared";
+
+        return connString;
+    }
+}

src/CmsKitDemo/Data/CmsKitConnectionStringResolver.cs

@@ -7,12 +7,12 @@ public class CmsKitDemoDbContextFactory : IDesignTimeDbContextFactory<CmsKitDemo
 {
     public CmsKitDemoDbContext CreateDbContext(string[] args)
     {
-
         var configuration = BuildConfiguration();
 
-        var dbFolder = configuration["App:SqliteDbFolder"]?.EnsureEndsWith(Path.DirectorySeparatorChar);
+        var dbFolder = configuration["App:DbFolderName"]!.EnsureEndsWith(Path.DirectorySeparatorChar);
+
         var builder = new DbContextOptionsBuilder<CmsKitDemoDbContext>()
-            .UseSqlite($"Data Source={dbFolder}{configuration["App:DefaultDbName"]}.db");
+            .UseSqlite($"Data Source={dbFolder}{configuration["App:DefaultDbName"]}.db;");
 
         return new CmsKitDemoDbContext(builder.Options);
     }

src/CmsKitDemo/Data/CmsKitDemoDbContextFactory.cs

@@ -17,23 +17,73 @@ public class CmsKitDemoDbMigrationService : ITransientDependency
     private readonly CmsKitDemoEFCoreDbSchemaMigrator _dbSchemaMigrator;
     private readonly ITenantRepository _tenantRepository;
     private readonly ICurrentTenant _currentTenant;
+    private readonly IConfiguration _configuration;
 
     public CmsKitDemoDbMigrationService(
         IDataSeeder dataSeeder,
         CmsKitDemoEFCoreDbSchemaMigrator dbSchemaMigrator,
         ITenantRepository tenantRepository,
-        ICurrentTenant currentTenant)
+        ICurrentTenant currentTenant, 
+        IConfiguration configuration)
     {
         _dataSeeder = dataSeeder;
         _dbSchemaMigrator = dbSchemaMigrator;
         _tenantRepository = tenantRepository;
         _currentTenant = currentTenant;
+        _configuration = configuration;
 
         Logger = NullLogger<CmsKitDemoDbMigrationService>.Instance;
     }
+    
+    private async Task MigrateHostDatabaseAsync(string connectionString)
+    {
+        Logger.LogInformation("Migrating host database schema...");
+
+        if (!connectionString.Contains(_configuration["App:DefaultDbName"] + ".db"))
+        {
+            TryToCopyFromDefaultDb(connectionString);
+        }
+        else
+        {
+            await _dbSchemaMigrator.MigrateAsync(connectionString);
+        }
 
-    public async Task MigrateAsync()
+        Logger.LogInformation("Executing host database seed...");
+
+        await _dataSeeder.SeedAsync(
+            new DataSeedContext()
+                .WithProperty("AdminPassword", "123456")
+        );
+
+        Logger.LogInformation("Successfully completed host database migrations.");
+    }
+
+    private void TryToCopyFromDefaultDb(string connectionString)
     {
+        try
+        {
+            var filePath = connectionString!.Replace("Data Source=", "").Split(";")[0];
+            File.Copy(_configuration["App:DbFolderName"]?.EnsureEndsWith(Path.DirectorySeparatorChar) + _configuration["App:DefaultDbName"] + ".db", filePath);
+        }
+        catch
+        {
+            //...
+        }
+    }
+
+    public async Task MigrateAsync(string? connectionString = null)
+    {
+        if (!connectionString.IsNullOrWhiteSpace())
+        {
+            Logger.LogInformation("Started database migrations...");
+
+            await MigrateHostDatabaseAsync(connectionString!);
+
+            Logger.LogInformation("Successfully completed database migrations.");
+            
+            return;
+        }
+        
         var initialMigrationAdded = AddInitialMigrationIfNotExist();
 
         if (initialMigrationAdded)

src/CmsKitDemo/Data/CmsKitDemoDbMigrationService.cs

@@ -7,23 +7,26 @@ public class CmsKitDemoEFCoreDbSchemaMigrator : ITransientDependency
 {
     private readonly IServiceProvider _serviceProvider;
 
-    public CmsKitDemoEFCoreDbSchemaMigrator(
-        IServiceProvider serviceProvider)
+    public CmsKitDemoEFCoreDbSchemaMigrator(IServiceProvider serviceProvider)
     {
         _serviceProvider = serviceProvider;
     }
 
-    public async Task MigrateAsync()
+    public async Task MigrateAsync(string? connectionString = null)
     {
-        /* We intentionally resolve the CmsKitDemoDbContext
-         * from IServiceProvider (instead of directly injecting it)
-         * to properly get the connection string of the current tenant in the
-         * current scope.
-         */
+        if (connectionString.IsNullOrWhiteSpace())
+        {
+            await _serviceProvider.GetRequiredService<CmsKitDemoDbContext>().Database.MigrateAsync();
+            return;
+        }
 
-        await _serviceProvider
-            .GetRequiredService<CmsKitDemoDbContext>()
-            .Database
-            .MigrateAsync();
+        var options = new DbContextOptionsBuilder<CmsKitDemoDbContext>()
+                .UseSqlite(connectionString)
+                .Options;
+        
+        using (var dbContext = new CmsKitDemoDbContext(options))
+        {
+            await dbContext.Database.MigrateAsync();
+        }
     }
-}
+}

src/CmsKitDemo/Data/CmsKitDemoEFCoreDbSchemaMigrator.cs

@@ -0,0 +1,63 @@
+using Volo.Abp.DependencyInjection;
+using Volo.Abp.Guids;
+
+namespace CmsKitDemo.Data;
+
+public class CmsKitDemoUserIdResolver : ITransientDependency
+{
+    private const string DemoUserCookieName = "CmsKitDemoUser";
+
+    private readonly IHttpContextAccessor _httpContextAccessor;
+    private readonly IGuidGenerator _guidGenerator;
+
+    public CmsKitDemoUserIdResolver(IHttpContextAccessor httpContextAccessor, IGuidGenerator guidGenerator)
+    {
+        _httpContextAccessor = httpContextAccessor;
+        _guidGenerator = guidGenerator;
+    }
+    
+    public string? GetDemoUserIdOrNull()
+    {
+        var httpContext = _httpContextAccessor.HttpContext;
+        if (httpContext == null)
+        {
+            return null;
+        }
+
+        var demoUserId = httpContext.Items[DemoUserCookieName] as string;
+        if (demoUserId != null)
+        {
+            return demoUserId;
+        }
+
+        demoUserId = GetDemoUserFromQueryStringOrNull(httpContext) ?? GetDemoUserFromCookieOrNull(httpContext);
+        if (demoUserId == null)
+        {
+            demoUserId = _guidGenerator.Create().ToString();
+        }
+
+        SetDemoUserCookie(demoUserId);
+        httpContext.Items[DemoUserCookieName] = demoUserId;
+        return demoUserId;
+    }
+
+    private static string? GetDemoUserFromCookieOrNull(HttpContext httpContext)
+    {
+        return httpContext.Request?.Cookies[DemoUserCookieName];
+    }
+
+    private static string? GetDemoUserFromQueryStringOrNull(HttpContext httpContext)
+    {
+        return httpContext.Request?.Query[DemoUserCookieName];
+    }
+
+    private void SetDemoUserCookie(string value)
+    {
+        var option = new CookieOptions
+        {
+            Expires = DateTime.Now.AddMonths(12)
+        };
+
+        _httpContextAccessor.HttpContext?.Response.Cookies.Append(DemoUserCookieName, value, option);
+    }
+}

src/CmsKitDemo/Data/CmsKitDemoUserIdResolver.cs

@@ -0,0 +1,46 @@
+using Volo.Abp.Data;
+using Volo.Abp.DependencyInjection;
+
+namespace CmsKitDemo.Data;
+
+public class DbMigrationMiddleware : IMiddleware, ITransientDependency
+{
+    private readonly CmsKitDemoDbMigrationService _dbMigrationService;
+
+    private readonly IConnectionStringResolver _connectionStringResolver;
+
+    public DbMigrationMiddleware(CmsKitDemoDbMigrationService dbMigrationService, IConnectionStringResolver connectionStringResolver)
+    {
+        _dbMigrationService = dbMigrationService;
+        _connectionStringResolver = connectionStringResolver;
+    }
+
+    public async Task InvokeAsync(HttpContext context, RequestDelegate next)
+    {
+        var connString = await _connectionStringResolver.ResolveAsync();
+        var dbFilePath = connString.Replace("Data Source=", "").Replace(";Cache=Shared", "");
+            
+        if (ShouldCreateUserDb(context, dbFilePath))
+        {
+            await _dbMigrationService.MigrateAsync(connString);
+        }
+            
+        await next(context);
+    }
+    
+    private static bool ShouldCreateUserDb(HttpContext context, string dbFilePath)
+    {
+        if (!context.Request.Headers.ContainsKey("User-Agent"))
+        {
+            return !File.Exists(dbFilePath);
+        }
+
+        var userAgent = context.Request.Headers.FirstOrDefault(e=> e.Key == "User-Agent");
+        if (CmsKitDemoConsts.IgnoredUserAgents.Any(ignoredUserAgent => userAgent.Value.ToString().Contains(ignoredUserAgent)))
+        {
+            return false;
+        }
+
+        return !File.Exists(dbFilePath);
+    }
+}

src/CmsKitDemo/Data/DbMigrationMiddleware.cs

@@ -1,9 +1,11 @@
 {
   "App": {
-    "SelfUrl": "https://localhost:44373"
+    "SelfUrl": "https://localhost:44373",
+    "DefaultDbName": "CmsKitDemo",
+    "DbFolderName": "CmsKitDemoDb"
   },
   "ConnectionStrings": {
-    "Default": "Data Source=CmsKitDemo.db;"
+    "Default": "Data Source=/CmsKitDemoDb/CmsKitDemo.db;"
   },
   "StringEncryption": {
     "DefaultPassPhrase": "cZl2tCN43sVGDX6m"