GraphDB configuration variables

README.md

@@ -133,6 +133,12 @@ AppSignal:
 - `APPSIGNAL_APP_NAME` : name of this app (e.g. 'Biofactoid')
 - `APPSIGNAL_APP_ENV` : used to indicate which instance is running (e.g 'master', 'production', 'unstable')
 
+Graph Database:
+
+- `GRAPHDB_CONN` : The connection string
+- `GRAPHDB_USER` : Authentication username
+- `GRAPHDB_PASS` : Authentication password
+
 The following environment variables should always be set in production instances:
 
 - `NODE_ENV` : set to `production`

neo4j-test/connect-neo4j.js

@@ -1,38 +1,23 @@
-//import { config } from 'dotenv';
 import { expect } from 'chai';
+import neo4j from 'neo4j-driver';
 
 import { closeDriver, getDriver, initDriver } from '../src/neo4j/neo4j-driver.js';
 
 describe('01. Initiate Driver', () => {
-    //beforeAll(() => config());
-    //afterAll(() => closeDriver());
 
-    it('Should create a driver instance and connect to server', async () => {
-        await initDriver();
-    });
-
-    it('Driver has been instantiated', () => {
-        const driver = getDriver();
-        expect(driver).toBeDefined();
-
-        expect(driver.constructor.name).toEqual('Driver');
-    });
-
-    it('Driver can verify connectivity', () => {
-        const driver = getDriver();
-        expect(driver).toBeDefined();
-        expect(driver.constructor.name).toEqual('Driver');
-
-        driver.verifyConnectivity()
-            .then(() => {
-                expect(true).toEqual(true);
-            })
-            .catch(e => {
-                expect(e).toBeUndefined('Unable to verify connectivity');
-            });
-    });
-
-    it('Close the Driver', () => {
-        closeDriver();
-    });
+  it('initDriver Should initialize and return a driver', () => {
+    const driver = initDriver();
+    expect(driver).an.instanceof(neo4j.Driver);
+  });
+
+  it('getDriver should return the driver', () => {
+    initDriver();
+    const driver = getDriver();
+    expect(driver).an.instanceof(neo4j.Driver);
+  });
+
+  it('closeDriver should remove driver instance', async () => {
+    const driver = await closeDriver();
+    expect(driver).to.be.undefined;
+  });
 });

src/config.js

@@ -138,3 +138,10 @@ export const MIN_RELATED_PAPERS = env('MIN_RELATED_PAPERS', 6);
 // google analytics
 // google tag manager
 export const GTM_ID = env('GTM_ID', 'GTM-NV468LC');
+
+// Graph Database
+export const GRAPHDB_CONN = env('GRAPHDB_CONN', 'bolt://localhost:7687');
+export const GRAPHDB_USER = env('GRAPHDB_USER', undefined);
+export const GRAPHDB_PASS = env('GRAPHDB_PASS', undefined);
+export const GRAPHDB_DBNAME = env('GRAPHDB_DBNAME', 'factoid');
+

src/neo4j/neo4j-driver.js

@@ -1,17 +1,36 @@
 import neo4j from 'neo4j-driver';
+import { GRAPHDB_CONN, GRAPHDB_USER, GRAPHDB_PASS } from '../config';
 
 let driver;
 
-export function initDriver() {
-    driver = neo4j.driver('bolt://localhost:7687');
-    return driver.verifyConnectivity()
-    .then( () => driver);
+/**
+ * Initialize the Neo4j driver singleton
+ *
+ * @param {object} config additional configuration
+ * @returns Neo4j {@link https://neo4j.com/docs/api/javascript-driver/current/class/lib6/driver.js~Driver.html Driver} instance
+ */
+export function initDriver( config = {} ) {
+  driver = neo4j.driver( GRAPHDB_CONN,
+    neo4j.auth.basic( GRAPHDB_USER, GRAPHDB_PASS ),
+    config
+  );
+  return driver;
 }
 
+/**
+ * Retrieve the Neo4j driver instance
+ *
+ * @returns The Neo4j Driver instance
+ */
 export function getDriver() {
-    return driver;
+  return driver;
 }
 
-export function closeDriver() {
-    return driver && driver.close();
+/**
+ * Close the Neo4j driver instance
+ *
+ * @returns Promise<void>
+ */
+export async function closeDriver() {
+  return driver && driver.close();
 }