ssh-client-wrapper 1.8.0 → 1.8.2

package/lib/fork.js

@@ -1,6 +1,7 @@
 "use strict";
 const debug = require("debug")("sshClientWrapper:fork");
 const debugVerbose = require("debug")("sshClientWrapper:fork_verbose");
+const debugMasterVerbose = require("debug")("sshClientWrapper:fork_masterPty_verbose");
 const debugSendPty = require("debug")("sshClientWrapper:fork_sendpty");
 const { spawn } = require("node-pty");
 
@@ -53,7 +54,7 @@ function sshLoginCallback(output, ptyProcess, pw, ph) {
 function getMasterPty(hostInfo) {
   debug("fork pty for master connection");
   const ptyProcess = spawn(nodePtyOpt.shell, [], nodePtyOpt);
-  ptyProcess.onData(buff2String.bind(null, debugVerbose));
+  ptyProcess.onData(buff2String.bind(null, debugMasterVerbose));
   ptyProcess.onData((data)=>{
     const output = data.toString();
     sshLoginCallback(output, ptyProcess, hostInfo.password, hostInfo.passphrase);
@@ -62,9 +63,10 @@ function getMasterPty(hostInfo) {
 }
 
 async function fork(hostInfo, cmd, args, outputCallback) {
-  return new Promise((resolve, reject)=>{
+  let ptyProcess = null;
+  const p = new Promise((resolve, reject)=>{
     debug(`cmd=${cmd}: args=${args}`);
-    const ptyProcess = spawn(cmd, args, nodePtyOpt);
+    ptyProcess = spawn(cmd, args, nodePtyOpt);
     ptyProcess.onData(buff2String.bind(null, debugVerbose));
     ptyProcess.onData((data)=>{
       const output = data.toString();
@@ -97,6 +99,8 @@ async function fork(hostInfo, cmd, args, outputCallback) {
       return reject(err);
     });
   });
+  p.pty = ptyProcess;
+  return p;
 }
 module.exports = {
   fork,

package/lib/sshExec.js

@@ -64,6 +64,9 @@ async function canConnect(hostInfo, timeout = 60) {
  * @returns {boolean} - true if master session exists
  */
 async function existsMaster(hostInfo) {
+  const ac = new AbortController();
+  const signal = ac.signal;
+
   const args = getSshOption(hostInfo);
   args.push("-Ocheck");
 
@@ -72,16 +75,39 @@ async function existsMaster(hostInfo) {
     output += e;
   };
 
+  let rt = true; //if timeout occurred during ssh -Ocheck, it will turn to false
+  let p;
+  const timeout = hostInfo.ConnectTimeout || 60;
+  setTimeoutPromise(timeout * 1000, "neverUsedValue", { signal })
+    .then(()=>{
+      debug(`can not finish master session check within ${timeout} sec`);
+
+      if (p.pty) {
+        p.pty.kill();
+      }
+      rt = false;
+    })
+    .catch((err)=>{
+      if (err.name === "AbortError") {
+        debug("timeout was aborted because master session check has done");
+      } else {
+        throw err;
+      }
+    });
+
   try {
     debug(`check master session: ${sshCmd} ${args.join(" ")}`);
-    await fork(hostInfo, sshCmd, args, cb);
+    p = fork(hostInfo, sshCmd, args, cb);
+    await p;
+    ac.abort();
   } catch (err) {
     if (err.rt !== 255) {
       debug("check master session failed", err);
       throw err;
     }
   }
-  return !/Control socket connect.*: No such file or directory/.test(output);
+
+  return rt && !/Control socket connect.*: No such file or directory/.test(output);
 }
 
 /**
@@ -94,24 +120,33 @@ async function connect(hostInfo, timeout = 60) {
     return;
   }
   debug(`create master ssh session to ${hostInfo.host}`);
-  const pty = getMasterPty(hostInfo);
-  hostInfo.masterPty = pty;
+
+  if (!hostInfo.masterPty) {
+    debug(`create master pty for ${hostInfo.host}`);
+    hostInfo.masterPty = getMasterPty(hostInfo);
+  } else {
+    debug(`master pty for ${hostInfo.host} exists`);
+  }
 
   const ac = new AbortController();
   const signal = ac.signal;
   setTimeoutPromise(timeout * 1000, "neverUsedValue", { signal })
     .then(()=>{
+      debug(`can not connect within ${timeout} sec`);
+      hostInfo.masterPty.write("\n");
+      hostInfo.masterPty.write("exit\n");
+
       const err = new Error(`can not connect within ${timeout} sec`);
       err.host = hostInfo.host;
       err.user = hostInfo.user;
       err.port = hostInfo.port;
-      pty.write("\n");
-      pty.write("exit\n");
       throw err;
     })
     .catch((err)=>{
       if (err.name === "AbortError") {
         debug("timeout was aborted because connection check has done");
+      } else {
+        throw err;
       }
     });
 
@@ -119,8 +154,9 @@ async function connect(hostInfo, timeout = 60) {
   const re = new RegExp(`^${words}`);
   const p = new Promise((resolve, reject)=>{
     let done = false;
-    pty.onData((data)=>{
+    hostInfo.masterPty.onData((data)=>{
       if (done) {
+        //safeguard
         return;
       }
       const output = data.toString();
@@ -128,7 +164,7 @@ async function connect(hostInfo, timeout = 60) {
 
       if (re.test(output)) {
         debug("test done. call exit on remotehost");
-        pty.write("exit\n");
+        hostInfo.masterPty.write("exit\n");
         done = true;
         resolve();
       } else if (/Permission denied \(/.test(output)) {
@@ -141,7 +177,7 @@ async function connect(hostInfo, timeout = 60) {
         reject(new Error("Operation timed out"));
       }
     });
-    pty.onExit((e)=>{
+    hostInfo.masterPty.onExit((e)=>{
       debug("master pty exit", e);
       resolve(e);
     });
@@ -151,7 +187,7 @@ async function connect(hostInfo, timeout = 60) {
   args.push(`echo ${words}`);
   const cmd = `${sshCmd} ${args.join(" ")}\n`;
   debugVerbose(cmd);
-  pty.write(cmd);
+  hostInfo.masterPty.write(cmd);
   await p;
   ac.abort();
   debug(`connected to ${hostInfo.host}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh-client-wrapper",
-  "version": "1.8.0",
+  "version": "1.8.2",
   "description": "wrapper library for open ssh client and rsync",
   "keywords": [
     "ssh",
@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "debug": "^4.3.4",
-    "glob": "^10.3.1",
+    "glob": "^10.3.3",
     "node-pty": "^0.10.1",
     "nyc": "^15.1.0",
     "promise-retry": "^2.0.1"