fix: add missing memory circuit breaker options (opensearch-project#266)

Signed-off-by: Robert Da Silva <mail@robdasilva.com>
AMoo-Miki · Jul 12, 2023 · 4678ab0 · 4678ab0
1 parent f5c6d16
commit 4678ab0
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 6 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -45,6 +45,7 @@ import Transport, {
   RequestBody,
   RequestNDBody,
   Context,
+  MemoryCircuitBreakerOptions,
 } from './lib/Transport';
 import { URL } from 'url';
 import Connection, { AgentOptions, agentFn } from './lib/Connection';
@@ -137,10 +138,7 @@ interface ClientOptions {
     password?: string;
   };
   disablePrototypePoisoningProtection?: boolean | 'proto' | 'constructor';
-  memoryCircuitBreaker?: {
-    enabled: boolean;
-    maxPercentage: number;
-  };
+  memoryCircuitBreaker?: MemoryCircuitBreakerOptions
 }
 
 declare class Client {

diff --git a/lib/Transport.d.ts b/lib/Transport.d.ts
@@ -29,10 +29,10 @@
  */
 
 import { Readable as ReadableStream } from 'stream';
-import { ConnectionPool, CloudConnectionPool } from './pool';
 import Connection from './Connection';
-import Serializer from './Serializer';
 import * as errors from './errors';
+import { CloudConnectionPool, ConnectionPool } from './pool';
+import Serializer from './Serializer';
 
 export type ApiError =
   | errors.ConfigurationError
@@ -59,6 +59,11 @@ export interface generateRequestIdFn {
   (params: TransportRequestParams, options: TransportRequestOptions): any;
 }
 
+export interface MemoryCircuitBreakerOptions {
+  enabled: boolean;
+  maxPercentage: number;
+}
+
 interface TransportOptions {
   emit: (event: string | symbol, ...args: any[]) => boolean;
   connectionPool: ConnectionPool | CloudConnectionPool;
@@ -77,6 +82,7 @@ interface TransportOptions {
   generateRequestId?: generateRequestIdFn;
   name?: string;
   opaqueIdPrefix?: string;
+  memoryCircuitBreaker?: MemoryCircuitBreakerOptions;
 }
 
 export interface RequestEvent<TResponse = Record<string, any>, TContext = Context> {
@@ -172,6 +178,7 @@ export default class Transport {
   sniffInterval: number;
   sniffOnConnectionFault: boolean;
   opaqueIdPrefix: string | null;
+  memoryCircuitBreaker: MemoryCircuitBreakerOptions | undefined;
   sniffEndpoint: string;
   _sniffEnabled: boolean;
   _nextSniff: number;