Fix command service invocation return type (#3622)

Author: Nateowami

src/SIL.XForge.Scripture/ClientApp/src/app/core/sf-project.service.ts

@@ -80,15 +80,15 @@ export class SFProjectService extends ProjectService<SFProject, SFProjectDoc> {
   }
 
   async onlineCreate(settings: SFProjectCreateSettings): Promise<string> {
-    return (await this.onlineInvoke<string>('create', { settings }))!;
+    return await this.onlineInvoke<string>('create', { settings });
   }
 
   /**
    * Creates an SF project/resource with the given paratext id, and adds the user to it.
    * @param paratextId The paratext id of the project or resource.
    * @returns The SF project id.
    */
-  async onlineCreateResourceProject(paratextId: string): Promise<string | undefined> {
+  async onlineCreateResourceProject(paratextId: string): Promise<string> {
     return this.onlineInvoke<string>('createResourceProject', { paratextId });
   }
 
@@ -219,7 +219,7 @@ export class SFProjectService extends ProjectService<SFProject, SFProjectDoc> {
     scriptureRange: string,
     targetProjectId: string,
     timestamp: Date
-  ): Promise<string | undefined> {
+  ): Promise<string> {
     return this.onlineInvoke<string>('applyPreTranslationToProject', {
       projectId,
       scriptureRange,
@@ -244,40 +244,40 @@ export class SFProjectService extends ProjectService<SFProject, SFProjectDoc> {
   }
 
   async onlineIsAlreadyInvited(id: string, email: string): Promise<boolean> {
-    return (await this.onlineInvoke<boolean>('isAlreadyInvited', {
+    return await this.onlineInvoke<boolean>('isAlreadyInvited', {
       projectId: id,
       email
-    }))!;
+    });
   }
 
   /** Get list of email addresses that have outstanding invitations on project.
    * Caller must be an admin on the project. */
   async onlineInvitedUsers(projectId: string): Promise<InviteeStatus[]> {
-    return (await this.onlineInvoke<InviteeStatus[]>('invitedUsers', {
+    return await this.onlineInvoke<InviteeStatus[]>('invitedUsers', {
       projectId
-    }))!;
+    });
   }
 
   /** Get added into project with specified shareKey code. */
   async onlineJoinWithShareKey(shareKey: string): Promise<string> {
-    return (await this.onlineInvoke<string>('joinWithShareKey', { shareKey }))!;
+    return await this.onlineInvoke<string>('joinWithShareKey', { shareKey });
   }
 
-  onlineInvite(id: string, email: string, locale: string, role: string): Promise<string | undefined> {
+  onlineInvite(id: string, email: string, locale: string, role: string): Promise<string> {
     return this.onlineInvoke('invite', { projectId: id, email, locale, role });
   }
 
   async onlineUninviteUser(projectId: string, emailToUninvite: string): Promise<string> {
-    return (await this.onlineInvoke<string>('uninviteUser', {
+    return await this.onlineInvoke<string>('uninviteUser', {
       projectId,
       emailToUninvite
-    }))!;
+    });
   }
 
   async onlineIsSourceProject(projectId: string): Promise<boolean> {
-    return (await this.onlineInvoke<boolean>('isSourceProject', {
+    return await this.onlineInvoke<boolean>('isSourceProject', {
       projectId
-    }))!;
+    });
   }
 
   async onlineGetLinkSharingKey(
@@ -286,14 +286,12 @@ export class SFProjectService extends ProjectService<SFProject, SFProjectDoc> {
     shareLinkType: ShareLinkType,
     daysBeforeExpiration: number
   ): Promise<string> {
-    return (
-      (await this.onlineInvoke<string>('linkSharingKey', {
-        projectId,
-        role,
-        shareLinkType,
-        daysBeforeExpiration
-      })) ?? ''
-    );
+    return await this.onlineInvoke<string>('linkSharingKey', {
+      projectId,
+      role,
+      shareLinkType,
+      daysBeforeExpiration
+    });
   }
 
   async onlineReserveLinkSharingKey(shareKey: string, daysBeforeExpiration: number): Promise<void> {
@@ -305,19 +303,19 @@ export class SFProjectService extends ProjectService<SFProject, SFProjectDoc> {
   }
 
   async onlineSetRoleProjectPermissions(projectId: string, role: string, permissions: string[]): Promise<void> {
-    return (await this.onlineInvoke<void>('setRoleProjectPermissions', {
+    return await this.onlineInvoke<void>('setRoleProjectPermissions', {
       projectId,
       role,
       permissions
-    }))!;
+    });
   }
 
   async onlineSetUserProjectPermissions(projectId: string, userId: string, permissions: string[]): Promise<void> {
-    return (await this.onlineInvoke<void>('setUserProjectPermissions', {
+    return await this.onlineInvoke<void>('setUserProjectPermissions', {
       projectId,
       userId,
       permissions
-    }))!;
+    });
   }
 
   async onlineCreateAudioTimingData(
@@ -383,11 +381,7 @@ export class SFProjectService extends ProjectService<SFProject, SFProjectDoc> {
     });
   }
 
-  async onlineEventMetrics(
-    projectId: string,
-    pageIndex: number,
-    pageSize: number
-  ): Promise<QueryResults<EventMetric> | undefined> {
+  async onlineEventMetrics(projectId: string, pageIndex: number, pageSize: number): Promise<QueryResults<EventMetric>> {
     return await this.onlineInvoke<QueryResults<EventMetric>>('eventMetrics', { projectId, pageIndex, pageSize });
   }
 
@@ -396,7 +390,7 @@ export class SFProjectService extends ProjectService<SFProject, SFProjectDoc> {
     projectId?: string,
     startDate?: Date,
     endDate?: Date
-  ): Promise<QueryResults<EventMetric> | undefined> {
+  ): Promise<QueryResults<EventMetric>> {
     const params: any = {
       projectId: projectId ?? null,
       scopes: [3], // Drafting scope

src/SIL.XForge.Scripture/ClientApp/src/app/event-metrics/event-metrics-log.component.spec.ts

@@ -187,7 +187,7 @@ class TestEnvironment {
     when(mockedUserService.currentUserId).thenReturn('user01');
     when(mockedAuthService.currentUserRoles).thenReturn([]);
     when(mockDialogService.openMatDialog(EventMetricDialogComponent, anything())).thenReturn(instance(this.dialogRef));
-    when(mockedProjectService.onlineEventMetrics(anything(), anything(), anything())).thenResolve(undefined);
+    when(mockedProjectService.onlineEventMetrics(anything(), anything(), anything())).thenResolve({} as any);
 
     this.fixture = TestBed.createComponent(EventMetricsLogComponent);
     this.component = this.fixture.componentInstance;

src/SIL.XForge.Scripture/ClientApp/src/app/event-metrics/event-metrics-log.component.ts

@@ -130,8 +130,8 @@ export class EventMetricsLogComponent extends DataLoadingComponent implements On
           this.loadingStarted();
           if (isOnline) {
             const queryResults = await this.projectService.onlineEventMetrics(projectId, pageIndex, pageSize);
-            this.length = queryResults?.unpagedCount ?? 0;
-            if (Array.isArray(queryResults?.results)) {
+            this.length = queryResults.unpagedCount ?? 0;
+            if (Array.isArray(queryResults.results)) {
               this.eventMetrics = queryResults.results as EventMetric[];
             } else {
               this.eventMetrics = [];

src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.spec.ts

@@ -334,7 +334,7 @@ class TestEnvironment {
 
     when(
       mockedProjectService.onlineInvite(anything(), 'unknown-address@example.com', anything(), anything())
-    ).thenResolve(undefined);
+    ).thenResolve({} as any);
     when(
       mockedProjectService.onlineInvite(anything(), 'already-project-member@example.com', anything(), anything())
     ).thenResolve(this.component.alreadyProjectMemberResponse);

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

@@ -144,7 +144,7 @@ describe('EditorTabAddResourceDialogComponent', () => {
 
     it('should set projectFetchFailed to true when fetchProject returns undefined', fakeAsync(() => {
       const env = new TestEnvironment();
-      when(mockSFProjectService.onlineCreateResourceProject(env.paratextId)).thenReturn(Promise.resolve(undefined));
+      when(mockSFProjectService.onlineCreateResourceProject(env.paratextId)).thenResolve({} as any);
       env.component.confirmSelection();
       tick();
       verify(mockSFProjectService.onlineCreateResourceProject(env.paratextId)).once();

src/SIL.XForge.Scripture/ClientApp/src/xforge-common/command.service.ts

@@ -25,19 +25,30 @@ interface JsonRpcRequest {
   id?: string;
 }
 
-export interface JsonRpcResponse<T> {
+interface JsonRpcFailure {
   jsonrpc: '2.0';
-  result?: T;
-  error?: JsonRpcError;
   id: string;
+  error: JsonRpcError;
 }
 
+interface JsonRpcSuccess<T> {
+  jsonrpc: '2.0';
+  id: string;
+  result: T;
+}
+
+export type JsonRpcResponse<T> = JsonRpcSuccess<T> | JsonRpcFailure;
+
 export interface JsonRpcError {
   code: number;
   message: string;
   data?: any;
 }
 
+function isJsonRpcFailure<T>(response: JsonRpcResponse<T>): response is JsonRpcFailure {
+  return 'error' in response && response.error != null;
+}
+
 export function isNetworkError(error: any): boolean {
   return (
     error instanceof CommandError && hasStringProp(error, 'message') && error.message.includes('504 Gateway Timeout')
@@ -70,7 +81,7 @@ export class CommandService {
     private readonly bugsnagService: BugsnagService
   ) {}
 
-  async onlineInvoke<T>(url: string, method: string, params: any = {}): Promise<T | undefined> {
+  async onlineInvoke<T>(url: string, method: string, params: any = {}): Promise<T> {
     url = `${COMMAND_API_NAMESPACE}/${url}`;
     const request: JsonRpcRequest = {
       jsonrpc: '2.0',
@@ -92,7 +103,7 @@ export class CommandService {
       const response = await lastValueFrom(
         this.http.post<JsonRpcResponse<T>>(url, request, { headers: { 'Content-Type': 'application/json' } })
       );
-      if (response.error != null) {
+      if (isJsonRpcFailure(response)) {
         throw response.error;
       }
       return response.result;

src/SIL.XForge.Scripture/ClientApp/src/xforge-common/project.service.ts

@@ -94,7 +94,7 @@ export abstract class ProjectService<
     return this.onlineInvoke<void>('setSyncDisabled', { projectId, isDisabled });
   }
 
-  protected onlineInvoke<T>(method: string, params?: any): Promise<T | undefined> {
+  protected onlineInvoke<T>(method: string, params?: any): Promise<T> {
     return this.commandService.onlineInvoke<T>(PROJECTS_URL, method, params);
   }
 

src/SIL.XForge.Scripture/ClientApp/src/xforge-common/user.service.ts

@@ -139,7 +139,7 @@ export class UserService {
     }
   }
 
-  private onlineInvoke<T>(method: string, params?: any): Promise<T | undefined> {
+  private onlineInvoke<T>(method: string, params?: any): Promise<T> {
     return this.commandService.onlineInvoke<T>(USERS_URL, method, params);
   }
 }