SF-3397 Synchronize drafting sources if needed when configured (#3320)

Author: RaymondLuong3

src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.component.html

@@ -213,7 +213,7 @@ <h3>{{ t("overview_source") }} {{ parentheses(sourceLanguageDisplayName) }}</h3>
           } @else if (getControlState("projectSettings") === ElementState.Submitted) {
             <mat-icon class="success">checkmark</mat-icon> {{ t("all_changes_saved") }}
           } @else {
-            <mat-icon class="failure">error</mat-icon> Failed to save changes
+            <mat-icon class="failure">error</mat-icon> {{ t("failed_to_save_changes") }}
           }
         </div>
         @for (entry of syncStatus | keyvalue; track entry.key) {

src/SIL.XForge.Scripture/ClientApp/src/assets/i18n/non_checking_en.json

@@ -301,6 +301,7 @@
     "confirm_language_codes": "Please confirm that the language codes are correct before saving.",
     "discard_changes_confirmation": "Are you sure you want to leave the page with unsaved changes?",
     "draft_source": "Draft source",
+    "failed_to_save_changes": "Failed to save changes.",
     "generate_draft_from_language_model": "Generate draft from language model",
     "language_code": "Language code: ",
     "leave_and_discard": "Leave & discard changes",
@@ -334,7 +335,6 @@
     "unknown_language_code": "unknown"
   },
   "draft_usfm_format": {
-    "changes_have_been_saved": "Changes have been saved",
     "cancel": "Cancel",
     "connect_to_the_internet": "Please connect to the internet to change the USFM format for your draft",
     "draft_format_description": "The draft has been created. Here are some formatting options for the text. You can try each option to see the difference it makes.",

src/SIL.XForge.Scripture/Services/SFProjectService.cs

@@ -172,7 +172,7 @@ public async Task<string> CreateProjectAsync(string curUserId, SFProjectCreateSe
                     curUserId,
                     projectDoc.Id,
                     settings.SourceParatextId,
-                    syncIfCreated: false,
+                    skipSync: true,
                     updatePermissions: false,
                     ptProjects,
                     resources
@@ -418,7 +418,7 @@ public async Task UpdateSettingsAsync(string curUserId, string projectId, SFProj
                 curUserId,
                 projectId,
                 settings.SourceParatextId,
-                syncIfCreated: false,
+                skipSync: true,
                 updatePermissions: true,
                 ptProjects,
                 resources,
@@ -440,7 +440,7 @@ public async Task UpdateSettingsAsync(string curUserId, string projectId, SFProj
                 curUserId,
                 projectId,
                 settings.AlternateSourceParatextId,
-                syncIfCreated: true,
+                skipSync: false,
                 // Only update permissions if this project is different to the preceding project
                 updatePermissions: settings.SourceParatextId != settings.AlternateSourceParatextId,
                 ptProjects,
@@ -463,7 +463,7 @@ public async Task UpdateSettingsAsync(string curUserId, string projectId, SFProj
                 curUserId,
                 projectId,
                 settings.AlternateTrainingSourceParatextId,
-                syncIfCreated: true,
+                skipSync: false,
                 // Only update permissions if this project is different to the preceding projects
                 updatePermissions: settings.SourceParatextId != settings.AlternateTrainingSourceParatextId
                     && settings.AlternateSourceParatextId != settings.AlternateTrainingSourceParatextId,
@@ -487,7 +487,7 @@ public async Task UpdateSettingsAsync(string curUserId, string projectId, SFProj
                 curUserId,
                 projectId,
                 settings.AdditionalTrainingSourceParatextId,
-                syncIfCreated: true,
+                skipSync: false,
                 // Only update permissions if this project is different to the preceding projects
                 updatePermissions: settings.SourceParatextId != settings.AdditionalTrainingSourceParatextId
                     && settings.AlternateSourceParatextId != settings.AdditionalTrainingSourceParatextId
@@ -1927,7 +1927,7 @@ private async Task<string> CreateResourceProjectInternalAsync(IConnection conn,
     /// <param name="curUserId">The current user identifier.</param>
     /// <param name="sfProjectId">The Scripture Forge project identifier.</param>
     /// <param name="paratextId">The paratext identifier.</param>
-    /// <param name="syncIfCreated">If <c>true</c> sync the project if it is created.</param>
+    /// <param name="skipSync">If <c>true</c> the project will not be synced even if it is not already synced.</param>
     /// <param name="updatePermissions">If <c>true</c> update the project's permissions.</param>
     /// <param name="ptProjects">The paratext projects.</param>
     /// <param name="resources">The paratext resources.</param>
@@ -1939,7 +1939,7 @@ private async Task<TranslateSource> GetTranslateSourceAsync(
         string curUserId,
         string sfProjectId,
         string paratextId,
-        bool syncIfCreated,
+        bool skipSync,
         bool updatePermissions,
         IEnumerable<ParatextProject> ptProjects,
         IEnumerable<ParatextResource> resources,
@@ -1948,25 +1948,25 @@ private async Task<TranslateSource> GetTranslateSourceAsync(
     {
         ParatextProject sourcePTProject = ptProjects.SingleOrDefault(p => p.ParatextId == paratextId);
         string sourceProjectRef;
-        if (sourcePTProject == null)
+        if (sourcePTProject is null)
         {
             // If it is not a project, see if there is a matching resource
             sourcePTProject = resources.SingleOrDefault(r => r.ParatextId == paratextId);
-            if (sourcePTProject == null)
+            if (sourcePTProject is null)
             {
                 throw new DataNotFoundException("The source paratext project does not exist.");
             }
         }
 
         // Get the users who will access this source resource or project
-        IEnumerable<string> userIds = userRoles != null ? userRoles.Keys : [curUserId];
+        IEnumerable<string> userIds = userRoles is not null ? userRoles.Keys : [curUserId];
 
         // Get the project reference
         SFProject sourceProject = RealtimeService
             .QuerySnapshots<SFProject>()
             .FirstOrDefault(p => p.ParatextId == paratextId);
         bool projectCreated;
-        if (sourceProject != null)
+        if (sourceProject is not null)
         {
             sourceProjectRef = sourceProject.Id;
             projectCreated = false;
@@ -1983,7 +1983,7 @@ private async Task<TranslateSource> GetTranslateSourceAsync(
             try
             {
                 // Add the user to the project, if the user does not have a role in it
-                if (sourceProject == null || !sourceProject.UserRoles.ContainsKey(userId))
+                if (sourceProject is null || !sourceProject.UserRoles.ContainsKey(userId))
                 {
                     await AddUserAsync(conn, userId, sourceProjectRef, null);
                 }
@@ -1994,9 +1994,11 @@ private async Task<TranslateSource> GetTranslateSourceAsync(
             }
         }
 
-        // If the project is created, sync it only if we need to
+        // If the project is created or the last sync was not successful, sync it unless explicitly skipped.
         // This is usually because this is an alternate source for drafting
-        if (projectCreated && syncIfCreated)
+        bool syncNeeded =
+            projectCreated || (sourceProject is not null && sourceProject.Sync.LastSyncSuccessful == false);
+        if (syncNeeded && !skipSync)
         {
             string jobId = await _syncService.SyncAsync(
                 new SyncConfig { ProjectId = sourceProjectRef, UserId = curUserId }

test/SIL.XForge.Scripture.Tests/Services/SFProjectServiceTests.cs

@@ -39,6 +39,8 @@ public class SFProjectServiceTests
     private const string Resource01 = "resource_project";
     private const string SourceOnly = "source_only";
     private const string Resource01PTId = "resid_is_16_char";
+    private const string ResourceNeedsSync = "resource_sync_needed";
+    private const string ResourceNeedsSyncPTId = "resource_sync_id";
     private const string User01 = "user01";
     private const string User02 = "user02";
     private const string User03 = "user03";
@@ -2423,6 +2425,40 @@ await env
         );
     }
 
+    [Test]
+    public async Task UpdateSettingsAsync_ChangeAlternateSource_SyncProjectWhenSyncFailed()
+    {
+        var env = new TestEnvironment();
+        const string newProjectParatextId = ResourceNeedsSyncPTId;
+
+        // Ensure that the new project does not exist
+        Assert.That(
+            env.RealtimeService.GetRepository<SFProject>().Query().Any(p => p.ParatextId == newProjectParatextId),
+            Is.True
+        );
+
+        // SUT
+        await env.Service.UpdateSettingsAsync(
+            User01,
+            Project01,
+            new SFProjectSettings { AlternateSourceParatextId = newProjectParatextId }
+        );
+
+        SFProject project = env.GetProject(Project01);
+        Assert.That(project.TranslateConfig.DraftConfig.AlternateSource?.ProjectRef, Is.Not.Null);
+        Assert.That(project.TranslateConfig.DraftConfig.AlternateSource?.ParatextId, Is.EqualTo(newProjectParatextId));
+        Assert.That(project.TranslateConfig.DraftConfig.AlternateSource?.Name, Is.EqualTo("Resource Needs Sync"));
+
+        SFProject alternateSourceProject = env.GetProject(
+            project.TranslateConfig.DraftConfig.AlternateSource!.ProjectRef
+        );
+        Assert.That(alternateSourceProject.ParatextId, Is.EqualTo(newProjectParatextId));
+        Assert.That(alternateSourceProject.Name, Is.EqualTo("Resource Needs Sync"));
+
+        await env.SyncService.Received(1).SyncAsync(Arg.Any<SyncConfig>());
+        env.BackgroundJobClient.Received().Create(Arg.Any<Job>(), Arg.Any<IState>());
+    }
+
     [Test]
     public async Task UpdateSettingsAsync_ChangeAlternateTrainingSource_CannotUseTargetProject()
     {
@@ -4972,6 +5008,15 @@ public TestEnvironment()
                             ShortName = "DSP",
                             UserRoles = { { User01, SFProjectRole.Administrator } },
                         },
+                        new SFProject
+                        {
+                            Id = ResourceNeedsSync,
+                            ParatextId = ResourceNeedsSyncPTId,
+                            Name = "Resource Needs Sync",
+                            ShortName = "RNSP",
+                            UserRoles = { { User01, SFProjectRole.Administrator } },
+                            Sync = new Sync { LastSyncSuccessful = false },
+                        },
                     ]
                 )
             );
@@ -5295,6 +5340,12 @@ public TestEnvironment()
                     LanguageTag = "qaa",
                 },
                 new ParatextResource { ParatextId = GetProject(Resource01).ParatextId },
+                new ParatextResource
+                {
+                    ParatextId = ResourceNeedsSyncPTId,
+                    Name = "Resource Needs Sync",
+                    LanguageTag = "en",
+                },
             ];
             ParatextService.GetResourcesAsync(Arg.Any<string>()).Returns(ptResources);
             ParatextService.CanUserAuthenticateToPTRegistryAsync(Arg.Any<UserSecret>()).Returns(Task.FromResult(true));
@@ -5421,6 +5472,10 @@ public TestEnvironment()
                     callInfo.ArgAt<string?>(0)?.Length == SFInstallableDblResource.ResourceIdentifierLength
                 );
 
+            ParatextService
+                .GetResourcePermissionAsync(Arg.Any<string>(), Arg.Any<string>(), CancellationToken.None)
+                .Returns(TextInfoPermission.Read);
+
             Service = new SFProjectService(
                 RealtimeService,
                 siteOptions,