Merge branch '1.0' into 1.1

Author: oskarhane

src/v1/result-summary.js

@@ -33,12 +33,16 @@ class ResultSummary {
   constructor(statement, parameters, metadata) {
     this.statement = {text: statement, parameters};
     this.statementType = metadata.type;
-    this.updateStatistics = new StatementStatistics(metadata.stats || {});
+    let counters = new StatementStatistics(metadata.stats || {});
+    this.counters = counters;
+    //for backwards compatibility, remove in future version
+    this.updateStatistics = counters;
     this.plan = metadata.plan || metadata.profile ? new Plan(metadata.plan || metadata.profile) : false;
     this.profile = metadata.profile ? new ProfiledPlan(metadata.profile) : false;
     this.notifications = this._buildNotifications(metadata.notifications);
+    this.resultConsumedAfter = metadata.result_consumed_after;
+    this.resultAvailableAfter = metadata.result_available_after;
   }
-
   _buildNotifications(notifications) {
     if(!notifications) {
       return [];

src/v1/result.js

@@ -35,12 +35,14 @@ class Result {
    * @param {StreamObserver} streamObserver
    * @param {mixed} statement - Cypher statement to execute
    * @param {Object} parameters - Map with parameters to use in statement
+   * @param metaSupplier function, when called provides metadata
    */
-  constructor(streamObserver, statement, parameters) {
+  constructor(streamObserver, statement, parameters, metaSupplier) {
     this._streamObserver = streamObserver;
     this._p = null;
     this._statement = statement;
     this._parameters = parameters || {};
+    this._metaSupplier = metaSupplier || function(){return {};};
   }
 
   /**
@@ -102,7 +104,15 @@ class Result {
    */
   subscribe(observer) {
     let onCompletedOriginal = observer.onCompleted;
+    let self = this;
     let onCompletedWrapper = (metadata) => {
+
+      let additionalMeta = self._metaSupplier();
+      for(var key in additionalMeta) {
+        if (additionalMeta.hasOwnProperty(key)) {
+          metadata[key] = additionalMeta[key];
+        }
+      }
       let sum = new ResultSummary(this._statement, this._parameters, metadata);
       onCompletedOriginal.call(observer, sum);
     };

src/v1/session.js

@@ -20,6 +20,7 @@
 import StreamObserver from './internal/stream-observer';
 import Result from './result';
 import Transaction from './transaction';
+import {Integer, int} from "./integer";
 import {newError} from "./error";
 
 /**
@@ -57,7 +58,7 @@ class Session {
       parameters = statement.parameters || {};
       statement = statement.text;
     }
-    let streamObserver = new StreamObserver();
+    let streamObserver = new _RunObserver();
     if (!this._hasTx) {
       this._conn.run(statement, parameters, streamObserver);
       this._conn.pullAll(streamObserver);
@@ -67,7 +68,7 @@ class Session {
        + "session with an open transaction; either run from within the "
        + "transaction or use a different session."));
     }
-    return new Result( streamObserver, statement, parameters );
+    return new Result( streamObserver, statement, parameters, () => streamObserver.meta() );
   }
 
   /**
@@ -107,4 +108,25 @@ class Session {
   }
 }
 
+/** Internal stream observer used for transactional results*/
+class _RunObserver extends StreamObserver {
+  constructor() {
+    super();
+    this._meta = {};
+  }
+
+  onCompleted(meta) {
+    super.onCompleted(meta);
+    for(var key in meta){
+      if(meta.hasOwnProperty(key)){
+        this._meta[key]=meta[key];
+      }
+    }
+  }
+
+  meta() {
+    return this._meta;
+  }
+}
+
 export default Session;

test/v1/examples.test.js

@@ -88,7 +88,7 @@ describe('examples', function() {
     var s = driver.session();
     s.run( "CREATE (p:Person { name: {name} })", {name: "The One"} )
       .then( function(result) {
-        var theOnesCreated = result.summary.updateStatistics.nodesCreated();
+        var theOnesCreated = result.summary.counters.nodesCreated();
         console.log(theOnesCreated);
         s.close();
         driver.close();
@@ -106,7 +106,7 @@ describe('examples', function() {
       .run( "CREATE (person:Person {name: {name}})", {name: "Arthur"} )
     // end::statement[]
       .then( function(result) {
-        var theOnesCreated = result.summary.updateStatistics.nodesCreated();
+        var theOnesCreated = result.summary.counters.nodesCreated();
         console.log("There were " + theOnesCreated + " the ones created.")
       })
       .then(function() {
@@ -122,7 +122,7 @@ describe('examples', function() {
       .run( "CREATE (p:Person { name: 'Arthur' })" )
     // end::statement-without-parameters[]
       .then( function(result) {
-        var theOnesCreated = result.summary.updateStatistics.nodesCreated();
+        var theOnesCreated = result.summary.counters.nodesCreated();
         console.log("There were " + theOnesCreated + " the ones created.");
       });
 

test/v1/session.test.js

@@ -23,10 +23,13 @@ var Session = require("../../lib/v1/session");
 
 describe('session', function () {
 
-  var driver, session;
+  var driver, session, server;
 
   beforeEach(function (done) {
     driver = neo4j.driver("bolt://localhost", neo4j.auth.basic("neo4j", "neo4j"));
+    driver.onCompleted = function (meta) {
+      server = meta['server'];
+    };
     session = driver.session();
 
     session.run("MATCH (n) DETACH DELETE n").then(done);
@@ -151,13 +154,35 @@ describe('session', function () {
         var sum = result.summary;
         expect(sum.statement.text).toBe(statement);
         expect(sum.statement.parameters).toBe(params);
-        expect(sum.updateStatistics.containsUpdates()).toBe(true);
-        expect(sum.updateStatistics.nodesCreated()).toBe(1);
+        expect(sum.counters.containsUpdates()).toBe(true);
+        expect(sum.counters.nodesCreated()).toBe(1);
         expect(sum.statementType).toBe(StatementType.READ_WRITE);
         done();
       });
   });
 
+  it('should expose execution time information when using 3.1 and onwards', function (done) {
+
+    //lazy way of checking the version number
+    //if server has been set we know it is at least
+    //3.1 (todo actually parse the version string)
+    if (!server) {
+      done();
+      return;
+    }
+    // Given
+    var statement = "UNWIND range(1,10000) AS n RETURN n AS number";
+    // When & Then
+
+    session.run(statement)
+      .then(function (result) {
+        var sum = result.summary;
+        expect(sum.resultAvailableAfter.toInt()).toBeGreaterThan(0);
+        expect(sum.resultConsumedAfter.toInt()).toBeGreaterThan(0);
+        done();
+      });
+  });
+
   it('should expose empty parameter map on call with no parameters', function (done) {
     // Given
     var statement = "CREATE (n:Label {prop:'string'}) RETURN n";
@@ -305,7 +330,6 @@ describe('session', function () {
         done();
       })
   });
-
 });
 
 

test/v1/tck/steps/resultapisteps.js

@@ -56,11 +56,11 @@ module.exports = function () {
   });
 
   this.Then(/^requesting `Counters` from `Result Summary` should give$/, function (table) {
-    var updateStatistics = this.summary.updateStatistics
+    var counters = this.summary.counters;
     for ( var i = 0 ; i < table.hashes().length; i++) {
       var statistic = table.hashes()[i].counter;
       var expected = util.literalValueToTestValueNormalIntegers(table.hashes()[i].result);
-      var given = getStatistic(statistic, updateStatistics)
+      var given = getStatistic(statistic, counters)
       if (!util.compareValues(given, expected)) {
         throw Error("Statistics for: " + statistic + " does not match. Expected: '" + expected + "' Given: '" + given + "'");
       }
@@ -195,42 +195,42 @@ this.Then(/^the `Result Summary` `Notifications` has one notification with$/, fu
     throw Error("No statement type mapping of: " + type)
   }
 
-  function getStatistic(statementString, updateStatistics) {
+  function getStatistic(statementString, counters) {
     if (statementString == 'nodes created') {
-      return updateStatistics.nodesCreated();
+      return counters.nodesCreated();
     }
     if (statementString == 'nodes deleted') {
-      return updateStatistics.nodesDeleted();
+      return counters.nodesDeleted();
     }
     if (statementString == 'relationships created') {
-      return updateStatistics.relationshipsCreated();
+      return counters.relationshipsCreated();
     }
     if (statementString == 'relationships deleted') {
-      return updateStatistics.relationshipsDeleted();
+      return counters.relationshipsDeleted();
     }
     if (statementString == 'properties set') {
-      return updateStatistics.propertiesSet();
+      return counters.propertiesSet();
     }
     if (statementString == 'labels added') {
-      return updateStatistics.labelsAdded();
+      return counters.labelsAdded();
     }
     if (statementString == 'labels removed') {
-      return updateStatistics.labelsRemoved();
+      return counters.labelsRemoved();
     }
     if (statementString == 'indexes added') {
-      return updateStatistics.indexesAdded();
+      return counters.indexesAdded();
     }
     if (statementString == 'indexes removed') {
-      return updateStatistics.indexesRemoved();
+      return counters.indexesRemoved();
     }
     if (statementString == 'constraints added') {
-      return updateStatistics.constraintsAdded();
+      return counters.constraintsAdded();
     }
     if (statementString == 'constraints removed') {
-      return updateStatistics.constraintsRemoved();
+      return counters.constraintsRemoved();
     }
     if (statementString == 'contains updates') {
-      return updateStatistics.containsUpdates();
+      return counters.containsUpdates();
     }
     throw Error("No statistics mapping of: " + statementString)
   }