Added readyTimeout support in connection settings

Signed-off-by: Seb Julliand <[email protected]>

Author: sebjulliand

src/api/IBMi.ts

@@ -8,7 +8,7 @@ import { IBMiComponent } from "../components/component";
 import { CopyToImport } from "../components/copyToImport";
 import { CustomQSh } from '../components/cqsh';
 import { ComponentManager } from "../components/manager";
-import { CommandData, CommandResult, ConnectionData, IBMiMember, RemoteCommand, SpecialAuthorities, WrapResult } from "../typings";
+import { CommandData, CommandResult, ConnectionData, IBMiMember, RemoteCommand, WrapResult } from "../typings";
 import { CompileTools } from "./CompileTools";
 import { ConnectionConfiguration } from "./Configuration";
 import IBMiContent from "./IBMiContent";
@@ -76,7 +76,7 @@ export default class IBMi {
    */
   content = new IBMiContent(this);
 
-  client: node_ssh.NodeSSH|undefined;
+  client: node_ssh.NodeSSH | undefined;
   currentHost: string = ``;
   currentPort: number = 22;
   currentUser: string = ``;
@@ -106,7 +106,7 @@ export default class IBMi {
   //Maximum admited length for command's argument - any command whose arguments are longer than this won't be executed by the shell
   maximumArgsLength = 0;
 
-  private disconnectedCallback: (DisconnectCallback)|undefined;
+  private disconnectedCallback: (DisconnectCallback) | undefined;
 
   /**
    * Will only be called once per connection.

src/typings.ts

@@ -85,6 +85,7 @@ export interface ConnectionData {
   password?: string;
   privateKeyPath?: string;
   keepaliveInterval?: number;
+  readyTimeout?: number;
 }
 
 export interface Server {

src/webviews/login/index.ts

@@ -1,9 +1,8 @@
 import vscode, { l10n, ThemeIcon } from "vscode";
 import { ConnectionConfiguration, ConnectionManager } from "../../api/Configuration";
 import { CustomUI, Section } from "../../api/CustomUI";
-import IBMi from "../../api/IBMi";
-import { safeDisconnect, instance } from "../../instantiate";
 import { Tools } from "../../api/Tools";
+import { instance, safeDisconnect } from "../../instantiate";
 import { ConnectionData } from '../../typings';
 
 type NewLoginSettings = ConnectionData & {
@@ -30,6 +29,8 @@ export class Login {
       .addInput(`host`, l10n.t(`Host or IP Address`), undefined, { minlength: 1 })
       .addInput(`port`, l10n.t(`Port (SSH)`), ``, { default: `22`, minlength: 1, maxlength: 5, regexTest: `^\\d+$` })
       .addInput(`username`, l10n.t(`Username`), undefined, { minlength: 1, maxlength: 10 })
+      .addInput(`readyTimeout`, l10n.t(`Connection Timeout (in milliseconds)`), l10n.t(`How long to wait for the SSH handshake to complete.`), { inputType: "number", min: 1, default: "20000" })
+      .addHorizontalRule()
       .addParagraph(l10n.t(`Only provide either the password or a private key - not both.`))
       .addPassword(`password`, l10n.t(`Password`))
       .addCheckbox(`savePassword`, l10n.t(`Save Password`))
@@ -55,6 +56,7 @@ export class Login {
       page.panel.dispose();
 
       data.port = Number(data.port);
+      data.readyTimeout = Number(data.readyTimeout);
       data.privateKeyPath = data.privateKeyPath?.trim() ? Tools.normalizePath(data.privateKeyPath) : undefined;
       if (data.name) {
         const existingConnection = ConnectionManager.getByName(data.name);
@@ -96,7 +98,7 @@ export class Login {
 
               if (data.password || data.privateKeyPath) {
                 try {
-                  const connected = await instance.connect({data, onConnectedOperations: toDoOnConnected});
+                  const connected = await instance.connect({ data, onConnectedOperations: toDoOnConnected });
                   if (connected.success) {
                     if (newConnection) {
                       vscode.window.showInformationMessage(`Connected to ${data.host}! Would you like to configure this connection?`, `Open configuration`).then(async (selectionA) => {
@@ -172,7 +174,7 @@ export class Login {
       }
 
       try {
-        const connected = await instance.connect({data: connectionConfig, onConnectedOperations: toDoOnConnected, reloadServerSettings});
+        const connected = await instance.connect({ data: connectionConfig, onConnectedOperations: toDoOnConnected, reloadServerSettings });
         if (connected.success) {
           vscode.window.showInformationMessage(`Connected to ${connectionConfig.host}!`);
         } else {

src/webviews/settings/index.ts

@@ -362,6 +362,8 @@ export class SettingsUI {
               .addInput(`host`, vscode.l10n.t(`Host or IP Address`), undefined, { default: stored.host, minlength: 1 })
               .addInput(`port`, vscode.l10n.t(`Port (SSH)`), undefined, { default: String(stored.port), minlength: 1, maxlength: 5, regexTest: `^\\d+$` })
               .addInput(`username`, vscode.l10n.t(`Username`), undefined, { default: stored.username, minlength: 1 })
+              .addInput(`readyTimeout`, vscode.l10n.t(`Connection Timeout (in milliseconds)`), vscode.l10n.t(`How long to wait for the SSH handshake to complete.`), { inputType: "number", min: 1, default: stored.readyTimeout ? String(stored.readyTimeout) : "20000" })
+              .addHorizontalRule()
               .addParagraph(vscode.l10n.t(`Only provide either the password or a private key - not both.`))
               .addPassword(`password`, `${vscode.l10n.t(`Password`)}${storedPassword ? ` (${vscode.l10n.t(`stored`)})` : ``}`, vscode.l10n.t("Only provide a password if you want to update an existing one or set a new one."))
               .addFile(`privateKeyPath`, `${vscode.l10n.t(`Private Key`)}${privateKeyPath ? ` (${vscode.l10n.t(`Private Key`)}: ${privateKeyPath})` : ``}`, privateKeyWarning + vscode.l10n.t("Only provide a private key if you want to update from the existing one or set one.") + '<br />' + vscode.l10n.t("OpenSSH, RFC4716 and PPK formats are supported."))
@@ -410,6 +412,7 @@ export class SettingsUI {
 
                 //Fix values before assigning the data
                 data.port = Number(data.port);
+                data.readyTimeout = Number(data.readyTimeout);
                 delete data.password;
                 delete data.buttons;