调试&实时日志

Author: wescai

README.md

@@ -5,16 +5,79 @@
 
 ## 已支持能力
 
+- [在线调试&实时日志功能](#在线调试&实时日志功能)
 - [实时日志功能](#实时日志功能)
 - [获取用户信息](#获取用户信息)
 - [一键登录功能](#一键登录功能)
 - [检测用户实名](#检测用户实名)
 - [判断中国用户](#判断中国用户)
 - [ServerlessApi](#ServerlessApi)
 
-
 ## 基本功能
 
+### 在线调试&实时日志功能
+基本使用方法(开启调试和实时日志)：
+```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.remoteDebug(auth, func, region))
+
+```
+输出结果：无
+
+输入参数：
+
+| 参数 | 必须 | 默认 | 描述 | 
+| --- | --- | --- | ---|
+| auth | 是 | - | 鉴权信息 |
+| func | 是 | - | 函数信息 |
+| region | 否 | ap-guangzhou | 地域 |
+
+auth参数描述：
+
+| 参数 | 必须 | 默认 | 描述 | 
+| --- | --- | --- | ---|
+| SecretId | 是 | - | 用户密钥Id |
+| SecretKey | 是 | - | 用户密钥Key |
+| token | 否 | - | 临时密钥需要传递此参数 |
+
+func参数描述：
+
+| 参数 | 必须 | 默认 | 描述 | 
+| --- | --- | --- | ---|
+| functionName | 是 | - | 地域 |
+| nameSpace | 否 | default | 命名空间 |
+| qualifier | 否 | $LATEST | 版本 |
+
+输出参数：
+
+无输出。调试和实时日志能力都集成在接口里面实现
+
+基本使用方法(结束调试模式)：
+```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

@@ -18,7 +18,14 @@
  "author": "Dfounderliu",
  "license": "Apache",
  "dependencies": {
- "dijkstrajs": "^1.0.1"
+ "@tencent-sdk/capi": "^0.2.15-alpha.0",
+ "dijkstrajs": "^1.0.1",
+ "duplexify": "^4.1.1",
+ "end-of-stream": "^1.4.4",
+ "https-proxy-agent": "^5.0.0",
+ "socket.io-client": "^2.3.0",
+ "socket.io-stream": "^0.9.1",
+ "winston": "^3.2.1"
  },
  "devDependencies": {
  "babel-eslint": "9.0.0",

sdk/debug/index.js

@@ -0,0 +1,32 @@
+const ApiRequest = require("./lib/apiRequest")
+const WshubClient = require("./lib/client")
+
+module.exports = {
+ ApiRequest,
+ WshubClient,
+ remoteDebug: async function (auth, func, Region = 'ap-guangzhou') {
+ 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()
+ },
+ stop: async function (auth, func, Region = 'ap-guangzhou') {
+ const request = new ApiRequest(auth, func, Region)
+ return request.stopDebugging()
+ }
+
+};

sdk/debug/lib/apiRequest.js

@@ -0,0 +1,90 @@
+const { Capi } = require('@tencent-sdk/capi');
+
+const ApiRequest = function (auth, func, Region, debugOptions) {
+ const { SecretId, SecretKey } = auth
+ const Token = auth.Token || auth.token
+ const body = {
+ FunctionName: func.functionName || func.FunctionName,
+ Namespace: func.nameSpace || func.Namespace || 'default',
+ Qualifier: func.Qualifier || func.qualifier || '$LATEST'
+ }
+ if (!SecretId || !SecretKey) {
+ throw Error('The SecretId or SecretKey does not exist.');
+ }
+ if (!body.FunctionName) {
+ throw Error('The FunctionName does not exist.');
+ }
+
+ this.client = new Capi({
+ Region,
+ SecretId,
+ SecretKey,
+ Token,
+ ServiceType: 'scf',
+ baseHost: 'tencentcloudapi.com'
+ });
+ this.commonParams = {
+ Version: '2018-04-16',
+ ...body
+ }
+ this.debugOptions = debugOptions
+}
+
+ApiRequest.prototype.request = async function (action, params) {
+ return this.client.request(
+ {
+ Action: action,
+ ...this.commonParams,
+ ...params,
+ },
+ this.debugOptions,
+ true
+ );
+}
+
+ApiRequest.prototype.startDebugging = async function (params) {
+ return this.request('StartDebugging', params);
+}
+
+ApiRequest.prototype.stopDebugging = async function (params) {
+ return this.request('StopDebugging', params);
+}
+
+ApiRequest.prototype.getDebuggingInfo = async function (params) {
+ const getDebuggingInfoPm = () => {
+ return new Promise((resolve, reject) => {
+ let debuggingInfo
+ let count = 0
+ let timer = setInterval(async () => {
+ try {
+ count++
+ if (count > 20) {
+ clearInterval(timer)
+ reject({
+ "Response":
+ {
+ "Error":
+ {
+ "Code": "Timeout",
+ "Message": "Get debugging info timeout."
+ }
+ }
+ })
+ }
+ debuggingInfo = await this.request('GetDebuggingInfo', params) || {}
+ const { Response = {} } = debuggingInfo
+ if (Response.Status === 'Active') {
+ resolve(Response.DebuggingInfo)
+ clearInterval(timer)
+ }
+ } catch (e) {
+ clearInterval(timer)
+ reject(e)
+ }
+ }, 2000);
+ })
+ }
+ return getDebuggingInfoPm()
+}
+
+module.exports = ApiRequest

sdk/debug/lib/client.js

@@ -0,0 +1,65 @@
+const { default: connect } = require('./wshub-client');
+const { default: createLogger } = require('./wshub-logger');
+
+const duplex = require('duplexify');
+
+const Client = function (options) {
+ const {
+ Url,
+ Token,
+ logType = 'error',
+ localPort = 9222,
+ debugRemotePort = 9000,
+ logRemotePort = 3332,
+ timeout,
+ } = options
+ //日志类型，verbose或者info，测试阶段建议verbose
+ this.logger = createLogger(logType)
+ //映射的本地端口，默认9222
+ this.localPort = localPort
+ //远端调试端口，默认9000
+ this.debugRemotePort = debugRemotePort
+ //远端日志端口，默认3222
+ this.logRemotePort = logRemotePort
+ //连接wshub的超时时间
+ this.timeout = timeout
+ this.Url = Url
+ this.Token = Token
+}
+
+/**
+ * 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 () {
+ return connect({ url: this.Url, token: this.Token, logger: this.logger, timeout: this.timeout })
+}
+
+
+/**
+ * forward for debug
+ * @param client ws-hub client
+ * @returns the client local port
+ */
+Client.prototype.forwardDebug = async function () {
+ if (!this.client) {
+ this.client = await this._connect()
+ }
+ return this.client.forward(this.localPort, this.debugRemotePort);
+}
+
+/**
+ * forward for real time log
+ * @param client ws-hub client
+ * @returns the client local port
+ */
+Client.prototype.forwardLog = async function () {
+ if (!this.client) {
+ this.client = await this._connect()
+ }
+ return this.client.forward(duplex(process.stdout, null, { end: false }), this.logRemotePort)
+}
+
+module.exports = Client

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

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var eos = require("end-of-stream");
+function pipe(stream1, stream2, cb) {
+ stream1.pipe(stream2);
+ stream2.pipe(stream1);
+ var closed = false;
+ var cleanup = function () {
+ if (closed) {
+ return;
+ }
+ if (!stream1.writableEnded) {
+ stream1.end();
+ }
+ if (!stream2.writableEnded) {
+ stream2.end();
+ }
+ closed = true;
+ cb();
+ };
+ eos(stream1, cleanup);
+ eos(stream2, cleanup);
+}
+exports.default = pipe;