Merge pull request #296 from lutovich/1.5-conn-timeout-default-value

Set default connection timeout to 5 seconds

Author: zhenlineo

src/v1/index.js

@@ -144,7 +144,7 @@ const USER_AGENT = "neo4j-javascript/" + VERSION;
  *
  *       // Specify socket connection timeout in milliseconds. Non-numeric, negative and zero values are treated as an
  *       // infinite timeout. Connection will be then bound by the timeout configured on the operating system level.
- *       // Timeout value should be numeric and greater or equal to zero.
+ *       // Timeout value should be numeric and greater or equal to zero. Default value is 5000 which is 5 seconds.
  *       connectionTimeout: 5000, // 5 seconds
  *     }
  *

src/v1/internal/ch-config.js

@@ -20,7 +20,7 @@
 import hasFeature from './features';
 import {SERVICE_UNAVAILABLE} from '../error';
 
-const DEFAULT_CONNECTION_TIMEOUT_MILLIS = 0; // turned off by default
+const DEFAULT_CONNECTION_TIMEOUT_MILLIS = 5000; // 5 seconds by default
 
 export default class ChannelConfig {
 

test/internal/ch-config.test.js

@@ -110,4 +110,16 @@ describe('ChannelConfig', () => {
     expect(config.connectionErrorCode).toEqual(SERVICE_UNAVAILABLE);
   });
 
+  it('should have connection timeout by default', () => {
+    const config = new ChannelConfig('', 42, {}, '');
+
+    expect(config.connectionTimeout).toEqual(5000);
+  });
+
+  it('should respect configured connection timeout', () => {
+    const config = new ChannelConfig('', 42, {connectionTimeout: 424242}, '');
+
+    expect(config.connectionTimeout).toEqual(424242);
+  });
+
 });

types/v1/driver.d.ts

@@ -48,6 +48,7 @@ declare interface Config {
   maxTransactionRetryTime?: number;
   loadBalancingStrategy?: LoadBalancingStrategy;
   maxConnectionLifetime?: number;
+  connectionTimeout?: number;
 }
 
 declare type SessionMode = "READ" | "WRITE";