NAS-131557: Rename IncomingWebsocketMessage to IncomingApiMessage

truenas · Nov 13, 2024 · 0fa3a26 · 0fa3a26
1 parent 4e942dd
commit 0fa3a26
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 11 deletions.
diff --git a/src/app/interfaces/api-message.interface.ts b/src/app/interfaces/api-message.interface.ts
@@ -44,7 +44,7 @@ export type ApiEventTyped<
   T extends ApiEventResponseType<M> = ApiEventResponseType<M>,
 > = ApiEvent<T>;
 
-export type IncomingWebSocketMessage =
+export type IncomingApiMessage =
   | PongMessage
   | SubscriptionReadyMessage
   | ResultMessage

diff --git a/src/app/services/api.service.ts b/src/app/services/api.service.ts
@@ -26,7 +26,7 @@ import {
 } from 'app/interfaces/api/api-job-directory.interface';
 import { ApiError } from 'app/interfaces/api-error.interface';
 import {
-  ApiEvent, ApiEventMethod, ApiEventTyped, IncomingWebSocketMessage, ResultMessage,
+  ApiEvent, ApiEventMethod, ApiEventTyped, IncomingApiMessage, ResultMessage,
 } from 'app/interfaces/api-message.interface';
 import { Job } from 'app/interfaces/job.interface';
 import { WebSocketConnectionService } from 'app/services/websocket-connection.service';
@@ -155,8 +155,8 @@ export class ApiService {
         });
       }),
       switchMap(() => this.ws$),
-      filter((data: IncomingWebSocketMessage) => data.msg === IncomingApiMessageType.Result && data.id === uuid),
-      switchMap((data: IncomingWebSocketMessage) => {
+      filter((data: IncomingApiMessage) => data.msg === IncomingApiMessageType.Result && data.id === uuid),
+      switchMap((data: IncomingApiMessage) => {
         if ('error' in data && data.error) {
           this.printError(data.error, { method, params });
           const error = this.enhanceError(data.error, { method });

diff --git a/src/app/services/auth/auth.service.ts b/src/app/services/auth/auth.service.ts
@@ -27,7 +27,7 @@ import {
   ApiCallParams,
   ApiCallResponse,
 } from 'app/interfaces/api/api-call-directory.interface';
-import { IncomingWebSocketMessage, ResultMessage } from 'app/interfaces/api-message.interface';
+import { IncomingApiMessage, ResultMessage } from 'app/interfaces/api-message.interface';
 import { LoginExMechanism, LoginExResponse, LoginExResponseType } from 'app/interfaces/auth.interface';
 import { LoggedInUser } from 'app/interfaces/ds-cache.interface';
 import { GlobalTwoFactorConfig } from 'app/interfaces/two-factor-config.interface';
@@ -258,8 +258,8 @@ export class AuthService {
 
   private getFilteredWebSocketResponse<T>(uuid: string): Observable<T> {
     return this.wsManager.websocket$.pipe(
-      filter((data: IncomingWebSocketMessage) => data.msg === IncomingApiMessageType.Result && data.id === uuid),
-      switchMap((data: IncomingWebSocketMessage) => {
+      filter((data: IncomingApiMessage) => data.msg === IncomingApiMessageType.Result && data.id === uuid),
+      switchMap((data: IncomingApiMessage) => {
         if ('error' in data && data.error) {
           return throwError(() => data.error);
         }

diff --git a/src/app/services/websocket-connection.service.ts b/src/app/services/websocket-connection.service.ts
@@ -8,7 +8,7 @@ import { webSocket as rxjsWebSocket, WebSocketSubject } from 'rxjs/webSocket';
 import { IncomingApiMessageType, OutgoingApiMessageType } from 'app/enums/api-message-type.enum';
 import { WEBSOCKET } from 'app/helpers/websocket.helper';
 import { WINDOW } from 'app/helpers/window.helper';
-import { ApiEventMethod, ApiEventTyped, IncomingWebSocketMessage } from 'app/interfaces/api-message.interface';
+import { ApiEventMethod, ApiEventTyped, IncomingApiMessage } from 'app/interfaces/api-message.interface';
 
 @Injectable({
   providedIn: 'root',
@@ -76,7 +76,7 @@ export class WebSocketConnectionService {
       },
     });
     this.wsAsObservable$ = this.ws$.asObservable().pipe(
-      switchMap((data: IncomingWebSocketMessage) => {
+      switchMap((data: IncomingApiMessage) => {
         if (this.hasAuthError(data)) {
           console.error(data);
           this.ws$.complete();
@@ -86,7 +86,7 @@ export class WebSocketConnectionService {
     );
     // At least one explicit subscription required to keep the connection open
     this.ws$.pipe(
-      tap((response: IncomingWebSocketMessage) => {
+      tap((response: IncomingApiMessage) => {
         if (response.msg === IncomingApiMessageType.Connected) {
           performance.mark('WS Connected');
           performance.measure('Establishing WS connection', 'WS Init', 'WS Connected');
@@ -129,7 +129,7 @@ export class WebSocketConnectionService {
     });
   }
 
-  private hasAuthError(data: IncomingWebSocketMessage): boolean {
+  private hasAuthError(data: IncomingApiMessage): boolean {
     return 'error' in data && data.error.error === 207;
   }