mssql 4.0.1 → 4.1.0

package/CHANGELOG.txt

@@ -1,3 +1,22 @@
+v4.1.0 (2017-09-29)
+-------------------
+[new] Adding support for the MultiSubnetFailover option in connection strings (Paul Kehrer)
+[new] Add request timeout support for msnodesqlv8 queries (Michael Parque)
+[fix] Fix type inference of non-integer numbers (Andrew Crites)
+[fix] Set acquireTimeout on generic pool (Karl Wiggisser)
+
+v4.0.4 (2017-04-25)
+-------------------
+[fix] Fix auto-closing of idle connections
+
+v4.0.3 (2017-04-25)
+-------------------
+[fix] Fixed broken CLI & debugging
+
+v4.0.2 (2017-04-19)
+-------------------
+[fix] Fixed broken JSON parser
+
 v4.0.1 (2017-04-02)
 -------------------
 [fix] Fixed stream in pipe mode

package/README.md

@@ -40,7 +40,7 @@ If you're on Windows Azure, add `?encrypt=true` to your connection string. See [
 
 ### Examples
 
-* [Async/Await](#async-await)
+* [Async/Await](#asyncawait)
 * [Promises](#promises)
 * [ES6 Tagged template literals](#es6-tagged-template-literals)
 * [Callbacks](#callbacks)
@@ -59,7 +59,7 @@ If you're on Windows Azure, add `?encrypt=true` to your connection string. See [
 
 ### Connections
 
-* [ConnectionPool](#connectionpool)
+* [ConnectionPool](#connections-1)
 * [connect](#connect-callback)
 * [close](#close)
 
@@ -168,7 +168,7 @@ sql.connect(config).then(pool => {
     .input('input_parameter', sql.Int, value)
     .query('select * from mytable where id = @input_parameter')
 }).then(result => {
-    console.dir(recordset)
+    console.dir(result)
     
     // Stored procedure
     
@@ -189,7 +189,7 @@ sql.on('error', err => {
 
 Native Promise is used by default. You can easily change this with `sql.Promise = require('myownpromisepackage')`.
 
-**ES6 Tagged template literals**
+### ES6 Tagged template literals
 
 ```javascript
 const sql = require('mssql')
@@ -301,7 +301,7 @@ pool1.on('error', err => {
     // ... error handler
 })
 
-const pool2 = new sql.Connection(config, err => {
+const pool2 = new sql.ConnectionPool(config, err => {
     // ... error checks
 
     // Stored Procedure
@@ -316,7 +316,7 @@ const pool2 = new sql.Connection(config, err => {
     })
 })
 
-pool1.on('error', err => {
+pool2.on('error', err => {
     // ... error handler
 })
 ```
@@ -360,13 +360,15 @@ const config = {
 - **domain** - Once you set domain, driver will connect to SQL Server using domain login.
 - **database** - Database to connect to (default: dependent on server configuration).
 - **connectionTimeout** - Connection timeout in ms (default: `15000`).
-- **requestTimeout** - Request timeout in ms (default: `15000`).
+- **requestTimeout** - Request timeout in ms (default: `15000`). NOTE: msnodesqlv8 driver doesn't support timeouts < 1 second.
 - **stream** - Stream recordsets/rows instead of returning them all at once as an argument of callback (default: `false`). You can also enable streaming for each request independently (`request.stream = true`). Always set to `true` if you plan to work with large amount of rows.
 - **parseJSON** - Parse JSON recordsets to JS objects (default: `false`). For more information please see section [JSON support](#json-support).
 - **pool.max** - The maximum number of connections there can be in the pool (default: `10`).
 - **pool.min** - The minimum of connections there can be in the pool (default: `0`).
 - **pool.idleTimeoutMillis** - The Number of milliseconds before closing an unused connection (default: `30000`).
 
+Complete list of pool options can be found [here](https://github.com/coopernurse/node-pool).
+
 ### Formats
 
 In addition to configuration object there is an option to pass config as a connection string. Two formats of connection string are supported.
@@ -725,7 +727,7 @@ You can enable multiple recordsets in queries with the `request.multiple = true`
 
 ---------------------------------------
 
-### bulk(table, [callback])
+### bulk (table, [callback])
 
 Perform a bulk insert.
 
@@ -1540,7 +1542,6 @@ request.query('select @myval as myval', (err, result) => {
 - msnodesqlv8 has problem with errors during transactions - [reported](https://github.com/patriksimek/node-mssql/issues/77).
 - msnodesqlv8 doesn't timeout the connection reliably - [reported](https://github.com/TimelordUK/node-sqlserver-v8/issues/9).
 - msnodesqlv8 doesn't support [TVP](#table-valued-parameter-tvp) data type.
-- msnodesqlv8 doesn't support Variant data type.
 - msnodesqlv8 doesn't support request timeout.
 - msnodesqlv8 doesn't support request cancellation.
 - msnodesqlv8 doesn't support [detailed SQL errors](#detailed-sql-errors).

package/lib/base.js

@@ -66,14 +66,12 @@ let getTypeByValue = function (value) {
       return TYPES.NVarChar
 
     case 'number':
-      for (item of Array.from(map)) {
-        if (item.js === Number) {
-          return item.sql
-        }
+      if (value % 1 === 0) {
+        return TYPES.Int
+      } else {
+        return TYPES.Float
       }
 
-      return TYPES.Int
-
     case 'boolean':
       for (item of Array.from(map)) {
         if (item.js === Boolean) {
@@ -171,7 +169,7 @@ class ConnectionPool extends EventEmitter {
     debug('conn: acquire')
 
     if (typeof callback === 'function') {
-      this._acquire().then(connection => callback(null, connection)).catch(callback)
+      this._acquire().then(connection => callback(null, connection, this.config)).catch(callback)
       return this
     }
 
@@ -253,9 +251,10 @@ class ConnectionPool extends EventEmitter {
       }, Object.assign({
         max: 10,
         min: 0,
+        acquireTimeoutMillis: this.config.connectionTimeout || this.config.timeout || 15000,
+        evictionRunIntervalMillis: 1000,
         idleTimeoutMillis: 30000,
-        testOnBorrow: true,
-        autostart: false
+        testOnBorrow: true
       }, this.config.pool))
 
       this.pool.on('factoryCreateError', this.emit.bind(this, 'error'))
@@ -414,7 +413,7 @@ class PreparedStatement extends EventEmitter {
     debug('ps: acquire ok')
 
     this._activeRequest = request
-    setImmediate(callback, null, this._acquiredConnection)
+    setImmediate(callback, null, this._acquiredConnection, this._acquiredConfig)
     return this
   }
 
@@ -543,10 +542,11 @@ class PreparedStatement extends EventEmitter {
 
     this.statement = statement || this.statement
 
-    this.parent.acquire(this, (err, connection) => {
+    this.parent.acquire(this, (err, connection, config) => {
       if (err) return callback(err)
 
       this._acquiredConnection = connection
+      this._acquiredConfig = config
 
       const req = new driver.Request(this)
       req.stream = false
@@ -564,6 +564,7 @@ class PreparedStatement extends EventEmitter {
         if (err) {
           this.parent.release(this._acquiredConnection)
           this._acquiredConnection = null
+          this._acquiredConfig = null
 
           return callback(err)
         }
@@ -678,6 +679,7 @@ class PreparedStatement extends EventEmitter {
 
       this.parent.release(this._acquiredConnection)
       this._acquiredConnection = null
+      this._acquiredConfig = null
       this._handle = 0
       this.prepared = false
 
@@ -742,7 +744,7 @@ class Transaction extends EventEmitter {
     debug('tran: acquire ok')
 
     this._activeRequest = request
-    setImmediate(callback, null, this._acquiredConnection)
+    setImmediate(callback, null, this._acquiredConnection, this._acquiredConfig)
     return this
   }
 
@@ -1419,6 +1421,7 @@ class ConnectionError extends Error {
       super(message.message)
       this.code = message.code || code
 
+      Error.captureStackTrace(this, this.constructor)
       Object.defineProperty(this, 'originalError', {enumerable: true, value: message})
     } else {
       super(message)
@@ -1446,6 +1449,7 @@ class TransactionError extends Error {
       super(message.message)
       this.code = message.code || code
 
+      Error.captureStackTrace(this, this.constructor)
       Object.defineProperty(this, 'originalError', {enumerable: true, value: message})
     } else {
       super(message)
@@ -1492,6 +1496,7 @@ class RequestError extends Error {
         this.state = message.sqlstate // err.sqlstate is returned by msnodesql driver
       }
 
+      Error.captureStackTrace(this, this.constructor)
       Object.defineProperty(this, 'originalError', {enumerable: true, value: message})
     } else {
       super(message)
@@ -1522,6 +1527,7 @@ class PreparedStatementError extends Error {
       super(message.message)
       this.code = message.code || code
 
+      Error.captureStackTrace(this, this.constructor)
       Object.defineProperty(this, 'originalError', {enumerable: true, value: message})
     } else {
       super(message)
@@ -1551,7 +1557,8 @@ module.exports = {
     ISOLATION_LEVEL,
     TYPES,
     MAX: 65535, // (1 << 16) - 1
-    map
+    map,
+    getTypeByValue
   }
 }
 

package/lib/cli.js

@@ -2,7 +2,7 @@
 
 const fs = require('fs')
 const path = require('path')
-const sql = require('./main')
+const sql = require('./tedious')
 
 const exit = process.exit
 const write = text => process.stdout.write(text)

package/lib/connectionstring.js

@@ -75,7 +75,7 @@ const parseConnectionString = function (string) {
   const parsed = {}
   const original = {}
 
-  Object.defineProperty(parsed, '__original__', {value: original})
+  Object.defineProperty(parsed, '__original__', { value: original })
   Object.defineProperty(parsed, 'toString', {
     value () {
       const out = []
@@ -96,7 +96,7 @@ const parseConnectionString = function (string) {
         if (parsing === 'name') {
           buffer = buffer.trim()
           param = buffer.toLowerCase()
-          original[param] = {name: buffer}
+          original[param] = { name: buffer }
           parsing = 'value'
           buffer = ''
         } else {
@@ -210,10 +210,10 @@ const resolveConnectionString = function (string, driver) {
     parsed.driver = 'SQL Server Native Client 11.0'
 
     if (parsed.__original__) {
-      parsed.__original__.driver = {name: 'Driver', escape: ['{', '}']}
+      parsed.__original__.driver = { name: 'Driver', escape: ['{', '}'] }
     }
 
-    return {connectionString: parsed.toString()}
+    return { connectionString: parsed.toString() }
   }
 
   let user = parsed.uid || parsed.uid || parsed['user id']
@@ -241,6 +241,10 @@ const resolveConnectionString = function (string, driver) {
     config.requestTimeout = parseInt(config.requestTimeout, 10)
   }
 
+  if (parsed.multisubnetfailover != null) {
+    config.options.multiSubnetFailover = parsed.multisubnetfailover.toLowerCase() === 'true'
+  }
+
   if (/^(.*)\\(.*)$/.exec(user)) {
     config.domain = RegExp.$1
     user = RegExp.$2

package/lib/msnodesqlv8.js

@@ -151,6 +151,10 @@ class ConnectionPool extends base.ConnectionPool {
         defaultConnectionString = CONNECTION_STRING_NAMED_INSTANCE
       }
 
+      if (this.config.requestTimeout == null) {
+        this.config.requestTimeout = 15000
+      }
+
       const cfg = {
         conn_str: this.config.connectionString || defaultConnectionString,
         conn_timeout: (this.config.connectionTimeout || 15000) / 1000
@@ -205,10 +209,11 @@ class Transaction extends base.Transaction {
 
       debug('tran: begin')
 
-      this.parent.acquire(this, (err, connection) => {
+      this.parent.acquire(this, (err, connection, config) => {
         if (err) return callback(err)
 
         this._acquiredConnection = connection
+        this._acquiredConfig = config
 
         const req = new Request(this)
         req.stream = false
@@ -216,6 +221,7 @@ class Transaction extends base.Transaction {
           if (err) {
             this.parent.release(this._acquiredConnection)
             this._acquiredConnection = null
+            this._acquiredConfig = null
 
             return callback(err)
           }
@@ -241,6 +247,7 @@ class Transaction extends base.Transaction {
 
         this.parent.release(this._acquiredConnection)
         this._acquiredConnection = null
+        this._acquiredConfig = null
 
         if (!err) debug('tran: commit ok')
 
@@ -262,6 +269,7 @@ class Transaction extends base.Transaction {
 
         this.parent.release(this._acquiredConnection)
         this._acquiredConnection = null
+        this._acquiredConfig = null
 
         if (!err) debug('tran: rollback ok')
 
@@ -406,7 +414,7 @@ class Request extends base.Request {
         }
       }
 
-      this.parent.acquire(this, (err, connection) => {
+      this.parent.acquire(this, (err, connection, config) => {
         if (err) return callback(err)
 
         debug('req:connection acquired')
@@ -415,15 +423,18 @@ class Request extends base.Request {
         for (let name in this.parameters) {
           let param = this.parameters[name]
           if (param.io === 1) {
-            params.push(castParameter(param.value, param.type))
+            params.push(castParameter(param.value, param.type, param))
           }
         }
 
-        const req = connection.queryRaw(command, params)
+        const req = connection.queryRaw({
+          query_str: command,
+          query_timeout: config.requestTimeout / 1000  // msnodesqlv8 timeouts are in seconds (<1 second not supported)
+        }, params)
         req.on('meta', metadata => {
           if (row) {
             if (isChunkedRecordset) {
-              if ((columns[0].name === JSON_COLUMN_ID) && (this.connection.config.parseJSON === true)) {
+              if ((columns[0].name === JSON_COLUMN_ID) && (config.parseJSON === true)) {
                 try {
                   row = JSON.parse(chunksBuffer.join(''))
                   if (!this.stream) { recordsets[recordsets.length - 1][0] = row }
@@ -531,7 +542,7 @@ class Request extends base.Request {
           if (!this._nested) {
             if (row) {
               if (isChunkedRecordset) {
-                if ((columns[0].name === JSON_COLUMN_ID) && (this.connection.config.parseJSON === true)) {
+                if ((columns[0].name === JSON_COLUMN_ID) && (config.parseJSON === true)) {
                   try {
                     row = JSON.parse(chunksBuffer.join(''))
                     if (!this.stream) { recordsets[recordsets.length - 1][0] = row }

package/lib/tedious.js

@@ -230,7 +230,7 @@ class ConnectionPool extends base.ConnectionPool {
       })
 
       if (this.config.debug) {
-        tedious.on('debug', msg => this._debug(msg))
+        tedious.on('debug', this.emit.bind(this, 'debug', tedious))
       }
     })
   }
@@ -267,6 +267,7 @@ class Transaction extends base.Transaction {
 
         this._acquiredConnection.removeListener('rollbackTransaction', this._abort)
         this._acquiredConnection = null
+        this._acquiredConfig = null
         this._aborted = true
 
         this.emit('rollback', true)
@@ -280,11 +281,12 @@ class Transaction extends base.Transaction {
 
       debug('tran: begin')
 
-      this.parent.acquire(this, (err, connection) => {
+      this.parent.acquire(this, (err, connection, config) => {
         if (err) return callback(err)
 
         this._acquiredConnection = connection
         this._acquiredConnection.on('rollbackTransaction', this._abort)
+        this._acquiredConfig = config
 
         connection.beginTransaction(err => {
           if (err) err = new base.TransactionError(err)
@@ -309,6 +311,7 @@ class Transaction extends base.Transaction {
         this._acquiredConnection.removeListener('rollbackTransaction', this._abort)
         this.parent.release(this._acquiredConnection)
         this._acquiredConnection = null
+        this._acquiredConfig = null
 
         if (!err) debug('tran: commit ok')
 
@@ -329,6 +332,7 @@ class Transaction extends base.Transaction {
         this._acquiredConnection.removeListener('rollbackTransaction', this._abort)
         this.parent.release(this._acquiredConnection)
         this._acquiredConnection = null
+        this._acquiredConfig = null
 
         if (!err) debug('tran: rollback ok')
 
@@ -547,7 +551,7 @@ class Request extends base.Request {
         })
       }
 
-      this.parent.acquire(this, (err, connection) => {
+      this.parent.acquire(this, (err, connection, config) => {
         if (err) return callback(err)
 
         let row
@@ -646,7 +650,7 @@ class Request extends base.Request {
           if (Object.keys(columns).length === 0) return
 
           if (isChunkedRecordset) {
-            if (columns[JSON_COLUMN_ID] && this.connection.config.parseJSON === true) {
+            if (columns[JSON_COLUMN_ID] && config.parseJSON === true) {
               try {
                 row = JSON.parse(chunksBuffer.join(''))
               } catch (ex) {
@@ -844,7 +848,7 @@ class Request extends base.Request {
         errors.push(err)
       }
 
-      this.parent.acquire(this, (err, connection) => {
+      this.parent.acquire(this, (err, connection, config) => {
         if (err) return callback(err)
 
         let row
@@ -951,7 +955,7 @@ class Request extends base.Request {
           if (Object.keys(columns).length === 0) return
 
           if (isChunkedRecordset) {
-            if (columns[JSON_COLUMN_ID] && connection.config.parseJSON === true) {
+            if (columns[JSON_COLUMN_ID] && config.parseJSON === true) {
               try {
                 row = JSON.parse(chunksBuffer.join(''))
               } catch (ex) {

package/package.json

@@ -21,7 +21,7 @@
     "azure",
     "node-mssql"
   ],
-  "version": "4.0.1",
+  "version": "4.1.0",
   "main": "index.js",
   "repository": {
     "type": "git",

package/.npmignore

@@ -1,4 +0,0 @@
-node_modules
-.DS_Store
-.vscode
-test