use EF Migrations in FwLite (#1378)

* switch to using migrations with LcmCrdt, auto migrate all projects on startup * check for pending model changes in fw-lite workflow
sillsdev · Jan 15, 2025 · 481cae7 · 481cae7
1 parent d0e337d
commit 481cae7
Show file tree

Hide file tree

Showing 9 changed files with 1,670 additions and 6 deletions.
diff --git a/.github/workflows/fw-lite.yaml b/.github/workflows/fw-lite.yaml
@@ -40,6 +40,10 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version-file: './frontend/package.json'
+      - name: Install Task
+        uses: arduino/setup-task@b91d5d2c96a56797b48ac1e0e89220bf64044611 #v2
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Set Version
         id: setVersion
@@ -50,6 +54,9 @@ jobs:
           echo "VERSION=v$(date --rfc-3339=date)-$shortSha" >> ${GITHUB_OUTPUT}
           echo "SEMVER_VERSION=$(date +%Y.%-m.%-d)" >> ${GITHUB_OUTPUT}
 
+      - name: Check for pending EF model changes
+        run: task fw-lite:has-pending-model-changes
+
       - name: Build viewer
         working-directory: frontend/viewer
         run: |

diff --git a/backend/FwLite/FwLiteShared/Sync/BackgroundSyncService.cs b/backend/FwLite/FwLiteShared/Sync/BackgroundSyncService.cs
@@ -1,5 +1,6 @@
 using System.Threading.Channels;
 using LcmCrdt;
+using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Caching.Memory;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
@@ -70,24 +71,31 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
         var crdtProjects = crdtProjectsService.ListProjects();
         foreach (var crdtProject in crdtProjects)
         {
-            await SyncProject(crdtProject);
+            await SyncProject(crdtProject, true, stoppingToken);
         }
 
         await foreach (var project in _syncResultsChannel.Reader.ReadAllAsync(stoppingToken))
         {
             //todo, this might not be required, but I can't remember why I added it
             await Task.Delay(100, stoppingToken);
-            await SyncProject(project);
+            await SyncProject(project, false, stoppingToken);
         }
     }
 
-    private async Task<SyncResults> SyncProject(CrdtProject crdtProject)
+    private async Task<SyncResults> SyncProject(CrdtProject crdtProject,
+        bool applyMigrations = false,
+        CancellationToken cancellationToken = default)
     {
         try
         {
             await using var serviceScope = serviceProvider.CreateAsyncScope();
-            await serviceScope.ServiceProvider.GetRequiredService<CurrentProjectService>().SetupProjectContext(crdtProject);
-            var syncService = serviceScope.ServiceProvider.GetRequiredService<SyncService>();
+            var services = serviceScope.ServiceProvider;
+            await services.GetRequiredService<CurrentProjectService>().SetupProjectContext(crdtProject);
+            if (applyMigrations)
+            {
+                await services.GetRequiredService<LcmCrdtDbContext>().Database.MigrateAsync(cancellationToken);
+            }
+            var syncService = services.GetRequiredService<SyncService>();
             return await syncService.ExecuteSync();
         }
         catch (Exception e)

diff --git a/backend/FwLite/LcmCrdt/CrdtProjectsService.cs b/backend/FwLite/LcmCrdt/CrdtProjectsService.cs
@@ -5,6 +5,8 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using LcmCrdt.Objects;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Migrations;
 using MiniLcm.Project;
 
 namespace LcmCrdt;
@@ -101,7 +103,7 @@ public async Task<CrdtProject> CreateProject(CreateProjectRequest request)
 
     internal static async Task InitProjectDb(LcmCrdtDbContext db, ProjectData data)
     {
-        await db.Database.EnsureCreatedAsync();
+        await db.Database.MigrateAsync();
         db.ProjectData.Add(data);
         await db.SaveChangesAsync();
     }

diff --git a/backend/FwLite/LcmCrdt/Data/DbContextDesignFactory.cs b/backend/FwLite/LcmCrdt/Data/DbContextDesignFactory.cs
@@ -0,0 +1,20 @@
+using Microsoft.EntityFrameworkCore.Design;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace LcmCrdt.Data;
+
+[Obsolete("this class is only here to facilitate migrations, it's not used in the application", true)]
+public class DbContextDesignFactory: IDesignTimeDbContextFactory<LcmCrdtDbContext>
+{
+    public LcmCrdtDbContext CreateDbContext(string[] args)
+    {
+        var servicesRoot = new ServiceCollection()
+            .AddSingleton<IConfiguration>(new ConfigurationRoot([]))
+            .AddLcmCrdtClient()
+            .BuildServiceProvider();
+        var scope = servicesRoot.CreateScope();
+        scope.ServiceProvider.GetRequiredService<CurrentProjectService>().SetupProjectContextForNewDb(new ("DesignDb", "design.sqlite"));
+        return scope.ServiceProvider.GetRequiredService<LcmCrdtDbContext>();
+    }
+}
diff --git a/backend/FwLite/LcmCrdt/LcmCrdt.csproj b/backend/FwLite/LcmCrdt/LcmCrdt.csproj
@@ -12,6 +12,10 @@
         <PackageReference Include="Humanizer.Core" Version="2.14.1"/>
         <PackageReference Include="linq2db.AspNet" Version="5.4.1"/>
         <PackageReference Include="linq2db.EntityFrameworkCore" Version="8.1.0" />
+        <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="8.0.11">
+          <PrivateAssets>all</PrivateAssets>
+          <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
         <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="8.0.0"/>
         <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="9.0.0" />
         <PackageReference Include="Refit" Version="8.0.0"/>