Pass the agent parameter to WebSocket to support accessing the target service through a proxy

Author: xqin

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@larksuiteoapi/node-sdk",
-  "version": "1.51.0",
+  "version": "1.52.0",
   "description": "larksuite open sdk for nodejs",
   "keywords": [
     "feishu",

typings/http.ts

@@ -1,12 +1,15 @@
+import { AxiosDefaults } from 'axios';
+
 export interface HttpInstance {
   request<T = any, R = T, D = any>(opts: HttpRequestOptions<D>): Promise<R>;
-	get<T = any, R = T, D = any>(url: string, opts?: HttpRequestOptions<D>): Promise<R>;
-	delete<T = any, R = T, D = any>(url: string, opts?: HttpRequestOptions<D>): Promise<R>;
-	head<T = any, R = T, D = any>(url: string, opts?: HttpRequestOptions<D>): Promise<R>;
-	options<T = any, R = T, D = any>(url: string, opts?: HttpRequestOptions<D>): Promise<R>;
-	post<T = any, R = T, D = any>(url: string, data?: D, opts?: HttpRequestOptions<D>): Promise<R>;
-	put<T = any, R = T, D = any>(url: string, data?: D, opts?: HttpRequestOptions<D>): Promise<R>;
-	patch<T = any, R = T, D = any>(url: string, data?: D, opts?: HttpRequestOptions<D>): Promise<R>;
+  get<T = any, R = T, D = any>(url: string, opts?: HttpRequestOptions<D>): Promise<R>;
+  delete<T = any, R = T, D = any>(url: string, opts?: HttpRequestOptions<D>): Promise<R>;
+  head<T = any, R = T, D = any>(url: string, opts?: HttpRequestOptions<D>): Promise<R>;
+  options<T = any, R = T, D = any>(url: string, opts?: HttpRequestOptions<D>): Promise<R>;
+  post<T = any, R = T, D = any>(url: string, data?: D, opts?: HttpRequestOptions<D>): Promise<R>;
+  put<T = any, R = T, D = any>(url: string, data?: D, opts?: HttpRequestOptions<D>): Promise<R>;
+  patch<T = any, R = T, D = any>(url: string, data?: D, opts?: HttpRequestOptions<D>): Promise<R>;
+  defaults: AxiosDefaults;
 }
 
 export type ResponseType =
@@ -18,13 +21,13 @@ export type ResponseType =
   | 'stream';
 
 export interface HttpRequestOptions<D> {
-	url?: string;
-	method?: string;
-	headers?: Record<string, any>;
-	params?: Record<string, any>;
-	data?: D;
-	responseType?: ResponseType;
-	paramsSerializer?: (params: Record<string, any>) => string;
-	timeout?: number;
-	$return_headers?: boolean;
+  url?: string;
+  method?: string;
+  headers?: Record<string, any>;
+  params?: Record<string, any>;
+  data?: D;
+  responseType?: ResponseType;
+  paramsSerializer?: (params: Record<string, any>) => string;
+  timeout?: number;
+  $return_headers?: boolean;
 }

ws-client/index.ts

@@ -46,21 +46,21 @@ export class WSClient {
   }
 
   constructor(params: IConstructorParams) {
-    const { 
-      appId, 
-      appSecret, 
-      domain = Domain.Feishu, 
+    const {
+      appId,
+      appSecret,
+      domain = Domain.Feishu,
       httpInstance = defaultHttpInstance,
       loggerLevel = LoggerLevel.info,
       logger = defaultLogger,
       autoReconnect = true
     } = params;
 
     this.logger = new LoggerProxy(loggerLevel, logger);
-    
+
     assert(!appId, () => this.logger.error('appId is needed'));
     assert(!appSecret, () => this.logger.error('appSecret is needed'));
-    
+
     this.dataCache = new DataCache({logger: this.logger});
     this.httpInstance = httpInstance;
     this.wsConfig.updateClient({
@@ -72,10 +72,10 @@ export class WSClient {
     this.wsConfig.updateWs({
       autoReconnect
     })
-  }  
+  }
 
   private async pullConnectConfig() {
-    const { 
+    const {
       appId,
       appSecret
     } = this.wsConfig.getClient();
@@ -116,7 +116,7 @@ export class WSClient {
 
       this.wsConfig.updateWs({
         connectUrl: URL,
-        
+
         deviceId: device_id as string,
         serviceId: service_id as string,
 
@@ -141,7 +141,8 @@ export class WSClient {
     let wsInstance;
 
     try {
-      wsInstance = new WebSocket(connectUrl);
+      const { httpsAgent, httpAgent } = this.httpInstance.defaults;
+      wsInstance = new WebSocket(connectUrl, { agent: httpsAgent || httpAgent });
     } catch(e) {
       this.logger.error('[ws]', 'new WebSocket error');
     }
@@ -214,17 +215,17 @@ export class WSClient {
     }
 
     const { autoReconnect, reconnectNonce, reconnectCount, reconnectInterval } = this.wsConfig.getWS();
-    
+
     if (!autoReconnect) {
       return;
     }
 
     this.logger.info('[ws]', 'reconnect');
-    
+
     if (wsInstance) {
       wsInstance?.terminate();
     }
-    
+
     this.wsConfig.setWSInstance(null);
 
     const reconnectNonceTime = reconnectNonce ? reconnectNonce * Math.random() : 0
@@ -256,7 +257,7 @@ export class WSClient {
   }
 
   private pingLoop() {
-    const { 
+    const {
       serviceId,
       pingInterval
     } = this.wsConfig.getWS();
@@ -310,7 +311,7 @@ export class WSClient {
   private async handleControlData(data: pbbp2.Frame) {
     const type = data.headers.find(item => item.key === HeaderKey.type)?.value;
     const payload = data.payload;
-    
+
     if (type === MessageType.ping) {
       return;
     }