Make paratext role nullable

Author: RaymondLuong3

deploy/roles_common

@@ -0,0 +1 @@
+Subproject commit 306fa9e30f7c2182433f7b7ee39739fd90db7a89

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

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

src/RealtimeServer/scriptureforge/services/sf-project-service.ts

@@ -558,7 +558,7 @@ export class SFProjectService extends ProjectService<SFProject> {
         bsonType: 'array',
         items: {
           bsonType: 'object',
-          required: ['username', 'opaqueUserId', 'role'],
+          required: ['username', 'opaqueUserId'],
           properties: {
             username: {
               bsonType: 'string'

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

@@ -761,8 +761,7 @@ class TestEnvironment {
           isConnectable: false,
           isConnected: true,
           hasUserRoleChanged: false,
-          hasUpdate: false,
-          members: []
+          hasUpdate: false
         },
         selectableProjectWithLanguageCode: translateSourceToSelectableProjectWithLanguageTag(o.data),
         translateSource: {
@@ -788,8 +787,7 @@ class TestEnvironment {
         isConnectable: true,
         isConnected: false,
         hasUserRoleChanged: false,
-        hasUpdate: false,
-        members: []
+        hasUpdate: false
       })).map((o: ParatextProject) => ({
         paratextProject: o,
         selectableProjectWithLanguageCode: o,
@@ -810,8 +808,7 @@ class TestEnvironment {
         isConnectable: true,
         isConnected: false,
         hasUserRoleChanged: false,
-        hasUpdate: false,
-        members: []
+        hasUpdate: false
       })).map((o: ParatextProject) => ({
         paratextProject: o,
         selectableProjectWithLanguageCode: o,

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

@@ -117,8 +117,7 @@ function setUpMocks(args: DraftSourcesComponentStoryState): void {
     isConnectable: true,
     isConnected: true,
     hasUserRoleChanged: false,
-    hasUpdate: false,
-    members: []
+    hasUpdate: false
   }));
 
   // Add a project that has an unknown language code

src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.html

@@ -59,7 +59,7 @@ <h2>
                       ></div>
                     }
                     <div class="hide-gt-sm">
-                      <em>{{ userRow.role ? i18n.localizeRole(userRow.role) : "" }}</em>
+                      <em>{{ userRow.role ? i18n.localizeRole(userRow.role) : t("role_unknown") }}</em>
                     </div>
                   </td>
                 </ng-container>
@@ -83,7 +83,7 @@ <h2>
                 </ng-container>
                 <ng-container matColumnDef="role">
                   <td class="hide-lt-sm" mat-cell *matCellDef="let userRow">
-                    <em>{{ userRow.role ? i18n.localizeRole(userRow.role) : "" }}</em>
+                    <em>{{ userRow.role ? i18n.localizeRole(userRow.role) : t("role_unknown") }}</em>
                   </td>
                 </ng-container>
                 <ng-container matColumnDef="more">

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

@@ -84,7 +84,7 @@ describe('CollaboratorsComponent', () => {
     env.fixture.detectChanges();
     tick();
     env.fixture.detectChanges();
-    const numParatextUsers = 5;
+    const numParatextUsers = 6;
     expect(env.userRowsByCategory(UserType.Paratext).length).toEqual(numParatextUsers);
     expect(env.noUsersLabel(UserType.Paratext)).toBeNull();
     expect(env.userTable(UserType.Guest)).toBeNull();
@@ -100,7 +100,7 @@ describe('CollaboratorsComponent', () => {
 
     expect(env.noUsersLabel(UserType.Paratext)).toBeNull();
     expect(env.noUsersLabel(UserType.Guest)).toBeNull();
-    const numParatextUsers = 5;
+    const numParatextUsers = 6;
     const numProjectGuests = 1;
     expect(env.userRowsByCategory(UserType.Paratext).length).toEqual(numParatextUsers);
     expect(env.userRowsByCategory(UserType.Guest).length).toEqual(numProjectGuests);
@@ -132,11 +132,11 @@ describe('CollaboratorsComponent', () => {
     tick();
     env.fixture.detectChanges();
 
-    const numParatextUsers = 5;
+    const numParatextUsers = 6;
     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 C', 'User B', 'User A']);
+    ).toEqual(['User 01', 'User 02', 'User C', 'User B', 'User A', 'User No Role']);
     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();
@@ -155,7 +155,7 @@ describe('CollaboratorsComponent', () => {
     tick();
     env.fixture.detectChanges();
 
-    const numParatextUsers = 5;
+    const numParatextUsers = 6;
     const numGuestUsers = 1;
     const numInvitees = 3;
     expect(env.userRowsByCategory(UserType.Paratext).length).toEqual(numParatextUsers);
@@ -190,10 +190,19 @@ describe('CollaboratorsComponent', () => {
     tick();
     env.fixture.detectChanges();
 
-    expect(env.userRowsByCategory(UserType.Paratext).length).toEqual(5);
-    expect(env.userRowsByCategory(UserType.Guest).length).toEqual(4);
+    const numParatextUsers = 6;
+    const numGuestUsers = 4;
+    expect(env.userRowsByCategory(UserType.Paratext).length).toEqual(numParatextUsers);
+    expect(env.userRowsByCategory(UserType.Guest).length).toEqual(numGuestUsers);
     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', 'User C', 'User B', 'User A']);
+    expect(paratextRows.map(r => r.user.displayName)).toEqual([
+      'User 01',
+      'User 02',
+      'User C',
+      'User B',
+      'User A',
+      'User No Role'
+    ]);
     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',
@@ -579,7 +588,8 @@ class TestEnvironment {
     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 }
+      { username: 'User C', opaqueUserId: 'opaqueC', role: SFProjectRole.ParatextAdministrator },
+      { username: 'User No Role', opaqueUserId: 'opaqueNoRole' }
     ];
     paratextUsers.push(...ptMembersNotConnected);
     return createTestProject({

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

@@ -99,8 +99,14 @@ export class CollaboratorsComponent extends DataLoadingComponent implements OnIn
 
   get projectUsers(): ProjectUserLists[] {
     return [
-      { userType: UserType.Paratext, rows: this._userRows?.filter(u => isParatextRole(u.role)) ?? [] },
-      { userType: UserType.Guest, rows: this._userRows?.filter(u => !isParatextRole(u.role)) ?? [] }
+      {
+        userType: UserType.Paratext,
+        rows: this._userRows?.filter(u => isParatextRole(u.role) || u.paratextMemberNotConnected) ?? []
+      },
+      {
+        userType: UserType.Guest,
+        rows: this._userRows?.filter(u => !isParatextRole(u.role) && !u.paratextMemberNotConnected) ?? []
+      }
     ];
   }
 
@@ -243,15 +249,19 @@ export class CollaboratorsComponent extends DataLoadingComponent implements OnIn
   }
 
   private sortUsers(projectUsers: Row[], paratextMembersNotConnected: Row[], invitees: Row[]): Row[] {
-    // Administrators, Translators, Consultants, Observers, Community Checkers, Commenters, SF Observers, None
-    const userRoles: SFProjectRole[] = Object.values(SFProjectRole).filter(r => r !== SFProjectRole.None);
+    // Administrators, Translators, Consultants, Observers, Community Checkers, Commenters, SF Observers
+    const userRoles: (SFProjectRole | null | undefined)[] = Object.values(SFProjectRole).filter(
+      r => r !== SFProjectRole.None
+    );
+
     const sortedRows: Row[] = [];
     for (const role of userRoles) {
       const rowsForRole = projectUsers.filter(u => u.role === role).sort(this.sortByName);
       sortedRows.push(...rowsForRole);
     }
 
-    for (const role of userRoles) {
+    for (const role of [...userRoles].concat(undefined, null)) {
+      // include users that do not have their role set
       const paratextMembers = paratextMembersNotConnected.filter(u => u.role === role).sort(this.sortByName);
       sortedRows.push(...paratextMembers);
     }

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

@@ -103,6 +103,7 @@
     "project_guests": "Project Guests",
     "remove_from_project": "Remove from project",
     "remove_user": "Remove User",
+    "role_unknown": "Role unknown",
     "share_with_others": "Share with others"
   },
   "confirm_draft_sources": {

src/SIL.XForge.Scripture/Models/ParatextUserProfile.cs

@@ -13,5 +13,5 @@ public class ParatextUserProfile
     /// </summary>
     public string OpaqueUserId { get; set; }
     public string? SFUserId { get; set; }
-    public string Role { get; set; }
+    public string? Role { get; set; }
 }