Feature/xiaolei/td 1860 node restful (#7900)

* chore: esbuild support for nodejs connector

* TD-1860-feature-node-restful

* commit index,showdatabase

* fix some description

* fix test without assert, try to add CI

* test ci 2nd

* ci test 3rd

* ci test 4th

* remove src/index.js
Co-authored-by: NHuo Linhe <linhehuo@gmail.com>

Jenkinsfile

@@ -240,6 +240,16 @@ pipeline {
               node nanosecondTest.js
 
               '''
+
+              sh '''
+              cd ${WKC}/src/connector/node-rest/
+              npm install
+              npm run build 
+              npm run build:test
+              npm run test
+
+              '''
+
               sh '''
                 cd ${WKC}/tests/examples/C#/taosdemo
                 mcs -out:taosdemo *.cs > /dev/null 2>&1

src/connector/node-rest/.gitignore

+
+# Created by https://www.toptal.com/developers/gitignore/api/node
+# Edit at https://www.toptal.com/developers/gitignore?templates=node
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+.env.production
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# End of https://www.toptal.com/developers/gitignore/api/node
+
+lib/
+yarn.lock

src/connector/node-rest/.nvmrc

+14

src/connector/node-rest/TDengineRest.js

+import {TDengineRestConnection} from './src/restConnect'
+
+export function TDRestConnection(connection = {}) {
+  return new TDengineRestConnection(connection)
+}

src/connector/node-rest/examples/show-database.js

+import {TDengineRestConnection} from "../src/restConnect";
+
+let conn = new TDengineRestConnection({host: '127.0.0.1', user: 'root', pass: 'taosdata', port: 6041})
+let cursor = conn.cursor();
+console.log(conn)
+let data = {};
+(async () => {
+  data = await cursor.query("show databases");
+  data.toString()
+})()
+
+
+

src/connector/node-rest/package.json

+{
+  "name": "td-rest-connector",
+  "version": "1.0.0",
+  "description": "A Node.js connector for TDengine restful",
+  "module": "src/TDengineRest.js",
+  "main": "lib/TDengineclearRest.js",
+  "license": "MIT",
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "esbuild --bundle --platform=node --outfile=lib/TDengineRest.js  ./TDengineRest.js",
+    "build:dev": "esbuild --bundle --platform=node --outfile=dist/examples/show-database.js examples/show-database.js ",
+    "build:test": "esbuild test/testRestConn.js   --bundle --platform=node --outfile=dist/tests/testRestConn.js ",
+    "test": "node dist/tests/testRestConn.js"
+  },
+  "devDependencies": {
+    "esbuild": "^0.12.25",
+    "eslint": "^7.32.0",
+    "assert": "^2.0.0"
+  },
+  "dependencies": {
+    "node-fetch": "^2.x"
+  }
+}

src/connector/node-rest/readme.md

+# TDengine Nodejs Restful
+
+This is the Node.js library that lets you connect to [TDengine](https://www.github.com/taosdata/tdengine) though
+restful. This restful can help you access the TDengine from different platform.
+
+## Install
+To get started, just type in the following to install the connector through [npm](https://www.npmjs.com/)
+
+```cmd
+npm install td-rest-connector
+```
+
+## Usage
+
+### Connection
+
+```javascript
+import taoRest  from 'TDengineRest'
+var connRest = taoRest({host:'127.0.0.1',user:'root',pass:'taosdata',port:6041})
+```
+
+query
+```javascript
+(async()=>{
+  data = await connRest.query("show databases");
+  data.toString();
+  }
+)()
+```
+
+## Example
+An example of using the NodeJS Restful connector to create a table with weather data and create and execute queries can be found [here](https://github.com/taosdata/TDengine/tree/master/tests/examples/node-rest/show-database.js) 
+
+## Contributing to TDengine
+
+Please follow the [contribution guidelines](https://github.com/taosdata/TDengine/blob/master/CONTRIBUTING.md) to contribute to the project.
+
+## License
+
+[GNU AGPL v3.0](http://www.gnu.org/licenses/agpl-3.0.html)

src/connector/node-rest/src/restConnect.js

+import {TDengineRestCursor} from '../src/restCursor'
+
+/**
+ *this class collect basic information that can be used to build
+ * a restful connection.
+ */
+export class TDengineRestConnection {
+  /**
+   * constructor,give variables some default values
+   * @param options
+   * @returns {TDengineRestConnection}
+   */
+  constructor(options) {
+    this.host = 'localhost'
+    this.port = '6041'
+    this.user = 'root'
+    this.pass = 'taosdata'
+    this.path = '/rest/sqlt/'
+    this._initConnection(options)
+    return this
+  }
+
+  /**
+   * used to init the connection info using  the input options
+   * @param options
+   * @private
+   */
+  _initConnection(options) {
+    if (options['host']) {
+      this.host = options['host']
+    }
+    if (options['port']) {
+      this.port = options['port']
+    }
+    if (options['user']) {
+      this.user = options['user']
+    }
+    if (options['pass']) {
+      this.pass = options['pass']
+    }
+    if (options['path']) {
+      this.path = options['path']
+    }
+  }
+
+  /**
+   * cursor will return an object of TDengineRestCursor, which can send restful(http) request and get
+   * the response from server.
+   * @returns {TDengineRestCursor}
+   */
+  cursor() {
+    return new TDengineRestCursor(this)
+  }
+}
+
+
+
+
+

src/connector/node-rest/src/restConstant.js

+/**
+ * indicate the every type's type code
+ * @type {{"0": string, "1": string, "2": string, "3": string, "4": string, "5": string, "6": string, "7": string, "8": string, "9": string, "10": string}}
+ */
+export const typeCodesToName = {
+  0: 'Null',
+  1: 'Boolean',
+  2: 'Tiny Int',
+  3: 'Small Int',
+  4: 'Int',
+  5: 'Big Int',
+  6: 'Float',
+  7: 'Double',
+  8: 'Binary',
+  9: 'Timestamp',
+  10: 'Nchar',
+}
+
+/**
+ * get the type of input typecode, in fact the response of restful will send every column's typecode
+ * @param typecode
+ * @returns {*}
+ */
+export function getTaoType(typecode) {
+  return typeCodesToName[typecode];
+}
\ No newline at end of file

src/connector/node-rest/src/restCursor.js

+import fetch from 'node-fetch'
+import {TDengineRestResultSet} from '../src/restResult'
+
+/**
+ * this class is core of restful js connector
+ * this class resends http request to the TDengine server
+ * and receive the response.
+ */
+export class TDengineRestCursor {
+  /**
+   * constructor,used to get the connection info
+   * @param connection
+   */
+  constructor(connection) {
+    this._connection = null;
+    this.data = [];
+    this.http = false
+    if (connection != null) {
+      this._connection = connection
+    } else {
+      throw new Error("A TDengineRestConnection object is required to be passed to the TDengineRestCursor")
+    }
+  }
+
+  /**
+   * used to build an url,like http://localhost:6041/rest/sql
+   * @returns {string}
+   * @private
+   */
+  _apiUpl() {
+    return (this.http ? "https" : "http") + "://" + this._connection.host + ":" + this._connection.port + this._connection.path
+  }
+
+  /**
+   * used to make an authorization token
+   * @returns {string}
+   * @private
+   */
+  _token() {
+    return 'Basic ' + Buffer.from(this._connection.user + ":" + this._connection.pass).toString('base64')
+  }
+
+  /**
+   * Used fetch to send http request， and return the response as an object of TDengineRestResultSet
+   * @param sql
+   * @returns {Promise<TDengineRestResultSet>}
+   */
+  async query(sql) {
+    try {
+      let response = await fetch(this._apiUpl(), {
+        method: 'POST',
+        body: sql,
+        headers: {'Authorization': this._token()}
+      })
+      // if (response.status == 'succ') {
+      return await new TDengineRestResultSet(await response.json())
+      // } else {
+      //   throw new Error(response.desc)
+      // }
+    } catch (e) {
+      console.log("Request Failed " + e)
+    }
+
+  }
+}
+

src/connector/node-rest/src/restResult.js

+import {getTaoType} from '../src/restConstant'
+
+
+export class TDengineRestResultSet {
+  constructor(result) {
+    this.status = ''    //succ
+    this.column_name = {} //head
+    this.column_type = {} //column_meta
+    this.data = {}
+    this.affectRows = null //rows
+    this.code = null
+    this.desc = null
+    this._init(result)
+  }
+
+  //initial the resultSet with a jason parameter
+  /**
+   *
+   * @param jason
+   */
+  _init(result) {
+    if (result.status) {
+      this.status = result.status
+    }
+    if (result.head) {
+      this.column_name = result.head
+    }
+    if (result.column_meta) {
+      this.column_type = result.column_meta
+    }
+    if (result.data) {
+      this.data = result.data
+    }
+    if (result.rows) {
+      this.affectRows = result.rows
+    }
+    if (result.code) {
+      this.code = result.code
+    }
+    if (result.desc) {
+      this.desc = result.desc
+    }
+  }
+
+  getStatus() {
+    return this.status
+  }
+
+  getColumn_name() {
+    return this.column_name
+  }
+
+  getColumn_type() {
+    let column_data = []
+    this.column_type.forEach(function (column) {
+      column[1] = getTaoType(column[1])
+      column_data.push(column)
+    })
+    return column_data
+  }
+
+  getData() {
+    return this.data
+  }
+
+  getAffectRow() {
+    return this.affectRows
+  }
+
+  getCode() {
+    return this.code
+  }
+
+  getDesc() {
+    return this.desc
+  }
+
+
+  toString() {
+    if(this.status === 'succ'){
+      let fields = this.column_type
+      let rows = this.data
+      this._prettyStr(fields, rows)
+    }else{
+      console.log(this.status+":"+this.desc)
+    }
+  }
+
+  _prettyStr(fields, data) {
+    let colName = []
+    let colType = []
+    let colSize = []
+    let colStr = ""
+
+
+    for (let i = 0; i < fields.length; i++) {
+      colName.push(fields[i][0])
+      colType.push(fields[i][1])
+
+      if ((fields[i][1]) == 8 || (fields[i][1]) == 10) {
+        colSize.push(Math.max(fields[i][0].length, fields[i][2]));  //max(column_name.length,column_type_precision)
+      } else {
+        colSize.push(Math.max(fields[i][0].length, suggestedMinWidths[fields[i][1]]));// max(column_name.length,suggest_column_with_suggestion)
+      }
+      // console.log(colSize)
+    }
+    colName.forEach((name, i) => {
+      colStr += this._fillEmpty(Math.floor(colSize[i] / 2 - name.length / 2)) + name.toString() + this._fillEmpty(Math.ceil(colSize[i] / 2 - name.length / 2)) + " | "
+    })
+
+    let strSperator = ""
+    let sizeSum = colSize.reduce((a, b) => a += b, (0)) + colSize.length * 3
+    strSperator = this._printN("=", sizeSum)
+
+    console.log("\n" + colStr)
+    console.log(strSperator)
+
+    data.forEach((row) => {
+      let rowStr = ""
+      row.forEach((cell, index) => {
+        rowStr += cell == null ? 'null' : cell.toString();
+        rowStr += this._fillEmpty(colSize[index] - cell.toString().length) + " | "
+      })
+      console.log(rowStr)
+    })
+
+    return colStr
+  }
+
+  _fillEmpty(n) {
+    let str = "";
+    for (let i = 0; i < n; i++) {
+      str += " ";
+    }
+    return str;
+  }
+
+  _printN(s, n) {
+    let f = "";
+    for (let i = 0; i < n; i++) {
+      f += s;
+    }
+    return f;
+  }
+}
+
+const suggestedMinWidths = {
+  0: 4,
+  1: 4,
+  2: 4,
+  3: 6,
+  4: 11,
+  5: 12,
+  6: 24,
+  7: 24,
+  8: 10,
+  9: 25,
+  10: 10,
+}

src/connector/node-rest/test/testRestConn.js

+import {TDRestConnection} from "../TDengineRest";
+import assert from "assert"
+
+let conn = new TDRestConnection({host: '127.0.0.1', user: 'root', pass: 'taosdata', port: 6041});
+let cursor = conn.cursor();
+
+const createDB = "create database if not exists node_rest";
+const dropDB = "drop database if exists  node_rest";
+const createTBL = "CREATE STABLE if not exists node_rest.meters (ts timestamp, current float, voltage int, phase float) TAGS (location binary(64), groupId int)";
+const dropTBL = "drop table if exists node_rest.meters ";
+const insert = "INSERT INTO node_rest.d1001 USING node_rest.meters TAGS (\"Beijng.Chaoyang\", 2) VALUES (now, 10.2, 219, 0.32) ";
+const select = "select * from node_rest.d1001 ";
+const selectStbl = "select * from node_rest.meters";
+
+async function execute(sql) {
+  console.log("SQL:" + sql);
+  let result = await cursor.query(sql);
+  try {
+    assert.strictEqual(result.getStatus(), 'succ', new Error("response error"))
+    result.toString()
+  } catch (e) {
+    console.log(e)
+  }
+
+}
+
+(async () => {
+  await execute(createDB);
+  await execute(createTBL);
+  await execute(insert);
+  await execute(select);
+  await execute(selectStbl);
+  await execute(dropDB);
+})()
+
+// (async () => {
+//   result = await cursor.query("drop database if exists  node_rest").catch(e=>console.log(e))
+//   result.toString()
+// })()