Update user entry when user joins a project

Author: RaymondLuong3

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

@@ -49,6 +49,7 @@ public class SFProjectService : ProjectService<SFProject, SFProjectSecret>, ISFP
     private readonly ITransceleratorService _transceleratorService;
     private readonly IEventMetricService _eventMetricService;
     private readonly ISFProjectRights _projectRights;
+    private readonly IGuidService _guidService;
 
     public SFProjectService(
         IRealtimeService realtimeService,
@@ -68,7 +69,8 @@ public SFProjectService(
         ITransceleratorService transceleratorService,
         IBackgroundJobClient backgroundJobClient,
         IEventMetricService eventMetricService,
-        ISFProjectRights projectRights
+        ISFProjectRights projectRights,
+        IGuidService guidService
     )
         : base(realtimeService, siteOptions, audioService, projectSecrets, fileSystemService)
     {
@@ -86,6 +88,7 @@ ISFProjectRights projectRights
         _eventMetricService = eventMetricService;
         _backgroundJobClient = backgroundJobClient;
         _projectRights = projectRights;
+        _guidService = guidService;
     }
 
     protected override string ProjectAdminRole => SFProjectRole.Administrator;
@@ -1322,6 +1325,31 @@ await conn.CreateAsync(
         }
         // Listeners can now assume the ProjectUserConfig is ready when the user is added.
         await base.AddUserToProjectAsync(conn, projectDoc, userDoc, projectRole, shareKey);
+        if (SFProjectRole.IsParatextRole(projectRole))
+        {
+            int index = projectDoc.Data.ParatextUsers.FindIndex(u => u.Username == userDoc.Data.Name);
+            if (index > -1)
+                await projectDoc.SubmitJson0OpAsync(op =>
+                {
+                    op.Set(p => p.ParatextUsers[index].SFUserId, userDoc.Id);
+                    op.Set(p => p.ParatextUsers[index].Role, projectRole);
+                });
+            else
+            {
+                await projectDoc.SubmitJson0OpAsync(op =>
+                    op.Add(
+                        p => p.ParatextUsers,
+                        new ParatextUserProfile
+                        {
+                            SFUserId = userDoc.Id,
+                            Username = userDoc.Data.Name,
+                            Role = projectRole,
+                            OpaqueUserId = _guidService.NewObjectId(),
+                        }
+                    )
+                );
+            }
+        }
 
         // Update book and chapter permissions on SF project/resource, but only if user
         // has a role on the PT project or permissions to the DBL resource. These permissions are needed
@@ -1372,7 +1400,13 @@ projectDoc.Data.UserRoles[curUserId] is not (SFProjectRole.Administrator or SFPr
             && ptRole is SFProjectRole.Administrator or SFProjectRole.Translator;
         if (projectDoc.Data.UserRoles[curUserId] != ptRole)
         {
-            await projectDoc.SubmitJson0OpAsync(op => op.Set(p => p.UserRoles[curUserId], ptRole));
+            await projectDoc.SubmitJson0OpAsync(op =>
+            {
+                op.Set(p => p.UserRoles[curUserId], ptRole);
+                int index = projectDoc.Data.ParatextUsers.FindIndex(u => u.SFUserId == curUserId);
+                if (index > -1)
+                    op.Set(p => p.ParatextUsers[index].Role, ptRole);
+            });
         }
 
         // If the user can now write text, we should sync to see if there are new permissions for them.

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

@@ -1712,6 +1712,34 @@ public void UninviteUser_SystemAdmin_NoSpecialAccess()
         );
     }
 
+    [Test]
+    public async Task AddUserAsync_AddsRoleAndIdToParatextUsers()
+    {
+        var env = new TestEnvironment();
+        SFProject project = env.GetProject(Project02);
+
+        Assert.That(project.UserRoles.ContainsKey(User01), Is.False, "setup");
+        Assert.That(project.ParatextUsers.Exists(u => u.Username == "User 01"), Is.True, "setup");
+        Assert.That(project.ParatextUsers.Exists(u => u.SFUserId == User01), Is.False, "setup");
+        env.ParatextService.TryGetProjectRoleAsync(
+                Arg.Any<UserSecret>(),
+                Arg.Any<string>(),
+                Arg.Any<CancellationToken>()
+            )
+            .Returns(Task.FromResult(Attempt.Success(SFProjectRole.Administrator)));
+
+        await env.Service.AddUserAsync(User01, Project02, null);
+        project = env.GetProject(Project02);
+
+        Assert.That(project.UserRoles.ContainsKey(User01), Is.True, "User should have been added to project");
+        Assert.That(
+            project.ParatextUsers.Exists(u =>
+                u.SFUserId == User01 && u.Username == "User 01" && u.Role == SFProjectRole.Administrator
+            ),
+            Is.True
+        );
+    }
+
     [Test]
     public async Task AddUserAsync_ShareKeyExists_AddsUserAndRemovesKey()
     {
@@ -1732,6 +1760,7 @@ public async Task AddUserAsync_ShareKeyExists_AddsUserAndRemovesKey()
         project = env.GetProject(Project03);
 
         Assert.That(project.UserRoles.ContainsKey(User03), Is.True, "User should have been added to project");
+        Assert.That(project.ParatextUsers.Exists(u => u.SFUserId == User03 && u.Username == "User 03"), Is.True);
     }
 
     [Test]
@@ -1743,6 +1772,7 @@ public void AddUserAsync_SourceProjectUnavailable_SkipProject()
         Assert.DoesNotThrowAsync(() => env.Service.AddUserAsync(User03, Project04, SFProjectRole.Translator));
         var project = env.GetProject(Project04);
         Assert.That(project.UserRoles[User03], Is.EqualTo(SFProjectRole.Translator));
+        Assert.That(project.ParatextUsers.Exists(u => u.SFUserId == User03 && u.Username == "User 03"), Is.True);
     }
 
     [Test]
@@ -1909,8 +1939,9 @@ public async Task AddUserAsync_HasSourceProjectRole_AddedToSourceProject()
         await env.Service.AddUserAsync(User03, Project03, SFProjectRole.Translator);
         project03 = env.GetProject(Project03);
         source = env.GetProject(SourceOnly);
-        Assert.That(project03.UserRoles.ContainsKey(User03));
-        Assert.That(source.UserRoles.ContainsKey(User03));
+        Assert.That(project03.UserRoles.ContainsKey(User03), Is.True);
+        Assert.That(project03.ParatextUsers.Exists(u => u.SFUserId == User03 && u.Username == "User 03"), Is.True);
+        Assert.That(source.UserRoles.ContainsKey(User03), Is.True);
         user = env.GetUser(User03);
         Assert.That(user.Sites[SiteId].Projects, Is.EquivalentTo(new[] { Project01, Project03, SourceOnly }));
     }
@@ -4622,13 +4653,20 @@ public async Task SyncUserRoleAsync_DowngradesRole()
         var env = new TestEnvironment();
         var user = env.GetProject(Project01).UserRoles[User01];
         Assert.AreEqual(SFProjectRole.Administrator, user);
+        SFProject project = env.GetProject(Project01);
+        Assert.IsFalse(
+            project.ParatextUsers.Exists(u => u.Username == "User 01" && u.Role == SFProjectRole.Translator),
+            "setup"
+        );
 
         // SUT
         env.ParatextService.TryGetProjectRoleAsync(Arg.Any<UserSecret>(), Arg.Any<string>(), CancellationToken.None)
             .Returns(Task.FromResult(Attempt.Success(SFProjectRole.Translator)));
         await env.Service.SyncUserRoleAsync(User01, Project01);
-        user = env.GetProject(Project01).UserRoles[User01];
+        project = env.GetProject(Project01);
+        user = project.UserRoles[User01];
         Assert.AreEqual(SFProjectRole.Translator, user);
+        Assert.IsTrue(project.ParatextUsers.Exists(u => u.Username == "User 01" && u.Role == SFProjectRole.Translator));
         await env.SyncService.DidNotReceive().SyncAsync(Arg.Any<SyncConfig>());
     }
 
@@ -4651,13 +4689,20 @@ public async Task SyncUserRoleAsync_UpgradesRole()
         var env = new TestEnvironment();
         var user = env.GetProject(Project01).UserRoles[User03];
         Assert.AreEqual(SFProjectRole.Consultant, user);
+        SFProject project = env.GetProject(Project01);
+        Assert.IsFalse(
+            project.ParatextUsers.Exists(u => u.Username == "User 03" && u.Role == SFProjectRole.Translator),
+            "setup"
+        );
 
         // SUT
         env.ParatextService.TryGetProjectRoleAsync(Arg.Any<UserSecret>(), Arg.Any<string>(), CancellationToken.None)
             .Returns(Task.FromResult(Attempt.Success(SFProjectRole.Translator)));
         await env.Service.SyncUserRoleAsync(User03, Project01);
-        user = env.GetProject(Project01).UserRoles[User03];
+        project = env.GetProject(Project01);
+        user = project.UserRoles[User03];
         Assert.AreEqual(SFProjectRole.Translator, user);
+        Assert.IsTrue(project.ParatextUsers.Exists(u => u.Username == "User 03" && u.Role == SFProjectRole.Translator));
         await env.SyncService.Received().SyncAsync(Arg.Any<SyncConfig>());
     }
 
@@ -4678,6 +4723,7 @@ public TestEnvironment()
                             Id = User01,
                             Email = "[email protected]",
                             ParatextId = "pt-user01",
+                            Name = "User 01",
                             Roles = [SystemRole.User],
                             Sites = new Dictionary<string, Site>
                             {
@@ -4692,6 +4738,7 @@ public TestEnvironment()
                             Id = User02,
                             Email = "[email protected]",
                             ParatextId = "pt-user02",
+                            Name = "User 02",
                             Roles = [SystemRole.User],
                             Sites = new Dictionary<string, Site>
                             {
@@ -4706,6 +4753,7 @@ public TestEnvironment()
                             Id = User03,
                             Email = "[email protected]",
                             ParatextId = "pt-user03",
+                            Name = "User 03",
                             Roles = [SystemRole.User],
                             Sites = new Dictionary<string, Site>
                             {
@@ -4720,6 +4768,7 @@ public TestEnvironment()
                             Id = User04,
                             Email = "[email protected]",
                             Roles = [SystemRole.SystemAdmin],
+                            Name = "User 04",
                             Sites = new Dictionary<string, Site> { { SiteId, new Site() } },
                         },
                         new User
@@ -4734,6 +4783,7 @@ public TestEnvironment()
                             Id = User05,
                             Email = "[email protected]",
                             ParatextId = "pt-user05",
+                            Name = "User 05",
                             Roles = [SystemRole.User],
                             Sites = new Dictionary<string, Site>
                             {
@@ -4748,6 +4798,7 @@ public TestEnvironment()
                             Id = User06,
                             Email = "[email protected]",
                             Roles = [SystemRole.User],
+                            Name = "User 06",
                             Sites = new Dictionary<string, Site>
                             {
                                 {
@@ -4761,6 +4812,7 @@ public TestEnvironment()
                             Id = User07,
                             Email = "[email protected]",
                             Roles = [SystemRole.SystemAdmin],
+                            Name = "User 07",
                             Sites = new Dictionary<string, Site>
                             {
                                 {
@@ -4869,6 +4921,30 @@ public TestEnvironment()
                                 },
                             },
                             WritingSystem = new WritingSystem { Tag = "qaa" },
+                            ParatextUsers =
+                            {
+                                new ParatextUserProfile
+                                {
+                                    SFUserId = User01,
+                                    Username = "User 01",
+                                    Role = SFProjectRole.Administrator,
+                                    OpaqueUserId = "syncuser01",
+                                },
+                                new ParatextUserProfile
+                                {
+                                    SFUserId = User03,
+                                    Username = "User 03",
+                                    OpaqueUserId = "syncuser03",
+                                    Role = SFProjectRole.Consultant,
+                                },
+                                new ParatextUserProfile
+                                {
+                                    SFUserId = User05,
+                                    Username = "User 05",
+                                    OpaqueUserId = "syncuser05",
+                                    Role = SFProjectRole.Translator,
+                                },
+                            },
                         },
                         new SFProject
                         {
@@ -4889,6 +4965,22 @@ public TestEnvironment()
                                 { User02, SFProjectRole.Administrator },
                                 { User04, SFProjectRole.CommunityChecker },
                             },
+                            ParatextUsers =
+                            {
+                                new ParatextUserProfile
+                                {
+                                    SFUserId = User02,
+                                    Username = "User 02",
+                                    Role = SFProjectRole.Administrator,
+                                    OpaqueUserId = "syncuser02",
+                                },
+                                new ParatextUserProfile
+                                {
+                                    SFUserId = string.Empty,
+                                    Username = "User 01",
+                                    OpaqueUserId = "syncuser01",
+                                },
+                            },
                         },
                         new SFProject
                         {
@@ -5440,6 +5532,8 @@ public TestEnvironment()
             TransceleratorService = Substitute.For<ITransceleratorService>();
             EventMetricService = Substitute.For<IEventMetricService>();
             BackgroundJobClient = Substitute.For<IBackgroundJobClient>();
+            GuidService = Substitute.For<IGuidService>();
+            GuidService.NewObjectId().Returns($"syncuser");
 
             // These project rights correspond to the permissions in the projects above
             ProjectRights = Substitute.For<ISFProjectRights>();
@@ -5566,7 +5660,8 @@ public TestEnvironment()
                 TransceleratorService,
                 BackgroundJobClient,
                 EventMetricService,
-                ProjectRights
+                ProjectRights,
+                GuidService
             );
         }
 
@@ -5586,6 +5681,7 @@ public TestEnvironment()
         public ITransceleratorService TransceleratorService { get; set; }
         public IBackgroundJobClient BackgroundJobClient { get; }
         public ISFProjectRights ProjectRights { get; }
+        public IGuidService GuidService { get; }
 
         public SFProject GetProject(string id) => RealtimeService.GetRepository<SFProject>().Get(id);