version 2.9.0

Author: krystianity

README.md

@@ -15,7 +15,10 @@ const yildiz = new YildizClient({
     proto: "http",
     host: "localhost",
     port: 3058,
-    token: "bla-bla-bla-bla" //optional
+    token: "bla-bla-bla-bla", //optional
+    disableKeepAlive: false, //optional - disable keep alive pool
+    enableTimings: false //optional - adds time object to response of yildiz.raw()
+    timeoutMs: 7500 //optional - timeout in milliseconds for the request
 });
 
 (async () => {

lib/HttpClient.js

@@ -16,21 +16,27 @@ class HttpClient {
             proto,
             host,
             port,
-            token
+            token,
+            disableKeepAlive,
+            enableTimings,
+            timeoutMs
         } = config;
 
         prefix = prefix || DEFAULT_PREFIX;
 
-        this._agent = new http.Agent({
-            keepAlive: true,
-            keepAliveMsecs: 3000,
-            maxSockets: 200,
-            maxFreeSockets: 150
-        });
+        this._agent = undefined;
+        if(disableKeepAlive !== true){
+            this._agent = new http.Agent({
+                keepAlive: true,
+                keepAliveMsecs: 3000,
+                maxSockets: 200,
+                maxFreeSockets: 150
+            });
+        }
 
-        this.timeoutMs = 7500;
+        this.timeoutMs = timeoutMs || 7500;
 
-        this._req = getInstance(prefix, token, proto, host, port, this._agent);
+        this._req = getInstance(prefix, token, proto, host, port, this._agent, enableTimings);
         debug(`${proto}://${host}:${port} via prefix = ${prefix}.`);
     }
 

lib/promRequest.js

@@ -4,7 +4,7 @@ const Promise = require("bluebird");
 const request = require("request");
 const debug = require("debug")("yildiz:http:pr");
 
-const reqProm = (prefix, token, proto, host, port, path = "/", options = {}, agent = undefined, expectedStatusCode = null) => {
+const reqProm = (prefix, token, proto, host, port, path = "/", options = {}, agent = undefined, timings = false, expectedStatusCode = null) => {
 
     options.url = `${proto}://${host}:${port}${path}`;
 
@@ -28,7 +28,13 @@ const reqProm = (prefix, token, proto, host, port, path = "/", options = {}, age
     }
 
     //keep-alive
-    options.agent = agent;
+    if(agent){
+        options.agent = agent;
+    }
+
+    if(timings){
+        options.time = true;
+    }
 
     return new Promise((resolve, reject) => {
         request(options, (error, response, body) => {
@@ -46,6 +52,20 @@ const reqProm = (prefix, token, proto, host, port, path = "/", options = {}, age
                 //empty
             }
 
+            const responseData = {
+                time: null
+            };
+
+            if(timings){
+                responseData.time = {
+                    elapsedTime: response.elapsedTime,
+                    responseStartTime: response.responseStartTime,
+                    timingStart: response.timingStart,
+                    timings: response.timings,
+                    timingPhases: response.timingPhases
+                };
+            }
+
             if(expectedStatusCode && response.statusCode !== expectedStatusCode){
 
                 let errorMessage = "No error message present in body";
@@ -58,19 +78,19 @@ const reqProm = (prefix, token, proto, host, port, path = "/", options = {}, age
                 return reject(new Error(`Response status code: ${response.statusCode} does match expected status code: ${expectedStatusCode}. ${errorMessage}.`));
             }
 
-            resolve({
+            resolve(Object.assign(responseData, {
                 status: response.statusCode,
                 headers: response.headers,
                 body: parsedBody
-            });
+            }));
         });
     });
 };
 
 module.exports = {
-    getInstance: (prefix, token, proto = "http", host = "localhost", port = 3058, agent = undefined) => {
+    getInstance: (prefix, token, proto = "http", host = "localhost", port = 3058, agent = undefined, timings = false) => {
         return (path, options, expectedStatusCode) => {
-            return reqProm(prefix, token, proto, host, port, path, options, agent, expectedStatusCode);
+            return reqProm(prefix, token, proto, host, port, path, options, agent, timings, expectedStatusCode);
         };
     }
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "yildiz-js",
-  "version": "2.8.0",
+  "version": "2.9.0",
   "description": "Client for yildiz graph database",
   "main": "index.js",
   "scripts": {
@@ -26,11 +26,11 @@
   "dependencies": {
     "bluebird": "^3.5.1",
     "debug": "^3.1.0",
-    "request": "^2.83.0"
+    "request": "^2.85.0"
   },
   "devDependencies": {
     "body-parser": "^1.18.2",
-    "express": "^4.16.2",
-    "mocha": "^4.0.1"
+    "express": "^4.16.3",
+    "mocha": "^5.0.4"
   }
 }

test/int/Client.test.js

@@ -14,7 +14,9 @@ describe("Client INT", () => {
     const client = new HttpClient({
         proto: "http",
         host: "localhost",
-        port
+        port,
+        disableKeepAlive: false,
+        enableTimings: true
     });
 
     before(done => {