neo4j-driver 2.0.0-alpha03 → 3.8.0

package/README.md

@@ -1,16 +1,26 @@
 # Neo4j Driver for JavaScript
 
-A database driver for Neo4j 3.0.0+.
+This is the official Neo4j driver for JavaScript.
+
+Starting with 5.0, the Neo4j Drivers will be moving to a monthly release cadence. A minor version will be released on the last Friday of each month so as to maintain versioning consistency with the core product (Neo4j DBMS) which has also moved to a monthly cadence.
+
+As a policy, patch versions will not be released except on rare occasions. Bug fixes and updates will go into the latest minor version and users should upgrade to that. Driver upgrades within a major version will never contain breaking API changes.
+
+See also: https://neo4j.com/developer/kb/neo4j-supported-versions/
 
 Resources to get you started:
 
-- [Detailed docs](http://neo4j.com/docs/api/javascript-driver/current/).
-- [Sample small project using the driver](https://github.com/neo4j-examples/movies-javascript-bolt)
-- [Sample application using the driver](https://github.com/neo4j-examples/neo4j-movies-template)
+- [API Documentation](https://neo4j.com/docs/api/javascript-driver/current/)
 - [Neo4j Manual](https://neo4j.com/docs/)
 - [Neo4j Refcard](https://neo4j.com/docs/cypher-refcard/current/)
 
-## Include module in Node.js application
+## What's New in 5.x
+
+- [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/5.0-changelog)
+
+## Including the Driver
+
+### In Node.js application
 
 Stable channel:
 
@@ -34,12 +44,12 @@ var neo4j = require('neo4j-driver')
 Driver instance should be closed when Node.js application exits:
 
 ```javascript
-driver.close()
+driver.close() // returns a Promise
 ```
 
 otherwise application shutdown might hang or it might exit with a non-zero exit code.
 
-## Include in web browser
+### In web browser
 
 We build a special browser version of the driver, which supports connecting to Neo4j over WebSockets.
 It can be included in an HTML page using one of the following tags:
@@ -59,102 +69,217 @@ It can be included in an HTML page using one of the following tags:
 <script src="https://cdn.jsdelivr.net/npm/neo4j-driver@X.Y.Z/lib/browser/neo4j-web.min.js"></script>
 ```
 
-This will make a global `neo4j` object available, where you can access the driver API at `neo4j`\*:
+This will make a global `neo4j` object available, where you can create a driver instance with `neo4j.driver`:
 
 ```javascript
 var driver = neo4j.driver(
-  'bolt://localhost',
-  neo4j.auth.basic('neo4j', 'neo4j')
+  'neo4j://localhost',
+  neo4j.auth.basic('neo4j', 'password')
 )
 ```
 
-\* Since 2.0, driver API is moved from `neo4j.v1` to `neo4j`.
+From `5.4.0`, this version is also exported as ECMA Script Module.
+It can be imported from a module using the following statements:
+
+```javascript
+// Direct reference
+import neo4j from 'lib/browser/neo4j-web.esm.min.js'
+
+// unpkg CDN non-minified , version X.Y.Z where X.Y.Z >= 5.4.0
+import neo4j from 'https://unpkg.com/neo4j-driver@X.Y.Z/lib/browser/neo4j-web.esm.js'
+
+// unpkg CDN minified for production use, version X.Y.Z where X.Y.Z >= 5.4.0
+import neo4j from 'https://unpkg.com/neo4j-driver@X.Y.Z/lib/browser/neo4j-web.esm.min.js'
+
+// jsDelivr CDN non-minified, version X.Y.Z where X.Y.Z >= 5.4.0
+import neo4j from 'https://cdn.jsdelivr.net/npm/neo4j-driver@X.Y.Z/lib/browser/neo4j-web.esm.js'
+
+// jsDelivr CDN minified for production use, version X.Y.Z where X.Y.Z >= 5.4.0
+import neo4j from 'https://cdn.jsdelivr.net/npm/neo4j-driver@X.Y.Z/lib/browser/neo4j-web.esm.min.js'
+
+```
 
 It is not required to explicitly close the driver on a web page. Web browser should gracefully close all open
 WebSockets when the page is unloaded. However, driver instance should be explicitly closed when it's lifetime
 is not the same as the lifetime of the web page:
 
 ```javascript
-driver.close()
+driver.close() // returns a Promise
 ```
 
 ## Usage examples
 
-Driver lifecycle:
+### Constructing a Driver
 
 ```javascript
-// Create a driver instance, for the user neo4j with password neo4j.
+// Create a driver instance, for the user `neo4j` with password `password`.
 // It should be enough to have a single driver per database per application.
 var driver = neo4j.driver(
-  'bolt://localhost',
-  neo4j.auth.basic('neo4j', 'neo4j')
+  'neo4j://localhost',
+  neo4j.auth.basic('neo4j', 'password')
 )
 
 // Close the driver when application exits.
 // This closes all used network connections.
-driver.close()
+await driver.close()
 ```
 
-Session API:
+### Acquiring a Session
+
+#### Regular Session
 
 ```javascript
 // Create a session to run Cypher statements in.
 // Note: Always make sure to close sessions when you are done using them!
 var session = driver.session()
+```
+
+##### with a Default Access Mode of `READ`
+
+```javascript
+var session = driver.session({ defaultAccessMode: neo4j.session.READ })
+```
+
+##### with Bookmarks
+
+```javascript
+var session = driver.session({
+  bookmarks: [bookmark1FromPreviousSession, bookmark2FromPreviousSession]
+})
+```
+
+##### against a Database
+
+```javascript
+var session = driver.session({
+  database: 'foo',
+  defaultAccessMode: neo4j.session.WRITE
+})
+```
+
+#### Reactive Session
+
+```javascript
+// Create a reactive session to run Cypher statements in.
+// Note: Always make sure to close sessions when you are done using them!
+var rxSession = driver.rxSession()
+```
+
+##### with a Default Access Mode of `READ`
+
+```javascript
+var rxSession = driver.rxSession({ defaultAccessMode: neo4j.session.READ })
+```
+
+##### with Bookmarks
+
+```javascript
+var rxSession = driver.rxSession({
+  bookmarks: [bookmark1FromPreviousSession, bookmark2FromPreviousSession]
+})
+```
+
+##### against a Database
+
+```javascript
+var rxSession = driver.rxSession({
+  database: 'foo',
+  defaultAccessMode: neo4j.session.WRITE
+})
+```
+
+### Executing Queries
 
+#### Consuming Records with Streaming API
+
+```javascript
 // Run a Cypher statement, reading the result in a streaming manner as records arrive:
 session
-  .run('MERGE (alice:Person {name : {nameParam} }) RETURN alice.name AS name', {
+  .run('MERGE (alice:Person {name : $nameParam}) RETURN alice.name AS name', {
     nameParam: 'Alice'
   })
   .subscribe({
-    onNext: function(record) {
+    onKeys: keys => {
+      console.log(keys)
+    },
+    onNext: record => {
       console.log(record.get('name'))
     },
-    onCompleted: function() {
-      session.close()
+    onCompleted: () => {
+      session.close() // returns a Promise
     },
-    onError: function(error) {
+    onError: error => {
       console.log(error)
     }
   })
+```
+
+Subscriber API allows following combinations of `onKeys`, `onNext`, `onCompleted` and `onError` callback invocations:
+
+- zero or one `onKeys`,
+- zero or more `onNext` followed by `onCompleted` when operation was successful. `onError` will not be invoked in this case
+- zero or more `onNext` followed by `onError` when operation failed. Callback `onError` might be invoked after couple `onNext` invocations because records are streamed lazily by the database. `onCompleted` will not be invoked in this case.
+
+#### Consuming Records with Promise API
 
-// or
+```javascript
 // the Promise way, where the complete result is collected before we act on it:
 session
-  .run('MERGE (james:Person {name : {nameParam} }) RETURN james.name AS name', {
+  .run('MERGE (james:Person {name : $nameParam}) RETURN james.name AS name', {
     nameParam: 'James'
   })
-  .then(function(result) {
-    result.records.forEach(function(record) {
+  .then(result => {
+    result.records.forEach(record => {
       console.log(record.get('name'))
     })
-    session.close()
   })
-  .catch(function(error) {
+  .catch(error => {
     console.log(error)
   })
+  .then(() => session.close())
 ```
 
-Transaction functions API:
+#### Consuming Records with Reactive API
+
+```javascript
+rxSession
+  .run('MERGE (james:Person {name: $nameParam}) RETURN james.name AS name', {
+    nameParam: 'Bob'
+  })
+  .records()
+  .pipe(
+    map(record => record.get('name')),
+    concatWith(rxSession.close())
+  )
+  .subscribe({
+    next: data => console.log(data),
+    complete: () => console.log('completed'),
+    error: err => console.log(err)
+  })
+```
+
+### Transaction functions
 
 ```javascript
 // Transaction functions provide a convenient API with minimal boilerplate and
 // retries on network fluctuations and transient errors. Maximum retry time is
 // configured on the driver level and is 30 seconds by default:
-neo4j.driver('bolt://localhost', neo4j.auth.basic('neo4j', 'neo4j'), {
+// Applies both to standard and reactive sessions.
+neo4j.driver('neo4j://localhost', neo4j.auth.basic('neo4j', 'password'), {
   maxTransactionRetryTime: 30000
 })
+```
+
+#### Reading with Async Session
 
+```javascript
 // It is possible to execute read transactions that will benefit from automatic
 // retries on both single instance ('bolt' URI scheme) and Causal Cluster
 // ('neo4j' URI scheme) and will get automatic load balancing in cluster deployments
-var readTxResultPromise = session.readTransaction(function(transaction) {
+var readTxResultPromise = session.readTransaction(txc => {
   // used transaction will be committed automatically, no need for explicit commit/rollback
 
-  var result = transaction.run(
-    'MATCH (person:Person) RETURN person.name AS name'
-  )
+  var result = txc.run('MATCH (person:Person) RETURN person.name AS name')
   // at this point it is possible to either return the result or process it and return the
   // result of processing it is also possible to run more statements in the same transaction
   return result
@@ -162,190 +287,209 @@ var readTxResultPromise = session.readTransaction(function(transaction) {
 
 // returned Promise can be later consumed like this:
 readTxResultPromise
-  .then(function(result) {
-    session.close()
+  .then(result => {
     console.log(result.records)
   })
-  .catch(function(error) {
+  .catch(error => {
     console.log(error)
   })
+  .then(() => session.close())
+```
+
+#### Reading with Reactive Session
+
+```javascript
+rxSession
+  .readTransaction(txc =>
+    txc
+      .run('MATCH (person:Person) RETURN person.name AS name')
+      .records()
+      .pipe(map(record => record.get('name')))
+  )
+  .subscribe({
+    next: data => console.log(data),
+    complete: () => console.log('completed'),
+    error: err => console.log(error)
+  })
+```
+
+#### Writing with Async Session
 
+```javascript
 // It is possible to execute write transactions that will benefit from automatic retries
 // on both single instance ('bolt' URI scheme) and Causal Cluster ('neo4j' URI scheme)
-var writeTxResultPromise = session.writeTransaction(function(transaction) {
+var writeTxResultPromise = session.writeTransaction(async txc => {
   // used transaction will be committed automatically, no need for explicit commit/rollback
 
-  var result = transaction.run(
-    "MERGE (alice:Person {name : 'Alice' }) RETURN alice.name AS name"
+  var result = await txc.run(
+    "MERGE (alice:Person {name : 'Alice'}) RETURN alice.name AS name"
   )
   // at this point it is possible to either return the result or process it and return the
   // result of processing it is also possible to run more statements in the same transaction
-  return result.records.map(function(record) {
-    return record.get('name')
-  })
+  return result.records.map(record => record.get('name'))
 })
 
 // returned Promise can be later consumed like this:
 writeTxResultPromise
-  .then(function(namesArray) {
-    session.close()
+  .then(namesArray => {
     console.log(namesArray)
   })
-  .catch(function(error) {
+  .catch(error => {
     console.log(error)
   })
+  .then(() => session.close())
 ```
 
-Explicit transactions API:
+#### Writing with Reactive Session
 
 ```javascript
-// run statement in a transaction
-var tx = session.beginTransaction()
-
-tx.run('MERGE (bob:Person {name : {nameParam} }) RETURN bob.name AS name', {
-  nameParam: 'Bob'
-}).subscribe({
-  onNext: function(record) {
-    console.log(record.get('name'))
-  },
-  onCompleted: function() {
-    console.log('First query completed')
-  },
-  onError: function(error) {
-    console.log(error)
-  }
-})
+rxSession
+  .writeTransaction(txc =>
+    txc
+      .run("MERGE (alice:Person {name: 'James'}) RETURN alice.name AS name")
+      .records()
+      .pipe(map(record => record.get('name')))
+  )
+  .subscribe({
+    next: data => console.log(data),
+    complete: () => console.log('completed'),
+    error: error => console.log(error)
+  })
+```
 
-tx.run('MERGE (adam:Person {name : {nameParam} }) RETURN adam.name AS name', {
-  nameParam: 'Adam'
-}).subscribe({
-  onNext: function(record) {
-    console.log(record.get('name'))
-  },
-  onCompleted: function() {
-    console.log('Second query completed')
-  },
-  onError: function(error) {
-    console.log(error)
-  }
-})
+### Explicit Transactions
 
-//decide if the transaction should be committed or rolled back
-var success = false
+#### With Async Session
 
-if (success) {
-  tx.commit().subscribe({
-    onCompleted: function() {
-      // this transaction is now committed and session can be closed
-      session.close()
-    },
-    onError: function(error) {
-      console.log(error)
+```javascript
+// run statement in a transaction
+const txc = session.beginTransaction()
+try {
+  const result1 = await txc.run(
+    'MERGE (bob:Person {name: $nameParam}) RETURN bob.name AS name',
+    {
+      nameParam: 'Bob'
     }
-  })
-} else {
-  //transaction is rolled black and nothing is created in the database
+  )
+  result1.records.forEach(r => console.log(r.get('name')))
+  console.log('First query completed')
+
+  const result2 = await txc.run(
+    'MERGE (adam:Person {name: $nameParam}) RETURN adam.name AS name',
+    {
+      nameParam: 'Adam'
+    }
+  )
+  result2.records.forEach(r => console.log(r.get('name')))
+  console.log('Second query completed')
+
+  await txc.commit()
+  console.log('committed')
+} catch (error) {
+  console.log(error)
+  await txc.rollback()
   console.log('rolled back')
-  tx.rollback()
+} finally {
+  await session.close()
 }
 ```
 
-Subscriber API allows following combinations of `onNext`, `onCompleted` and `onError` callback invocations:
-
-- zero or more `onNext` followed by `onCompleted` when operation was successful. `onError` will not be invoked
-  in this case
-- zero or more `onNext` followed by `onError` when operation failed. Callback `onError` might be invoked after
-  couple `onNext` invocations because records are streamed lazily by the database. `onCompleted` will not be invoked
-  in this case
+#### With Reactive Session
 
-## Parallelization
-
-In a single session, multiple queries will be executed serially. In order to parallelize queries, multiple sessions are required.
-
-## Building
-
-    npm install
-    npm run build
-
-This produces browser-compatible standalone files under `lib/browser` and a Node.js module version under `lib/`.
-See files under `examples/` on how to use.
-
-## Testing
-
-Tests **require** latest [Boltkit](https://github.com/neo4j-contrib/boltkit) to be installed in the system. It is needed to start, stop and configure local test database. Boltkit can be installed with the following command:
-
-    pip install --upgrade boltkit
-
-To run tests against "default" Neo4j version:
-
-    ./runTests.sh
-
-To run tests against specified Neo4j version:
-
-./runTests.sh '-e 3.1.3'
-
-Simple `npm test` can also be used if you already have a running version of a compatible Neo4j server.
-
-For development, you can have the build tool rerun the tests each time you change
-the source code:
-
-    gulp watch-n-test
+```javascript
+rxSession
+  .beginTransaction()
+  .pipe(
+    mergeMap(txc =>
+      concatWith(
+        txc
+          .run(
+            'MERGE (bob:Person {name: $nameParam}) RETURN bob.name AS name',
+            {
+              nameParam: 'Bob'
+            }
+          )
+          .records()
+          .pipe(map(r => r.get('name'))),
+        of('First query completed'),
+        txc
+          .run(
+            'MERGE (adam:Person {name: $nameParam}) RETURN adam.name AS name',
+            {
+              nameParam: 'Adam'
+            }
+          )
+          .records()
+          .pipe(map(r => r.get('name'))),
+        of('Second query completed'),
+        txc.commit(),
+        of('committed')
+      ).pipe(catchError(err => txc.rollback().pipe(throwError(() => err))))
+    )
+  )
+  .subscribe({
+    next: data => console.log(data),
+    complete: () => console.log('completed'),
+    error: error => console.log(error)
+  })
+```
 
-### Testing on windows
+### Numbers and the Integer type
 
-Running tests on windows requires PhantomJS installed and its bin folder added in windows system variable `Path`.
-To run the same test suite, run `.\runTest.ps1` instead in powershell with admin right.
-The admin right is required to start/stop Neo4j properly as a system service.
-While there is no need to grab admin right if you are running tests against an existing Neo4j server using `npm test`.
+The Neo4j type system uses 64-bit signed integer values. The range of values is between `-(2`<sup>`64`</sup>`- 1)` and `(2`<sup>`63`</sup>`- 1)`.
 
-## A note on numbers and the Integer type
+However, JavaScript can only safely represent integers between `Number.MIN_SAFE_INTEGER` `-(2`<sup>`53`</sup>`- 1)` and `Number.MAX_SAFE_INTEGER` `(2`<sup>`53`</sup>`- 1)`.
 
-The Neo4j type system includes 64-bit integer values.
-However, JavaScript can only safely represent integers between `-(2`<sup>`53`</sup>`- 1)` and `(2`<sup>`53`</sup>`- 1)`.
 In order to support the full Neo4j type system, the driver will not automatically convert to javascript integers.
 Any time the driver receives an integer value from Neo4j, it will be represented with an internal integer type by the driver.
 
-### Write integers
+_**Any javascript number value passed as a parameter will be recognized as `Float` type.**_
+
+#### Writing integers
+
+Numbers written directly e.g. `session.run("CREATE (n:Node {age: $age})", {age: 22})` will be of type `Float` in Neo4j.
 
-Number written directly e.g. `session.run("CREATE (n:Node {age: {age}})", {age: 22})` will be of type `Float` in Neo4j.
 To write the `age` as an integer the `neo4j.int` method should be used:
 
 ```javascript
 var neo4j = require('neo4j-driver')
 
-session.run('CREATE (n {age: {myIntParam}})', { myIntParam: neo4j.int(22) })
+session.run('CREATE (n {age: $myIntParam})', { myIntParam: neo4j.int(22) })
 ```
 
-To write integers larger than can be represented as JavaScript numbers, use a string argument to `neo4j.int`:
+To write an integer value that are not within the range of `Number.MIN_SAFE_INTEGER` `-(2`<sup>`53`</sup>`- 1)` and `Number.MAX_SAFE_INTEGER` `(2`<sup>`53`</sup>`- 1)`, use a string argument to `neo4j.int`:
 
 ```javascript
-session.run('CREATE (n {age: {myIntParam}})', {
+session.run('CREATE (n {age: $myIntParam})', {
   myIntParam: neo4j.int('9223372036854775807')
 })
 ```
 
-### Read integers
+#### Reading integers
+
+In Neo4j, the type Integer can be larger what can be represented safely as an integer with JavaScript Number.
+
+It is only safe to convert to a JavaScript Number if you know that the number will be in the range `Number.MIN_SAFE_INTEGER` `-(2`<sup>`53`</sup>`- 1)` and `Number.MAX_SAFE_INTEGER` `(2`<sup>`53`</sup>`- 1)`.
 
-Since Integers can be larger than can be represented as JavaScript numbers, it is only safe to convert to JavaScript numbers if you know that they will not exceed `(2`<sup>`53`</sup>`- 1)` in size.
 In order to facilitate working with integers the driver include `neo4j.isInt`, `neo4j.integer.inSafeRange`, `neo4j.integer.toNumber`, and `neo4j.integer.toString`.
 
 ```javascript
-var aSmallInteger = neo4j.int(123)
-if (neo4j.integer.inSafeRange(aSmallInteger)) {
-  var aNumber = aSmallInteger.toNumber()
+var smallInteger = neo4j.int(123)
+if (neo4j.integer.inSafeRange(smallInteger)) {
+  var aNumber = smallInteger.toNumber()
 }
 ```
 
-If you will be handling integers larger than that, you should convert them to strings:
+If you will be handling integers that is not within the JavaScript safe range of integers, you should convert the value to a string:
 
 ```javascript
-var aLargerInteger = neo4j.int('9223372036854775807')
-if (!neo4j.integer.inSafeRange(aLargerInteger)) {
-  var integerAsString = aLargerInteger.toString()
+var largeInteger = neo4j.int('9223372036854775807')
+if (!neo4j.integer.inSafeRange(largeInteger)) {
+  var integerAsString = largeInteger.toString()
 }
 ```
 
-### Enable native numbers
+#### Enabling native numbers
 
 Starting from 1.6 version of the driver it is possible to configure it to only return native numbers instead of custom `Integer` objects.
 The configuration option affects all integers returned by the driver. **Enabling this option can result in a loss of precision and incorrect numeric
@@ -354,8 +498,95 @@ To enable potentially lossy integer values use the driver's configuration object
 
 ```javascript
 var driver = neo4j.driver(
-  'bolt://localhost',
-  neo4j.auth.basic('neo4j', 'neo4j'),
+  'neo4j://localhost',
+  neo4j.auth.basic('neo4j', 'password'),
   { disableLosslessIntegers: true }
 )
 ```
+
+## Building
+
+```
+npm ci
+npm run build
+```
+
+This produces browser-compatible standalone files under `lib/browser` and a Node.js module version under `lib/`.
+See files under `examples/` on how to use.
+
+## Testing
+
+Tests **require** latest [Testkit 4.3](https://github.com/neo4j-drivers/testkit/tree/4.3), Python3 and Docker.
+
+Testkit is needed to be cloned and configured to run against the Javascript Lite Driver. Use the following steps to configure Testkit.
+
+1. Clone the Testkit repository
+
+```
+git clone https://github.com/neo4j-drivers/testkit.git
+```
+
+2. Under the Testkit folder, install the requirements.
+
+```
+pip3 install -r requirements.txt
+```
+
+3. Define some enviroment variables to configure Testkit
+
+```
+export TEST_DRIVER_NAME=javascript
+export TEST_DRIVER_REPO=<path for the root folder of driver repository>
+unset TEST_DRIVER_LITE
+```
+
+To run test against against some Neo4j version:
+
+```
+python3 main.py
+```
+
+More details about how to use Teskit could be found on [its repository](https://github.com/neo4j-drivers/testkit/tree/4.3)
+
+## Testing (Legacy)
+
+Tests **require** latest [Boltkit](https://github.com/neo4j-contrib/boltkit) and [Firefox](https://www.mozilla.org/firefox/) to be installed in the system.
+
+Boltkit is needed to start, stop and configure local test database. Boltkit can be installed with the following command:
+
+```
+pip3 install --upgrade boltkit
+```
+
+To run tests against "default" Neo4j version:
+
+```
+./runTests.sh
+```
+
+To run tests against specified Neo4j version:
+
+```
+./runTests.sh '-e 4.2.0'
+```
+
+Simple `npm test` can also be used if you already have a running version of a compatible Neo4j server.
+
+For development, you can have the build tool rerun the tests each time you change
+the source code:
+
+```
+gulp watch-n-test
+```
+
+If the `gulp` command line tool is not available, you might need to install this globally:
+
+```
+npm install -g gulp-cli
+```
+
+### Testing on windows
+
+To run the same test suite, run `.\runTest.ps1` instead in powershell with admin right.
+The admin right is required to start/stop Neo4j properly as a system service.
+While there is no need to grab admin right if you are running tests against an existing Neo4j server using `npm test`.