@superhero/db 0.0.2 → 0.4.0

package/LICENCE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2018 Erik Landvall
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -23,22 +23,45 @@ A simple DB interface implementation that reads queries from a file, segregating
 }
 ```
 
-## Example
+## Example | MySql
 
 ```js
 const
-connections = 5,
-host        = 'mysql.example.com',
-user        = 'root',
-pass        = 'b4real',
-filePath    = '/sql',
-fileSuffix  = '.sql',
-mysql       = require('mysql'),
-Db          = require('@superhero/db'),
-Adaptor     = require('@superhero/db/adaptor/mysql'),
-adaptor     = Adapter.from(mysql, { connections, host, user, password }),
-db          = new Db(adaptor, filePath, fileSuffix),
-result      = await db.query('file', ['context'])
+connections     = 5,
+host            = 'mysql.example.com',
+user            = 'root',
+password        = 'b4real',
+filePath        = '/sql',
+fileSuffix      = '.sql',
+mysql           = require('mysql'),
+Db              = require('@superhero/db'),
+AdapterFactory  = require('@superhero/db/adapter/mysql/factory'),
+adapterFactory  = new AdapterFactory(),
+adapter         = adapterFactory.create(mysql, { connections, host, user, password }),
+db              = new Db(adapter, filePath, fileSuffix),
+result          = await db.query('file', ['context'])
 ```
 
 The example above will create a pool with 5 idle connections and query the database with the content from the `/sql/file.sql` file composed with the specified context.
+
+
+## Example | Postgres
+
+```js
+const
+host            = 'postgres.example.com',
+user            = 'root',
+database        = 'stuff',
+password        = 'b4real',
+filePath        = '/sql',
+fileSuffix      = '.sql',
+pg              = require('pg'),
+Db              = require('@superhero/db'),
+AdapterFactory  = require('@superhero/db/adapter/postgres/factory'),
+adapterFactory  = new AdapterFactory(),
+adapter         = adapterFactory.create(pg, { host, user, password, database }),
+db              = new Db(adapter, filePath, fileSuffix),
+result          = await db.query('file', ['context'])
+```
+
+The example above will create a pool and query the database with the content from the `/sql/file.sql` file composed with the specified context.

package/adapter/influxdb/factory.js

@@ -0,0 +1,11 @@
+const AdapterInfluxDb = require('.')
+
+class AdapterInfluxDbFactory
+{
+  create(influxdb, escape)
+  {
+    return new AdapterInfluxDb(influxdb, escape)
+  }
+}
+
+module.exports = AdapterInfluxDbFactory

package/{adaptor → adapter}/influxdb/index.js

@@ -1,6 +1,6 @@
 const TransactionsNotAllowed = require('./error/transactions-not-allowed')
 
-class AdaptorInfluxDb
+class AdapterInfluxDb
 {
   constructor(influxdb, escape)
   {
@@ -29,6 +29,11 @@ class AdaptorInfluxDb
   {
     throw new TransactionsNotAllowed('InfluxDb transactions are not available')
   }
+
+  close()
+  {
+    // no need to close an http request, which influxdb is based on...
+  }
 }
 
-module.exports = AdaptorInfluxDb
+module.exports = AdapterInfluxDb

package/adapter/mysql/factory.js

@@ -0,0 +1,12 @@
+const AdapterMySql = require('.')
+
+class AdapterMySqlFactory
+{
+  create(mysql, config)
+  {
+    const pool = mysql.createPool(config)
+    return new AdapterMySql(pool)
+  }
+}
+
+module.exports = AdapterMySqlFactory

package/adapter/mysql/index.js

@@ -0,0 +1,51 @@
+const AdapterMySqlTransaction = require('./transaction')
+
+class AdapterMySql
+{
+  constructor(pool)
+  {
+    this.pool = pool
+  }
+
+  query(query, ...ctx)
+  {
+    const resolve = (accept, reject, i = 0) =>
+      this.pool.query(query, ...ctx, (error, response) =>
+        error
+        ? error.code === 'ETIMEDOUT' && i < 3
+          ? resolve(accept, reject, ++i)
+          : reject(error)
+        : accept(response))
+
+    return new Promise(resolve)
+  }
+
+  getConnection()
+  {
+    const resolve = (accept, reject, i = 0) =>
+      this.pool.getConnection((error, connection) =>
+        error
+        ? error.code === 'ETIMEDOUT' && i < 3
+          ? resolve(accept, reject, ++i)
+          : reject(error)
+        : accept(connection))
+
+    return new Promise(resolve)
+  }
+
+  async createTransaction()
+  {
+    const connection  = await this.getConnection()
+    await connection.query('START TRANSACTION')
+    const transaction = new AdapterMySqlTransaction(connection)
+
+    return transaction
+  }
+
+  close()
+  {
+    this.pool.end()
+  }
+}
+
+module.exports = AdapterMySql

package/{adaptor → adapter}/mysql/transaction.js

@@ -1,6 +1,6 @@
 const NestedTransactionsNotAllowed = require('./error/nested-transactions-not-allowed')
 
-class AdaptorMySqlTransaction
+class AdapterMySqlTransaction
 {
   constructor(connection)
   {
@@ -41,4 +41,4 @@ class AdaptorMySqlTransaction
   }
 }
 
-module.exports = AdaptorMySqlTransaction
+module.exports = AdapterMySqlTransaction

package/adapter/postgres/error/nested-transactions-not-allowed.js

@@ -0,0 +1,10 @@
+class NestedTransactionsNotAllowed extends Error
+{
+  constructor(...args)
+  {
+    super(...args)
+    this.code = 'E_POSTGRES_NESTED_TRANSACTIONS_UNSUPPORTED'
+  }
+}
+
+module.exports = NestedTransactionsNotAllowed

package/adapter/postgres/factory.js

@@ -0,0 +1,12 @@
+const AdapterPostgres = require('.')
+
+class AdapterPostgresFactory
+{
+  create(pg, config)
+  {
+    const pool = new pg.Pool(config)
+    return new AdapterPostgres(pool)
+  }
+}
+
+module.exports = AdapterPostgresFactory

package/adapter/postgres/index.js

@@ -0,0 +1,35 @@
+const AdapterPostgresTransaction = require('./transaction')
+
+class AdapterPostgres
+{
+  constructor(pool)
+  {
+    this.pool = pool
+  }
+
+  query(...args)
+  {
+    return this.pool.query(...args)
+  }
+
+  getConnection()
+  {
+    return this.pool.connect()
+  }
+
+  async createTransaction()
+  {
+    const connection  = await this.getConnection()
+    await connection.query('BEGIN')
+    const transaction = new AdapterPostgresTransaction(connection)
+
+    return transaction
+  }
+
+  close()
+  {
+    this.pool.end()
+  }
+}
+
+module.exports = AdapterPostgres

package/adapter/postgres/transaction.js

@@ -0,0 +1,33 @@
+const NestedTransactionsNotAllowed = require('./error/nested-transactions-not-allowed')
+
+class AdapterPostgresTransaction
+{
+  constructor(connection)
+  {
+    this.connection = connection
+  }
+
+  createTransaction()
+  {
+    throw new NestedTransactionsNotAllowed('Nested transactions are not allowed')
+  }
+
+  query(...args)
+  {
+    return this.connection.query(...args)
+  }
+
+  async commit()
+  {
+    await this.connection.query('COMMIT')
+    this.connection.release()
+  }
+
+  async rollback()
+  {
+    await this.connection.query('ROLLBACK')
+    this.connection.release()
+  }
+}
+
+module.exports = AdapterPostgresTransaction

package/adapter/redis/factory.js

@@ -0,0 +1,12 @@
+const AdapterRedis = require('.')
+
+class AdapterRedisFactory
+{
+  create(redis, options)
+  {
+    const client = redis.createClient(options)
+    return new AdapterRedis(client)
+  }
+}
+
+module.exports = AdapterRedisFactory

package/{adaptor → adapter}/redis/index.js

@@ -1,6 +1,6 @@
 const TransactionsNotAllowed = require('./error/transactions-not-allowed')
 
-class AdaptorRedis
+class AdapterRedis
 {
   constructor(redis)
   {
@@ -20,6 +20,11 @@ class AdaptorRedis
   {
     throw new TransactionsNotAllowed('Redis transactions are not available')
   }
+
+  close()
+  {
+    this.redis.end()
+  }
 }
 
-module.exports = AdaptorRedis
+module.exports = AdapterRedis

package/index.js

@@ -1,10 +1,10 @@
 const
-util        = require('util'),
-fs          = require('fs'),
-promisify   = util.promisify,
-readFile    = promisify(fs.readFile)
+  util        = require('util'),
+  fs          = require('fs'),
+  promisify   = util.promisify,
+  readFile    = promisify(fs.readFile)
 
-module.exports = class
+class Db
 {
   constructor(adaptor, queryPath, fileSuffix = '')
   {
@@ -14,11 +14,26 @@ module.exports = class
     this.queries    = {}
   }
 
+  async close()
+  {
+    await this.adaptor.close()
+  }
+
   async query(file, ...ctx)
   {
     const
-    query     = await this.getQuery(file),
-    response  = await this.adaptor.query(query, ...ctx)
+      query     = await this.getQuery(file),
+      response  = await this.adaptor.query(query, ...ctx)
+
+    return response
+  }
+
+  async formatQuery(file, formatCtx, sqlCtx)
+  {
+    const
+      query           = await this.getQuery(file),
+      formattedQuery  = util.format(query, ...formatCtx),
+      response        = await this.adaptor.query(formattedQuery, ...sqlCtx)
 
     return response
   }
@@ -53,3 +68,5 @@ module.exports = class
     return query.toString()
   }
 }
+
+module.exports = Db

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superhero/db",
-  "version": "0.0.2",
+  "version": "0.4.0",
   "description": "Db interaction, designed to separate queries from the source code",
   "repository": "git@github.com:superhero/js.db.git",
   "main": "index.js",
@@ -11,7 +11,6 @@
     "url": "http://erik.landvall.se"
   },
   "scripts": {
-    "prepublishOnly": "npm run-script generate-doc-coverage && npm run-script generate-doc-tests",
     "generate-doc-coverage": "nyc report --reporter=html --report-dir=./docs/coverage",
     "generate-doc-tests": "mocha 'test.js' --reporter mochawesome --reporter-options reportDir=docs/tests,reportFilename=index,showHooks=always",
     "syntax-check": "syntax-check",

package/adaptor/influxdb/factory.js

@@ -1,11 +0,0 @@
-const AdaptorInfluxDb = require('.')
-
-class AdaptorInfluxDbFactory
-{
-  create(influxdb, escape)
-  {
-    return new AdaptorInfluxDb(influxdb, escape)
-  }
-}
-
-module.exports = AdaptorInfluxDbFactory

package/adaptor/mysql/factory.js

@@ -1,12 +0,0 @@
-const AdaptorMySql = require('.')
-
-class AdaptorMySqlFactory
-{
-  create(mysql, config)
-  {
-    const pool = mysql.createPool(config)
-    return new AdaptorMySql(pool)
-  }
-}
-
-module.exports = AdaptorMySqlFactory

package/adaptor/mysql/index.js

@@ -1,38 +0,0 @@
-const AdaptorMySqlTransaction = require('./transaction')
-
-class AdaptorMySql
-{
-  constructor(pool)
-  {
-    this.pool = pool
-  }
-
-  query(query, ...ctx)
-  {
-    return new Promise((accept, reject) =>
-      this.pool.query(query, ...ctx, (error, response) =>
-        error
-        ? reject(error)
-        : accept(response)))
-  }
-
-  getConnection()
-  {
-    return new Promise((accept, reject) =>
-      this.pool.getConnection((error, connection) =>
-        error
-        ? reject(error)
-        : accept(connection)))
-  }
-
-  async createTransaction()
-  {
-    const connection  = await this.getConnection()
-    await connection.query('START TRANSACTION')
-    const transaction = new AdaptorMySqlTransaction(connection)
-
-    return transaction
-  }
-}
-
-module.exports = AdaptorMySql

package/adaptor/redis/factory.js

@@ -1,12 +0,0 @@
-const AdaptorRedis = require('.')
-
-class AdaptorRedisFactory
-{
-  create(redis, options)
-  {
-    const client = redis.createClient(options)
-    return new AdaptorRedis(client)
-  }
-}
-
-module.exports = AdaptorRedisFactory