Merge pull request #20 from cemremengu/prep-4.x

Update for 4.x

Author: cemremengu

.travis.yml

@@ -3,12 +3,12 @@ sudo: required
 dist: xenial
 
 node_js:
+  - "11"
   - "10"
   - "8"
   - "6"
 
 script:
-  - npm run lint
   - npm run test
 
 env:

README.md

@@ -103,13 +103,16 @@ fastify.oracle.transact((conn, commit) => {
 `fastify-oracle` requires an options object with at least one of the following
 properties:
 
-+ `pool`: an `oracledb` [pool configuration object](https://github.com/oracle/node-oracledb/blob/33331413/doc/api.md#createpool)
-+ `poolAlias`: the name of a pool alias that has already been configured. This
+- `pool`: an `oracledb` [pool configuration object](https://github.com/oracle/node-oracledb/blob/33331413/doc/api.md#createpool)
+- `poolAlias`: the name of a pool alias that has already been configured. This
 takes precedence over the `pool` option.
-+ `client`: an instance of an `oracledb` connection pool. This takes precedence
+- `client`: an instance of an `oracledb` connection pool. This takes precedence
 over the `pool` and `poolAlias` options.
-+ `name`: can be used in order to connect to multiple oracledb instances. The first registered instance can be accessed via `fastify.oracle` or `fastify.oracle.<dbname>`. Note that once you register a *named* instance, you will *not* be able to register an unnamed instance.
-+ `objectOutput`: sets the `outFormat` of oracledb to `OBJECT` (default: `false` i.e: `ARRAY`)
+- `name`: (optional) can be used in order to connect to multiple oracledb instances. The first registered instance can be accessed via `fastify.oracle` or `fastify.oracle.<dbname>`. Note that once you register a *named* instance, you will *not* be able to register an unnamed instance.
+- `outFormat`: (optional) sets the `outFormat` of oracledb. Should be `'ARRAY'` or `'OBJECT'`. Default: `'ARRAY'`
+- `fetchAsString`: (optional) the column data of specified types are returned as a string instead of the default representation. Should be an array of valid data types. 
+Valid values are `['DATE', 'NUMBER', 'BUFFER', 'CLOB']`. Default `[]`.
+
 
 ```js
 const fastify = require('fastify')()
@@ -140,7 +143,7 @@ fastify.get('/db_1_data', async function (req, reply) {
     return result.rows
   } finally {
     if (conn) {
-      conn.close().catch((err) => {})    
+      conn.close().catch((err) => {})
     }
   } 
 })
@@ -153,7 +156,7 @@ fastify.get('/db_2_data', async function (req, reply) {
     return result.rows
   } finally {
     if (conn) {
-      conn.close().catch((err) => {})    
+      conn.close().catch((err) => {})
     }
   }
 })
@@ -170,7 +173,7 @@ fastify.get('/db_data', async function (req, reply) {
     return result.rows
   } finally {
     if (conn) {
-      conn.close().catch((err) => {})    
+      conn.close().catch((err) => {})
     }
   } 
 })

package.json

@@ -4,11 +4,11 @@
   "description": "A plugin for Fastify to provide Oracle DB connections",
   "main": "plugin.js",
   "scripts": {
-    "test": "standard && tap --cov test/*.test.js",
-    "lint": "standard | snazzy"
+    "pretest": "npm run lint",
+    "test": " tap --cov test/*.test.js",
+    "lint": "standard --fix | snazzy"
   },
   "precommit": [
-    "lint",
     "test"
   ],
   "repository": {
@@ -26,14 +26,14 @@
   },
   "homepage": "https://github.com/cemremengu/fastify-oracle#readme",
   "devDependencies": {
-    "fastify": "^1.11.1",
+    "fastify": "^1.13.3",
     "pre-commit": "^1.2.2",
     "snazzy": "^8.0.0",
     "standard": "^12.0.1",
-    "tap": "^12.0.1"
+    "tap": "^12.1.1"
   },
   "dependencies": {
-    "fastify-plugin": "^1.2.0",
-    "oracledb": "^2.1.2"
+    "fastify-plugin": "^1.4.0",
+    "oracledb": "^3.0.1"
   }
 }

plugin.js

@@ -95,8 +95,12 @@ function fastifyOracleDB (fastify, options, next) {
     return next(Error('fastify-oracle: must supply options.pool oracledb pool options'))
   }
 
-  if (options.objectOutput) {
-    oracledb.outFormat = oracledb.OBJECT
+  if (options.outFormat) {
+    oracledb.outFormat = oracledb[options.outFormat.toUpperCase()]
+  }
+
+  if (options.fetchAsString) {
+    oracledb.fetchAsString = options.fetchAsString.map(t => oracledb[t.toUpperCase()])
   }
 
   oracledb.createPool(options.pool, (err, pool) => {

test/opts.test.js

@@ -92,7 +92,7 @@ test('sets OBJECT as default outFormat', (t) => {
   oracledb.outFormat = oracledb.ARRAY
 
   const fastify = Fastify()
-  fastify.register(plugin, { pool: {}, objectOutput: true })
+  fastify.register(plugin, { pool: {}, outFormat: 'OBJECT' })
 
   fastify.ready(err => {
     t.error(err)
@@ -101,3 +101,16 @@ test('sets OBJECT as default outFormat', (t) => {
     oracledb.outFormat = oracledb.ARRAY
   })
 })
+
+test('sets fetchAsString values', (t) => {
+  t.plan(3)
+
+  const fastify = Fastify()
+  fastify.register(plugin, { pool: {}, fetchAsString: ['NUMBER'] })
+
+  fastify.ready(err => {
+    t.error(err)
+    t.ok(fastify.oracle.pool)
+    t.deepEquals(fastify.oracle.db.fetchAsString, [fastify.oracle.db.NUMBER])
+  })
+})

test/plugin.test.js

@@ -120,7 +120,7 @@ test('transact with promise', (t) => {
   t.plan(6)
 
   const fastify = Fastify()
-  fastify.register(plugin, { pool: poolOptions, objectOutput: true })
+  fastify.register(plugin, { pool: poolOptions, outFormat: 'OBJECT' })
 
   fastify.ready(err => {
     t.error(err)
@@ -144,7 +144,7 @@ test('transact with callback', (t) => {
   t.plan(6)
 
   const fastify = Fastify()
-  fastify.register(plugin, { pool: poolOptions, objectOutput: true })
+  fastify.register(plugin, { pool: poolOptions, outFormat: 'OBJECT' })
 
   fastify.ready(err => {
     t.error(err)
@@ -168,7 +168,7 @@ test('transact with commit callback', (t) => {
   t.plan(6)
 
   const fastify = Fastify()
-  fastify.register(plugin, { pool: poolOptions, objectOutput: true })
+  fastify.register(plugin, { pool: poolOptions, outFormat: 'OBJECT' })
 
   fastify.ready(err => {
     t.error(err)
@@ -193,7 +193,7 @@ test('transact with promise (error)', (t) => {
   t.plan(5)
 
   const fastify = Fastify()
-  fastify.register(plugin, { pool: poolOptions, objectOutput: true })
+  fastify.register(plugin, { pool: poolOptions, outFormat: 'OBJECT' })
 
   fastify.ready(err => {
     t.error(err)
@@ -216,7 +216,7 @@ test('transact with callback (error)', (t) => {
   t.plan(6)
 
   const fastify = Fastify()
-  fastify.register(plugin, { pool: poolOptions, objectOutput: true })
+  fastify.register(plugin, { pool: poolOptions, outFormat: 'OBJECT' })
 
   fastify.ready(err => {
     t.error(err)
@@ -240,7 +240,7 @@ test('transact with commit callback (error)', (t) => {
   t.plan(6)
 
   const fastify = Fastify()
-  fastify.register(plugin, { pool: poolOptions, objectOutput: true })
+  fastify.register(plugin, { pool: poolOptions, outFormat: 'OBJECT' })
 
   fastify.ready(err => {
     t.error(err)
@@ -265,7 +265,7 @@ test('transact with callback + invalid connection pool', (t) => {
   t.plan(6)
 
   const fastify = Fastify()
-  fastify.register(plugin, { pool: {}, objectOutput: true })
+  fastify.register(plugin, { pool: {}, outFormat: 'object' })
 
   fastify.ready(err => {
     t.error(err)
@@ -289,7 +289,7 @@ test('transact with promise + invalid connection pool', (t) => {
   t.plan(5)
 
   const fastify = Fastify()
-  fastify.register(plugin, { pool: {}, objectOutput: true })
+  fastify.register(plugin, { pool: {}, outFormat: 'OBJECT' })
 
   fastify.ready(err => {
     t.error(err)
@@ -312,7 +312,7 @@ test('transact commit should error if connection drops', (t) => {
   t.plan(6)
 
   const fastify = Fastify()
-  fastify.register(plugin, { pool: poolOptions, objectOutput: true })
+  fastify.register(plugin, { pool: poolOptions, outFormat: 'OBJECT' })
 
   fastify.ready(err => {
     t.error(err)