Determine paratext users not connected by the ParatextUsers property

Author: RaymondLuong3

src/RealtimeServer/scriptureforge/models/paratext-user-profile.ts

@@ -2,4 +2,5 @@ export interface ParatextUserProfile {
   username: string;
   opaqueUserId: string;
   sfUserId?: string;
+  role: string;
 }

src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts

@@ -298,8 +298,7 @@ class TestEnvironment {
       isConnectable: true,
       isConnected: false,
       hasUserRoleChanged: false,
-      hasUpdate: false,
-      members: []
+      hasUpdate: false
     },
     {
       paratextId: 'pt02',
@@ -310,8 +309,7 @@ class TestEnvironment {
       isConnectable: false,
       isConnected: true,
       hasUserRoleChanged: false,
-      hasUpdate: false,
-      members: []
+      hasUpdate: false
     },
     {
       paratextId: 'pt04',
@@ -321,8 +319,7 @@ class TestEnvironment {
       isConnectable: false,
       isConnected: false,
       hasUserRoleChanged: false,
-      hasUpdate: false,
-      members: []
+      hasUpdate: false
     },
     {
       paratextId: 'pt03',
@@ -333,8 +330,7 @@ class TestEnvironment {
       isConnectable: true,
       isConnected: true,
       hasUserRoleChanged: false,
-      hasUpdate: false,
-      members: []
+      hasUpdate: false
     }
   ];
 

src/SIL.XForge.Scripture/ClientApp/src/app/core/models/paratext-project.ts

@@ -1,11 +1,3 @@
-import { SFProjectRole } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-role';
-
-export interface ParatextMember {
-  connectedToProject: boolean;
-  username: string;
-  role: SFProjectRole;
-}
-
 /** See documentation in ParatextProject.cs. */
 export interface ParatextProject {
   paratextId: string;
@@ -16,7 +8,6 @@ export interface ParatextProject {
   projectId?: string | null;
   isConnectable: boolean;
   isConnected: boolean;
-  members: ParatextMember[];
   hasUserRoleChanged: boolean;
   hasUpdate: boolean;
 }

src/SIL.XForge.Scripture/ClientApp/src/app/settings/settings.component.spec.ts

@@ -299,8 +299,7 @@ describe('SettingsComponent', () => {
             isConnectable: true,
             isConnected: false,
             hasUserRoleChanged: false,
-            hasUpdate: false,
-            members: []
+            hasUpdate: false
           }
         ]);
         when(mockedParatextService.getResources()).thenResolve([]);
@@ -793,8 +792,7 @@ class TestEnvironment {
         isConnectable: true,
         isConnected: false,
         hasUserRoleChanged: false,
-        hasUpdate: false,
-        members: []
+        hasUpdate: false
       },
       {
         paratextId: 'paratextId02',
@@ -804,8 +802,7 @@ class TestEnvironment {
         isConnectable: true,
         isConnected: false,
         hasUserRoleChanged: false,
-        hasUpdate: false,
-        members: []
+        hasUpdate: false
       }
     ]);
     when(mockedParatextService.getResources()).thenResolve([

src/SIL.XForge.Scripture/ClientApp/src/app/shared/test-utils.ts

@@ -112,7 +112,7 @@ export function getEmptyChapterDoc(id: TextDocId): TextData {
 export function paratextUsersFromRoles(userRoles: { [id: string]: string }): ParatextUserProfile[] {
   return Object.keys(userRoles)
     .filter(u => isParatextRole(userRoles[u]))
-    .map(u => ({ sfUserId: u, username: `pt${u}`, opaqueUserId: `opaque${u}` }));
+    .map(u => ({ sfUserId: u, username: `pt${u}`, opaqueUserId: `opaque${u}`, role: userRoles[u] }));
 }
 
 // Function to create a mock MediaStream with an audio track

src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.stories.ts

@@ -131,8 +131,7 @@ function setUpMocks(args: DraftSourcesComponentStoryState): void {
     isConnectable: true,
     isConnected: false,
     hasUserRoleChanged: false,
-    hasUpdate: false,
-    members: []
+    hasUpdate: false
   });
 
   when(mockedParatextService.getResources()).thenResolve(resources);

src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-resource-dialog/editor-tab-add-resource-dialog.component.spec.ts

@@ -285,7 +285,6 @@ class TestEnvironment {
       isConnected: false,
       hasUserRoleChanged: false,
       hasUpdate: false,
-      members: [],
       ...overrides
     };
   }

src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-resource-dialog/editor-tab-add-resource-dialog.stories.ts

@@ -40,7 +40,6 @@ function createTestParatextProject(index: number, overrides?: Partial<ParatextPr
     isConnected: false,
     hasUserRoleChanged: false,
     hasUpdate: false,
-    members: [],
     ...overrides
   };
 }

src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts

@@ -8,9 +8,10 @@ import { NoopAnimationsModule } from '@angular/platform-browser/animations';
 import { UserProfile } from 'realtime-server/lib/esm/common/models/user';
 import { createTestUserProfile } from 'realtime-server/lib/esm/common/models/user-test-data';
 import { CheckingAnswerExport, CheckingConfig } from 'realtime-server/lib/esm/scriptureforge/models/checking-config';
-import { SFProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project';
+import { ParatextUserProfile } from 'realtime-server/lib/esm/scriptureforge/models/paratext-user-profile';
+import { SFProject, SFProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project';
 import { SFProjectRole } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-role';
-import { createTestProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-test-data';
+import { createTestProject } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-test-data';
 import { of } from 'rxjs';
 import { anything, mock, verify, when } from 'ts-mockito';
 import { ActivatedProjectService } from 'xforge-common/activated-project.service';
@@ -28,20 +29,18 @@ import { TestRealtimeService } from 'xforge-common/test-realtime.service';
 import { configureTestingModule, emptyHammerLoader, TestTranslocoModule } from 'xforge-common/test-utils';
 import { UICommonModule } from 'xforge-common/ui-common.module';
 import { UserService } from 'xforge-common/user.service';
-import { ParatextProject } from '../../core/models/paratext-project';
 import { SFProjectDoc } from '../../core/models/sf-project-doc';
 import { SFProjectProfileDoc } from '../../core/models/sf-project-profile-doc';
 import { SF_PROJECT_ROLES } from '../../core/models/sf-project-role-info';
 import { SF_TYPE_REGISTRY } from '../../core/models/sf-type-registry';
-import { ParatextService } from '../../core/paratext.service';
 import { SFProjectService } from '../../core/sf-project.service';
 import { SharedModule } from '../../shared/shared.module';
+import { paratextUsersFromRoles } from '../../shared/test-utils';
 import { CollaboratorsComponent, UserType } from './collaborators.component';
 
 const mockedActivatedProject = mock(ActivatedProjectService);
 const mockedNoticeService = mock(NoticeService);
 const mockedProjectService = mock(SFProjectService);
-const mockedParatextService = mock(ParatextService);
 const mockedUserService = mock(UserService);
 const mockedDialogService = mock(DialogService);
 
@@ -61,7 +60,6 @@ describe('CollaboratorsComponent', () => {
       { provide: ActivatedProjectService, useMock: mockedActivatedProject },
       { provide: NoticeService, useMock: mockedNoticeService },
       { provide: SFProjectService, useMock: mockedProjectService },
-      { provide: ParatextService, useMock: mockedParatextService },
       { provide: UserService, useMock: mockedUserService },
       { provide: OnlineStatusService, useClass: TestOnlineStatusService },
       { provide: DialogService, useMock: mockedDialogService },
@@ -86,7 +84,7 @@ describe('CollaboratorsComponent', () => {
     env.fixture.detectChanges();
     tick();
     env.fixture.detectChanges();
-    const numParatextUsers = 3;
+    const numParatextUsers = 5;
     expect(env.userRowsByCategory(UserType.Paratext).length).toEqual(numParatextUsers);
     expect(env.noUsersLabel(UserType.Paratext)).toBeNull();
     expect(env.userTable(UserType.Guest)).toBeNull();
@@ -102,7 +100,7 @@ describe('CollaboratorsComponent', () => {
 
     expect(env.noUsersLabel(UserType.Paratext)).toBeNull();
     expect(env.noUsersLabel(UserType.Guest)).toBeNull();
-    const numParatextUsers = 3;
+    const numParatextUsers = 5;
     const numProjectGuests = 1;
     expect(env.userRowsByCategory(UserType.Paratext).length).toEqual(numParatextUsers);
     expect(env.userRowsByCategory(UserType.Guest).length).toEqual(numProjectGuests);
@@ -134,11 +132,11 @@ describe('CollaboratorsComponent', () => {
     tick();
     env.fixture.detectChanges();
 
-    const numParatextUsers = 3;
+    const numParatextUsers = 5;
     expect(env.userRowsByCategory(UserType.Paratext).length).toEqual(numParatextUsers);
     expect(
       env.component.projectUsers.find(u => u.userType === UserType.Paratext)!.rows.map(r => r.user.displayName)
-    ).toEqual(['User 01', 'User 02', 'User Not On SF']);
+    ).toEqual(['User 01', 'User 02', 'User C', 'User B', 'User A']);
     expect(env.userRowsByCategory(UserType.Paratext)[0].nativeElement.querySelector('.user-more-menu')).not.toBeNull();
     expect(env.userRowsByCategory(UserType.Paratext)[1].nativeElement.querySelector('.user-more-menu')).not.toBeNull();
     expect(env.userRowsByCategory(UserType.Paratext)[2].nativeElement.querySelector('.user-more-menu')).toBeNull();
@@ -157,7 +155,7 @@ describe('CollaboratorsComponent', () => {
     tick();
     env.fixture.detectChanges();
 
-    const numParatextUsers = 3;
+    const numParatextUsers = 5;
     const numGuestUsers = 1;
     const numInvitees = 3;
     expect(env.userRowsByCategory(UserType.Paratext).length).toEqual(numParatextUsers);
@@ -188,26 +186,14 @@ describe('CollaboratorsComponent', () => {
       { email: '[email protected]', role: 'sf_community_checker', expired: false }
     ]);
 
-    when(mockedParatextService.getProjects()).thenResolve([
-      {
-        paratextId: 'paratextId1',
-        name: 'Project 01',
-        members: [
-          { username: 'A User', role: SFProjectRole.ParatextConsultant, connectedToProject: false },
-          { username: 'B User', role: SFProjectRole.ParatextTranslator, connectedToProject: false },
-          { username: 'C User', role: SFProjectRole.ParatextAdministrator, connectedToProject: false }
-        ]
-      } as ParatextProject
-    ]);
-
     env.fixture.detectChanges();
     tick();
     env.fixture.detectChanges();
 
     expect(env.userRowsByCategory(UserType.Paratext).length).toEqual(5);
     expect(env.userRowsByCategory(UserType.Guest).length).toEqual(4);
     const paratextRows = Array.from(env.component.projectUsers.find(u => u.userType === UserType.Paratext)!.rows);
-    expect(paratextRows.map(r => r.user.displayName)).toEqual(['User 01', 'User 02', 'C User', 'B User', 'A User']);
+    expect(paratextRows.map(r => r.user.displayName)).toEqual(['User 01', 'User 02', 'User C', 'User B', 'User A']);
     const guestRows = Array.from(env.component.projectUsers.find(u => u.userType === UserType.Guest)!.rows);
     expect(guestRows.map(r => r.user.displayName ?? r.user.email)).toEqual([
       'User 03',
@@ -217,18 +203,6 @@ describe('CollaboratorsComponent', () => {
     ]);
   }));
 
-  it('handle error from paratext project query', fakeAsync(() => {
-    const env = new TestEnvironment();
-    when(mockedParatextService.getProjects()).thenThrow(new Error('Network error'));
-    env.setupProjectData();
-    env.fixture.detectChanges();
-    expect(() => {
-      tick();
-    }).not.toThrow();
-    verify(mockedNoticeService.show(anything())).once();
-    tick();
-  }));
-
   it('handle error from invited users query, when user is not on project', fakeAsync(() => {
     // If an admin user is removed from the project, or loses admin
     // privileges, while looking at the component, they will run loadUsers
@@ -461,17 +435,6 @@ class TestEnvironment {
       }
     );
 
-    when(mockedParatextService.getProjects()).thenResolve([
-      {
-        paratextId: 'paratextId1',
-        name: 'Project 01',
-        members: [
-          { connectedToProject: true, username: 'User 01', role: SFProjectRole.ParatextAdministrator },
-          { connectedToProject: true, username: 'User 02', role: SFProjectRole.ParatextTranslator },
-          { connectedToProject: false, username: 'User Not On SF', role: SFProjectRole.ParatextTranslator }
-        ]
-      } as ParatextProject
-    ]);
     this.realtimeService.addSnapshots<UserProfile>(UserProfileDoc.COLLECTION, [
       {
         id: 'user01',
@@ -611,20 +574,27 @@ class TestEnvironment {
     this.fixture.detectChanges();
   }
 
-  private createProject(userRoles: { [userRef: string]: string }): SFProjectProfile {
-    return createTestProjectProfile({
+  private createProject(userRoles: { [userRef: string]: string }): SFProject {
+    const paratextUsers: ParatextUserProfile[] = paratextUsersFromRoles(userRoles);
+    const ptMembersNotConnected = [
+      { username: 'User A', opaqueUserId: 'opaqueA', role: SFProjectRole.ParatextObserver },
+      { username: 'User B', opaqueUserId: 'opaqueB', role: SFProjectRole.ParatextTranslator },
+      { username: 'User C', opaqueUserId: 'opaqueC', role: SFProjectRole.ParatextAdministrator }
+    ];
+    paratextUsers.push(...ptMembersNotConnected);
+    return createTestProject({
       checkingConfig: {
         checkingEnabled: false,
         usersSeeEachOthersResponses: false,
         answerExportMethod: CheckingAnswerExport.MarkedForExport
       },
-      userRoles
+      userRoles,
+      paratextUsers
     });
   }
 
   private setupThisProjectData(projectId: string, project: SFProjectProfile): void {
-    const projectDoc = { id: projectId, data: project } as SFProjectProfileDoc;
-    when(mockedActivatedProject.changes$).thenReturn(of(projectDoc));
+    when(mockedActivatedProject.projectId$).thenReturn(of(projectId));
     this.realtimeService.addSnapshot<SFProjectProfile>(SFProjectDoc.COLLECTION, {
       id: projectId,
       data: project