Update session creation API

The API is changed to leverage object destructuring, so that we have named arguments and default values.

Author: ali-ince

src/driver.js

@@ -178,13 +178,18 @@ class Driver {
    * it is closed, the underlying connection will be released to the connection
    * pool and made available for others to use.
    *
-   * @param {string} [mode=WRITE] the access mode of this session, allowed values are {@link READ} and {@link WRITE}.
-   * @param {string|string[]} [bookmarkOrBookmarks=null] the initial reference or references to some previous
+   * @param {string} [defaultAccessMode=WRITE] the access mode of this session, allowed values are {@link READ} and {@link WRITE}.
+   * @param {string|string[]} [bookmarks=null] the initial reference or references to some previous
    * transactions. Value is optional and absence indicates that that the bookmarks do not exist or are unknown.
+   * @param {string} [db=''] the database this session will connect to.
    * @return {Session} new session.
    */
-  session (mode, bookmarkOrBookmarks) {
-    const sessionMode = Driver._validateSessionMode(mode)
+  session ({
+    defaultAccessMode = WRITE,
+    bookmarks: bookmarkOrBookmarks,
+    db = ''
+  } = {}) {
+    const sessionMode = Driver._validateSessionMode(defaultAccessMode)
     const connectionProvider = this._getOrCreateConnectionProvider()
     const bookmark = bookmarkOrBookmarks
       ? new Bookmark(bookmarkOrBookmarks)

test/examples.test.js

@@ -193,7 +193,7 @@ describe('examples', () => {
         'b.acme.com:7676',
         'c.acme.com:8787'
       ])
-      const session = driver.session(neo4j.WRITE)
+      const session = driver.session({ defaultAccessMode: neo4j.WRITE })
 
       session
         .run('CREATE (n:Person { name: $name })', { name: name })
@@ -628,7 +628,7 @@ describe('examples', () => {
     const savedBookmarks = []
 
     // Create the first person and employment relationship.
-    const session1 = driver.session(neo4j.WRITE)
+    const session1 = driver.session({ defaultAccessMode: neo4j.WRITE })
     const first = session1
       .writeTransaction(tx => addCompany(tx, 'Wayne Enterprises'))
       .then(() => session1.writeTransaction(tx => addPerson(tx, 'Alice')))
@@ -644,7 +644,7 @@ describe('examples', () => {
       })
 
     // Create the second person and employment relationship.
-    const session2 = driver.session(neo4j.WRITE)
+    const session2 = driver.session({ defaultAccessMode: neo4j.WRITE })
     const second = session2
       .writeTransaction(tx => addCompany(tx, 'LexCorp'))
       .then(() => session2.writeTransaction(tx => addPerson(tx, 'Bob')))
@@ -659,7 +659,10 @@ describe('examples', () => {
 
     // Create a friendship between the two people created above.
     const last = Promise.all([first, second]).then(ignore => {
-      const session3 = driver.session(neo4j.WRITE, savedBookmarks)
+      const session3 = driver.session({
+        defaultAccessMode: neo4j.WRITE,
+        bookmarks: savedBookmarks
+      })
 
       return session3
         .writeTransaction(tx => makeFriends(tx, 'Alice', 'Bob'))

test/internal/node/direct.driver.boltkit.test.js

@@ -75,7 +75,10 @@ describe('direct driver with stub server', () => {
 
     boltStub.run(() => {
       const driver = boltStub.newDriver('bolt://127.0.0.1:9001')
-      const session = driver.session(READ, 'neo4j:bookmark:v1:tx42')
+      const session = driver.session({
+        defaultAccessMode: READ,
+        bookmarks: ['neo4j:bookmark:v1:tx42']
+      })
       const tx = session.beginTransaction()
       tx.run('MATCH (n) RETURN n.name AS name').then(result => {
         const records = result.records
@@ -111,7 +114,10 @@ describe('direct driver with stub server', () => {
 
     boltStub.run(() => {
       const driver = boltStub.newDriver('bolt://127.0.0.1:9001')
-      const session = driver.session(WRITE, 'neo4j:bookmark:v1:tx42')
+      const session = driver.session({
+        defaultAccessMode: WRITE,
+        bookmarks: ['neo4j:bookmark:v1:tx42']
+      })
       const tx = session.beginTransaction()
       tx.run("CREATE (n {name:'Bob'})").then(result => {
         const records = result.records
@@ -145,7 +151,10 @@ describe('direct driver with stub server', () => {
 
     boltStub.run(() => {
       const driver = boltStub.newDriver('bolt://127.0.0.1:9001')
-      const session = driver.session(WRITE, 'neo4j:bookmark:v1:tx42')
+      const session = driver.session({
+        defaultAccessMode: WRITE,
+        bookmarks: ['neo4j:bookmark:v1:tx42']
+      })
       const writeTx = session.beginTransaction()
       writeTx.run("CREATE (n {name:'Bob'})").then(result => {
         const records = result.records
@@ -192,7 +201,10 @@ describe('direct driver with stub server', () => {
 
     boltStub.run(() => {
       const driver = boltStub.newDriver('bolt://127.0.0.1:9001')
-      const session = driver.session(WRITE, 'neo4j:bookmark:v1:tx42')
+      const session = driver.session({
+        defaultAccessMode: WRITE,
+        bookmarks: ['neo4j:bookmark:v1:tx42']
+      })
       const writeTx = session.beginTransaction()
       writeTx.run("CREATE (n {name:'Bob'})").then(result => {
         const records = result.records
@@ -239,7 +251,10 @@ describe('direct driver with stub server', () => {
 
     boltStub.run(() => {
       const driver = boltStub.newDriver('bolt://127.0.0.1:9001')
-      const session = driver.session(WRITE, 'neo4j:bookmark:v1:tx42')
+      const session = driver.session({
+        defaultAccessMode: WRITE,
+        bookmarks: ['neo4j:bookmark:v1:tx42']
+      })
       const writeTx = session.beginTransaction()
       writeTx.run("CREATE (n {name:'Bob'})").then(result => {
         const records = result.records