feat: report connector version information

.github/workflows/build.yml

@@ -29,7 +29,6 @@ jobs:
           repository: "taosdata/TDengine"
           path: "TDengine"
           ref: "main"
-          submodules: "recursive"
 
       - name: Install system dependencies
         run: |

.github/workflows/compatibility.yml

@@ -49,6 +49,7 @@ jobs:
         env:
           TDENGINE_CLOUD_URL: ${{ secrets.TDENGINE_CLOUD_URL }}
           TDENGINE_CLOUD_TOKEN: ${{ secrets.TDENGINE_CLOUD_TOKEN }}
+          TEST_3360: true
         run: |
           npm install
           npm list

nodejs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tdengine/websocket",
-  "version": "3.2.2",
+  "version": "3.2.3",
   "description": "The websocket Node.js connector for TDengine. TDengine versions 3.3.2.0 and above are recommended to use this connector.",
   "source": "index.ts",
   "main": "lib/index.js",

nodejs/prepare.js

@@ -4,6 +4,7 @@ const path = require("path");
 const { resolve, parse } = path;
 
 const tsFile = /\/src\/.*.ts$/;
+
 async function dir(folder, ts = []) {
     let files = await readdir(folder);
     for (let f of files) {

nodejs/src/client/wsClient.ts

@@ -10,7 +10,7 @@ import {
 import { WSVersionResponse, WSQueryResponse } from "./wsResponse";
 import { ReqId } from "../common/reqid";
 import logger from "../common/log";
-import { safeDecodeURIComponent, compareVersions } from "../common/utils";
+import { safeDecodeURIComponent, compareVersions, CONNECTOR_INFO } from "../common/utils";
 import { w3cwebsocket } from "websocket";
 import { TSDB_OPTION_CONNECTION } from "../common/constant";
 
@@ -41,6 +41,7 @@ export class WsClient {
                 user: safeDecodeURIComponent(this._url.username),
                 password: safeDecodeURIComponent(this._url.password),
                 db: database,
+                connector: CONNECTOR_INFO,
                 ...(this._timezone && { tz: this._timezone }),
             },
         };

nodejs/src/client/wsConnectorPool.ts

@@ -159,19 +159,13 @@ process.on("exit", (code) => {
 });
 
 process.on("SIGINT", () => {
-    logger.info(
-        "Received SIGINT. Press Control-D to exit, begin destroy connect..."
-    );
+    logger.info("Received SIGINT. Press Control-D to exit, begin destroy connect...");
     WebSocketConnectionPool.instance().destroyed();
     process.exit();
 });
 
 process.on("SIGTERM", () => {
-    logger.info(
-        "Received SIGINT. Press Control-D to exit, begin destroy connect"
-    );
+    logger.info("Received SIGTERM. Press Control-D to exit, begin destroy connect...");
     WebSocketConnectionPool.instance().destroyed();
     process.exit();
 });
-
-// process.kill(process.pid, 'SIGINT');

nodejs/src/client/wsEventCallback.ts

@@ -29,10 +29,10 @@ export enum OnMessageType {
 }
 
 const eventMutex = new Mutex();
+
 export class WsEventCallback {
     private static _instance?: WsEventCallback;
-    private static _msgActionRegister: Map<MessageId, MessageAction> =
-        new Map();
+    private static _msgActionRegister: Map<MessageId, MessageAction> = new Map();
     private constructor() { }
 
     public static instance(): WsEventCallback {

nodejs/src/client/wsResponse.ts

@@ -1,7 +1,3 @@
-/**
- * define ws Response type|class, for query?
- */
-
 import { MessageResp, readVarchar } from "../common/taosResult";
 
 export class WSVersionResponse {
@@ -10,6 +6,7 @@ export class WSVersionResponse {
     message: string;
     action: string;
     totalTime: number;
+
     constructor(resp: MessageResp) {
         this.version = resp.msg.version;
         this.code = resp.msg.code;
@@ -41,6 +38,7 @@ export class WSQueryResponse {
         this.totalTime = resp.totalTime;
         this.initMsg(resp.msg);
     }
+
     private initMsg(msg: any) {
         this.code = msg.code;
         this.message = msg.message;
@@ -81,6 +79,7 @@ export class WSFetchBlockResponse {
     finished: number | undefined;
     metaType: number | undefined;
     textDecoder: TextDecoder;
+
     constructor(msg: ArrayBuffer) {
         let dataView = new DataView(msg);
         this.action = dataView.getBigUint64(8, true);

nodejs/src/common/taosResult.ts

@@ -12,7 +12,6 @@ import {
 import { appendRune } from "./ut8Helper";
 import logger from "./log";
 import { decimalToString } from "./utils";
-import { TMQRawDataSchema } from "../tmq/constant";
 
 export interface TDengineMeta {
     name: string;

nodejs/src/common/utils.ts

@@ -1,5 +1,8 @@
 import { WSConfig } from "./config";
 import { ErrorCode, TDWebSocketClientError } from "./wsError";
+import pkg from "../../package.json";
+
+export const CONNECTOR_INFO = `nodejs-ws-v${pkg.version}-ncid000`;
 
 export function getUrl(wsConfig: WSConfig): URL {
     let url = new URL(wsConfig.getUrl());

nodejs/src/index.ts

@@ -29,4 +29,5 @@ let setLogLevel = (level: string) => {
 let destroy = () => {
     WebSocketConnectionPool.instance().destroyed();
 };
+
 export { sqlConnect, tmqConnect, setLogLevel, destroy };

nodejs/src/tmq/config.ts

@@ -1,7 +1,6 @@
 import { TMQConstants } from "./constant";
 
 export class TmqConfig {
-    // req_id: number;
     url: URL | null = null;
     sql_url: URL | null = null;
     user: string | null = null;
@@ -57,6 +56,7 @@ export class TmqConfig {
             } else {
                 this.user = this.url.username;
             }
+
             if (this.password) {
                 this.url.password = this.password;
             } else {

nodejs/src/tmq/tmqResponse.ts

@@ -147,11 +147,8 @@ export class WSTmqFetchBlockInfo {
         this.withTableName = dataView.getUint8(4) == 1 ? true : false;
         this.withSchema = dataView.getUint8(5) == 1 ? true : false;
 
-        // let dataBuffer = dataView.buffer.slice(6)
         let dataBuffer = new DataView(dataView.buffer, dataView.byteOffset + 6);
         let rows = 0;
-        // const parseStartTime = new Date().getTime();
-        // console.log("parseBlockInfos blockNum="+ blockNum)
         for (let i = 0; i < blockNum; i++) {
             let variableInfo = this.parseVariableByteInteger(dataBuffer);
             this.taosResult.setPrecision(variableInfo[1].getUint8(17));

nodejs/src/tmq/wsTmq.ts

@@ -18,18 +18,19 @@ import {
     TopicPartition,
     WSTmqFetchBlockInfo,
     WsPollResponse,
-    WsTmqQueryResponse,
 } from "./tmqResponse";
 import { ReqId } from "../common/reqid";
 import logger from "../common/log";
 import { WSFetchBlockResponse } from "../client/wsResponse";
+import { CONNECTOR_INFO } from "../common/utils";
 
 export class WsConsumer {
     private _wsClient: WsClient;
     private _wsConfig: TmqConfig;
     private _topics?: string[];
     private _commitTime?: number;
     private _lastMessageID?: bigint;
+
     private constructor(wsConfig: Map<string, any>) {
         this._wsConfig = new TmqConfig(wsConfig);
         logger.debug(this._wsConfig);
@@ -106,6 +107,7 @@ export class WsConsumer {
                 auto_commit: this._wsConfig.auto_commit,
                 auto_commit_interval_ms: this._wsConfig.auto_commit_interval_ms,
                 config: this._wsConfig.otherConfigs,
+                connector: CONNECTOR_INFO,
             },
         };
         this._topics = topics;

nodejs/test/bulkPulling/sql.test.ts

@@ -265,6 +265,28 @@ describe("TDWebSocket.WsSql()", () => {
 
         await wsSql.close();
     });
+
+    const maybeConnectorVersionTest = process.env.TEST_3360 ? test.skip : test;
+
+    maybeConnectorVersionTest("connector version info", async () => {
+        let conf: WSConfig = new WSConfig(dns);
+        conf.setUser("root");
+        conf.setPwd("taosdata");
+        let wsSql = await WsSql.open(conf);
+        await Sleep(2000);
+        let wsRows = await wsSql.query("show connections");
+        let hasNodejsWs = false;
+        while (await wsRows.next()) {
+            const data = wsRows.getData();
+            if (Array.isArray(data) && data.some(v => typeof v === "string" && v.includes("nodejs-ws"))) {
+                hasNodejsWs = true;
+                break;
+            }
+        }
+        expect(hasNodejsWs).toBe(true);
+        await wsRows.close();
+        await wsSql.close();
+    });
 });
 
 afterAll(async () => {

nodejs/test/bulkPulling/tmq.test.ts

@@ -2,9 +2,9 @@ import { TMQConstants } from "../../src/tmq/constant";
 import { WsConsumer } from "../../src/tmq/wsTmq";
 import { WSConfig } from "../../src/common/config";
 import { WsSql } from "../../src/sql/wsSql";
-import { createSTable, insertStable } from "../utils";
+import { createSTable, insertStable, Sleep } from "../utils";
 import { WebSocketConnectionPool } from "../../src/client/wsConnectorPool";
-import logger, { setLevel } from "../../src/common/log";
+import { setLevel } from "../../src/common/log";
 
 setLevel("debug");
 const stable = "st";
@@ -398,6 +398,34 @@ describe("TDWebSocket.Tmq()", () => {
         await consumer.unsubscribe();
         await consumer.close();
     });
+
+    const maybeConnectorVersionTest = process.env.TEST_3360 ? test.skip : test;
+
+    maybeConnectorVersionTest("connector version info", async () => {
+        let consumer = await WsConsumer.newConsumer(configMap);
+        await consumer.subscribe(topics);
+
+        let conf: WSConfig = new WSConfig("ws://localhost:6041");
+        conf.setUser("root");
+        conf.setPwd("taosdata");
+        let wsSql = await WsSql.open(conf);
+        await Sleep(2000);
+
+        let wsRows = await wsSql.query("show connections");
+        let count = 0;
+        while (await wsRows.next()) {
+            const data = wsRows.getData();
+            if (Array.isArray(data) && data.some(v => typeof v === "string" && v.includes("nodejs-ws"))) {
+                count++;
+            }
+        }
+        expect(count).toBeGreaterThanOrEqual(2);
+        await wsRows.close();
+        await wsSql.close();
+
+        await consumer.unsubscribe();
+        await consumer.close();
+    });
 });
 
 afterAll(async () => {

nodejs/tsconfig.json

@@ -33,7 +33,7 @@
     // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
     // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
     // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
-    // "resolveJsonModule": true,                        /* Enable importing .json files */
+    "resolveJsonModule": true,                           /* Enable importing .json files */
     // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
 
     /* JavaScript Support */