Remove Server Info From verifyConnectivity() (#1317)

Author: MaxAake

packages/core/src/driver.ts

@@ -635,17 +635,16 @@ class Driver {
   /**
    * Verifies connectivity of this driver by trying to open a connection with the provided driver options.
    *
-   * @deprecated This return of this method will change in 6.0.0 to not async return the {@link ServerInfo} and
-   * async return {@link void} instead. If you need to use the server info, use {@link getServerInfo} instead.
-   *
    * @public
    * @param {Object} param - The object parameter
    * @param {string} param.database - The target database to verify connectivity for.
-   * @returns {Promise<ServerInfo>} promise resolved with server info or rejected with error.
+   * @returns {Promise<void>} promise resolved with void or rejected with error.
    */
-  verifyConnectivity ({ database = '' }: { database?: string } = {}): Promise<ServerInfo> {
+  verifyConnectivity ({ database = '' }: { database?: string } = {}): Promise<void> {
     const connectionProvider = this._getOrCreateConnectionProvider()
-    return connectionProvider.verifyConnectivityAndGetServerInfo({ database, accessMode: READ })
+    return new Promise((resolve, reject) => {
+      connectionProvider.verifyConnectivityAndGetServerInfo({ database, accessMode: READ }).then(() => resolve()).catch(e => reject(e))
+    })
   }
 
   /**

packages/core/test/driver.test.ts

@@ -336,20 +336,25 @@ describe('Driver', () => {
   })
 
   it.each([
-    [undefined, 'Promise.resolve(ServerInfo>)', Promise.resolve(new ServerInfo())],
-    [undefined, 'Promise.reject(Error)', Promise.reject(newError('something went wrong'))],
-    [{}, 'Promise.resolve(ServerInfo>)', Promise.resolve(new ServerInfo())],
-    [{}, 'Promise.reject(Error)', Promise.reject(newError('something went wrong'))],
-    [{ database: undefined }, 'Promise.resolve(ServerInfo>)', Promise.resolve(new ServerInfo())],
-    [{ database: undefined }, 'Promise.reject(Error)', Promise.reject(newError('something went wrong'))],
-    [{ database: 'db' }, 'Promise.resolve(ServerInfo>)', Promise.resolve(new ServerInfo())],
-    [{ database: 'db' }, 'Promise.reject(Error)', Promise.reject(newError('something went wrong'))]
-  ])('.verifyConnectivity(%o) => %s', (input: { database?: string } | undefined, _, expectedPromise) => {
+    [undefined, 'Promise.resolve(ServerInfo>)', Promise.resolve(new ServerInfo()), true],
+    [undefined, 'Promise.reject(Error)', Promise.reject(newError('something went wrong')), false],
+    [{}, 'Promise.resolve(ServerInfo>)', Promise.resolve(new ServerInfo()), true],
+    [{}, 'Promise.reject(Error)', Promise.reject(newError('something went wrong')), false],
+    [{ database: undefined }, 'Promise.resolve(ServerInfo>)', Promise.resolve(new ServerInfo()), true],
+    [{ database: undefined }, 'Promise.reject(Error)', Promise.reject(newError('something went wrong')), false],
+    [{ database: 'db' }, 'Promise.resolve(ServerInfo>)', Promise.resolve(new ServerInfo()), true],
+    [{ database: 'db' }, 'Promise.reject(Error)', Promise.reject(newError('something went wrong')), false]
+  ])('.verifyConnectivity(%o) => %s', (input: { database?: string } | undefined, _, expectedPromise, shouldBeVoid) => {
     connectionProvider.verifyConnectivityAndGetServerInfo = jest.fn(() => expectedPromise)
 
-    const promise: Promise<ServerInfo> | undefined = driver?.verifyConnectivity(input)
+    const promise: Promise<void> | undefined = driver?.verifyConnectivity(input)
 
-    expect(promise).toBe(expectedPromise)
+    if (shouldBeVoid) {
+      const expectedVoid = Promise.resolve()
+      expect(promise).toEqual(expectedVoid)
+    } else {
+      expect(promise).toEqual(expectedPromise)
+    }
     expect(connectionProvider.verifyConnectivityAndGetServerInfo)
       .toBeCalledWith({ database: input?.database ?? '', accessMode: READ })
 

packages/neo4j-driver-deno/lib/core/driver.ts

@@ -411,7 +411,7 @@ describe('#integration driver', () => {
     )
 
     // Expect
-    driver.verifyConnectivity().then(server => {
+    driver.getServerInfo().then(server => {
       expect(server.address).toBeDefined()
       done()
     })
@@ -425,7 +425,7 @@ describe('#integration driver', () => {
     )
 
     // Expect
-    driver.verifyConnectivity().then(server => {
+    driver.getServerInfo().then(server => {
       expect(server.address).toBeDefined()
       done()
     })
@@ -444,7 +444,7 @@ describe('#integration driver', () => {
     )
 
     // Expect
-    driver.verifyConnectivity().then(server => {
+    driver.getServerInfo().then(server => {
       expect(server.address).toBeDefined()
       done()
     })
@@ -464,7 +464,7 @@ describe('#integration driver', () => {
     )
 
     // Expect
-    driver.verifyConnectivity().then(server => {
+    driver.getServerInfo().then(server => {
       expect(server.address).toBeDefined()
       done()
     })

packages/neo4j-driver/test/driver.test.js

@@ -99,7 +99,7 @@ session1
 
 const close: Promise<void> = driver.close().catch(error => console.error(error))
 
-driver.verifyConnectivity().then((serverInfo: ServerInfo) => {
+driver.getServerInfo().then((serverInfo: ServerInfo) => {
   console.log(serverInfo.address)
 }).catch(error => console.error(error))