tencentcloud-sdk-nodejs-intl-en 3.0.871 → 3.0.872

package/examples/cls/v20201016/cls.proto

@@ -0,0 +1,34 @@
+syntax = "proto2";
+
+package cls;
+
+message Log
+{
+    message Content
+    {
+        required string key   = 1; // 每组字段的 key
+        required string value = 2; // 每组字段的 value
+    }
+    required int64   time     = 1; // 时间戳，UNIX时间格式
+    repeated Content contents = 2; // 一条日志里的多个kv组合
+}
+
+message LogTag
+{
+    required string key       = 1;
+    required string value     = 2;
+}
+
+message LogGroup
+{
+    repeated Log    logs        = 1; // 多条日志合成的日志数组
+    optional string contextFlow = 2; // 目前暂无效用
+    optional string filename    = 3; // 日志文件名
+    optional string source      = 4; // 日志来源，一般使用机器IP
+    repeated LogTag logTags     = 5;
+}
+
+message LogGroupList
+{
+    repeated LogGroup logGroupList = 1; // 日志组列表
+}

package/examples/cls/v20201016/upload_log.js

@@ -0,0 +1,68 @@
+const tencentcloud = require("../../../../tencentcloud-sdk-nodejs-intl-en");
+const protobuf = require("protobufjs")
+const lz4 = require("lz4")
+const path = require("path")
+
+const Credential = tencentcloud.common.Credential;
+const ClientProfile = tencentcloud.common.ClientProfile;
+const HttpProfile = tencentcloud.common.HttpProfile;
+const CommonClient = tencentcloud.common.CommonClient
+
+let cred = new Credential(process.env.TENCENTCLOUD_SECRET_ID, process.env.TENCENTCLOUD_SECRET_KEY);
+
+let httpProfile = new HttpProfile();
+httpProfile.endpoint = "cls.tencentcloudapi.com";
+httpProfile.headers["X-CLS-TopicId"] = "c241abf2-7acd-470d-845a-fb1da6916c99"; // 替换为自己业务的 topic
+httpProfile.headers["X-CLS-HashKey"] = ""; // 可选参数
+httpProfile.headers["X-CLS-CompressType"] = "lz4"; // lz4压缩方式, 空字符串意味不压缩
+
+let clientProfile = new ClientProfile();
+clientProfile.signMethod = "TC3-HMAC-SHA256";
+clientProfile.httpProfile = httpProfile;
+
+let client = new CommonClient('cls.tencentcloudapi.com', '2020-10-16', cred, "ap-guangzhou", clientProfile);
+
+let params = compress(getBodyInfo())
+
+client.requestOctetStream('UploadLog', params, function(err, response) {
+  if (err) {
+    console.log(err);
+    return;
+  }
+
+  console.log(response)
+})
+
+
+function compress(input) {
+  const output = Buffer.alloc(lz4.encodeBound(input.length))
+  const compressedBlockSize = lz4.encodeBlock(input, output)
+  return output.slice(0, compressedBlockSize)
+}
+
+function getBodyInfo() {
+  const root = protobuf.loadSync(path.join(__dirname, "cls.proto"))
+  const LogGroupList = root.lookupType("cls.LogGroupList")
+  const payload = {
+    logGroupList: [
+      {
+        logs: [
+          {
+            time: Date.now(),
+            contents: [
+              {
+                key: "name",
+                value: "张三",
+              },
+              {
+                key: "age",
+                value: "18",
+              },
+            ],
+          },
+        ],
+      },
+    ],
+  }
+  return LogGroupList.encode(payload).finish()
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs-intl-en",
-  "version": "3.0.871",
+  "version": "3.0.872",
   "description": "腾讯云 API NODEJS SDK",
   "main": "index.js",
   "scripts": {

package/tencentcloud/common/abstract_client.js

@@ -4,6 +4,7 @@ const ClientProfile = require("./profile/client_profile");
 const Sign = require("./sign");
 const HttpConnection = require("./http/http_connection");
 const TencentCloudSDKHttpException = require("./exception/tencent_cloud_sdk_exception");
+const SSEResponseModel = require("./sse_response_model");
 
 /**
  * @inner
@@ -80,6 +81,26 @@ class AbstractClient {
         }
     }
 
+    /**
+     * @inner
+     */
+    requestOctetStream(action, req, resp, options, cb) {
+        if (typeof options === 'function') {
+            cb = options
+            options = {}
+        }
+        options = Object.assign({}, options, {
+            headers: {
+              "Content-Type": "application/octet-stream; charset=utf-8",
+            }
+        })
+        if (this.profile.signMethod === 'TC3-HMAC-SHA256') {
+            this.doRequestWithSign3(action, req, options).then(data => this.succRequest(resp, cb, data), error => this.failRequest(error, cb));
+        } else {
+            this.doRequest(action, req).then(data => this.succRequest(resp, cb, data), error => this.failRequest(error, cb));
+        }
+    }
+
     /**
      * @inner
      */
@@ -92,7 +113,8 @@ class AbstractClient {
                 method: this.profile.httpProfile.reqMethod,
                 url: this.profile.httpProfile.protocol + this.getEndpoint() + this.path,
                 data: params,
-                timeout: this.profile.httpProfile.reqTimeout * 1000
+                timeout: this.profile.httpProfile.reqTimeout * 1000,
+                headers: Object.assign({}, this.profile.httpProfile.headers),
             });
         } catch (error) {
             throw new TencentCloudSDKHttpException(error.message);
@@ -119,7 +141,8 @@ class AbstractClient {
                 multipart: options.multipart,
                 timeout: this.profile.httpProfile.reqTimeout * 1000,
                 token: this.credential.token,
-                requestClient: this.sdkVersion
+                requestClient: this.sdkVersion,
+                headers: Object.assign({}, this.profile.httpProfile.headers, options.headers),
             })
         } catch (e) {
             throw new TencentCloudSDKHttpException(e.message)
@@ -133,13 +156,17 @@ class AbstractClient {
             tcError.httpCode = res.status
             throw tcError;
         } else {
-            const data = await res.json();
-            if (data.Response.Error) {
-                const tcError = new TencentCloudSDKHttpException(data.Response.Error.Message, data.Response.RequestId)
-                tcError.code = data.Response.Error.Code
-                throw tcError;
+            if (res.headers.get("content-type") === "text/event-stream") {
+                return new SSEResponseModel(res.body)
             } else {
-                return data.Response;
+                const data = await res.json();
+                if (data.Response.Error) {
+                    const tcError = new TencentCloudSDKHttpException(data.Response.Error.Message, data.Response.RequestId)
+                    tcError.code = data.Response.Error.Code
+                    throw tcError;
+                } else {
+                    return data.Response;
+                }
             }
         }
     }

package/tencentcloud/common/common_client.js

@@ -0,0 +1,31 @@
+const AbstractClient = require('./abstract_client')
+const SSEResponseModel = require("./sse_response_model");
+
+class CommonClient extends AbstractClient {
+  /**
+   * @inner
+   */
+  succRequest(resp, cb, data) {
+    if (data instanceof SSEResponseModel) {
+      cb(null, data);
+      return;
+    }
+    cb(null, JSON.stringify(data))
+  }
+
+  /**
+   * @inner
+   */
+  request(action, params, options, cb) {
+    super.request(action, params, null, options, cb);
+  }
+
+  /**
+   * @inner
+   */
+  requestOctetStream(action, params, options, cb) {
+    super.requestOctetStream(action, params, null, options, cb);
+  }
+}
+
+module.exports = CommonClient;

package/tencentcloud/common/http/http_connection.js

@@ -10,10 +10,10 @@ const fetch = require('./fetch');
  * @inner
  */
 class HttpConnection {
-    static async doRequest({ method, url, data, timeout }) {
+    static async doRequest({ method, url, data, timeout, headers }) {
         let config = {
             method: method,
-            headers: {},
+            headers,
             timeout
         };
         if (method === "GET") {
@@ -38,7 +38,8 @@ class HttpConnection {
         multipart = false,
         timeout = 60000,
         token,
-        requestClient
+        requestClient,
+        headers = {}
     }) {
         // data 中可能带有 readStream，由于需要计算整个 body 的 hash，
         // 所以这里把 readStream 转为 Buffer
@@ -68,7 +69,8 @@ class HttpConnection {
                 'X-TC-Timestamp': timestamp,
                 'X-TC-Version': version,
                 'X-TC-Token': token,
-                'X-TC-RequestClient': requestClient
+                'X-TC-RequestClient': requestClient,
+                ...headers,
             }
         }
 
@@ -81,8 +83,10 @@ class HttpConnection {
             config.headers['Content-Type'] = 'application/x-www-form-urlencoded'
         }
         if (method === 'POST' && !multipart) {
-            config.body = JSON.stringify(data)
-            config.headers['Content-Type'] = 'application/json'
+            config.body = data
+            const contentType = config.headers["Content-Type"] || "application/json"
+            if (!isBuffer(data)) config.body = JSON.stringify(data)
+            config.headers["Content-Type"] = contentType
         }
         if (method === 'POST' && multipart) {
             form = new FormData();
@@ -102,7 +106,8 @@ class HttpConnection {
             secretId,
             secretKey,
             multipart,
-            boundary: form ? form.getBoundary() : undefined
+            boundary: form ? form.getBoundary() : undefined,
+            headers: config.headers,
         })
 
         config.headers['Authorization'] = signature

package/tencentcloud/common/index.js

@@ -3,4 +3,6 @@ module.exports = {
     ClientProfile: require("./profile/client_profile"),
     HttpProfile: require("./profile/http_profile"),
     Credential: require("./credential"),
+    SSEResponseModel: require("./sse_response_model"),
+    CommonClient: require("./common_client"),
 };

package/tencentcloud/common/profile/http_profile.js

@@ -2,6 +2,11 @@
  * HTTP settings.
  * @class
  */
+/**
+ * @typedef {Object.<string, string>} StringRecord
+ * @property {string} key
+ * @property {string} value
+ */
 class HttpProfile {
 
     /**
@@ -9,8 +14,9 @@ class HttpProfile {
      * @param {string} endpoint Domain name, such as cvm.ap-shanghai.tencentcloud.com.
      * @param {string} reqMethod HTTP method, only supports GET and POST.
      * @param {number} reqTimeout Request timeout value, in seconds, default 60.
+     * @param {StringRecord} headers HTTP headers, default {}.
      */
-    constructor(protocol, endpoint, reqMethod, reqTimeout) {
+    constructor(protocol, endpoint, reqMethod, reqTimeout, headers) {
         /**
          * @type {string}
          */
@@ -30,6 +36,11 @@ class HttpProfile {
          * @type {number}
          */
         this.reqTimeout = reqTimeout || 60;
+
+        /**
+         * @type {StringRecord}
+         */
+        this.headers = headers || {};
     }
 }
 module.exports = HttpProfile;

package/tencentcloud/common/sdk_version.js

@@ -1,2 +1,2 @@
-const sdkVersion = "3.0.871";
+const sdkVersion = "3.0.872";
 module.exports = sdkVersion

package/tencentcloud/common/sign.js

@@ -29,22 +29,24 @@ class Sign {
         secretId,
         secretKey,
         multipart,
-        boundary
+        boundary,
+        headers: configHeaders = {},
     }) {
         const urlObj = new URL(url)
+        const contentType = configHeaders["Content-Type"]
     
         // 通用头部
         let headers = ''
         let signedHeaders = ''
         if (method === 'GET') {
             signedHeaders = 'content-type'
-            headers = 'content-type:application/x-www-form-urlencoded\n'
+            headers = `content-type:${contentType}\n`
         } else if (method === 'POST') {
             signedHeaders = 'content-type'
             if (multipart) {
                 headers = `content-type:multipart/form-data; boundary=${boundary}\n`
             } else {
-                headers = 'content-type:application/json\n'
+                headers = `content-type:${contentType}\n`
             }
         }
         headers += `host:${urlObj.hostname}\n`
@@ -72,7 +74,8 @@ class Sign {
             hash.update(`--\r\n`)
             payload_hash = hash.digest('hex')
         } else {
-            payload_hash = payload ? getHash(JSON.stringify(payload)) : getHash('')
+            const hashMessage = Buffer.isBuffer(payload) ? payload : JSON.stringify(payload)
+            payload_hash = payload ? getHash(hashMessage) : getHash('')
         }
     
         const canonicalRequest =

package/tencentcloud/common/sse_response_model.js

@@ -0,0 +1,154 @@
+const { EventEmitter } = require('events')
+
+/**
+ * @interface EventSourceMessage
+ * @description Represents a type EventSourceMessage.
+ * @property {string} id - The event ID to set the EventSource object's last event ID value.
+ * @property {string} event - A string identifying the type of event described.
+ * @property {string} data - The event data.
+ * @property {string} retry - The reconnection interval (in milliseconds) to wait before retrying the connection (optional).
+ */
+
+class SSEEventEmitter extends EventEmitter {}
+
+class SSEResponseModel {
+  /**
+   * Initialize the SSE response model.
+   * @param {NodeJS.ReadableStream} stream
+   */
+  constructor(stream) {
+    this.stream = stream
+    this.eventSource = new SSEEventEmitter()
+    this.init()
+  }
+
+  /**
+   * @inner
+   */
+  init() {
+    const { stream, eventSource } = this
+    stream.on("data", (chunk) => {
+      if (chunk !== null) {
+        const messages = chunk.toString().split("\n\n")
+        for (let i = 0; i < messages.length; i++) {
+          if (messages[i].length > 0) {
+            eventSource.emit("message", this.parseSSEMessage(messages[i]))
+          }
+        }
+      }
+    })
+    stream.on("close", () => {
+      eventSource.emit("close")
+    })
+    stream.on("error", (err) => {
+      eventSource.emit("error", err)
+    })
+  }
+
+  /**
+   * @inner
+   * @param {string} chunk
+   */
+  parseSSEMessage(chunk) {
+    /**
+     * @type {EventSourceMessage}
+     */
+    const message = {
+      data: "",
+      event: "",
+      id: "",
+      retry: undefined,
+    }
+
+    const lines = chunk.split("\n")
+    for (let i = 0; i < lines.length; i++) {
+      const line = lines[i]
+      // line is of format "<field>:<value>" or "<field>: <value>"
+      const colonIndex = line.indexOf(":")
+      if (colonIndex <= 0) continue // exclude comments and lines with no values
+      const field = line.slice(0, colonIndex)
+      const value = line.slice(colonIndex + (line[colonIndex + 1] === " " ? 2 : 1))
+
+      switch (field) {
+        case "data":
+          message.data = message.data ? message.data + "\n" + value : value
+          break
+        case "event":
+          message.event = value
+          break
+        case "id":
+          message.id = value
+          break
+        case "retry":
+          const retry = parseInt(value, 10)
+          if (!isNaN(retry)) {
+            // per spec, ignore non-integers
+            message.retry = retry
+          }
+          break
+      }
+    }
+
+    return message
+  }
+
+  /**
+   * add event listener.
+   * @param {"message"} event - The event type.
+   * @param {(message: EventSourceMessage) => void} listener - The event listener for "message" event.
+   * @returns {this}
+   * @param {"close"} event - The event type.
+   * @param {() => void} listener - The event listener for "close" event.
+   * @returns {this}
+   * @param {"error"} event - The event type.
+   * @param {(err: Error) => void} listener - The event listener for "error" event.
+   * @returns {this}
+   * @param {string} event - The event type.
+   * @param {any} listener - The event listener for other events.
+   * @returns {this}
+   */
+  on(event, listener) {
+    this.eventSource.on(event, listener)
+    return this
+  }
+
+  /**
+   * @param {"message"} event - The event type.
+   * @param {(message: EventSourceMessage) => void} listener - The event listener for "message" event.
+   * @returns {this}
+   * @param {"close"} event - The event type.
+   * @param {() => void} listener - The event listener for "close" event.
+   * @returns {this}
+   * @param {"error"} event - The event type.
+   * @param {(err: Error) => void} listener - The event listener for "error" event.
+   * @returns {this}
+   * @param {string} event - The event type.
+   * @param {any} listener - The event listener for other events.
+   * @returns {this}
+   */
+  removeListener(event, listener) {
+    this.eventSource.removeListener(event, listener)
+    return this
+  }
+
+  /**
+   * @function
+   * @name Symbol.asyncIterator
+   * @description Async iterator function for Symbol.asyncIterator.
+   * @returns {AsyncIterableIterator<EventSourceMessage>}
+   */
+  async *[Symbol.asyncIterator]() {
+    for await (const chunk of this.stream) {
+      if (chunk !== null) {
+        const messages = chunk.toString().split("\n\n")
+        for (let i = 0; i < messages.length; i++) {
+          if (messages[i].length > 0) {
+            yield this.parseSSEMessage(messages[i])
+          }
+        }
+      }
+    }
+  }
+}
+
+module.exports = SSEResponseModel;