Add option to set client timeout explicitly (#97)

* Add option to set client timeout explicitly * fix * order _getClientTimeout
Azure · Oct 18, 2020 · e0fd2c7 · e0fd2c7
1 parent 5530022
commit e0fd2c7
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 8 deletions.
diff --git a/azure-kusto-data/package-lock.json b/azure-kusto-data/package-lock.json
diff --git a/azure-kusto-data/package.json b/azure-kusto-data/package.json
@@ -1,6 +1,6 @@
 {
   "name": "azure-kusto-data",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Azure Data Explorer Query SDK",
   "main": "index.js",
   "engines": {

diff --git a/azure-kusto-data/source/client.js b/azure-kusto-data/source/client.js
@@ -142,15 +142,19 @@ module.exports = class KustoClient {
     }
 
     _getClientTimeout(endpoint, properties) {
-        let timeout = null;
-        if (properties != null) {
-            var serverTimeout = properties instanceof ClientRequestProperties ? properties.getTimeout() : properties.timeout;
-            if (serverTimeout != null) {
+        if (properties != null && properties instanceof ClientRequestProperties) {
+            const clientTimeout = properties.getClientTimeout();
+            if(clientTimeout){
+                return clientTimeout;
+            }
+
+            const serverTimeout = properties.getTimeout();
+            if(serverTimeout){
                 return serverTimeout + CLIENT_SERVER_DELTA_IN_MILLISECS;
             }
         }
 
-        timeout = endpoint == this.endpoints.query ? QUERY_TIMEOUT_IN_MILLISECS : COMMAND_TIMEOUT_IN_MILLISECS;
-        return timeout;
+        const defaultTimeout = endpoint == this.endpoints.query ? QUERY_TIMEOUT_IN_MILLISECS : COMMAND_TIMEOUT_IN_MILLISECS;
+        return defaultTimeout;
     }
 };
diff --git a/azure-kusto-data/source/clientRequestProperties.js b/azure-kusto-data/source/clientRequestProperties.js
@@ -43,6 +43,14 @@ module.exports = class ClientRequestProperties {
         return this.getOption("servertimeout");
     }
 
+    setClientTimeout(timeoutMillis) {
+        this._clientTimeOut = timeoutMillis;
+    }
+
+    getClientTimeout() {
+        return this._clientTimeOut;
+    }
+
     clearOptions() {
         this._options = {};
     }

diff --git a/azure-kusto-data/test/clientTest.js b/azure-kusto-data/test/clientTest.js
@@ -106,6 +106,22 @@ describe("KustoClient", function () {
             await client.execute("Database", "Table | count", clientRequestProps);
         });
 
+        it("setClientTimout for request", async function () {
+            let url = "https://cluster.kusto.windows.net";
+            let client = new KustoClient(url);
+
+            let clientRequestProps = new KustoClientRequestProperties();
+            let timeoutMs = moment.duration(2.51, "minutes").asMilliseconds();
+            clientRequestProps.setClientTimeout(timeoutMs);
+            client.aadHelper._getAuthHeader = () => { return "MockToken" };
+            client._doRequest = (endpoint, headers, payload, timeout, properties) => {
+                let payloadObj = JSON.parse(payload);
+                assert.equal(timeout, timeoutMs);
+            };
+
+            await client.execute("Database", "Table | count", clientRequestProps);
+        });
+
         it("default timeout for query", async function () {
             let url = "https://cluster.kusto.windows.net";
             let client = new KustoClient(url);