oceanbase 0.0.1

package/lib/promise/pool.js

@@ -0,0 +1,112 @@
+'use strict';
+
+const EventEmitter = require('events').EventEmitter;
+const makeDoneCb = require('./make_done_cb.js');
+const PromisePoolConnection = require('./pool_connection.js');
+const inheritEvents = require('./inherit_events.js');
+const BasePool = require('../base/pool.js');
+
+class PromisePool extends EventEmitter {
+  constructor(pool, thePromise) {
+    super();
+    this.pool = pool;
+    this.Promise = thePromise || Promise;
+    inheritEvents(pool, this, ['acquire', 'connection', 'enqueue', 'release']);
+  }
+
+  getConnection() {
+    const corePool = this.pool;
+    return new this.Promise((resolve, reject) => {
+      corePool.getConnection((err, coreConnection) => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve(new PromisePoolConnection(coreConnection, this.Promise));
+        }
+      });
+    });
+  }
+
+  releaseConnection(connection) {
+    if (connection instanceof PromisePoolConnection) connection.release();
+  }
+
+  query(sql, args) {
+    const corePool = this.pool;
+    const localErr = new Error();
+    if (typeof args === 'function') {
+      throw new Error(
+        'Callback function is not available with promise clients.'
+      );
+    }
+    return new this.Promise((resolve, reject) => {
+      const done = makeDoneCb(resolve, reject, localErr);
+      if (args !== undefined) {
+        corePool.query(sql, args, done);
+      } else {
+        corePool.query(sql, done);
+      }
+    });
+  }
+
+  execute(sql, args) {
+    const corePool = this.pool;
+    const localErr = new Error();
+    if (typeof args === 'function') {
+      throw new Error(
+        'Callback function is not available with promise clients.'
+      );
+    }
+    return new this.Promise((resolve, reject) => {
+      const done = makeDoneCb(resolve, reject, localErr);
+      if (args) {
+        corePool.execute(sql, args, done);
+      } else {
+        corePool.execute(sql, done);
+      }
+    });
+  }
+
+  end() {
+    const corePool = this.pool;
+    const localErr = new Error();
+    return new this.Promise((resolve, reject) => {
+      corePool.end((err) => {
+        if (err) {
+          localErr.message = err.message;
+          localErr.code = err.code;
+          localErr.errno = err.errno;
+          localErr.sqlState = err.sqlState;
+          localErr.sqlMessage = err.sqlMessage;
+          reject(localErr);
+        } else {
+          resolve();
+        }
+      });
+    });
+  }
+}
+
+(function (functionsToWrap) {
+  for (let i = 0; functionsToWrap && i < functionsToWrap.length; i++) {
+    const func = functionsToWrap[i];
+
+    if (
+      typeof BasePool.prototype[func] === 'function' &&
+      PromisePool.prototype[func] === undefined
+    ) {
+      PromisePool.prototype[func] = (function factory(funcName) {
+        return function () {
+          return BasePool.prototype[funcName].apply(this.pool, arguments);
+        };
+      })(func);
+    }
+  }
+})([
+  // synchronous functions
+  'escape',
+  'escapeId',
+  'format',
+]);
+
+module.exports = PromisePool;

package/lib/promise/pool_cluster.js

@@ -0,0 +1,54 @@
+'use strict';
+
+const PromisePoolConnection = require('./pool_connection');
+const makeDoneCb = require('./make_done_cb');
+
+class PromisePoolNamespace {
+  constructor(poolNamespace, thePromise) {
+    this.poolNamespace = poolNamespace;
+    this.Promise = thePromise || Promise;
+  }
+
+  getConnection() {
+    const corePoolNamespace = this.poolNamespace;
+    return new this.Promise((resolve, reject) => {
+      corePoolNamespace.getConnection((err, coreConnection) => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve(new PromisePoolConnection(coreConnection, this.Promise));
+        }
+      });
+    });
+  }
+
+  query(sql, values) {
+    const corePoolNamespace = this.poolNamespace;
+    const localErr = new Error();
+    if (typeof values === 'function') {
+      throw new Error(
+        'Callback function is not available with promise clients.'
+      );
+    }
+    return new this.Promise((resolve, reject) => {
+      const done = makeDoneCb(resolve, reject, localErr);
+      corePoolNamespace.query(sql, values, done);
+    });
+  }
+
+  execute(sql, values) {
+    const corePoolNamespace = this.poolNamespace;
+    const localErr = new Error();
+    if (typeof values === 'function') {
+      throw new Error(
+        'Callback function is not available with promise clients.'
+      );
+    }
+    return new this.Promise((resolve, reject) => {
+      const done = makeDoneCb(resolve, reject, localErr);
+      corePoolNamespace.execute(sql, values, done);
+    });
+  }
+}
+
+module.exports = PromisePoolNamespace;

package/lib/promise/pool_connection.js

@@ -0,0 +1,19 @@
+'use strict';
+
+const PromiseConnection = require('./connection.js');
+const BasePoolConnection = require('../base/pool_connection.js');
+
+class PromisePoolConnection extends PromiseConnection {
+  constructor(connection, promiseImpl) {
+    super(connection, promiseImpl);
+  }
+
+  destroy() {
+    return BasePoolConnection.prototype.destroy.apply(
+      this.connection,
+      arguments
+    );
+  }
+}
+
+module.exports = PromisePoolConnection;

package/lib/promise/prepared_statement_info.js

@@ -0,0 +1,32 @@
+'use strict';
+
+const makeDoneCb = require('./make_done_cb.js');
+
+class PromisePreparedStatementInfo {
+  constructor(statement, promiseImpl) {
+    this.statement = statement;
+    this.Promise = promiseImpl;
+  }
+
+  execute(parameters) {
+    const s = this.statement;
+    const localErr = new Error();
+    return new this.Promise((resolve, reject) => {
+      const done = makeDoneCb(resolve, reject, localErr);
+      if (parameters) {
+        s.execute(parameters, done);
+      } else {
+        s.execute(done);
+      }
+    });
+  }
+
+  close() {
+    return new this.Promise((resolve) => {
+      this.statement.close();
+      resolve();
+    });
+  }
+}
+
+module.exports = PromisePreparedStatementInfo;

package/lib/results_stream.js

@@ -0,0 +1,38 @@
+'use strict';
+
+const Readable = require('stream').Readable;
+
+// copy-paste from https://github.com/mysqljs/mysql/blob/master/lib/protocol/sequences/Query.js
+module.exports = function (command, connectionStream) {
+  command.stream = function (options) {
+    let stream;
+
+    options = options || {};
+    options.objectMode = true;
+    (stream = new Readable(options)),
+      (stream._read = function () {
+        connectionStream.resume();
+      });
+
+    this.on('result', (row, i) => {
+      if (!stream.push(row)) {
+        connectionStream.pause();
+      }
+      stream.emit('result', row, i); // replicate old emitter
+    });
+
+    this.on('error', (err) => {
+      stream.emit('error', err); // Pass on any errors
+    });
+
+    this.on('end', () => {
+      stream.push(null); // pushing null, indicating EOF
+    });
+
+    this.on('fields', (fields, i) => {
+      stream.emit('fields', fields, i); // replicate old emitter
+    });
+
+    return stream;
+  };
+};

package/lib/server.js

@@ -0,0 +1,37 @@
+'use strict';
+
+const net = require('net');
+const EventEmitter = require('events').EventEmitter;
+
+const Connection = require('./connection');
+const ConnectionConfig = require('./connection_config');
+
+// TODO: inherit Server from net.Server
+class Server extends EventEmitter {
+  constructor() {
+    super();
+    this.connections = [];
+    this._server = net.createServer(this._handleConnection.bind(this));
+  }
+
+  _handleConnection(socket) {
+    const connectionConfig = new ConnectionConfig({
+      stream: socket,
+      isServer: true,
+    });
+    const connection = new Connection({ config: connectionConfig });
+    this.emit('connection', connection);
+  }
+
+  listen(port) {
+    this._port = port;
+    this._server.listen.apply(this._server, arguments);
+    return this;
+  }
+
+  close(cb) {
+    this._server.close(cb);
+  }
+}
+
+module.exports = Server;

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "oceanbase",
+  "version": "0.0.1",
+  "description": "fast oceanbase driver. Implements core protocol, prepared statements, ssl and compression in native JS",
+  "main": "index.js",
+  "typings": "typings/mysql/index",
+  "type": "commonjs",
+  "scripts": {
+    "lint": "eslint . && prettier --check .",
+    "lint:fix": "eslint . --fix && prettier --write .",
+    "test": "poku -d -r=verbose --sequential test/esm test/unit test/integration",
+    "test:bun": "bun poku -d --sequential test/esm test/unit test/integration",
+    "test:deno": "deno run --allow-read --allow-env --allow-run npm:poku -d --sequential --denoAllow=\"read,env,net,sys\" test/esm test/unit test/integration",
+    "test:tsc-build": "cd \"test/tsc-build\" && npx tsc -p \"tsconfig.json\"",
+    "coverage-test": "c8 npm run test",
+    "benchmark": "node ./benchmarks/benchmark.js",
+    "wait-port": "wait-on"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sidorares/node-mysql2.git"
+  },
+  "homepage": "https://sidorares.github.io/node-mysql2/docs",
+  "keywords": [
+    "mysql",
+    "client",
+    "server"
+  ],
+  "files": [
+    "lib",
+    "typings/mysql",
+    "index.js",
+    "index.d.ts",
+    "promise.js",
+    "promise.d.ts"
+  ],
+  "exports": {
+    ".": "./index.js",
+    "./package.json": "./package.json",
+    "./promise": "./promise.js",
+    "./promise.js": "./promise.js"
+  },
+  "engines": {
+    "node": ">= 8.0"
+  },
+  "author": "Andrey Sidorov <andrey.sidorov@gmail.com>",
+  "license": "MIT",
+  "dependencies": {
+    "aws-ssl-profiles": "^1.1.1",
+    "denque": "^2.1.0",
+    "generate-function": "^2.3.1",
+    "iconv-lite": "^0.7.0",
+    "long": "^5.2.1",
+    "lru.min": "^1.0.0",
+    "named-placeholders": "^1.1.3",
+    "seq-queue": "^0.0.5",
+    "sqlstring": "^2.3.2"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.3.0",
+    "@eslint/js": "^9.21.0",
+    "@eslint/markdown": "^7.0.0",
+    "@types/node": "^25.0.2",
+    "@typescript-eslint/eslint-plugin": "^8.26.0",
+    "@typescript-eslint/parser": "^8.26.0",
+    "assert-diff": "^3.0.2",
+    "benchmark": "^2.1.4",
+    "c8": "^10.1.1",
+    "error-stack-parser": "^2.0.3",
+    "eslint-config-prettier": "^10.0.2",
+    "eslint-plugin-async-await": "^0.0.0",
+    "eslint-plugin-markdown": "^5.1.0",
+    "eslint-plugin-prettier": "^5.2.3",
+    "globals": "^16.0.0",
+    "poku": "^3.0.0",
+    "portfinder": "^1.0.28",
+    "prettier": "^3.0.0",
+    "typescript": "^5.0.2"
+  }
+}

package/promise.d.ts

@@ -0,0 +1,131 @@
+import { EventEmitter } from 'events';
+
+import {
+  RowDataPacket,
+  OkPacket,
+  ResultSetHeader,
+  FieldPacket,
+  QueryOptions,
+  ConnectionOptions,
+  PoolOptions,
+  PoolClusterOptions,
+  Pool as CorePool,
+} from './index.js';
+import { ExecutableBase as ExecutableBaseClass } from './typings/mysql/lib/protocol/sequences/promise/ExecutableBase.js';
+import { QueryableBase as QueryableBaseClass } from './typings/mysql/lib/protocol/sequences/promise/QueryableBase.js';
+
+export * from './index.js';
+
+// Expose class interfaces
+declare class QueryableAndExecutableBase extends QueryableBaseClass(
+  ExecutableBaseClass(EventEmitter)
+) {}
+
+export interface PreparedStatementInfo {
+  close(): Promise<void>;
+  execute(
+    parameters: any | any[] | { [param: string]: any }
+  ): Promise<
+    [
+      (
+        | RowDataPacket[][]
+        | RowDataPacket[]
+        | OkPacket
+        | OkPacket[]
+        | ResultSetHeader
+      ),
+      FieldPacket[],
+    ]
+  >;
+}
+
+export interface Connection extends QueryableAndExecutableBase {
+  config: ConnectionOptions;
+
+  threadId: number;
+
+  connect(): Promise<void>;
+
+  ping(): Promise<void>;
+
+  beginTransaction(): Promise<void>;
+
+  commit(): Promise<void>;
+
+  rollback(): Promise<void>;
+
+  changeUser(options: ConnectionOptions): Promise<void>;
+
+  prepare(options: string | QueryOptions): Promise<PreparedStatementInfo>;
+
+  unprepare(sql: string | QueryOptions): void;
+
+  end(options?: any): Promise<void>;
+
+  destroy(): void;
+
+  pause(): void;
+
+  resume(): void;
+
+  escape(value: any): string;
+
+  escapeId(value: string): string;
+  escapeId(values: string[]): string;
+
+  format(sql: string, values?: any | any[] | { [param: string]: any }): string;
+}
+
+export interface PoolConnection extends Connection {
+  release(): void;
+  connection: Connection;
+}
+
+export interface Pool extends Connection {
+  getConnection(): Promise<PoolConnection>;
+
+  releaseConnection(connection: PoolConnection): void;
+
+  on(event: 'connection', listener: (connection: PoolConnection) => any): this;
+  on(event: 'acquire', listener: (connection: PoolConnection) => any): this;
+  on(event: 'release', listener: (connection: PoolConnection) => any): this;
+  on(event: 'enqueue', listener: () => any): this;
+
+  end(): Promise<void>;
+
+  pool: CorePool;
+}
+
+export interface PoolNamespace extends QueryableAndExecutableBase {
+  getConnection(): Promise<PoolConnection>;
+}
+
+export interface PoolCluster extends EventEmitter {
+  config: PoolClusterOptions;
+
+  add(config: PoolOptions): void;
+  add(group: string, connectionUri: string): void;
+  add(group: string, config: PoolOptions): void;
+
+  end(): Promise<void>;
+
+  getConnection(): Promise<PoolConnection>;
+  getConnection(group: string): Promise<PoolConnection>;
+  getConnection(group: string, selector: string): Promise<PoolConnection>;
+
+  of(pattern: string, selector?: string): PoolNamespace;
+
+  on(event: string, listener: (...args: any[]) => void): this;
+  on(event: 'remove', listener: (nodeId: number) => void): this;
+  on(event: 'warn', listener: (err: Error) => void): this;
+}
+
+export function createConnection(connectionUri: string): Promise<Connection>;
+export function createConnection(
+  config: ConnectionOptions
+): Promise<Connection>;
+
+export function createPool(connectionUri: string): Pool;
+export function createPool(config: PoolOptions): Pool;
+
+export function createPoolCluster(config?: PoolClusterOptions): PoolCluster;