Merge pull request #6 from oskarhane/explain-profile

Add support for plan and profile

Author: Stefan Plantikow

lib/result.js

@@ -93,7 +93,7 @@ class Result {
   subscribe(observer) {
     let onCompletedOriginal = observer.onCompleted;
     let onCompletedWrapper = (metadata) => {
-      this.summary = new ResultSummary(this._statement, this._parameters, metadata.type, metadata.stats);
+      this.summary = new ResultSummary(this._statement, this._parameters, metadata);
       onCompletedOriginal(metadata);
     }
     observer.onCompleted = onCompletedWrapper;
@@ -121,12 +121,69 @@ class ResultSummary {
    * @param {string} statementType - How did the statement effect the database
    * @param {Object} statistics - Result statistics
    */
-  constructor(statement, parameters, statementType, statistics) {
+  constructor(statement, parameters, metadata) {
+    let {type: statementType, stats: statistics, plan, profile} = metadata;
     this.statement = {text: statement, parameters};
     this.statementType = statementType;
     this.statistics = new StatementStatistics(statistics || {});
+    this.plan = plan || profile ? new Plan(plan || profile) : false;
+    this.profile = profile ? new ProfiledPlan(profile) : false;
   }
-}    
+
+  /**
+   * Check if the result summary has a plan
+   * @return {boolean}
+   */
+  hasPlan() {
+    return this.plan instanceof Plan
+  }
+
+  /**
+   * Check if the result summary has a profile
+   * @return {boolean}
+   */
+  hasProfile() {
+    return this.profile instanceof ProfiledPlan
+  }
+}
+
+/**
+  * Class for execution plan received by prepending Cypher with EXPLAIN.
+  * @access public
+  */
+class Plan {
+  /**
+   * Create a Plan instance
+   * @constructor
+   * @param {Object} plan - Object with plan data
+   */
+  constructor(plan) {
+    this.operatorType = plan.operatorType;
+    this.identifiers = plan.identifiers;
+    this.arguments = plan.args;
+    this.children = plan.children ? plan.children.map((child) => new Plan(child)) : [];
+  }
+}
+
+/**
+  * Class for execution plan received by prepending Cypher with PROFILE.
+  * @access public
+  */
+class ProfiledPlan {
+  /**
+   * Create a ProfiledPlan instance
+   * @constructor
+   * @param {Object} plan - Object with plan data
+   */
+  constructor(profile) {
+    this.operatorType = profile.operatorType;
+    this.identifiers = profile.identifiers;
+    this.arguments = profile.args;
+    this.dbHits = profile.args.DbHits.toInt();
+    this.rows = profile.args.Rows.toInt();
+    this.children = profile.children ? profile.children.map((child) => new ProfiledPlan(child)) : [];
+  }
+}
 
 /**
   * Get statistical information for a {Result}.
@@ -247,4 +304,14 @@ class StatementStatistics {
   }
 }
 
-export default Result;
+const statementType = {
+  READ_ONLY: 'r',
+  READ_WRITE: 'rw',
+  WRITE_ONLY: 'w',
+  SCHEMA_WRITE: 's'
+}
+
+export default {
+  Result,
+  statementType
+}

lib/session.js

@@ -18,7 +18,7 @@
  */
 
 import StreamObserver from './internal/stream-observer';
-import Result from './result';
+import {Result} from './result';
 
 /**
   * A Session instance is used for handling the connection and

test/session.test.js

@@ -1,5 +1,6 @@
 
 var neo4j = require("../build/node/neo4j");
+var StatementType = require("../build/node/result").statementType;
 
 describe('session', function() {
   it('should expose basic run/subscribe ', function(done) {
@@ -10,7 +11,7 @@ describe('session', function() {
     var records = [];
     driver.session().run( "RETURN 1.0 AS a").subscribe( {
       onNext : function( record ) {
-        records.push( record ); 
+        records.push( record );
       },
       onCompleted : function( ) {
         expect( records.length ).toBe( 1 );
@@ -52,7 +53,7 @@ describe('session', function() {
     )
   });
 
-  it('should expose summarize method ', function(done) {
+  it('should expose summarize method for basic metadata ', function(done) {
     // Given
     var driver = neo4j.driver("neo4j://localhost");
     var statement = "CREATE (n:Label {prop:{prop}}) RETURN n";
@@ -65,7 +66,49 @@ describe('session', function() {
       expect(sum.statement.parameters).toBe( params );
       expect(sum.statistics.containsUpdates()).toBe(true);
       expect(sum.statistics.nodesCreated()).toBe(1);
-      expect(sum.statementType).toBe('rw');
+      expect(sum.statementType).toBe(StatementType.READ_WRITE);
+      driver.close(); 
+      done();
+    });
+  });
+
+  it('should expose plan ', function(done) {
+    // Given
+    var driver = neo4j.driver("neo4j://localhost");
+    var statement = "EXPLAIN CREATE (n:Label {prop:{prop}}) RETURN n";
+    var params = {prop: "string"}
+    // When & Then
+    var result = driver.session().run( statement, params );
+    result.then(function( records ) {
+      var sum = result.summarize();
+      expect(sum.hasPlan()).toBe(true);
+      expect(sum.hasProfile()).toBe(false);
+      expect(sum.plan.operatorType).toBe('ProduceResults');
+      expect(sum.plan.arguments.runtime).toBe('INTERPRETED');
+      expect(sum.plan.identifiers[0]).toBe('n');
+      expect(sum.plan.children[0].operatorType).toBe('CreateNode');
+      driver.close(); 
+      done();
+    });
+  });
+
+  it('should expose profile ', function(done) {
+    // Given
+    var driver = neo4j.driver("neo4j://localhost");
+    var statement = "PROFILE MATCH (n:Label {prop:{prop}}) RETURN n";
+    var params = {prop: "string"}
+    // When & Then
+    var result = driver.session().run( statement, params );
+    result.then(function( records ) {
+      var sum = result.summarize();
+      expect(sum.hasPlan()).toBe(true); //When there's a profile, there's a plan
+      expect(sum.hasProfile()).toBe(true);
+      expect(sum.profile.operatorType).toBe('ProduceResults');
+      expect(sum.profile.arguments.runtime).toBe('INTERPRETED');
+      expect(sum.profile.identifiers[0]).toBe('n');
+      expect(sum.profile.children[0].operatorType).toBe('Filter');
+      expect(sum.profile.rows).toBeGreaterThan(0);
+      //expect(sum.profile.dbHits).toBeGreaterThan(0);
       driver.close(); 
       done();
     });