fix: support CommonLogger

Author: kirillgroshkov

CHANGELOG.md

@@ -1,48 +1 @@
-## [1.2.1](https://github.com/NaturalCycles/sqlite-lib/compare/v1.2.0...v1.2.1) (2021-10-17)
-
-
-### Bug Fixes
-
-* adapt to latest db-lib ([f043e61](https://github.com/NaturalCycles/sqlite-lib/commit/f043e61dced26d5d434a6e7b5f3f1af5b1dc7011))
-
-# [1.2.0](https://github.com/NaturalCycles/sqlite-lib/compare/v1.1.0...v1.2.0) (2021-08-25)
-
-
-### Features
-
-* `count` method on KeyValueDB ([3724a9e](https://github.com/NaturalCycles/sqlite-lib/commit/3724a9edad394e27052ad9c3af8c285ef60837cd))
-
-# [1.1.0](https://github.com/NaturalCycles/sqlite-lib/compare/v1.0.3...v1.1.0) (2021-08-24)
-
-
-### Features
-
-* implement streaming methods of KeyValueDB ([9da8ba7](https://github.com/NaturalCycles/sqlite-lib/commit/9da8ba7a62087b8ec36bfef8cb6c142fd43e972a))
-
-## [1.0.3](https://github.com/NaturalCycles/sqlite-lib/compare/v1.0.2...v1.0.3) (2021-07-04)
-
-
-### Bug Fixes
-
-* adapt naming `KV` => `KeyValue` ([193e80b](https://github.com/NaturalCycles/sqlite-lib/commit/193e80b370e7bcb52a63aeb516bb9745799b943d))
-
-## [1.0.2](https://github.com/NaturalCycles/sqlite-lib/compare/v1.0.1...v1.0.2) (2021-07-03)
-
-
-### Bug Fixes
-
-* don't begin/end transaction in saveBatch ([e01ec93](https://github.com/NaturalCycles/sqlite-lib/commit/e01ec9329122d4160cd26b83da3fcb522ac6fb42))
-
-## [1.0.1](https://github.com/NaturalCycles/sqlite-lib/compare/v1.0.0...v1.0.1) (2021-06-27)
-
-
-### Bug Fixes
-
-* test ([e72d0d1](https://github.com/NaturalCycles/sqlite-lib/commit/e72d0d10fc5c632f7307b6eef25b339b2d20c162))
-
-# 1.0.0 (2021-06-27)
-
-
-### Features
-
-* first version ([90035cc](https://github.com/NaturalCycles/sqlite-lib/commit/90035cce71bfc2bdd00f2f88982771c7dd597f54))
+See [Github Releases](https://github.com/NaturalCycles/sqlite-lib/releases)

package.json

@@ -34,7 +34,7 @@
     "url": "https://github.com/NaturalCycles/sqlite-lib"
   },
   "engines": {
-    "node": ">=12.13.1"
+    "node": ">=14.15.0"
   },
   "version": "1.2.1",
   "description": "CommonDB implementation based on SQLite",

src/sqlite.db.ts

@@ -5,8 +5,7 @@ import {
   CommonDBOptions,
   CommonDBSaveOptions,
 } from '@naturalcycles/db-lib'
-import { JsonSchemaObject, ObjectWithId } from '@naturalcycles/js-lib'
-import { Debug } from '@naturalcycles/nodejs-lib'
+import { CommonLogger, JsonSchemaObject, ObjectWithId } from '@naturalcycles/js-lib'
 import { boldWhite } from '@naturalcycles/nodejs-lib/dist/colors'
 import { Database, open } from 'sqlite'
 import { OPEN_CREATE, OPEN_READWRITE } from 'sqlite3'
@@ -25,15 +24,21 @@ export interface SQLiteDBCfg {
    * @default sqlite.Database
    */
   driver?: any
-}
 
-const log = Debug('nc:sqlite')
+  logger?: CommonLogger
+}
 
 export class SQLiteDB extends BaseCommonDB implements CommonDB {
-  constructor(public cfg: SQLiteDBCfg) {
+  constructor(cfg: SQLiteDBCfg) {
     super()
+    this.cfg = {
+      logger: console,
+      ...cfg,
+    }
   }
 
+  cfg: SQLiteDBCfg & { logger: CommonLogger }
+
   _db?: Database
 
   get db(): Database {
@@ -50,13 +55,13 @@ export class SQLiteDB extends BaseCommonDB implements CommonDB {
       mode: OPEN_READWRITE | OPEN_CREATE, // tslint:disable-line
       ...this.cfg,
     })
-    log(`${boldWhite(this.cfg.filename)} opened`)
+    this.cfg.logger.log(`${boldWhite(this.cfg.filename)} opened`)
   }
 
   async close(): Promise<void> {
     if (!this._db) return
     await this.db.close()
-    log(`${boldWhite(this.cfg.filename)} closed`)
+    this.cfg.logger.log(`${boldWhite(this.cfg.filename)} closed`)
   }
 
   override async ping(): Promise<void> {

src/sqliteKeyValueDB.ts

@@ -1,6 +1,6 @@
 import { CommonDBCreateOptions, CommonKeyValueDB, KeyValueDBTuple } from '@naturalcycles/db-lib'
-import { pMap } from '@naturalcycles/js-lib'
-import { Debug, readableCreate, ReadableTyped } from '@naturalcycles/nodejs-lib'
+import { CommonLogger, pMap } from '@naturalcycles/js-lib'
+import { readableCreate, ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { boldWhite } from '@naturalcycles/nodejs-lib/dist/colors'
 import { Database, open } from 'sqlite'
 import * as sqlite3 from 'sqlite3'
@@ -27,17 +27,27 @@ export interface SQLiteKeyValueDBCfg {
    * @default false
    */
   debug?: boolean
+
+  /**
+   * Defaults to `console`
+   */
+  logger?: CommonLogger
 }
 
 interface KeyValueObject {
   id: string
   v: Buffer
 }
 
-const log = Debug('nc:sqlite')
-
 export class SqliteKeyValueDB implements CommonKeyValueDB {
-  constructor(public cfg: SQLiteKeyValueDBCfg) {}
+  constructor(cfg: SQLiteKeyValueDBCfg) {
+    this.cfg = {
+      logger: console,
+      ...cfg,
+    }
+  }
+
+  cfg: SQLiteKeyValueDBCfg & { logger: CommonLogger }
 
   _db?: Database
 
@@ -55,13 +65,13 @@ export class SqliteKeyValueDB implements CommonKeyValueDB {
       mode: OPEN_READWRITE | OPEN_CREATE, // tslint:disable-line
       ...this.cfg,
     })
-    log(`${boldWhite(this.cfg.filename)} opened`)
+    this.cfg.logger.log(`${boldWhite(this.cfg.filename)} opened`)
   }
 
   async close(): Promise<void> {
     if (!this._db) return
     await this.db.close()
-    log(`${boldWhite(this.cfg.filename)} closed`)
+    this.cfg.logger.log(`${boldWhite(this.cfg.filename)} closed`)
   }
 
   async ping(): Promise<void> {
@@ -72,7 +82,7 @@ export class SqliteKeyValueDB implements CommonKeyValueDB {
     if (opt.dropIfExists) await this.dropTable(table)
 
     const sql = `create table ${table} (id TEXT PRIMARY KEY, v BLOB NOT NULL)`
-    console.log(sql)
+    this.cfg.logger.log(sql)
     await this.db.exec(sql)
   }
 
@@ -85,7 +95,7 @@ export class SqliteKeyValueDB implements CommonKeyValueDB {
 
   async deleteByIds(table: string, ids: string[]): Promise<void> {
     const sql = deleteByIdsSQL(table, ids)
-    if (this.cfg.debug) console.log(sql)
+    if (this.cfg.debug) this.cfg.logger.log(sql)
     await this.db.run(sql)
   }
 
@@ -95,7 +105,7 @@ export class SqliteKeyValueDB implements CommonKeyValueDB {
    */
   async getByIds(table: string, ids: string[]): Promise<KeyValueDBTuple[]> {
     const sql = selectKVSQL(table, ids)
-    if (this.cfg.debug) console.log(sql)
+    if (this.cfg.debug) this.cfg.logger.log(sql)
     const rows = await this.db.all<KeyValueObject[]>(sql)
     // console.log(rows)
     return rows.map(r => [r.id, r.v])
@@ -109,7 +119,7 @@ export class SqliteKeyValueDB implements CommonKeyValueDB {
 
     await pMap(statements, async statement => {
       const [sql, params] = statement
-      if (this.cfg.debug) console.log(sql)
+      if (this.cfg.debug) this.cfg.logger.log(sql)
       await this.db.run(sql, ...params)
     })
 
@@ -199,7 +209,7 @@ export class SqliteKeyValueDB implements CommonKeyValueDB {
   async count(table: string): Promise<number> {
     const sql = `SELECT count(*) as cnt FROM ${table}`
 
-    if (this.cfg.debug) console.log(sql)
+    if (this.cfg.debug) this.cfg.logger.log(sql)
 
     const { cnt } = (await this.db.get<{ cnt: number }>(sql))!
     return cnt