option "convertToString" to always return strings instead of neo4j.int instances

Author: bryanph

lib/browser/neo4j-web.js

@@ -99,13 +99,15 @@ var Driver = function () {
     var config = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
     (0, _classCallCheck3.default)(this, Driver);
 
+    sanitizeConfig(config);
+
     this._url = url;
     this._userAgent = userAgent;
     this._openSessions = {};
     this._sessionIdGenerator = 0;
     this._token = token;
     this._config = config;
-    this._pool = new _pool2.default(this._createConnection.bind(this), this._destroyConnection.bind(this), Driver._validateConnection.bind(this), config.connectionPoolSize);
+    this._pool = new _pool2.default(this._createConnection.bind(this), this._destroyConnection.bind(this), this._validateConnection.bind(this), config.connectionPoolSize);
 
     /**
      * Reference to the connection provider. Initialized lazily by {@link _getOrCreateConnectionProvider}.
@@ -145,14 +147,31 @@ var Driver = function () {
      **/
 
   }, {
-    key: '_destroyConnection',
+    key: '_validateConnection',
+    value: function _validateConnection(conn) {
+      if (!conn.isOpen()) {
+        return false;
+      }
+
+      var maxConnectionLifetime = this._config.maxConnectionLifetime;
+      if (maxConnectionLifetime) {
+        var lifetime = Date.now() - conn.creationTimestamp;
+        if (lifetime > maxConnectionLifetime) {
+          return false;
+        }
+      }
 
+      return true;
+    }
 
     /**
      * Dispose of a live session, closing any associated resources.
      * @return {Session} new session.
      * @access private
      */
+
+  }, {
+    key: '_destroyConnection',
     value: function _destroyConnection(conn) {
       delete this._openSessions[conn._id];
       conn.close();
@@ -245,11 +264,6 @@ var Driver = function () {
       }
     }
   }], [{
-    key: '_validateConnection',
-    value: function _validateConnection(conn) {
-      return conn.isOpen();
-    }
-  }, {
     key: '_validateSessionMode',
     value: function _validateSessionMode(rawMode) {
       var mode = rawMode || WRITE;
@@ -305,6 +319,25 @@ var _ConnectionStreamObserver = function (_StreamObserver) {
   return _ConnectionStreamObserver;
 }(_streamObserver2.default);
 
+/**
+ * @private
+ */
+
+
+function sanitizeConfig(config) {
+  var maxConnectionLifetime = config.maxConnectionLifetime;
+  if (maxConnectionLifetime) {
+    var sanitizedMaxConnectionLifetime = parseInt(maxConnectionLifetime, 10);
+    if (sanitizedMaxConnectionLifetime && sanitizedMaxConnectionLifetime > 0) {
+      config.maxConnectionLifetime = sanitizedMaxConnectionLifetime;
+    } else {
+      config.maxConnectionLifetime = null;
+    }
+  } else {
+    config.maxConnectionLifetime = null;
+  }
+}
+
 exports.Driver = Driver;
 exports.READ = READ;
 exports.WRITE = WRITE;

lib/browser/neo4j-web.min.js

@@ -125,7 +125,7 @@ var USER_AGENT = "neo4j-javascript/" + _version2.default;
  *       // TRUST_SYSTEM_CA_SIGNED_CERTIFICATES meand that you trust whatever certificates
  *       // are in the default certificate chain of th
  *       trust: "TRUST_ALL_CERTIFICATES" | "TRUST_ON_FIRST_USE" | "TRUST_SIGNED_CERTIFICATES" |
-  *       "TRUST_CUSTOM_CA_SIGNED_CERTIFICATES" | "TRUST_SYSTEM_CA_SIGNED_CERTIFICATES",
+ *       "TRUST_CUSTOM_CA_SIGNED_CERTIFICATES" | "TRUST_SYSTEM_CA_SIGNED_CERTIFICATES",
  *
  *       // List of one or more paths to trusted encryption certificates. This only
  *       // works in the NodeJS bundle, and only matters if you use "TRUST_CUSTOM_CA_SIGNED_CERTIFICATES".
@@ -144,11 +144,20 @@ var USER_AGENT = "neo4j-javascript/" + _version2.default;
  *       // Connection will be destroyed if this threshold is exceeded.
  *       connectionPoolSize: 50,
  *
+ *       // The maximum allowed lifetime for a pooled connection in milliseconds. Pooled connections older than this
+ *       // threshold will be closed and removed from the pool. Such discarding happens during connection acquisition
+ *       // so that new session is never backed by an old connection. Setting this option to a low value will cause
+ *       // a high connection churn and might result in a performance hit. It is recommended to set maximum lifetime
+ *       // to a slightly smaller value than the one configured in network equipment (load balancer, proxy, firewall,
+ *       // etc. can also limit maximum connection lifetime). No maximum lifetime limit is imposed by default. Zero
+ *       // and negative values result in lifetime not being checked.
+ *       maxConnectionLifetime: 30 * 60 * 1000, // 30 minutes
+ *
  *       // Specify the maximum time in milliseconds transactions are allowed to retry via
  *       // {@link Session#readTransaction()} and {@link Session#writeTransaction()} functions. These functions
  *       // will retry the given unit of work on `ServiceUnavailable`, `SessionExpired` and transient errors with
  *       // exponential backoff using initial delay of 1 second. Default value is 30000 which is 30 seconds.
- *       maxTransactionRetryTime: 30000,
+ *       maxTransactionRetryTime: 30000, // 30 seconds
  *
  *       // Provide an alternative load balancing strategy for the routing driver to use.
  *       // Driver uses "least_connected" by default.

lib/browser/neo4j-web.test.js

@@ -214,7 +214,7 @@ var Connection = function () {
    *                  callback property
    * @param url - url to connect to
    */
-  function Connection(channel, url) {
+  function Connection(channel, url, config) {
     (0, _classCallCheck3.default)(this, Connection);
 
     /**
@@ -224,13 +224,14 @@ var Connection = function () {
      */
     this.url = url;
     this.server = { address: url };
+    this.creationTimestamp = Date.now();
     this._pendingObservers = [];
     this._currentObserver = undefined;
     this._ch = channel;
     this._dechunker = new _chunking.Dechunker();
     this._chunker = new _chunking.Chunker(channel);
     this._packer = new _packstream.Packer(this._chunker);
-    this._unpacker = new _packstream.Unpacker();
+    this._unpacker = new _packstream.Unpacker(config);
 
     this._isHandlingFailure = false;
     this._currentFailure = null;
@@ -740,7 +741,7 @@ function connect(url) {
   var completeUrl = host + ':' + port;
   var channelConfig = new _chConfig2.default(host, port, config, connectionErrorCode);
 
-  return new Connection(new Ch(channelConfig), completeUrl);
+  return new Connection(new Ch(channelConfig), completeUrl, config);
 }
 
 exports.connect = connect;

lib/v1/driver.js

@@ -391,13 +391,15 @@ var Packer = function () {
 
 
 var Unpacker = function () {
-  function Unpacker() {
+  function Unpacker(config) {
     (0, _classCallCheck3.default)(this, Unpacker);
 
     // Higher level layers can specify how to map structs to higher-level objects.
     // If we recieve a struct that has a signature that does not have a mapper,
     // we simply return a Structure object.
     this.structMappers = {};
+
+    this._convertToString = config && config.convertToString;
   }
 
   (0, _createClass3.default)(Unpacker, [{
@@ -418,7 +420,7 @@ var Unpacker = function () {
 
       var number = this._unpackNumber(marker, buffer);
       if (number !== null) {
-        return number;
+        return !this._convertToString ? number : number.toString();
       }
 
       var string = this._unpackString(marker, markerHigh, markerLow, buffer);

lib/v1/index.js

@@ -75,7 +75,7 @@ var RoutingDriver = function (_Driver) {
     var config = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
     (0, _classCallCheck3.default)(this, RoutingDriver);
 
-    var _this = (0, _possibleConstructorReturn3.default)(this, (RoutingDriver.__proto__ || (0, _getPrototypeOf2.default)(RoutingDriver)).call(this, url, userAgent, token, RoutingDriver._validateConfig(config)));
+    var _this = (0, _possibleConstructorReturn3.default)(this, (RoutingDriver.__proto__ || (0, _getPrototypeOf2.default)(RoutingDriver)).call(this, url, userAgent, token, validateConfig(config)));
 
     _this._routingContext = routingContext;
     return _this;
@@ -93,16 +93,18 @@ var RoutingDriver = function (_Driver) {
       var _this2 = this;
 
       return new RoutingSession(mode, connectionProvider, bookmark, config, function (error, conn) {
-        if (error.code === _error.SESSION_EXPIRED) {
-          _this2._forgetConnection(conn);
+        if (!conn) {
+          // connection can be undefined if error happened before connection was acquired
           return error;
-        } else if (RoutingDriver._isFailureToWrite(error)) {
-          var url = 'UNKNOWN';
-          // connection is undefined if error happened before connection was acquired
-          if (conn) {
-            url = conn.url;
-            _this2._connectionProvider.forgetWriter(conn.url);
-          }
+        }
+
+        var url = conn.url;
+
+        if (error.code === _error.SESSION_EXPIRED || isDatabaseUnavailable(error)) {
+          _this2._connectionProvider.forget(url);
+          return error;
+        } else if (isFailureToWrite(error)) {
+          _this2._connectionProvider.forgetWriter(url);
           return (0, _error.newError)('No longer possible to write to server at ' + url, _error.SESSION_EXPIRED);
         } else {
           return error;
@@ -116,36 +118,16 @@ var RoutingDriver = function (_Driver) {
       // result in SESSION_EXPIRED because there might still exist other servers capable of serving the request
       return _error.SESSION_EXPIRED;
     }
-  }, {
-    key: '_forgetConnection',
-    value: function _forgetConnection(connection) {
-      // connection is undefined if error happened before connection was acquired
-      if (connection) {
-        this._connectionProvider.forget(connection.url);
-      }
-    }
-  }], [{
-    key: '_validateConfig',
-    value: function _validateConfig(config) {
-      if (config.trust === 'TRUST_ON_FIRST_USE') {
-        throw (0, _error.newError)('The chosen trust mode is not compatible with a routing driver');
-      }
-      return config;
-    }
-  }, {
-    key: '_isFailureToWrite',
-    value: function _isFailureToWrite(error) {
-      return error.code === 'Neo.ClientError.Cluster.NotALeader' || error.code === 'Neo.ClientError.General.ForbiddenOnReadOnlyDatabase';
-    }
 
     /**
      * Create new load balancing strategy based on the config.
      * @param {object} config the user provided config.
      * @param {Pool} connectionPool the connection pool for this driver.
      * @return {LoadBalancingStrategy} new strategy.
+     * @private
      */
 
-  }, {
+  }], [{
     key: '_createLoadBalancingStrategy',
     value: function _createLoadBalancingStrategy(config, connectionPool) {
       var configuredValue = config.loadBalancingStrategy;
@@ -161,6 +143,36 @@ var RoutingDriver = function (_Driver) {
   return RoutingDriver;
 }(_driver.Driver);
 
+/**
+ * @private
+ */
+
+
+function validateConfig(config) {
+  if (config.trust === 'TRUST_ON_FIRST_USE') {
+    throw (0, _error.newError)('The chosen trust mode is not compatible with a routing driver');
+  }
+  return config;
+}
+
+/**
+ * @private
+ */
+function isFailureToWrite(error) {
+  return error.code === 'Neo.ClientError.Cluster.NotALeader' || error.code === 'Neo.ClientError.General.ForbiddenOnReadOnlyDatabase';
+}
+
+/**
+ * @private
+ */
+function isDatabaseUnavailable(error) {
+  return error.code === 'Neo.TransientError.General.DatabaseUnavailable';
+}
+
+/**
+ * @private
+ */
+
 var RoutingSession = function (_Session) {
   (0, _inherits3.default)(RoutingSession, _Session);
 

lib/v1/internal/connector.js

@@ -166,7 +166,7 @@ class Connection {
    *                  callback property
    * @param url - url to connect to
    */
-  constructor (channel, url) {
+  constructor (channel, url, config) {
     /**
      * An ordered queue of observers, each exchange response (zero or more
      * RECORD messages followed by a SUCCESS message) we recieve will be routed
@@ -181,7 +181,7 @@ class Connection {
     this._dechunker = new Dechunker();
     this._chunker = new Chunker( channel );
     this._packer = new Packer( this._chunker );
-    this._unpacker = new Unpacker();
+    this._unpacker = new Unpacker(config);
 
     this._isHandlingFailure = false;
     this._currentFailure = null;
@@ -591,7 +591,7 @@ function connect(url, config = {}, connectionErrorCode = null) {
   const completeUrl = host + ':' + port;
   const channelConfig = new ChannelConfig(host, port, config, connectionErrorCode);
 
-  return new Connection( new Ch(channelConfig), completeUrl);
+  return new Connection( new Ch(channelConfig), completeUrl, config);
 }
 
 export {

lib/v1/internal/packstream.js

@@ -309,11 +309,13 @@ class Packer {
   * @access private
   */
 class Unpacker {
-  constructor () {
+  constructor (config) {
     // Higher level layers can specify how to map structs to higher-level objects.
     // If we recieve a struct that has a signature that does not have a mapper,
     // we simply return a Structure object.
     this.structMappers = {};
+
+    this._convertToString = config && config.convertToString
   }
 
   unpack(buffer) {
@@ -332,7 +334,7 @@ class Unpacker {
 
     const number = this._unpackNumber(marker, buffer);
     if (number !== null) {
-      return number;
+      return !this._convertToString ?  number : number.toString();
     }
 
     const string = this._unpackString(marker, markerHigh, markerLow, buffer);