stop时调用wsclient的关闭接口断开本地端口连接

Author: wescai

README.md

@@ -19,7 +19,7 @@
 基本使用方法(开启调试和实时日志)：
 ```javascript
 const tencentCloudTools = require('../../serverless-tencent-tools')
-const sdk = tencentCloudTools.Debug
+const Sdk = tencentCloudTools.Debug
 const region = 'ap-aaaaa'
 const auth = {
   SecretId: '****',
@@ -28,8 +28,12 @@ const auth = {
 const func = {
   functionName: 'course'
 }
-console.log(sdk.remoteDebug(auth, func, region))
+const sdk = new Sdk(auth, func, region)
+// 开启调试和实时日志
+await sdk.remoteDebug()
 
+// 调试后结束
+await sdk.stop()
 ```
 输出结果：无
 
@@ -61,23 +65,6 @@ func参数描述：
 
 无输出。调试和实时日志能力都集成在接口里面实现
 
-基本使用方法(结束调试模式)：
-```javascript
-const tencentCloudTools = require('../../serverless-tencent-tools')
-const sdk = tencentCloudTools.Debug
-const region = 'ap-aaaaa'
-const auth = {
-  SecretId: '****',
-  SecretKey: '*****'
-}
-const func = {
-  functionName: 'course'
-}
-console.log(sdk.stop(auth, func, region))
-
-```
-输出结果：stop接口返回内容
-
 ### 实时日志功能
 基本使用方法(getAddr)：
 ```javascript

package.json

@@ -35,4 +35,4 @@
     "eslint-plugin-prettier": "^3.0.1",
     "prettier": "^1.18.2"
   }
-}
+}

sdk/debug/index.js

@@ -1,39 +1,45 @@
 const ApiRequest = require("./lib/apiRequest")
 const WshubClient = require("./lib/client")
 
-module.exports = {
-    ApiRequest,
-    WshubClient,
-    remoteDebug: async function (auth, func, Region = 'ap-guangzhou') {
+const RemoteDebug = function (auth, func, Region = 'ap-guangzhou') {
+    this.auth = auth
+    this.func = func
+    this.Region = Region
+    this.request = new ApiRequest(auth, func, Region)
+}
+
+RemoteDebug.prototype.remoteDebug = async function () {
+    try {
+        await this.request.startDebugging()
+        const { Url, Token } = await this.request.getDebuggingInfo()
+        if (!Url || !Token) {
+            throw Error('Get debugging info error: the remote Url or Token does not exist.');
+        }
+        this.client = new WshubClient({ Url, Token })
         try {
-            const request = new ApiRequest(auth, func, Region)
-            await request.startDebugging()
-            const { Url, Token } = await request.getDebuggingInfo()
-            if (!Url || !Token) {
-                throw Error('Get debugging info error: the remote Url or Token does not exist.');
-            }
-            const client = new WshubClient({ Url, Token })
-            try {
-                await client.forwardDebug()
-                console.log('Debugging listening on ws://127.0.0.1:9222.')
-                console.log('For help see https://nodejs.org/en/docs/inspector.')
-                console.log('Please open chorme, and visit chrome://inspect, click [Open dedicated DevTools for Node] to debug your code.')
-            } catch (e) {
-                console.error('Debug init error. Please confirm if the local port 9222 is used');
-            }
-            console.log('--------------------- The realtime log ---------------------')
-            await client.forwardLog()
+            await this.client.forwardDebug()
+            console.log('Debugging listening on ws://127.0.0.1:9222.')
+            console.log('For help see https://nodejs.org/en/docs/inspector.')
+            console.log('Please open chorme, and visit chrome://inspect, click [Open dedicated DevTools for Node] to debug your code.')
         } catch (e) {
-            console.error(e.message)
+            console.error('Debug init error. Please confirm if the local port 9222 is used');
         }
+        console.log('--------------------- The realtime log ---------------------')
+        await this.client.forwardLog()
+    } catch (e) {
+        console.error(e.message)
+    }
+}
 
-    },
-    stop: async function (auth, func, Region = 'ap-guangzhou') {
-        try {
-            const request = new ApiRequest(auth, func, Region)
-            return await request.stopDebugging()
-        } catch (e) {
-            console.error(e.message)
+RemoteDebug.prototype.stop = async function () {
+    try {
+        if (this.client) {
+            this.client.close()
         }
+        return await this.request.stopDebugging()
+    } catch (e) {
+        console.error(e.message)
     }
-};
+}
+
+module.exports = RemoteDebug

sdk/debug/lib/client.js

@@ -29,8 +29,6 @@ const Client = function (options) {
 
 /**
  * connect to ws-hub service
- * @param url ws-hub service url
- * @param token ws-hub token
  * @returns the client promise
  */
 Client.prototype._connect = async function () {
@@ -40,7 +38,6 @@ Client.prototype._connect = async function () {
 
 /**
  * forward for debug
- * @param client ws-hub client
  * @returns the client local port
  */
 Client.prototype.forwardDebug = async function () {
@@ -52,7 +49,6 @@ Client.prototype.forwardDebug = async function () {
 
 /**
  * forward for real time log
- * @param client ws-hub client
  * @returns the client local port
  */
 Client.prototype.forwardLog = async function () {
@@ -62,4 +58,14 @@ Client.prototype.forwardLog = async function () {
     return this.client.forward(duplex(process.stdout, null, { end: false }), this.logRemotePort)
 }
 
+/**
+ * close the client
+ * @returns close result
+ */
+Client.prototype.close = async function () {
+    if (this.client) {
+        return this.client.close()
+    }
+}
+
 module.exports = Client

sdk/debug/lib/wshub-client/index.js

@@ -1,18 +1,18 @@
 "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt (value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled (value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected (value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step (result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
 var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function () { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function () { return this; }), g;
-    function verb (n) { return function (v) { return step([n, v]); }; }
-    function step (op) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
         while (_) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
@@ -46,15 +46,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var socketIo = require("socket.io-client");
 var socketIoStream = require("socket.io-stream");
 var net_1 = require("net");
-var wshub_bipipe_1 = require("../wshub-bipipe");
-var wshub_proxy_1 = require("../wshub-proxy");
-var wshub_types_1 = require("../wshub-types");
-function normalizeListenArgs (portOrPath) {
+var wshub_bipipe_1 = require("@tencent/wshub-bipipe");
+var wshub_proxy_1 = require("@tencent/wshub-proxy");
+var wshub_types_1 = require("@tencent/wshub-types");
+function normalizeListenArgs(portOrPath) {
     var port = Number(portOrPath);
     return port >= 0 ? [port, '127.0.0.1'] : [portOrPath];
 }
 var Client = /** @class */ (function () {
-    function Client (socket, streamSocket, logger) {
+    function Client(socket, streamSocket, logger) {
         this.socket = socket;
         this.streamSocket = streamSocket;
         this.logger = logger;
@@ -101,13 +101,14 @@ var Client = /** @class */ (function () {
                             local.unref();
                             sendStream(local, ":" + clientPort + " -> :" + targetName);
                         });
+                        this.socket.on('disconnect', function () { return tcpServer.close(); });
                         tcpServer.unref();
                         tcpServer.on('error', function (e) { return _this.logger.error("tcp server error " + e); });
                         return [2 /*return*/, new Promise(function (resolve) {
-                            tcpServer.listen.apply(tcpServer, __spreadArrays(normalizeListenArgs(clientPort), [function () {
-                                resolve(tcpServer.address());
-                            }]));
-                        })];
+                                tcpServer.listen.apply(tcpServer, __spreadArrays(normalizeListenArgs(clientPort), [function () {
+                                        resolve(tcpServer.address());
+                                    }]));
+                            })];
                 }
             });
         });
@@ -137,33 +138,33 @@ var Client = /** @class */ (function () {
     };
     return Client;
 }());
-function connect (options) {
+function connect(options) {
     var url = options.url, token = options.token, logger = options.logger, _a = options.timeout, timeout = _a === void 0 ? -1 : _a;
     var agent = wshub_proxy_1.default();
     var socket = socketIo.connect(url, { query: { token: token }, agent: agent });
     var streamSocket = socketIoStream(socket);
     streamSocket
         .on('forward', function (remote, clientPort, serverPort) {
-            var streamName = ":" + clientPort + " <- :" + serverPort;
-            var target = net_1.createConnection(clientPort).unref();
-            target
-                .once('connect', function () {
-                    logger.verbose(streamName + " connected");
-                    wshub_bipipe_1.default(remote, target, function () {
-                        logger.verbose(streamName + " closed");
-                    });
-                })
-                .on('error', function (err) {
-                    logger.error(streamName + " error '" + err + "'");
-                    remote.end();
-                });
+        var streamName = ":" + clientPort + " <- :" + serverPort;
+        var target = net_1.createConnection(clientPort).unref();
+        target
+            .once('connect', function () {
+            logger.verbose(streamName + " connected");
+            wshub_bipipe_1.default(remote, target, function () {
+                logger.verbose(streamName + " closed");
+            });
         })
+            .on('error', function (err) {
+            logger.error(streamName + " error '" + err + "'");
+            remote.end();
+        });
+    })
         .on('error', function () { return socket.disconnect(); });
     socket
         .on('disconnect', function (reason) {
-            logger.info("disconnected for " + reason);
-            socket.disconnect();
-        });
+        logger.info("disconnected for " + reason);
+        socket.disconnect();
+    });
     return new Promise(function (resolve, reject0) {
         var reject = function () {
             var args = [];