Merge pull request #347 from GordonSmith/GH-344-DISABLE_PING

feat: Added pingInterval setting
hpcc-systems · Jun 16, 2023 · 7ecbfca · 7ecbfca
2 parents f618ddf + 1d675be
commit 7ecbfca
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 16 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -36,24 +36,21 @@
                 "${workspaceRoot}\\ecl-sample"
             ],
             "outFiles": [
-                "${workspaceRoot}/src/**/*.js",
-                "${workspaceRoot}/src/notebook-renderers/**/*.js"
+                "${workspaceRoot}/dist/**/*.js"
             ]
         },
         {
             "name": "Launch Extension With Other Extensions",
             "type": "extensionHost",
             "request": "launch",
             "debugWebviews": true,
-            // path to VSCode executable
+            "runtimeExecutable": "${execPath}",
             "args": [
-                //                "--disable-extensions",
                 "--extensionDevelopmentPath=${workspaceRoot}",
                 "${workspaceRoot}\\ecl-sample"
             ],
             "outFiles": [
-                "${workspaceRoot}/src/**/*.js",
-                "${workspaceRoot}/src/notebook-renderers/**/*.js"
+                "${workspaceRoot}/dist/**/*.js"
             ]
         },
         {

diff --git a/README.md b/README.md
@@ -13,6 +13,7 @@ This extension adds rich language support for [HPCC Systems](https://hpccsystems
 
 ### v2.23.x
 * Added `ecl.submitNoArchive` command, submits raw content of editor to server without creating an archive first.
+* Added `ecl.pingInterval` setting, allows user to change or disable the "server alive" ping.
 
 ### v2.19.x
 * Added `ecl.saveOnSyntaxCheck` and `ecl.saveOnSubmit` option to ECL Settings (defaulting to off to match ECL IDE behaviour).
@@ -256,6 +257,9 @@ The following Visual Studio Code settings are available for the ECL extension.
 
   // Save file prior to submission
   "ecl.saveOnSubmit": false
+
+  // Ping interval (secs, -1 to disable)
+  "ecl.pingInterval": 5
 ```
 
 #### ECL Launch Settings

diff --git a/package.json b/package.json
@@ -1064,6 +1064,12 @@
           "default": false,
           "description": "%Force global 'proxySupport' to 'fallback'%"
         },
+        "ecl.pingInterval": {
+          "type": "number",
+          "scope": "resource",
+          "default": 5,
+          "description": "%Ping interval (secs, -1 to disable)%"
+        },
         "dashy.libraryLocation": {
           "type": "string",
           "scope": "resource",

diff --git a/package.nls.json b/package.nls.json
@@ -62,6 +62,7 @@
     "Override eclcc auto detection": "Override eclcc auto detection",
     "Pin launch configuration": "Pin launch configuration",
     "Pin launch configuration to current document": "Pin launch configuration to current document",
+    "Ping interval (secs, -1 to disable)": "Ping interval (secs, -1 to disable)",
     "Pinned launch configurations": "Pinned launch configurations",
     "Private": "Private",
     "Public": "Public",

diff --git a/src/hpccplatform/launchConfig.ts b/src/hpccplatform/launchConfig.ts
@@ -1,7 +1,7 @@
 import * as vscode from "vscode";
 import * as os from "os";
 import * as path from "path";
-import { AccountService, Activity, CodesignService, Ping, Workunit, WUQuery, WUUpdate, Topology, EclccErrors, IOptions, LogicalFile, TpLogicalClusterQuery, attachWorkspace, IECLErrorWarning, locateClientTools, ClientTools, Service, WorkunitsService } from "@hpcc-js/comms";
+import { AccountService, Activity, CodesignService, Ping, Workunit, WUQuery, WUUpdate, Topology, EclccErrors, IOptions, LogicalFile, TpLogicalClusterQuery, attachWorkspace, IECLErrorWarning, locateClientTools, ClientTools, WorkunitsService } from "@hpcc-js/comms";
 import { join, scopedLogger } from "@hpcc-js/util";
 import { LaunchConfigState, LaunchMode, LaunchProtocol, LaunchRequestArguments } from "../debugger/launchRequestArguments";
 import { showEclStatus } from "../ecl/clientTools";

diff --git a/src/hpccplatform/session.ts b/src/hpccplatform/session.ts
@@ -222,6 +222,10 @@ class SessionManager {
                 const targetCluster = eclConfig.get<object>("targetCluster")[launchConfig];
                 this.switchTo(launchConfig, targetCluster);
             }
+
+            if (e.affectsConfiguration("ecl.pingInterval")) {
+                this.monitorConnection();
+            }
         });
 
         const eclConfig = vscode.workspace.getConfiguration("ecl");
@@ -351,6 +355,20 @@ class SessionManager {
     }
 
     protected _monitor = {};
+    monitorConnection() {
+        const eclConfig = vscode.workspace.getConfiguration("ecl");
+        const pingInterval = eclConfig.get("pingInterval", 5);
+        for (const key in this._monitor) {
+            clearInterval(this._monitor[key]);
+        }
+        this.updateConnection();
+        if (!isNaN(pingInterval) && pingInterval > 0) {
+            this._monitor[this.session.id] = setInterval(() => {
+                this.updateConnection();
+            }, pingInterval * 1000);
+        }
+    }
+
     switchTo(id?: string, targetCluster?: string) {
         if (!this.session || this.session.id !== id) {
             vscode.commands.executeCommand("setContext", "ecl.connected", false);
@@ -367,15 +385,7 @@ class SessionManager {
         }
         this.updateSettings();
         this.refreshStatusBar();
-        if (!this._monitor[this.session.id]) {
-            for (const key in this._monitor) {
-                clearInterval(this._monitor[key]);
-            }
-            this.updateConnection();
-            this._monitor[this.session.id] = setInterval(() => {
-                this.updateConnection();
-            }, 5000);
-        }
+        this.monitorConnection();
     }
 
     updateSettings() {