sync: fix GetOutgoingRevisions to use draft phases (#3775)

Author: marksvc

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

@@ -47,8 +47,8 @@ public void BackupRepository(string repository, string backupFile) =>
     /// </returns>
     public string GetLastPublicRevision(string repository)
     {
-        string ids = RunCommand(repository, "log --rev \"public()\" --template \"{node}\n\"");
-        string revision = ids.Split(["\n"], StringSplitOptions.RemoveEmptyEntries).LastOrDefault()?.Trim();
+        string ids = RunCommand(repository, """log --rev "public()" --template "{node}\n" """);
+        string revision = ids.Split('\n', StringSplitOptions.RemoveEmptyEntries).LastOrDefault()?.Trim();
         return revision;
     }
 
@@ -86,6 +86,20 @@ public void RestoreRepository(string destination, string backupFile)
     /// <param name="repository">The repository.</param>
     public void MarkSharedChangeSetsPublic(string repository) => RunCommand(repository, "phase -p -r 'tip'");
 
+    /// <summary>
+    /// Returns the ids of commits with draft phase.
+    /// </summary>
+    public string[] GetDraftRevisions(string repositoryPath)
+    {
+        string ids = RunCommand(repositoryPath, """log --rev "draft()" --template "{node}\n" """);
+        return
+        [
+            .. ids.Split('\n', StringSplitOptions.RemoveEmptyEntries)
+                .Select(id => id.Trim())
+                .Where(id => id.Length > 0),
+        ];
+    }
+
     /// <summary> Set the default Mercurial installation. Must be called for all other methods to work. </summary>
     public void SetDefault(Hg hgDefault)
     {

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

@@ -13,4 +13,5 @@ public interface IHgWrapper
     string GetLastPublicRevision(string repository);
     string GetRepoRevision(string repositoryPath);
     void MarkSharedChangeSetsPublic(string repository);
+    string[] GetDraftRevisions(string repositoryPath);
 }

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

@@ -136,6 +136,15 @@ public override void Push(string repository, SharedRepository pushRepo)
     /// </summary>
     public override string GetHgUri(SharedRepository sharedRepository) => string.Empty;
 
+    /// <summary>
+    /// Returns the ids of unpushed commits. Overriding here since InternetSharedRepositorySource.GetOutgoingRevisions
+    /// is going to SharedRepositorySource.GetOutgoingRevisions which doesn't work for us because it needs to look at
+    /// the remote repository. One difference with this implementation is that it looks at commit phase to determine
+    /// what is pushed. Distinguishing between public and draft commit phase is not something ParatextData uses.
+    /// </summary>
+    public override string[] GetOutgoingRevisions(string repository, SharedProject sharedProject) =>
+        _hgWrapper.GetDraftRevisions(repository);
+
     /// <summary>
     /// Retrieve a list of <see cref="SharedRepository" />.
     /// </summary>

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

@@ -4,6 +4,7 @@
 using NSubstitute.Extensions;
 using NUnit.Framework;
 using Paratext.Data;
+using Paratext.Data.Repository;
 using Paratext.Data.Users;
 using SIL.XForge.Scripture.Models;
 using SIL.XForge.Services;
@@ -13,6 +14,11 @@ namespace SIL.XForge.Scripture.Services;
 [TestFixture]
 public class JwtInternetSharedRepositorySourceTests
 {
+    private const string RepoPath = "/sync/abc123/target";
+    private const string ProjectName = "TestProject";
+    private const string ProjectId = "4011111111111111111111111111111111111111";
+    private const string NewTipRevision = "bbb2222222222222222222222222222222222222";
+
     [Test]
     public void CanUserAuthenticateToPTArchives_Works()
     {
@@ -50,10 +56,48 @@ public void CanUserAuthenticateToPTArchives_Works()
         );
     }
 
+    [Test]
+    public void GetOutgoingRevisions_ReturnsDraftRevisions()
+    {
+        var env = new TestEnvironment();
+        SharedProject sharedProject = new SharedProject
+        {
+            SendReceiveId = HexId.FromStr(ProjectId),
+            ScrTextName = ProjectName,
+            Repository = TestEnvironment.CreatePushRepo(HexId.FromStr(ProjectId), ProjectName),
+        };
+        string[] expectedRevisions = [NewTipRevision];
+        env.MockHgWrapper.GetDraftRevisions(RepoPath).Returns(expectedRevisions);
+
+        // SUT
+        string[] result = env.RepoSource.GetOutgoingRevisions(RepoPath, sharedProject);
+
+        Assert.That(result, Is.EqualTo(expectedRevisions));
+    }
+
+    [Test]
+    public void GetOutgoingRevisions_NoDraftRevisions_ReturnsEmpty()
+    {
+        var env = new TestEnvironment();
+        SharedProject sharedProject = new SharedProject
+        {
+            SendReceiveId = HexId.FromStr(ProjectId),
+            ScrTextName = ProjectName,
+            Repository = TestEnvironment.CreatePushRepo(HexId.FromStr(ProjectId), ProjectName),
+        };
+        env.MockHgWrapper.GetDraftRevisions(RepoPath).Returns([]);
+
+        // SUT
+        string[] result = env.RepoSource.GetOutgoingRevisions(RepoPath, sharedProject);
+
+        Assert.That(result, Is.Empty);
+    }
+
     private class TestEnvironment
     {
         public readonly JwtInternetSharedRepositorySource RepoSource;
         public readonly IRESTClient MockPTArchivesClient;
+        public readonly IHgWrapper MockHgWrapper;
 
         public TestEnvironment()
         {
@@ -63,16 +107,20 @@ public TestEnvironment()
                 "applicationName",
                 "jwtToken"
             );
+            MockHgWrapper = Substitute.For<IHgWrapper>();
             RepoSource = Substitute.ForPartsOf<JwtInternetSharedRepositorySource>(
                 "access-token",
                 mockPTRegistryClient,
-                Substitute.For<IHgWrapper>(),
+                MockHgWrapper,
                 ptUser,
                 "sr-server-uri",
                 new MockLogger<InternetSharedRepositorySourceProvider>()
             );
             MockPTArchivesClient = Substitute.For<RESTClient>("pt-archives-server.example.com", "product-version-123");
             RepoSource.Configure().GetClient().Returns(MockPTArchivesClient);
         }
+
+        public static SharedRepository CreatePushRepo(HexId ptProjectId, string projectName) =>
+            new SharedRepository { SendReceiveId = ptProjectId, ScrTextName = projectName };
     }
 }