support audio playback in harmony (#1819)

* implement simple file downloading

* convert lexbox media files into remote crdt resources

* fix race condition when opening project page directly

* store local resource cache files in folder by project name, cleanup when deleting a project

Author: hahn-kev

backend/FwHeadless/Controllers/MediaFileController.cs

@@ -7,6 +7,7 @@
 using System.Security.Cryptography;
 using Microsoft.Net.Http.Headers;
 using System.Globalization;
+using FwHeadless.Media;
 using MimeMapping;
 
 namespace FwHeadless.Controllers;
@@ -42,16 +43,13 @@ public static async Task<Results<Ok<FileListing>, NotFound, BadRequest>> ListFil
     public static async Task<Results<PhysicalFileHttpResult, NotFound>> GetFile(
         Guid fileId,
         IOptions<FwHeadlessConfig> config,
-        LexBoxDbContext lexBoxDb)
+        LexBoxDbContext lexBoxDb,
+        MediaFileService mediaFileService)
     {
         var madeChanges = false;
         var mediaFile = await lexBoxDb.Files.FindAsync(fileId);
         if (mediaFile is null) return TypedResults.NotFound();
-        var projectId = mediaFile.ProjectId;
-        var project = await lexBoxDb.Projects.FindAsync(projectId);
-        if (project is null) return TypedResults.NotFound();
-        var projectFolder = config.Value.GetFwDataProject(project.Code, projectId).ProjectFolder;
-        var filePath = Path.Join(projectFolder, mediaFile.Filename);
+        var filePath = mediaFileService.FilePath(mediaFile);
         if (!File.Exists(filePath)) return TypedResults.NotFound();
         mediaFile.InitializeMetadataIfNeeded(filePath);
         var contentType = mediaFile.Metadata.MimeType;

backend/FwHeadless/FwHeadlessConfig.cs

@@ -64,6 +64,10 @@ public FwDataProject GetFwDataProject(string projectCode, Guid projectId)
         return new FwDataProject(FwDataSubFolder, GetProjectFolder(projectCode, projectId));
     }
 
+    public string GetFwDataFolder(Guid projectId)
+    {
+        return GetFwDataFolder(GetProjectFolder(projectId));
+    }
     public string GetFwDataFolder(string projectRootFolder)
     {
         return Path.Join(projectRootFolder, FwDataSubFolder);

backend/FwHeadless/FwHeadlessKernel.cs

@@ -6,6 +6,7 @@
 using LcmCrdt;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Options;
+using MiniLcm.Project;
 
 namespace FwHeadless;
 
@@ -32,6 +33,7 @@ public static void AddFwHeadless(this IServiceCollection services)
         services.RemoveAll(typeof(IMediaAdapter));
         services.AddScoped<IMediaAdapter, LexboxFwDataMediaAdapter>();
         services.AddScoped<MediaFileService>();
+        services.AddScoped<IServerHttpClientProvider, LexboxServerHttpClientProvider>();
 
         services.AddSingleton<SyncHostedService>();
         services.AddHostedService(s => s.GetRequiredService<SyncHostedService>());

backend/FwHeadless/LexboxFwDataMediaAdapter.cs

@@ -1,6 +1,7 @@
 using FwDataMiniLcmBridge.Media;
 using FwHeadless.Media;
 using LexCore.Entities;
+using LexCore.Exceptions;
 using Microsoft.Extensions.Options;
 using MiniLcm;
 using SIL.LCModel;
@@ -19,7 +20,8 @@ public MediaUri MediaUriFromPath(string path, LcmCache cache)
 
     public string PathFromMediaUri(MediaUri mediaUri, LcmCache cache)
     {
-        var mediaFile = mediaFileService.FindMediaFile(mediaUri.FileId);
+        var mediaFile = mediaFileService.FindMediaFile(mediaUri.FileId) ??
+                        throw new NotFoundException($"Unable to find file {mediaUri.FileId}.", nameof(MediaFile));
         var fullFilePath = Path.Join(cache.ProjectId.ProjectFolder, mediaFile.Filename);
         return Path.GetRelativePath(cache.LangProject.LinkedFilesRootDir, fullFilePath);
     }

backend/FwHeadless/Media/MediaFileService.cs

@@ -1,3 +1,5 @@
+using LcmCrdt;
+using LcmCrdt.MediaServer;
 using LexCore.Entities;
 using LexCore.Exceptions;
 using LexData;
@@ -86,9 +88,37 @@ public MediaFile FindMediaFile(Guid projectId, string path)
                    nameof(MediaFile));
     }
 
-    public MediaFile FindMediaFile(Guid fileId)
+    public MediaFile? FindMediaFile(Guid fileId)
     {
-        return dbContext.Files.Find(fileId) ??
-               throw new NotFoundException($"Unable to find file {fileId}.", nameof(MediaFile));
+        return dbContext.Files.Find(fileId);
+    }
+
+    public async ValueTask<MediaFile?> FindMediaFileAsync(Guid fileId)
+    {
+        return await dbContext.Files.FindAsync(fileId);
+    }
+
+    public string FilePath(MediaFile mediaFile)
+    {
+        return Path.Join(config.Value.GetFwDataFolder(mediaFile.ProjectId), mediaFile.Filename);
+    }
+
+    public async Task SyncMediaFiles(Guid projectId, LcmMediaService lcmMediaService)
+    {
+        var lcmResources = (await lcmMediaService.AllResources()).ToDictionary(r => r.Id);
+        var existingDbFiles = dbContext.Files.Where(p => p.ProjectId == projectId).AsAsyncEnumerable();
+        await foreach (var existingDbFile in existingDbFiles)
+        {
+            if (lcmResources.Remove(existingDbFile.Id))
+            {
+                //nothing to do, the file was already tracked in harmony
+                continue;
+            }
+            await lcmMediaService.AddExistingRemoteResource(existingDbFile.Id, FilePath(existingDbFile));
+        }
+        foreach (var lcmResource in lcmResources.Values)
+        {
+            await lcmMediaService.DeleteResource(lcmResource.Id);
+        }
     }
 }

backend/FwHeadless/Services/LexboxServerHttpClientProvider.cs

@@ -0,0 +1,16 @@
+using MiniLcm.Project;
+
+namespace FwHeadless.Services;
+
+public class LexboxServerHttpClientProvider(IHttpClientFactory httpClientFactory) : IServerHttpClientProvider
+{
+    public ValueTask<HttpClient> GetHttpClient()
+    {
+        return ValueTask.FromResult(httpClientFactory.CreateClient(FwHeadlessKernel.LexboxHttpClientName));
+    }
+
+    public ValueTask<ConnectionStatus> ConnectionStatus(bool forceRefresh = false)
+    {
+        return new ValueTask<ConnectionStatus>(MiniLcm.Project.ConnectionStatus.Online);
+    }
+}

backend/FwHeadless/Services/SyncHostedService.cs

@@ -6,6 +6,7 @@
 using FwHeadless.Media;
 using FwLiteProjectSync;
 using LcmCrdt;
+using LcmCrdt.MediaServer;
 using LcmCrdt.RemoteSync;
 using LexCore.Sync;
 using LexCore.Utils;
@@ -144,6 +145,9 @@ public async Task<SyncJobResult> ExecuteSync(CancellationToken stoppingToken)
         logger.LogDebug("fwDataFile: {fwDataFile}", fwDataProject.FilePath);
 
         var fwdataApi = await SetupFwData(fwDataProject, projectCode);
+        //always do this as existing projects need to run this even if they didn't S&R due to no pending changes
+        await mediaFileService.SyncMediaFiles(fwdataApi.Cache);
+
         using var deferCloseFwData = fwDataFactory.DeferClose(fwDataProject);
         var crdtProject = await SetupCrdtProject(crdtFile,
             projectLookupService,
@@ -161,6 +165,7 @@ public async Task<SyncJobResult> ExecuteSync(CancellationToken stoppingToken)
         {
             await crdtSyncService.SyncHarmonyProject();
         }
+        await mediaFileService.SyncMediaFiles(projectId, services.GetRequiredService<LcmMediaService>());
 
         var result = await syncService.Sync(miniLcmApi, fwdataApi);
         logger.LogInformation("Sync result, CrdtChanges: {CrdtChanges}, FwdataChanges: {FwdataChanges}",
@@ -203,8 +208,6 @@ private async Task<FwDataMiniLcmApi> SetupFwData(FwDataProject fwDataProject, st
         }
 
         var fwdataApi = fwDataFactory.GetFwDataMiniLcmApi(fwDataProject, true);
-        //always do this as existing projects need to run this even if they didn't S&R due to no pending changes
-        await mediaFileService.SyncMediaFiles(fwdataApi.Cache);
         return fwdataApi;
     }
 

backend/FwLite/FwDataMiniLcmBridge.Tests/MediaFileTests.cs

@@ -134,9 +134,10 @@ public async Task CanOpenAFile()
         var entry = await _api.GetEntry(entryId);
 
         entry.Should().NotBeNull();
-        await using var file = await _api.GetFileStream(new MediaUri(entry.CitationForm[_audioWs]));
-        file.Should().NotBeNull();
-        using var streamReader = new StreamReader(file);
+        var file = await _api.GetFileStream(new MediaUri(entry.CitationForm[_audioWs]));
+        await using var stream = file.Stream;
+        stream.Should().NotBeNull();
+        using var streamReader = new StreamReader(stream);
         var contents = await streamReader.ReadToEndAsync();
         contents.Should().Be("test");
     }
@@ -179,6 +180,7 @@ await _api.UpdateEntry(entryId,
     public async Task GetStreamForNotFoundIsNull()
     {
         var fileStream = await _api.GetFileStream(MediaUri.NotFound);
-        fileStream.Should().BeNull();
+        fileStream.Stream.Should().BeNull();
+        fileStream.Result.Should().Be(ReadFileResult.NotFound);
     }
 }

backend/FwLite/FwDataMiniLcmBridge/Api/FwDataMiniLcmApi.cs

@@ -1533,10 +1533,11 @@ private static void ValidateOwnership(ILexExampleSentence lexExampleSentence, Gu
         }
     }
 
-    public Task<Stream?> GetFileStream(MediaUri mediaUri)
+    public Task<ReadFileResponse> GetFileStream(MediaUri mediaUri)
     {
-        if (mediaUri == MediaUri.NotFound) return Task.FromResult<Stream?>(null);
+        if (mediaUri == MediaUri.NotFound) return Task.FromResult(new ReadFileResponse(ReadFileResult.NotFound));
         string fullPath = Path.Combine(Cache.LangProject.LinkedFilesRootDir, mediaAdapter.PathFromMediaUri(mediaUri, Cache));
-        return Task.FromResult<Stream?>(File.OpenRead(fullPath));
+        if (!File.Exists(fullPath)) return Task.FromResult(new ReadFileResponse(ReadFileResult.NotFound));
+        return Task.FromResult(new ReadFileResponse(File.OpenRead(fullPath), Path.GetFileName(fullPath)));
     }
 }

backend/FwLite/FwLiteProjectSync.Tests/Fixtures/TestingKernel.cs

@@ -1,6 +1,7 @@
 using FwDataMiniLcmBridge;
 using FwDataMiniLcmBridge.Tests.Fixtures;
 using LcmCrdt;
+using LcmCrdt.Tests;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 
@@ -10,7 +11,7 @@ public static class TestingKernel
 {
     public static IServiceCollection AddSyncServices(this IServiceCollection services, string projectName, bool mockFwProjectLoader = true)
     {
-        return services.AddLcmCrdtClient()
+        return services.AddTestLcmCrdtClient()
             .AddTestFwDataBridge(mockFwProjectLoader)
             .AddFwLiteProjectSync()
             .Configure<FwDataBridgeConfig>(c => c.ProjectsFolder = Path.Combine(".", projectName, "FwData"))