@milaboratories/pl-client 2.16.15 → 2.16.17

package/src/core/errors.ts

@@ -3,6 +3,8 @@ import { Aborted } from '@milaboratories/ts-helpers';
 import { Code } from '../proto-grpc/google/rpc/code';
 
 export function isConnectionProblem(err: unknown, nested: boolean = false): boolean {
+  if (err === undefined || err === null) return false;
+
   if (err instanceof DisconnectedError) return true;
   if ((err as any).name == 'RpcError' && (err as any).code == 'UNAVAILABLE') return true;
   if ((err as any).name == 'RESTError' && (err as any).status.code == Code.UNAVAILABLE) return true;
@@ -11,6 +13,8 @@ export function isConnectionProblem(err: unknown, nested: boolean = false): bool
 }
 
 export function isUnauthenticated(err: unknown, nested: boolean = false): boolean {
+  if (err === undefined || err === null) return false;
+
   if (err instanceof UnauthenticatedError) return true;
   if ((err as any).name == 'RpcError' && (err as any).code == 'UNAUTHENTICATED') return true;
   if ((err as any).name == 'RESTError' && (err as any).status.code == Code.UNAUTHENTICATED) return true;
@@ -19,6 +23,8 @@ export function isUnauthenticated(err: unknown, nested: boolean = false): boolea
 }
 
 export function isTimeoutError(err: unknown, nested: boolean = false): boolean {
+  if (err === undefined || err === null) return false;
+
   if ((err as any).name == 'TimeoutError') return true;
   if ((err as any).name == 'RpcError' && (err as any).code == 'DEADLINE_EXCEEDED') return true;
   if ((err as any).name == 'RESTError' && (err as any).status.code == Code.DEADLINE_EXCEEDED) return true;
@@ -27,6 +33,8 @@ export function isTimeoutError(err: unknown, nested: boolean = false): boolean {
 }
 
 export function isCancelError(err: unknown, nested: boolean = false): boolean {
+  if (err === undefined || err === null) return false;
+
   if ((err as any).name == 'RpcError' && (err as any).code == 'CANCELLED') return true;
   if ((err as any).name == 'RESTError' && (err as any).status.code == Code.CANCELLED) return true;
   if ((err as any).cause !== undefined && !nested) return isCancelError((err as any).cause, true);
@@ -34,6 +42,8 @@ export function isCancelError(err: unknown, nested: boolean = false): boolean {
 }
 
 export function isAbortedError(err: unknown, nested: boolean = false): boolean {
+  if (err === undefined || err === null) return false;
+
   if (err instanceof Aborted || (err as any).name == 'AbortError') return true;
   if ((err as any).code == 'ABORT_ERR') return true;
   if (err instanceof DOMException && err.code === DOMException.ABORT_ERR) return true; // WebSocket error
@@ -44,6 +54,8 @@ export function isAbortedError(err: unknown, nested: boolean = false): boolean {
 }
 
 export function isTimeoutOrCancelError(err: unknown, nested: boolean = false): boolean {
+  if (err === undefined || err === null) return false;
+
   if (isAbortedError(err, true)) return true;
   if (isTimeoutError(err, true)) return true;
   if (isCancelError(err, true)) return true;
@@ -52,6 +64,8 @@ export function isTimeoutOrCancelError(err: unknown, nested: boolean = false): b
 }
 
 export function isNotFoundError(err: unknown, nested: boolean = false): boolean {
+  if (err === undefined || err === null) return false;
+
   if ((err as any).name == 'RpcError' && (err as any).code == 'NOT_FOUND') return true;
   if ((err as any).name == 'RESTError' && (err as any).status.code == Code.NOT_FOUND) return true;
   if ((err as any).cause !== undefined && !nested) return isNotFoundError((err as any).cause, true);

package/src/core/ll_client.ts

@@ -30,6 +30,8 @@ import { notEmpty, retry, withTimeout, type RetryOptions } from '@milaboratories
 import { Code } from '../proto-grpc/google/rpc/code';
 import { WebSocketBiDiStream } from './websocket_stream';
 import { TxAPI_ClientMessage, TxAPI_ServerMessage } from '../proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api';
+import type { MiLogger } from '@milaboratories/ts-helpers';
+import { isAbortedError } from './errors';
 
 export interface PlCallOps {
   timeout?: number;
@@ -86,6 +88,7 @@ export class LLPlClient implements WireClientProviderFactory {
       auth?: AuthOps;
       statusListener?: PlConnectionStatusListener;
       shouldUseGzip?: boolean;
+      logger?: MiLogger;
     } = {},
   ) {
     const conf = typeof configOrAddress === 'string' ? plAddressToConfig(configOrAddress) : configOrAddress;
@@ -101,6 +104,7 @@ export class LLPlClient implements WireClientProviderFactory {
       auth?: AuthOps;
       statusListener?: PlConnectionStatusListener;
       shouldUseGzip?: boolean;
+      logger?: MiLogger;
     } = {},
   ) {
     const { auth, statusListener } = ops;
@@ -466,20 +470,47 @@ export class LLPlClient implements WireClientProviderFactory {
       return;
     }
 
+    // Each retry is:
+    //  - ping request timeout (100 to 3_000ms)
+    //  - backoff delay (30 to 500ms)
+    //
+    // 30 attempts are ~43 seconds of overall waiting time.
+    // Think twice on overall time this thing takes to complete when changing these parameters.
+    // It may block UI when connecting to the server and loading projects list.
+    const pingTimeoutFactor = 1.3;
+    const maxPingTimeoutMs = 3_000;
     const retryOptions: RetryOptions = {
       type: 'exponentialBackoff',
-      maxAttempts: 80,
+      maxAttempts: 30,
       initialDelay: 30,
       backoffMultiplier: 1.3,
       jitter: 0.2,
       maxDelay: 500,
     };
 
+    let attempt = 1;
+    let pingTimeoutMs = 100;
     await retry(
-      () => withTimeout(this.ping(), 500),
+      () => withTimeout(this.ping(), pingTimeoutMs),
       retryOptions,
-      () => {
+      (e: unknown) => {
+        if (isAbortedError(e)) {
+          this.ops.logger?.info(`Wire proto autodetect: ping timed out after ${pingTimeoutMs}ms: attempt=${attempt}, wire=${this._wireProto}`);
+
+          if (attempt % 2 === 0) {
+            // We have 2 wire protocols to check. Increase timeout each 2 attempts.
+            pingTimeoutMs = Math.min(
+              Math.round(pingTimeoutMs * pingTimeoutFactor),
+              maxPingTimeoutMs,
+            );
+          }
+        } else {
+          this.ops.logger?.info(`Wire proto autodetect: ping failed: attempt=${attempt}, wire=${this._wireProto}, err=${String(e)}`);
+        }
+
+        attempt++;
         const protocol = this._wireProto === 'grpc' ? 'rest' : 'grpc';
+        this.ops.logger?.info(`Wire protocol autodetect next attempt: will try wire '${protocol}' with timeout ${pingTimeoutMs}ms`);
         this.initWireConnection(protocol);
         return true;
       });

package/src/core/unauth_client.ts

@@ -4,7 +4,7 @@ import type {
   MaintenanceAPI_Ping_Response,
 } from '../proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api';
 import { LLPlClient } from './ll_client';
-import { notEmpty } from '@milaboratories/ts-helpers';
+import { type MiLogger, notEmpty } from '@milaboratories/ts-helpers';
 import { UnauthenticatedError } from './errors';
 
 /** Primarily used for initial authentication (login) */
@@ -15,8 +15,8 @@ export class UnauthenticatedPlClient {
     this.ll = ll;
   }
 
-  public static async build(configOrAddress: PlClientConfig | string): Promise<UnauthenticatedPlClient> {
-    const ll = await LLPlClient.build(configOrAddress);
+  public static async build(configOrAddress: PlClientConfig | string, ops?: { logger?: MiLogger }): Promise<UnauthenticatedPlClient> {
+    const ll = await LLPlClient.build(configOrAddress, ops);
     return new UnauthenticatedPlClient(ll);
   }