feat: report connector version information (#102)

Add connector version reporting to TDengine Node.js WebSocket connector.

Key changes:
- Added ConnectorInfo constant with version format: nodejs-ws-v{version}-ncid000
- Integrated version reporting in SQL and TMQ connection paths
- Added tests to verify connector info in 'show connections' output
- Version bump to 3.2.3
- Enabled resolveJsonModule in TypeScript config

The connector version is now visible when querying 'show connections', improving observability and debugging capabilities.

Author: qevolg

.github/workflows/compatibility.yml

@@ -51,6 +51,7 @@ jobs:
           TDENGINE_CLOUD_TOKEN: ${{ secrets.TDENGINE_CLOUD_TOKEN }}
           TDENGINE_TEST_USERNAME: ${{ secrets.TDENGINE_TEST_USERNAME }}
           TDENGINE_TEST_PASSWORD: ${{ secrets.TDENGINE_TEST_PASSWORD }}
+          TEST_3360: true
         run: |
           npm install
           npm list

nodejs/package-lock.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/package.json

@@ -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/prepare.js

@@ -12,7 +12,7 @@ import { ReqId } from "../common/reqid";
 import logger from "../common/log";
 import { safeDecodeURIComponent, compareVersions, maskSensitiveForLog, maskUrlForLog } from "../common/utils";
 import { w3cwebsocket } from "websocket";
-import { TSDB_OPTION_CONNECTION } from "../common/constant";
+import { ConnectorInfo, TSDB_OPTION_CONNECTION } from "../common/constant";
 
 export class WsClient {
     private _wsConnector?: WebSocketConnector;
@@ -44,6 +44,7 @@ export class WsClient {
                 user: safeDecodeURIComponent(this._url.username),
                 password: safeDecodeURIComponent(this._url.password),
                 db: database,
+                connector: ConnectorInfo,
                 ...(this._timezone && { tz: this._timezone }),
                 ...(this._bearerToken && { bearer_token: this._bearerToken }),
             },

nodejs/src/client/wsClient.ts

@@ -1,3 +1,5 @@
+import pkg from "../../package.json";
+
 export interface IndexableString {
     [index: number]: string;
 }
@@ -10,6 +12,7 @@ export interface NumberIndexable {
     [index: number]: number;
 }
 
+export const ConnectorInfo = `nodejs-ws-v${pkg.version}-ncid000`;
 export const BinaryQueryMessage: bigint = BigInt(6);
 export const FetchRawBlockMessage: bigint = BigInt(7);
 export const MinStmt2Version: string = "3.3.6.0";

nodejs/src/common/constant.ts

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

nodejs/src/index.ts

@@ -61,6 +61,7 @@ export class TmqConfig {
             } else {
                 this.user = this.url.username;
             }
+
             if (this.password) {
                 this.url.password = this.password;
             } else {

nodejs/src/tmq/config.ts

@@ -23,6 +23,7 @@ import { ReqId } from "../common/reqid";
 import logger from "../common/log";
 import { WSFetchBlockResponse } from "../client/wsResponse";
 import { maskTmqConfigForLog, maskUrlForLog } from "../common/utils";
+import { ConnectorInfo } from "../common/constant";
 
 export class WsConsumer {
     private _wsClient: WsClient;
@@ -109,6 +110,7 @@ export class WsConsumer {
                 auto_commit: String(this._wsConfig.auto_commit),
                 auto_commit_interval_ms: String(this._wsConfig.auto_commit_interval_ms),
                 config: Object.fromEntries(this._wsConfig.otherConfigs),
+                connector: ConnectorInfo,
             },
         };
         this._topics = topics;

nodejs/src/tmq/wsTmq.ts

@@ -1,7 +1,7 @@
 import { WebSocketConnectionPool } from "../../src/client/wsConnectorPool";
 import { WSConfig } from "../../src/common/config";
 import { WsSql } from "../../src/sql/wsSql";
-import { Sleep, testPassword, testUsername, testEnterprise } from "../utils";
+import { Sleep, testPassword, testUsername, testEnterprise, testNon3360 } from "../utils";
 import { setLevel } from "../../src/common/log";
 
 let dsn = "ws://localhost:6041";
@@ -326,6 +326,26 @@ describe("TDWebSocket.WsSql()", () => {
             message: expect.stringMatching(/invalid url/i),
         });
     });
+
+    testNon3360("connector version info", async () => {
+        const conf = new WSConfig(dsn);
+        conf.setUser(testUsername());
+        conf.setPwd(testPassword());
+        const wsSql = await WsSql.open(conf);
+        await Sleep(2000);
+        const 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 () => {