Moving creation of providers to the index.js

Author: bigmontz

src/driver.js

@@ -19,8 +19,9 @@
 
 import ConnectionProvider from './internal/connection-provider'
 import Bookmark from './internal/bookmark'
-import DirectConnectionProvider from './internal/connection-provider-direct'
 import ConnectivityVerifier from './internal/connectivity-verifier'
+import ConfiguredCustomResolver from './internal/resolver/configured-custom-resolver'
+
 import {
   ACCESS_MODE_READ,
   ACCESS_MODE_WRITE,
@@ -74,20 +75,23 @@ class Driver {
    * You should not be calling this directly, instead use {@link driver}.
    * @constructor
    * @protected
-   * @param {ServerAddress} address
-   * @param {string} userAgent
-   * @param {Object} authToken
+   * @param {Object} meta Metainformation about the driver
    * @param {Object} config
+   * @param {function(id: number, config:Object, log:Logger, hostNameResolver: ConfiguredCustomResolver): ConnectionProvider } createConnectonProvider Creates the connection provider
    */
-  constructor (address, userAgent, authToken = {}, config = {}) {
+  constructor (
+    meta,
+    config = {},
+    createConnectonProvider = (id, config, log, hostNameResolver) => {}
+  ) {
     sanitizeConfig(config)
+    validateConfig(config)
 
     this._id = idGenerator++
-    this._address = address
-    this._userAgent = userAgent
-    this._authToken = authToken
+    this._meta = meta
     this._config = config
     this._log = Logger.create(config)
+    this._createConnectionProvider = createConnectonProvider
 
     /**
      * Reference to the connection provider. Initialized lazily by {@link _getOrCreateConnectionProvider}.
@@ -144,7 +148,7 @@ class Driver {
    * @returns {boolean}
    */
   _supportsRouting () {
-    return false
+    return this._meta.routing
   }
 
   /**
@@ -259,24 +263,10 @@ class Driver {
    */
   _afterConstruction () {
     this._log.info(
-      `Direct driver ${this._id} created for server address ${this._address}`
+      `${this._meta.typename} driver ${this._id} created for server address ${this._meta.address}`
     )
   }
 
-  /**
-   * @protected
-   */
-  _createConnectionProvider (address, userAgent, authToken) {
-    return new DirectConnectionProvider({
-      id: this._id,
-      config: this._config,
-      log: this._log,
-      address: address,
-      userAgent: userAgent,
-      authToken: authToken
-    })
-  }
-
   /**
    * @private
    */
@@ -309,16 +299,31 @@ class Driver {
   _getOrCreateConnectionProvider () {
     if (!this._connectionProvider) {
       this._connectionProvider = this._createConnectionProvider(
-        this._address,
-        this._userAgent,
-        this._authToken
+        this._id,
+        this._config,
+        this._log,
+        createHostNameResolver(this._config)
       )
     }
 
     return this._connectionProvider
   }
 }
 
+/**
+ * @private
+ * @returns {Object} the given config.
+ */
+function validateConfig (config) {
+  const resolver = config.resolver
+  if (resolver && typeof resolver !== 'function') {
+    throw new TypeError(
+      `Configured resolver should be a function. Got: ${resolver}`
+    )
+  }
+  return config
+}
+
 /**
  * @private
  */
@@ -371,6 +376,15 @@ function validateFetchSizeValue (rawValue, defaultWhenAbsent) {
   }
 }
 
+/**
+ * @private
+ * @returns {ConfiguredCustomResolver} new custom resolver that wraps the passed-in resolver function.
+ *              If resolved function is not specified, it defaults to an identity resolver.
+ */
+function createHostNameResolver (config) {
+  return new ConfiguredCustomResolver(config.resolver)
+}
+
 export { Driver, READ, WRITE }
 
 export default Driver

src/index.js

@@ -17,7 +17,6 @@
  * limitations under the License.
  */
 import { Driver, READ, WRITE } from './driver'
-import RoutingDriver from './routing-driver'
 import VERSION from './version'
 import urlUtil from './internal/url-util'
 import ServerAddress from './internal/server-address'
@@ -55,6 +54,9 @@ import {
   ResultSummary,
   Result
 } from 'neo4j-driver-core'
+import { HostNameResolver } from './internal/node'
+import DirectConnectionProvider from './internal/connection-provider-direct'
+import RoutingConnectionProvider from './internal/connection-provider-routing'
 
 const {
   util: { ENCRYPTION_ON, ENCRYPTION_OFF, assertString, isEmptyObjectOrNull }
@@ -236,27 +238,46 @@ function driver (url, authToken, config = {}) {
 
   // Use default user agent or user agent specified by user.
   config.userAgent = config.userAgent || USER_AGENT
+  const address = ServerAddress.fromUrl(parsedUrl.hostAndPort)
 
-  if (routing) {
-    return new RoutingDriver(
-      ServerAddress.fromUrl(parsedUrl.hostAndPort),
-      parsedUrl.query,
-      config.userAgent,
-      authToken,
-      config
-    )
-  } else {
-    if (!isEmptyObjectOrNull(parsedUrl.query)) {
-      throw new Error(
-        `Parameters are not supported with none routed scheme. Given URL: '${url}'`
-      )
+  const meta = {
+    address,
+    typename: routing ? 'Routing' : 'Direct',
+    routing
+  }
+
+  return new Driver(meta, config, createConnectionProviderFunction())
+
+  function createConnectionProviderFunction () {
+    if (routing) {
+      return (id, config, log, hostNameResolver) =>
+        new RoutingConnectionProvider({
+          id,
+          config,
+          log,
+          hostNameResolver,
+          authToken,
+          address,
+          userAgent: config.userAgent,
+          routingContext: parsedUrl.query
+        })
+    } else {
+      if (!isEmptyObjectOrNull(parsedUrl.query)) {
+        throw new Error(
+          `Parameters are not supported with none routed scheme. Given URL: '${url}'`
+        )
+      }
+
+      return (id, config, log) =>
+        new DirectConnectionProvider({
+          id,
+          config,
+          log,
+          authToken,
+          address,
+          userAgent: config.userAgent
+        })
     }
-    return new Driver(
-      ServerAddress.fromUrl(parsedUrl.hostAndPort),
-      config.userAgent,
-      authToken,
-      config
-    )
   }
 }
 

src/routing-driver.js

@@ -379,11 +379,15 @@ describe('#integration driver', () => {
 
   it('should have correct user agent', async () => {
     const directDriver = neo4j.driver(`bolt://${sharedNeo4j.hostname}`)
-    expect(directDriver._userAgent).toBe('neo4j-javascript/0.0.0-dev')
+    expect(directDriver._getOrCreateConnectionProvider()._userAgent).toBe(
+      'neo4j-javascript/0.0.0-dev'
+    )
     await directDriver.close()
 
     const routingDriver = neo4j.driver(`neo4j://${sharedNeo4j.hostname}`)
-    expect(routingDriver._userAgent).toBe('neo4j-javascript/0.0.0-dev')
+    expect(routingDriver._getOrCreateConnectionProvider()._userAgent).toBe(
+      'neo4j-javascript/0.0.0-dev'
+    )
     await routingDriver.close()
   })
 

test/driver.test.js

@@ -785,7 +785,6 @@ describe('#unit url-util', () => {
 
   function verifyUrl (urlString, expectedUrl) {
     const url = parse(urlString)
-
     if (expectedUrl.scheme) {
       expect(url.scheme).toEqual(expectedUrl.scheme)
     } else {
@@ -803,7 +802,6 @@ describe('#unit url-util', () => {
     }
 
     verifyHostAndPort(url, expectedUrl)
-
     if (expectedUrl.query) {
       expect(url.query).toEqual(expectedUrl.query)
     } else {

test/internal/url-util.test.js

@@ -17,9 +17,6 @@
  * limitations under the License.
  */
 
-import LeastConnectedLoadBalancingStrategy from '../src/internal/least-connected-load-balancing-strategy'
-import RoutingDriver from '../src/routing-driver'
-import Pool from '../src/internal/pool'
 import neo4j from '../src'
 
 describe('#unit RoutingDriver', () => {