Introduce Driver.isEncrypted() method to the API (#868)

Author: bigmontz

packages/core/src/driver.ts

@@ -205,6 +205,15 @@ class Driver {
     return connectionProvider.supportsUserImpersonation()
   }
 
+  /**
+   * Returns boolean to indicate if driver has been configured with encryption enabled.
+   *
+   * @returns {boolean}
+   */
+  isEncrypted(): boolean {
+    return this._isEncrypted()
+  }
+
   /**
    * @protected
    * @returns {boolean}
@@ -220,7 +229,7 @@ class Driver {
    * @returns {boolean}
    */
   _isEncrypted() {
-    return this._config.encrypted === ENCRYPTION_ON
+    return this._config.encrypted === ENCRYPTION_ON || this._config.encrypted === true
   }
 
   /**

packages/core/test/driver.test.ts

@@ -140,6 +140,21 @@ describe('Driver', () => {
     promise.catch(_ => 'Do nothing').finally(() => {})
   })
 
+  it.each([
+    [{ encrypted: true }, true],
+    [{ encrypted: false }, false],
+    [{}, false],
+    [{ encrypted: 'ENCRYPTION_ON' }, true],
+    [{ encrypted: 'ENCRYPTION_OFF' }, false],
+  ])('.isEncrypted()', (config, expectedValue) => {
+    const connectionProvider = new ConnectionProvider()
+    connectionProvider.close = jest.fn(() => Promise.resolve())
+    // @ts-ignore
+    const driver = new Driver(META_INFO, config, mockCreateConnectonProvider(connectionProvider))
+
+    expect(driver.isEncrypted()).toEqual(expectedValue)
+  })
+
   function mockCreateConnectonProvider(connectionProvider: ConnectionProvider) {
     return (
       id: number,

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

@@ -48,6 +48,7 @@ describe('#unit driver', () => {
       sharedNeo4j.authToken
     )
     expect(driver._isEncrypted()).toBeFalsy()
+    expect(driver.isEncrypted()).toBeFalsy()
     expect(driver._supportsRouting()).toBeFalsy()
   })
 
@@ -57,6 +58,7 @@ describe('#unit driver', () => {
       sharedNeo4j.authToken
     )
     expect(driver._isEncrypted()).toBeTruthy()
+    expect(driver.isEncrypted()).toBeTruthy()
     expect(driver._getTrust()).toEqual('TRUST_SYSTEM_CA_SIGNED_CERTIFICATES')
     expect(driver._supportsRouting()).toBeFalsy()
   })
@@ -67,6 +69,7 @@ describe('#unit driver', () => {
       sharedNeo4j.authToken
     )
     expect(driver._isEncrypted()).toBeTruthy()
+    expect(driver.isEncrypted()).toBeTruthy()
     expect(driver._getTrust()).toEqual('TRUST_ALL_CERTIFICATES')
     expect(driver._supportsRouting()).toBeFalsy()
   })
@@ -77,6 +80,7 @@ describe('#unit driver', () => {
       sharedNeo4j.authToken
     )
     expect(driver._isEncrypted()).toBeFalsy()
+    expect(driver.isEncrypted()).toBeFalsy()
     expect(driver._supportsRouting()).toBeTruthy()
   })
 
@@ -86,6 +90,7 @@ describe('#unit driver', () => {
       sharedNeo4j.authToken
     )
     expect(driver._isEncrypted()).toBeTruthy()
+    expect(driver.isEncrypted()).toBeTruthy()
     expect(driver._getTrust()).toEqual('TRUST_SYSTEM_CA_SIGNED_CERTIFICATES')
     expect(driver._supportsRouting()).toBeTruthy()
   })
@@ -96,6 +101,7 @@ describe('#unit driver', () => {
       sharedNeo4j.authToken
     )
     expect(driver._isEncrypted()).toBeTruthy()
+    expect(driver.isEncrypted()).toBeTruthy()
     expect(driver._getTrust()).toEqual('TRUST_ALL_CERTIFICATES')
     expect(driver._supportsRouting()).toBeTruthy()
   })