mysql2-core 0.3.6 → 0.3.7

package/README.md

@@ -93,10 +93,10 @@ without hiding SQL from developers.
                Executor Interface
                        │
                        ▼
-               MySQL Adapter
+                 MySQL Adapter
         ┌──────────────┼──────────────┐
         ▼              ▼              ▼
-    Connection     Transaction     Stream
+    Connection     Transaction      Stream
         │              │              │
         └──────────────┼──────────────┘
                        ▼
@@ -146,15 +146,8 @@ const db = new MySQLDB({
 
 ```ts
 const users = await db.query<User>(
-
-    `
-    SELECT *
-    FROM users
-    WHERE age > ?
-    `,
-
+    `SELECT * FROM users WHERE age > ?`,
     [18]
-
 )
 ```
 
@@ -164,15 +157,8 @@ const users = await db.query<User>(
 
 ```ts
 await db.execute(
-
-    `
-    UPDATE users
-    SET active = ?
-    WHERE id = ?
-    `,
-
+    `UPDATE users SET active = ? WHERE id = ?`
     [true, 10]
-
 )
 ```
 
@@ -184,25 +170,14 @@ await db.execute(
 const tx = await db.beginTransaction()
 
 try {
-
     await tx.execute(
-
-        `
-        INSERT INTO users(name)
-        VALUES(?)
-        `,
-
+        `INSERT INTO users(name) VALUES(?)`,
         ["John"]
-
     )
-
     await tx.commit()
-
 }
 catch (err) {
-
     await tx.rollback()
-
 }
 ```
 
@@ -212,27 +187,14 @@ catch (err) {
 
 ```ts
 await db.executeBatch([
-
     {
-
-        query:
-            "INSERT INTO users(name) VALUES(?)",
-
-        params:
-            ["John"]
-
+        query: "INSERT INTO users(name) VALUES(?)",
+        params: ["John"]
     },
-
     {
-
-        query:
-            "INSERT INTO users(name) VALUES(?)",
-
-        params:
-            ["Jane"]
-
+        query: "INSERT INTO users(name) VALUES(?)",
+        params: ["Jane"]
     }
-
 ])
 ```
 
@@ -244,17 +206,11 @@ Stream large result sets without loading everything into memory.
 
 ```ts
 await db.stream(
-
     "SELECT * FROM users",
-
     [],
-
     async user => {
-
         console.log(user)
-
     }
-
 )
 ```
 
@@ -307,14 +263,8 @@ Export query results without loading everything into memory.
 
 ```ts
 await exporter.export(
-
-    `
-    SELECT *
-    FROM users
-    `,
-
+    `SELECT * FROM users`,
     "users.csv"
-
 )
 ```
 
@@ -378,31 +328,31 @@ Perfect for
 Designed to work seamlessly with **SQL Repository**.
 
 ```
-Application
+ Application
 
-        │
+      │
 
-        ▼
+      ▼
 
 SqlRepository
 
-        │
+      │
 
-        ▼
+      ▼
 
-Executor
+  Executor
 
-        │
+      │
 
-        ▼
+      ▼
 
 MySQL Adapter
 
-        │
+      │
 
-        ▼
+      ▼
 
-mysql2
+   mysql2
 ```
 
 The repository layer never depends directly on mysql2.
@@ -414,19 +364,19 @@ The repository layer never depends directly on mysql2.
 Internally the adapter manages a connection pool.
 
 ```
-Application
+ Application
 
-        │
+      │
 
-        ▼
+      ▼
 
 Pool Manager
 
-        │
+      │
 
-        ▼
+      ▼
 
-mysql2 Pool
+ mysql2 Pool
 ```
 
 Connection reuse improves performance.
@@ -436,25 +386,25 @@ Connection reuse improves performance.
 # Transaction Model
 
 ```
-Application
+ Application
 
-        │
+      │
 
-        ▼
+      ▼
 
-Transaction
+ Transaction
 
-        │
+      │
 
-        ▼
+      ▼
 
 PoolConnection
 
-        │
+      │
 
-        ▼
+      ▼
 
-mysql2
+   mysql2
 ```
 
 Transactions are isolated from application code.
@@ -595,14 +545,14 @@ Together they provide a lightweight, SQL-first data access framework.
 
 ---
 
-# License
+# Contributing
 
-MIT License
+Contributions are welcome!
 
----
+Feel free to submit issues, feature requests, or pull requests to improve the project.
 
-# Contributing
+---
 
-Contributions are welcome!
+# License
 
-Feel free to submit issues, feature requests, or pull requests to improve the project.
+MIT License

package/lib/index.js

@@ -1272,58 +1272,46 @@ export class MySQLBatchWriter {
   }
 }
 export class MySQLChecker {
-  constructor(pool, service, timeout) {
+  constructor(pool, service, timeout = 4500) {
     this.pool = pool;
-    this.timeout = timeout ? timeout : 4200;
-    this.service = service ? service : "mysql";
-    this.check = this.check.bind(this);
-    this.name = this.name.bind(this);
-    this.build = this.build.bind(this);
+    this.timeout = timeout;
+    this.service = service || "mysql";
+  }
+  name() {
+    return this.service;
+  }
+  build(data, error) {
+    return Object.assign(Object.assign({ name: this.name(), healthy: error == null, timestamp: new Date().toISOString() }, data), (error && {
+      error: {
+        message: error.message,
+        code: error.code,
+      },
+    }));
   }
   check() {
     return __awaiter(this, void 0, void 0, function* () {
-      const obj = {};
-      const promise = new Promise((resolve, reject) => {
-        this.pool.query("select current_time", (err, result) => {
-          if (err) {
-            return reject(err);
-          }
-          else {
-            resolve(obj);
-          }
-        });
-      });
-      if (this.timeout > 0) {
-        return promiseTimeOut(this.timeout, promise);
+      const started = Date.now();
+      try {
+        yield Promise.race([this.pool.query("SELECT 1"), this.timeoutPromise()]);
+        return this.build({
+          latency: Date.now() - started,
+        }, null);
       }
-      else {
-        return promise;
+      catch (err) {
+        return this.build({
+          latency: Date.now() - started,
+        }, err);
       }
     });
   }
-  name() {
-    return this.service;
-  }
-  build(data, err) {
-    if (err) {
-      if (!data) {
-        data = {};
-      }
-      data["error"] = err;
-    }
-    return data;
+  timeoutPromise() {
+    return new Promise((_, reject) => setTimeout(() => {
+      const error = new Error("Health check timeout");
+      error.code = "TIMEOUT";
+      reject(error);
+    }, this.timeout));
   }
 }
-function promiseTimeOut(timeoutInMilliseconds, promise) {
-  return Promise.race([
-    promise,
-    new Promise((resolve, reject) => {
-      setTimeout(() => {
-        reject(`Timed out in: ${timeoutInMilliseconds} milliseconds!`);
-      }, timeoutInMilliseconds);
-    }),
-  ]);
-}
 export class Exporter {
   constructor(connection, buildQuery, ft, write, end, attributes) {
     this.connection = connection;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql2-core",
-  "version": "0.3.6",
+  "version": "0.3.7",
   "description": "mysql2-core",
   "main": "./lib/index.js",
   "types": "./src/index.ts",

package/src/index.ts

@@ -985,61 +985,71 @@ export interface AnyMap {
   [key: string]: any
 }
 // tslint:disable-next-line:max-classes-per-file
-export class MySQLChecker {
-  timeout: number
-  service: string
+export interface HealthChecker {
+  name(): string
+  build(data: AnyMap, error: any): AnyMap
+  check(): Promise<AnyMap>
+}
+export class MySQLChecker implements HealthChecker {
+  protected readonly service: string
   constructor(
-    private pool: Pool,
+    protected readonly pool: Pool,
     service?: string,
-    timeout?: number,
+    protected readonly timeout = 4500,
   ) {
-    this.timeout = timeout ? timeout : 4200
-    this.service = service ? service : "mysql"
-    this.check = this.check.bind(this)
-    this.name = this.name.bind(this)
-    this.build = this.build.bind(this)
-  }
-  async check(): Promise<AnyMap> {
-    const obj = {} as AnyMap
-    const promise = new Promise<any>((resolve, reject) => {
-      this.pool.query("select current_time", (err, result) => {
-        if (err) {
-          return reject(err)
-        } else {
-          resolve(obj)
-        }
-      })
-    })
-    if (this.timeout > 0) {
-      return promiseTimeOut(this.timeout, promise)
-    } else {
-      return promise
-    }
+    this.service = service || "mysql"
   }
+
   name(): string {
     return this.service
   }
-  build(data: AnyMap, err: any): AnyMap {
-    if (err) {
-      if (!data) {
-        data = {} as AnyMap
-      }
-      data["error"] = err
+
+  build(data: AnyMap, error: any): AnyMap {
+    return {
+      name: this.name(),
+      healthy: error == null,
+      timestamp: new Date().toISOString(),
+      ...data,
+      ...(error && {
+        error: {
+          message: error.message,
+          code: error.code,
+        },
+      }),
+    }
+  }
+
+  async check(): Promise<AnyMap> {
+    const started = Date.now()
+    try {
+      await Promise.race([this.pool.query("SELECT 1"), this.timeoutPromise()])
+      return this.build(
+        {
+          latency: Date.now() - started,
+        },
+        null,
+      )
+    } catch (err) {
+      return this.build(
+        {
+          latency: Date.now() - started,
+        },
+        err,
+      )
     }
-    return data
   }
-}
 
-function promiseTimeOut(timeoutInMilliseconds: number, promise: Promise<any>): Promise<any> {
-  return Promise.race([
-    promise,
-    new Promise((resolve, reject) => {
+  private timeoutPromise(): Promise<never> {
+    return new Promise((_, reject) =>
       setTimeout(() => {
-        reject(`Timed out in: ${timeoutInMilliseconds} milliseconds!`)
-      }, timeoutInMilliseconds)
-    }),
-  ])
+        const error: any = new Error("Health check timeout")
+        error.code = "TIMEOUT"
+        reject(error)
+      }, this.timeout),
+    )
+  }
 }
+
 export interface Formatter<T> {
   format: (row: T) => string
 }

package/tsconfig.json

@@ -13,7 +13,9 @@
     "experimentalDecorators": false,
     "removeComments": true,
     "lib": [
-      "es6"
+      "es6",
+      "ES2016",
+      "DOM"
     ]
   },
   "include": [