Remove onCompleted callback and add verifyConnectivity method

Author: ali-ince

src/driver.js

@@ -93,8 +93,6 @@ class Driver {
      */
     this._connectionProvider = null;
 
-    this._onCompleted = null;
-
     this._afterConstruction();
   }
 
@@ -106,26 +104,13 @@ class Driver {
   }
 
   /**
-   * Get the installed connectivity verification callback.
-   * @return {null|function}
-   * @deprecated driver can be used directly once instantiated, use of this callback is not required.
+   * Verifies connectivity of this driver by trying to open a connection with the provided driver options.
+   * @returns {Promise<object>} promise resolved with server info or rejected with error.
    */
-  get onCompleted() {
-    return this._onCompleted;
-  }
-
-  /**
-   * Install a connectivity verification callback.
-   * @param {null|function} callback the new function to be notified about successful connection.
-   * @deprecated driver can be used directly once instantiated, use of this callback is not required.
-   */
-  set onCompleted(callback) {
-    this._onCompleted = callback;
-    if (this._onCompleted) {
-      const connectionProvider = this._getOrCreateConnectionProvider();
-      const connectivityVerifier = new ConnectivityVerifier(connectionProvider, this._onCompleted);
-      connectivityVerifier.verify();
-    }
+  verifyConnectivity() {
+    const connectionProvider = this._getOrCreateConnectionProvider();
+    const connectivityVerifier = new ConnectivityVerifier(connectionProvider);
+    return connectivityVerifier.verify();
   }
 
   /**

src/internal/connectivity-verifier.js

@@ -29,20 +29,17 @@ export default class ConnectivityVerifier {
   /**
    * @constructor
    * @param {ConnectionProvider} connectionProvider the provider to obtain connections from.
-   * @param {function} successCallback a callback to invoke when verification succeeds.
    */
-  constructor(connectionProvider, successCallback) {
+  constructor(connectionProvider) {
     this._connectionProvider = connectionProvider;
-    this._successCallback = successCallback;
   }
 
+  /**
+   * Try to obtain a working connection from the connection provider.
+   * @returns {Promise<object>} promise resolved with server info or rejected with error.
+   */
   verify() {
-    acquireAndReleaseDummyConnection(this._connectionProvider).then(serverInfo => {
-      if (this._successCallback) {
-        this._successCallback(serverInfo);
-      }
-    }).catch(ignoredError => {
-    });
+    return acquireAndReleaseDummyConnection(this._connectionProvider);
   }
 }
 

test/driver.test.js

@@ -147,43 +147,43 @@ describe('driver', () => {
     driver = neo4j.driver("bolt://localhost", sharedNeo4j.authToken);
 
     // Expect
-    driver.onCompleted = server => {
+    driver.verifyConnectivity().then(server => {
       expect(server.address).toBeDefined();
       done();
-    };
+    });
   });
 
   it('should be possible to pass a realm with basic auth tokens', done => {
     // Given
     driver = neo4j.driver("bolt://localhost", neo4j.auth.basic(sharedNeo4j.username, sharedNeo4j.password, "native"));
 
     // Expect
-    driver.onCompleted = server => {
+    driver.verifyConnectivity().then(server => {
       expect(server.address).toBeDefined();
       done();
-    };
+    });
   });
 
   it('should be possible to create custom auth tokens', done => {
     // Given
     driver = neo4j.driver("bolt://localhost", neo4j.auth.custom(sharedNeo4j.username, sharedNeo4j.password, "native", "basic"));
 
     // Expect
-    driver.onCompleted = server => {
+    driver.verifyConnectivity().then(server => {
       expect(server.address).toBeDefined();
       done();
-    };
+    });
   });
 
   it('should be possible to create custom auth tokens with additional parameters', done => {
     // Given
     driver = neo4j.driver("bolt://localhost", neo4j.auth.custom(sharedNeo4j.username, sharedNeo4j.password, "native", "basic", {secret: 42}));
 
     // Expect
-    driver.onCompleted = server => {
+    driver.verifyConnectivity().then(server => {
       expect(server.address).toBeDefined();
       done();
-    };
+    });
   });
 
   it('should fail nicely when connecting with routing to standalone server', done => {

test/examples.test.js

@@ -99,10 +99,10 @@ describe('examples', () => {
     const driver = neo4j.driver(uri, neo4j.auth.basic(user, password));
     // end::basic-auth[]
 
-    driver.onCompleted = () => {
+    driver.verifyConnectivity().then(() => {
       driver.close();
       done();
-    };
+    });
   });
 
   it('config connection pool example', done => {
@@ -116,10 +116,10 @@ describe('examples', () => {
     );
     // end::config-connection-pool[]
 
-    driver.onCompleted = () => {
+    driver.verifyConnectivity().then(() => {
       driver.close();
       done();
-    };
+    });
   });
 
   it('config connection timeout example', done => {
@@ -131,10 +131,10 @@ describe('examples', () => {
     );
     // end::config-connection-timeout[]
 
-    driver.onCompleted = () => {
+    driver.verifyConnectivity().then(() => {
       driver.close();
       done();
-    };
+    });
   });
 
   it('config max retry time example', done => {
@@ -147,10 +147,10 @@ describe('examples', () => {
     );
     // end::config-max-retry-time[]
 
-    driver.onCompleted = () => {
+    driver.verifyConnectivity().then(() => {
       driver.close();
       done();
-    };
+    });
   });
 
   it('config trust example', done => {
@@ -163,10 +163,10 @@ describe('examples', () => {
     );
     // end::config-trust[]
 
-    driver.onCompleted = () => {
+    driver.verifyConnectivity().then(() => {
       driver.close();
       done();
-    };
+    });
   });
 
   it('config unencrypted example', done => {
@@ -178,10 +178,10 @@ describe('examples', () => {
     );
     // end::config-unencrypted[]
 
-    driver.onCompleted = () => {
+    driver.verifyConnectivity().then(() => {
       driver.close();
       done();
-    };
+    });
   });
 
   it('config custom resolver example', done => {
@@ -217,10 +217,10 @@ describe('examples', () => {
     const driver = neo4j.driver(uri, neo4j.auth.custom(principal, credentials, realm, scheme, parameters));
     // end::custom-auth[]
 
-    driver.onCompleted = () => {
+    driver.verifyConnectivity().then(() => {
       driver.close();
       done();
-    };
+    });
   });
 
   it('kerberos auth example', () => {
@@ -261,9 +261,9 @@ describe('examples', () => {
     // tag::driver-lifecycle[]
     const driver = neo4j.driver(uri, neo4j.auth.basic(user, password));
 
-    driver.onCompleted = () => {
+    driver.verifyConnectivity().then(() => {
       console.log('Driver created');
-    };
+    });
 
     driver.onError = error => {
       console.log(error);

test/internal/connectivity-verifier.test.js

@@ -26,12 +26,11 @@ describe('ConnectivityVerifier', () => {
   it('should call success callback when able to acquire and release a connection', done => {
     const connectionPromise = Promise.resolve(new FakeConnection());
     const connectionProvider = new SingleConnectionProvider(connectionPromise);
+    const verifier = new ConnectivityVerifier(connectionProvider)
 
-    const verifier = new ConnectivityVerifier(connectionProvider, () => {
+    verifier.verify().then(() => {
       done();
     });
-
-    verifier.verify();
   });
 
 });

test/types/driver.test.ts

@@ -79,12 +79,10 @@ session1.run("RETURN 1").then(result => {
 
 const close: void = driver.close();
 
-driver.onCompleted = (serverInfo: ServerInfo) => {
+driver.verifyConnectivity().then((serverInfo: ServerInfo) => {
   console.log(serverInfo.version);
   console.log(serverInfo.address);
-};
-
-driver.onCompleted({version: "Neo4j/3.2.0", address: "localhost:7687"});
+});
 
 driver.onError = (error: Neo4jError) => {
   console.log(error);

types/driver.d.ts

@@ -66,7 +66,8 @@ declare interface Driver {
 
   close(): void;
 
-  onCompleted?: (serverInfo: ServerInfo) => void;
+  verifyConnectivity(): Promise<ServerInfo>;
+
   onError?: (error: Neo4jError) => void;
 }