@naturalcycles/mysql-lib 3.9.1 → 3.9.2

package/dist/mysql.db.js

@@ -75,7 +75,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
     async close() {
         const pool = this.pool();
         // eslint-disable-next-line @typescript-eslint/await-thenable
-        await (0, util_1.promisify)(pool.end.bind(pool));
+        await (0, util_1.promisify)(pool.end.bind(pool))();
         this.cfg.logger.log('closed');
     }
     /**
@@ -116,14 +116,20 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
     // QUERY
     async runQuery(q, _opt = {}) {
         const sql = (0, query_util_1.dbQueryToSQLSelect)(q);
-        const rows = await this.runSQL({ sql });
+        const rows = (await this.runSQL({ sql })).map(row => (0, js_lib_1._mapKeys)((0, js_lib_1._filterUndefinedValues)(row, true), k => (0, mysql_schema_util_1.mapNameFromMySQL)(k)));
+        // edge case where 0 fields are selected
+        if (q._selectedFieldNames?.length === 0) {
+            return {
+                rows: rows.map(_ => ({})),
+            };
+        }
         return {
-            rows: rows.map(r => (0, js_lib_1._mapKeys)((0, js_lib_1._filterNullishValues)(r, true), k => (0, mysql_schema_util_1.mapNameFromMySQL)(k))),
+            rows,
         };
     }
     async runSQL(q) {
         if (this.cfg.logSQL)
-            this.cfg.logger.log(q.sql, q.values);
+            this.cfg.logger.log(...[q.sql, q.values].filter(Boolean));
         return await new Promise((resolve, reject) => {
             this.pool().query(q, (err, res) => {
                 if (err)
@@ -147,7 +153,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
             .pipe(new stream_1.Transform({
             objectMode: true,
             transform(row, _encoding, cb) {
-                cb(null, (0, js_lib_1._filterNullishValues)(row, true));
+                cb(null, (0, js_lib_1._filterUndefinedValues)(row, true));
             },
         }));
     }
@@ -156,11 +162,11 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         if (!_rows.length)
             return;
         // Stringify object values
-        const rows = _rows.map(row => (0, js_lib_1._mapValues)(row, v => {
+        const rows = _rows.map(row => (0, js_lib_1._mapValues)(row, (_k, v) => {
             return v && typeof v === 'object' && !Buffer.isBuffer(v) ? JSON.stringify(v) : v;
         }));
         // inserts are split into multiple sentenses to respect the max_packet_size (1Mb usually)
-        const sqls = (0, query_util_1.insertSQL)(table, rows, 'INSERT', this.cfg.logger);
+        const sqls = (0, query_util_1.insertSQL)(table, rows, 'REPLACE', this.cfg.logger);
         for await (const sql of sqls) {
             await this.runSQL({ sql });
         }

package/dist/query.util.d.ts

@@ -6,7 +6,7 @@ export declare function dbQueryToSQLDelete(q: DBQuery<any>): string;
 /**
  * Returns array of sql statements to respect the max sql size.
  */
-export declare function insertSQL(table: string, records: Record<any, any>[], verb?: 'INSERT' | 'REPLACE', logger?: CommonLogger): string[];
+export declare function insertSQL(table: string, rows: Record<any, any>[], verb?: 'INSERT' | 'REPLACE', logger?: CommonLogger): string[];
 export declare function insertSQLSingle(table: string, record: Record<any, any>): string;
 export declare function insertSQLSetSingle(table: string, record: Record<any, any>): QueryOptions;
 export declare function dbQueryToSQLUpdate(q: DBQuery<any>, record: Record<any, any>): string;

package/dist/query.util.js

@@ -30,12 +30,12 @@ exports.dbQueryToSQLDelete = dbQueryToSQLDelete;
 /**
  * Returns array of sql statements to respect the max sql size.
  */
-function insertSQL(table, records, verb = 'INSERT', logger = console) {
+function insertSQL(table, rows, verb = 'INSERT', logger = console) {
     // INSERT INTO table_name (column1, column2, column3, ...)
     // VALUES (value1, value2, value3, ...);
     // eslint-disable-next-line unicorn/no-array-reduce
-    const fieldSet = records.reduce((set, rec) => {
-        Object.keys(rec).forEach(field => set.add(field));
+    const fieldSet = rows.reduce((set, row) => {
+        Object.keys(row).forEach(field => set.add(field));
         return set;
     }, new Set());
     const fields = [...fieldSet];
@@ -46,7 +46,7 @@ function insertSQL(table, records, verb = 'INSERT', logger = console) {
         `(` + [...fields].map(f => mysql.escapeId((0, mysql_schema_util_1.mapNameToMySQL)(f))).join(',') + `)`,
         `VALUES\n`,
     ].join(' ');
-    const valueRows = records.map(rec => {
+    const valueRows = rows.map(rec => {
         return `(` + fields.map(k => mysql.escape(rec[k])).join(',') + `)`;
     });
     const full = start + valueRows.join(',\n');

package/dist/schema/mysql.schema.util.js

@@ -80,7 +80,7 @@ function mysqlTableStatsToJsonSchemaField(table, stats, logger) {
         else if (t.startsWith('tinyint') || t.includes('(1)')) {
             s.properties[name] = { type: 'boolean' };
         }
-        else if (t.startsWith('int(')) {
+        else if (t === 'int' || t.startsWith('int(')) {
             s.properties[name] = { type: 'integer' };
         }
         else if (t.startsWith('float')) {

package/package.json

@@ -12,7 +12,7 @@
   },
   "devDependencies": {
     "@naturalcycles/dev-lib": "^12.7.5",
-    "@types/node": "^16.10.2",
+    "@types/node": "^17.0.5",
     "dotenv": "^10.0.0",
     "jest": "^27.2.4"
   },
@@ -36,7 +36,7 @@
   "engines": {
     "node": ">=14.15.0"
   },
-  "version": "3.9.1",
+  "version": "3.9.2",
   "description": "MySQL client implementing CommonDB interface",
   "keywords": [
     "mysql",

package/readme.md

@@ -3,12 +3,33 @@
 > MySQL client implementing CommonDB interface
 
 [![npm](https://img.shields.io/npm/v/@naturalcycles/mysql-lib/latest.svg)](https://www.npmjs.com/package/@naturalcycles/mysql-lib)
-[![](https://circleci.com/gh/NaturalCycles/mysql-lib.svg?style=shield&circle-token=123)](https://circleci.com/gh/NaturalCycles/mysql-lib)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 
-# Packaging
+# Quick start
 
-- `engines.node >= 10.13`: Latest Node.js LTS
-- `main: dist/index.js`: commonjs, es2018
-- `types: dist/index.d.ts`: typescript types
-- `/src` folder with source `*.ts` files included
+todo
+
+# Develop
+
+Install MySQL server+client on Mac:
+
+```shell
+
+brew install mysql
+
+# start
+
+mysql.server start
+
+# secure
+
+mysql_secure_installation
+
+# connect
+
+mysql -uroot
+
+# Default options are read from the following files in the given order:
+# /etc/my.cnf /etc/mysql/my.cnf /opt/homebrew/etc/my.cnf ~/.my.cnf
+
+```

package/src/mysql.db.ts

@@ -10,7 +10,7 @@ import {
   RunQueryResult,
 } from '@naturalcycles/db-lib'
 import {
-  _filterNullishValues,
+  _filterUndefinedValues,
   _mapKeys,
   _mapValues,
   _Memo,
@@ -136,7 +136,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   async close(): Promise<void> {
     const pool = this.pool()
     // eslint-disable-next-line @typescript-eslint/await-thenable
-    await promisify(pool.end.bind(pool))
+    await promisify(pool.end.bind(pool))()
     this.cfg.logger.log('closed')
   }
 
@@ -191,14 +191,24 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     _opt: MysqlDBOptions = {},
   ): Promise<RunQueryResult<OUT>> {
     const sql = dbQueryToSQLSelect(q)
-    const rows = await this.runSQL<ROW[]>({ sql })
+    const rows = (await this.runSQL<ROW[]>({ sql })).map(
+      row => _mapKeys(_filterUndefinedValues(row, true), k => mapNameFromMySQL(k)) as any,
+    )
+
+    // edge case where 0 fields are selected
+    if (q._selectedFieldNames?.length === 0) {
+      return {
+        rows: rows.map(_ => ({} as any)),
+      }
+    }
+
     return {
-      rows: rows.map(r => _mapKeys(_filterNullishValues(r, true), k => mapNameFromMySQL(k)) as any),
+      rows,
     }
   }
 
   async runSQL<RESULT>(q: QueryOptions): Promise<RESULT> {
-    if (this.cfg.logSQL) this.cfg.logger.log(q.sql, q.values)
+    if (this.cfg.logSQL) this.cfg.logger.log(...[q.sql, q.values].filter(Boolean))
 
     return await new Promise<RESULT>((resolve, reject) => {
       this.pool().query(q, (err, res) => {
@@ -232,7 +242,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
         new Transform({
           objectMode: true,
           transform(row, _encoding, cb) {
-            cb(null, _filterNullishValues(row, true))
+            cb(null, _filterUndefinedValues(row, true))
           },
         }),
       )
@@ -248,13 +258,13 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
 
     // Stringify object values
     const rows = _rows.map(row =>
-      _mapValues(row, v => {
+      _mapValues(row, (_k, v) => {
         return v && typeof v === 'object' && !Buffer.isBuffer(v) ? JSON.stringify(v) : v
       }),
     )
 
     // inserts are split into multiple sentenses to respect the max_packet_size (1Mb usually)
-    const sqls = insertSQL(table, rows, 'INSERT', this.cfg.logger)
+    const sqls = insertSQL(table, rows, 'REPLACE', this.cfg.logger)
 
     for await (const sql of sqls) {
       await this.runSQL({ sql })

package/src/query.util.ts

@@ -41,7 +41,7 @@ export function dbQueryToSQLDelete(q: DBQuery<any>): string {
  */
 export function insertSQL(
   table: string,
-  records: Record<any, any>[],
+  rows: Record<any, any>[],
   verb: 'INSERT' | 'REPLACE' = 'INSERT',
   logger: CommonLogger = console,
 ): string[] {
@@ -49,8 +49,8 @@ export function insertSQL(
   // VALUES (value1, value2, value3, ...);
 
   // eslint-disable-next-line unicorn/no-array-reduce
-  const fieldSet = records.reduce((set: Set<string>, rec) => {
-    Object.keys(rec).forEach(field => set.add(field))
+  const fieldSet = rows.reduce((set: Set<string>, row) => {
+    Object.keys(row).forEach(field => set.add(field))
     return set
   }, new Set<string>())
   const fields = [...fieldSet]
@@ -63,7 +63,7 @@ export function insertSQL(
     `VALUES\n`,
   ].join(' ')
 
-  const valueRows = records.map(rec => {
+  const valueRows = rows.map(rec => {
     return `(` + fields.map(k => mysql.escape(rec[k])).join(',') + `)`
   })
 

package/src/schema/mysql.schema.util.ts

@@ -106,7 +106,7 @@ export function mysqlTableStatsToJsonSchemaField<T = any>(
       s.properties[name] = { instanceof: 'Buffer' }
     } else if (t.startsWith('tinyint') || t.includes('(1)')) {
       s.properties[name] = { type: 'boolean' } as JsonSchemaBoolean
-    } else if (t.startsWith('int(')) {
+    } else if (t === 'int' || t.startsWith('int(')) {
       s.properties[name] = { type: 'integer' } as JsonSchemaNumber
     } else if (t.startsWith('float')) {
       s.properties[name] = { type: 'number' } as JsonSchemaNumber