added close and result set size (#47)

* added close and result set size

Author: DvirDukhan

README.md

@@ -65,9 +65,9 @@ let graph = new RedisGraph("social");
             let record = res.next();
             // See path.js for more path API.
             console.log(record.get("p").nodeCount);
-            graph.deleteGraph();
-            process.exit();
         }
+        graph.deleteGraph();
+        graph.close();
 
     })();
 

examples/redisGraphExample.js

@@ -36,9 +36,9 @@ try {
 			let record = res.next();
 			// See path.js for more path API.
 			console.log(record.get("p").nodeCount);
-			graph.deleteGraph();
-			process.exit();
-		}
+        }
+        graph.deleteGraph();
+        graph.close();
 	})();
 } catch (err) {
 	console.log(err);

src/graph.js

@@ -26,12 +26,18 @@ class Graph {
 		this._propertyPromise = undefined;      // used as a synchronization mechanizom for property names retrival
 		this._relationshipPromise = undefined;  // used as a synchronization mechanizom for relationship types retrival
 
-		let client =
+		this._client =
 			host instanceof redis.RedisClient
 				? host
 				: redis.createClient(port, host, options);
-		this._sendCommand = util.promisify(client.send_command).bind(client);
-	}
+		this._sendCommand = util.promisify(this._client.send_command).bind(this._client);
+    }
+    /**
+     * Closes the client.
+     */
+    close() {
+        this._client.quit();
+    }
 
 	/**
 	 * Auxiliary function to extract string(s) data from procedures such as:

src/resultSet.js

@@ -324,7 +324,14 @@ class ResultSet {
      */
 	getStatistics() {
 		return this._statistics;
-	}
+    }
+    
+    /**
+     * @returns {int} Result set size.
+     */
+    size() {
+        return this._resultsCount;
+    }
 }
 
 module.exports = ResultSet;

test/redisGraphAPITest.js

@@ -10,34 +10,41 @@ const assert = require("assert"),
 	deepEqual = require("deep-equal");
 
 describe("RedisGraphAPI Test", () => {
-    // Assuming this test is running against redis server at: localhost:6379 with no password.
+	// Assuming this test is running against redis server at: localhost:6379 with no password.
 	const api = new RedisGraph("social");
 
 	beforeEach(() => {
 		return api.deleteGraph().catch(() => {});
 	});
 
-    it("test connection from port and host", async () => {
-        // Assuming this test is running against redis server at: localhost:6379 with no password.
-        let graph = new RedisGraph("social", "127.0.0.1", 6379, {password:undefined});
-        let result = await graph.query("CREATE ({name:'roi', age:34})");
+	it("test connection from port and host", async () => {
+		// Assuming this test is running against redis server at: localhost:6379 with no password.
+		let graph = new RedisGraph("social", "127.0.0.1", 6379, {
+			password: undefined,
+		});
+		let result = await graph.query("CREATE ({name:'roi', age:34})");
+		assert.equal(result.size(), 0);
 		assert.ok(!result.hasNext());
-        assert.equal(1, result.getStatistics().nodesCreated());
-        graph.deleteGraph();
-    }) 
+		assert.equal(1, result.getStatistics().nodesCreated());
+		graph.deleteGraph();
+		graph.close();
+	});
 
 	it("test connection from client", async () => {
-        // Assuming this test is running against redis server at: localhost:6379 with no password.
-        let graph = new RedisGraph("social", redis.createClient());
-        let result = await graph.query("CREATE ({name:'roi', age:34})");
+		// Assuming this test is running against redis server at: localhost:6379 with no password.
+		let graph = new RedisGraph("social", redis.createClient());
+		let result = await graph.query("CREATE ({name:'roi', age:34})");
+		assert.equal(result.size(), 0);
 		assert.ok(!result.hasNext());
-        assert.equal(1, result.getStatistics().nodesCreated());
-        graph.deleteGraph();
+		assert.equal(1, result.getStatistics().nodesCreated());
+		graph.deleteGraph();
+		graph.close();
 	});
 
 	it("test Create Node", async () => {
 		// Create a node
 		let result = await api.query("CREATE ({name:'roi', age:34})");
+		assert.equal(result.size(), 0);
 		assert.ok(!result.hasNext());
 		assert.equal(1, result.getStatistics().nodesCreated());
 		assert.ifError(
@@ -71,6 +78,7 @@ describe("RedisGraphAPI Test", () => {
 	it("test Create Labeled Node", async () => {
 		// Create a node with a label
 		let result = await api.query("CREATE (:human {name:'danny', age:12})");
+		assert.equal(result.size(), 0);
 		assert.ok(!result.hasNext());
 		assert.equal(
 			"1",
@@ -97,6 +105,7 @@ describe("RedisGraphAPI Test", () => {
 			"MATCH (a:person {name:'roi'}), \
         (b:person {name:'amit'}) CREATE (a)-[:knows]->(b)"
 		);
+		assert.equal(matchResult.size(), 0);
 		assert.ok(!matchResult.hasNext());
 		assert.ifError(
 			matchResult.getStatistics().getStringValue(Label.NODES_CREATED)
@@ -122,6 +131,7 @@ describe("RedisGraphAPI Test", () => {
 		let resultSet = await api.query(
 			"MATCH (r:human)-[:knows]->(a:human) RETURN r.age, r.name"
 		);
+		assert.equal(resultSet.size(), 1);
 		assert.ok(resultSet.hasNext());
 		assert.equal(0, resultSet.getStatistics().nodesCreated());
 		assert.equal(0, resultSet.getStatistics().nodesDeleted());
@@ -162,7 +172,7 @@ describe("RedisGraphAPI Test", () => {
 		let resultSet = await api.query(
 			"MATCH (a:person)-[r:knows]->(b:person) RETURN a,r"
 		);
-
+		assert.equal(resultSet.size(), 1);
 		assert.ok(resultSet.hasNext());
 		assert.equal(0, resultSet.getStatistics().nodesCreated());
 		assert.equal(0, resultSet.getStatistics().nodesDeleted());
@@ -199,6 +209,7 @@ describe("RedisGraphAPI Test", () => {
 	it("test null value to string", async () => {
 		await api.query("CREATE ( {nullValue:null} )");
 		let resultSet = await api.query("MATCH (n) RETURN n.nullValue");
+		assert.equal(resultSet.size(), 1);
 		assert.ok(resultSet.hasNext());
 		let record = resultSet.next();
 		assert.equal(undefined, record.get(0));
@@ -217,6 +228,7 @@ describe("RedisGraphAPI Test", () => {
 			"MATCH (a:person)-[:knows]->(:person) RETURN a"
 		);
 
+		assert.equal(resultSet.size(), 0);
 		assert.ok(!resultSet.hasNext());
 		assert.equal(resultSet.getHeader()[0], "a");
 		assert.equal(0, resultSet.getStatistics().nodesCreated());
@@ -236,24 +248,27 @@ describe("RedisGraphAPI Test", () => {
 		await api.query("CREATE (:person{name:'a',age:32,array:[0,1,2]})");
 		await api.query("CREATE (:person{name:'b',age:30,array:[3,4,5]})");
 		let resultSet = await api.query("WITH [0,1,2] as x return x");
+
+		assert.equal(resultSet.size(), 1);
 		assert.ok(resultSet.hasNext());
 		assert.deepStrictEqual(["x"], resultSet.getHeader());
 		let record = resultSet.next();
 		assert.deepStrictEqual([0, 1, 2], record.get(0));
 		assert.ok(!resultSet.hasNext());
 
 		let newResultSet = await api.query("MATCH(n) return collect(n) as x");
+		assert.equal(newResultSet.size(), 1);
 		assert.ok(newResultSet.hasNext());
 		var nodeA = new Node("person", {
 			name: "a",
 			age: 32,
-			array: [0, 1, 2]
+			array: [0, 1, 2],
 		});
 		nodeA.setId(0);
 		var nodeB = new Node("person", {
 			name: "b",
 			age: 30,
-			array: [3, 4, 5]
+			array: [3, 4, 5],
 		});
 		nodeB.setId(1);
 		assert.deepStrictEqual(["x"], newResultSet.getHeader());
@@ -269,6 +284,7 @@ describe("RedisGraphAPI Test", () => {
 		}
 		let values = await Promise.all(promises);
 		for (var resultSet of values) {
+			assert.equal(resultSet.size(), 1);
 			let record = resultSet.next();
 			let n = record.get(0);
 			assert.equal(34, n.properties["age"]);
@@ -367,6 +383,7 @@ describe("RedisGraphAPI Test", () => {
 			.build();
 
 		let paths = new Set([path01, path12, path02]);
+		assert.equal(response.size(), 3);
 		while (response.hasNext()) {
 			let p = response.next().get("p");
 			let pInPaths = false;
@@ -394,7 +411,7 @@ describe("RedisGraphAPI Test", () => {
 			"str",
 			[1, 2, 3],
 			["1", "2", "3"],
-			null
+			null,
 		];
 		let promises = [];
 		for (var i = 0; i < params.length; i++) {