tmc.js 0.3.3 → 0.3.5

package/README.md

@@ -60,6 +60,24 @@ new Tmc('your_app_key', 'your_app_secret')
 
 消费端发起建立连接 `onopen` 事件，`address` 默认为 `ws://mc.api.taobao.com/`。
 
+**`tmc.send(msg: Message, options?: { mask?: true, binary?: true }, cb?: (err: Error) => void) => void`**
+
+实例化后，当自动应答确认消息无法满足需求的时候，比如消息处理失败，需要`Publisher`再次重推消息，在实例初始化时置`options.autoReplyConfirmation=false`，则在消息处理函数内，可以通过 `this.send()` 函数回复`确认`或者`失败`消息。例如：
+
+```js
+new Tmc('your_app_key', 'your_app_secret', { autoReplyConfirmation: false })
+.taobao_trade_TradeDelayConfirmPay(function needDoubleReriesThenConfirm(msg) {
+  if (msg instanceof Message && msg.content?.retried === 0) {
+    this.send(
+      new Message(MessageType.SENDACK, MessageKind.Failed)
+      .with(MessageFields.ID, msg.content?.id)
+      .with(MessageFields.MSG, 'Something went wrong, please retries this ID.')
+    );
+  }
+})
+.connect();
+```
+
 <details><summary>可选设置的 NODE_DEBUG=< label > 环境变量</summary>
 
 | label | 说明 |
@@ -69,7 +87,7 @@ new Tmc('your_app_key', 'your_app_secret')
 | `tmc:onpull` | 开启 `onpull` 时的日志
 | `tmc:onerror` | 开启 `onerror` 时的日志
 | `tmc:onclose` | 开启 `onclose` 时的日志
-| `tmc:onmessage` | 开启全部 `onmessage` 时的日志(即`From`淘宝消息)
+| `tmc:onmessage*` | 开启全部 `onmessage` 时的日志(即`From`淘宝消息)
 | `tmc:onmessage:connect` | 开启消费端发起连接 `connect` 时的日志
 | `tmc:onmessage:connectack` | 开启消费端回复连接 `connectack` 时的日志
 | `tmc:onmessage:send` | 开启消费端接收到(即`From`淘宝) `send` 的消息时的日志

package/lib/consumer.js

@@ -3,7 +3,7 @@ const { networkInterfaces } = require('os');
 const { EventEmitter, captureRejectionSymbol } = require('events');
 
 const WebSocket = require('ws');
-const JSONB = require('json-bigint')({ useNativeBigInt: true });
+const { stringify, parse } = require('json-bigint')({ useNativeBigInt: true });
 
 const logger = require('./logger');
 const Message = require('./message');
@@ -92,6 +92,17 @@ class TaoMessageConsumer extends EventEmitter {
     ).update(sk).digest('hex').toUpperCase();
   }
 
+  /**
+   * @param {Message} data - The data
+   * @param {object|Function} [options] - The options
+   * @param {Function} [cb] - The Callback
+   * @returns {void}
+   * @since v0.3.4
+   */
+  send(data, options = { mask: true, binary: true }, cb = undefined) {
+    if (data instanceof Message) { this[kWebSocket]?.send(data.with(TOKEN, this[kToken]).buffer, options, cb); }
+  }
+
   onopen() {
     const now = `${Date.now()}`;
     const msg = new Message(CONNECT)
@@ -102,9 +113,9 @@ class TaoMessageConsumer extends EventEmitter {
       .with(SDK, this.constructor.name)
       .with(INTRANET_IP, ipAddr());
 
-    logger.onopen(JSONB.stringify(msg));
+    logger.onopen(stringify(msg));
 
-    this[kWebSocket]?.send(msg.buffer, { mask: true, binary: true });
+    this.send(msg);
 
     if (this[kOptions].intervalId) { clearInterval(this[kOptions].intervalId); }
 
@@ -113,22 +124,22 @@ class TaoMessageConsumer extends EventEmitter {
 
   onpull() {
     const msg = new Message(SEND, PullRequest).with(TOKEN, this[kToken]);
-    logger.onpull(JSONB.stringify(msg));
-    this[kWebSocket]?.send(msg.buffer, { mask: true, binary: true });
+    logger.onpull(stringify(msg));
+    this.send(msg);
   }
 
   onping(data) {
-    logger.onping('The channel is onping with data [%s].', JSONB.stringify(data));
-    this[kWebSocket]?.pong(data, { mask: true }, true);
+    logger.onping('The channel is onping with data [%s].', stringify(data));
+    this[kWebSocket]?.pong(data, true);
   }
 
   onerror(err) {
-    logger.onerror('The channel is onerror(%s), let us reconnect.', JSONB.stringify(err));
+    logger.onerror('The channel is onerror(%s), let us reconnect.', stringify(err));
     this.reconnect(this[kOptions].onErrorReconnection);
   }
 
   onclose(...arg) {
-    logger.onclose('The channel is onclose(%s), let us reconnect.', JSONB.stringify(arg));
+    logger.onclose('The channel is onclose(%s), let us reconnect.', stringify(arg));
     this.reconnect(this[kOptions].onCloseReconnection);
   }
 
@@ -141,8 +152,8 @@ class TaoMessageConsumer extends EventEmitter {
 
     if (this[kOptions].autoReplyConfirmation && msg && msg[CONTENT] && msg[CONTENT][ID]) {
       const reply = new Message(SEND, Confirm).with(TOKEN, this[kToken]).with(ID, msg[CONTENT][ID]);
-      logger.onmessage[SEND][Confirm](JSONB.stringify(reply));
-      this[kWebSocket]?.send(reply.buffer, { mask: true, binary: true });
+      logger.onmessage[SEND][Confirm](stringify(reply));
+      this.send(reply);
     }
   }
 
@@ -164,10 +175,10 @@ class TaoMessageConsumer extends EventEmitter {
       && msg[CONTENT][CONTENT]
       && typeof msg[CONTENT][CONTENT] === 'string'
       && /^\{.*\}$/.test(msg[CONTENT][CONTENT])) {
-      Reflect.set(msg[CONTENT], CONTENT, JSONB.parse(msg[CONTENT][CONTENT]));
+      Reflect.set(msg[CONTENT], CONTENT, parse(msg[CONTENT][CONTENT]));
     }
 
-    logger.onmessage[msg[TYPE]](JSONB.stringify(msg));
+    logger.onmessage[msg[TYPE]](stringify(msg));
 
     this[`process${msg[TYPE]}`](msg);
   }
@@ -178,6 +189,7 @@ class TaoMessageConsumer extends EventEmitter {
     if (this[kOptions].intervalId) { this[kOptions].intervalId = clearInterval(this[kOptions].intervalId); }
     if (this[kOptions].timeoutId) { this[kOptions].timeoutId = clearTimeout(this[kOptions].timeoutId); }
 
+    this[kToken] = undefined;
     this[kWebSocket] = undefined;
     this[kOptions].timeoutId = setTimeout(() => this.connect(), ms);
 

package/lib/message.js

@@ -29,10 +29,8 @@ class Message {
   [CONTENT] = {};
 
   constructor(type, kind) {
-    /* eslint-disable-next-line no-unused-expressions */
-    MessageType.includes(type) && Reflect.set(this, TYPE, type);
-    /* eslint-disable-next-line no-unused-expressions */
-    MessageKind.includes(kind) && Reflect.set(this[CONTENT], MessageKind, kind);
+    if (MessageType.includes(type)) { this[TYPE] = type; }
+    if (MessageKind.includes(kind)) { this[CONTENT][MessageKind] = kind; }
   }
 
   with(key, value) {
@@ -93,14 +91,10 @@ class Encoder {
 
   compress() {
     this.put(this[kData].protocolVersion).put(this[kData][TYPE]);
-    /* eslint-disable-next-line no-unused-expressions */
-    this[kData][CODE] && this.putShort(StatusCode).putShort(this[kData][CODE]);
-    /* eslint-disable-next-line no-unused-expressions */
-    this[kData][PHRASE] && this.putShort(StatusPhrase).writeCountedString(this[kData][PHRASE]);
-    /* eslint-disable-next-line no-unused-expressions */
-    this[kData][FLAG] && this.putShort(Flag).putInt(this[kData][FLAG]);
-    /* eslint-disable-next-line no-unused-expressions */
-    this[kData][TOKEN] && this.putShort(Token).writeCountedString(this[kData][TOKEN]);
+    if (this[kData][CODE]) { this.putShort(StatusCode).putShort(this[kData][CODE]); }
+    if (this[kData][PHRASE]) { this.putShort(StatusPhrase).writeCountedString(this[kData][PHRASE]); }
+    if (this[kData][FLAG]) { this.putShort(Flag).putInt(this[kData][FLAG]); }
+    if (this[kData][TOKEN]) { this.putShort(Token).writeCountedString(this[kData][TOKEN]); }
     Object.entries(this[kData][CONTENT] || {}).forEach(([k, v]) => this.putShort(Custom).writeCountedString(k).writeCustomValue(v));
     this.putShort(EndOfHeaders);
 
@@ -134,8 +128,7 @@ class Encoder {
   writeCountedString(value) {
     const len = value ? Buffer.byteLength(value) : 0;
     this.putInt(len);
-    /* eslint-disable-next-line no-unused-expressions */
-    len && this[kBuffer].push(pick(len, write, value, utf8));
+    if (len) { this[kBuffer].push(pick(len, write, value, utf8)); }
 
     return this;
   }
@@ -187,18 +180,6 @@ class Encoder {
 
 const kOffset = Symbol('kOffset');
 
-const readInt8 = 'readInt8';
-
-const readInt16LE = 'readInt16LE';
-
-const readInt32LE = 'readInt32LE';
-
-const readBigInt64LE = 'readBigInt64LE';
-
-function read(buffer, method, offset, ...extra) {
-  return buffer[method](offset, ...extra);
-}
-
 class Decoder {
   [kOffset] = 1;
 
@@ -245,25 +226,25 @@ class Decoder {
   }
 
   get() {
-    const value = read(this[kBuffer], readInt8, this[kOffset]);
+    const value = this[kBuffer].readInt8(this[kOffset]);
     this[kOffset] += 1;
     return Number(value);
   }
 
   getShort() {
-    const value = read(this[kBuffer], readInt16LE, this[kOffset]);
+    const value = this[kBuffer].readInt16LE(this[kOffset]);
     this[kOffset] += 2;
     return Number(value);
   }
 
   getInt() {
-    const value = read(this[kBuffer], readInt32LE, this[kOffset]);
+    const value = this[kBuffer].readInt32LE(this[kOffset]);
     this[kOffset] += 4;
     return Number(value);
   }
 
   getLong() {
-    const value = read(this[kBuffer], readBigInt64LE, this[kOffset]);
+    const value = this[kBuffer].readBigInt64LE(this[kOffset]);
     this[kOffset] += 8;
     return BigInt(value);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tmc.js",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "Events driven and chained Taobao Message Channel(TMC) for NodeJS",
   "author": "James ZHANG",
   "license": "MIT",
@@ -30,11 +30,11 @@
   ],
   "dependencies": {
     "json-bigint": "^1.0.0",
-    "ws": "^8.11.0"
+    "ws": "^5.2.2 || ^6.2.1 || ^7.4.5 || ^8.0.0"
   },
   "devDependencies": {
     "@babel/eslint-parser": "^7.19.1",
-    "@types/node": "^18.8.3",
+    "@types/node": ">=11.9.0",
     "eslint": "^8.25.0",
     "eslint-config-airbnb-base": "^15.0.0"
   },

package/types/index.d.ts

@@ -26,6 +26,10 @@ declare interface ConsumerOptions {
 declare interface TaoMessageConstractor extends EventEmitter {
   new (appKey: string, appSecret: BinaryLike, groupName?: string | ConsumerOptions, options?: ConsumerOptions): TaoMessageConsumer;
   sign(timestamp: string): string;
+  /** @since v0.3.4 */
+  send(data: Message, cb?: (err?: Error) => void): void;
+  /** @since v0.3.4 */
+  send(data: Message, options?: { mask?: true, binary?: true, compress?: boolean, fin?: boolean }, cb?: (err: Error) => void): void;
   onopen(): void;
   onpull(): void;
   onping(data: Buffer): void;