ssh-client-wrapper 2.0.1 → 2.0.2

package/.github/workflows/coverage_report.yml

@@ -4,6 +4,8 @@ on:
     tags:
       - 'v*'
 jobs:
+  test:
+    uses: ./.github/workflows/run_test.yml
   coverage:
     needs:
       - test

package/lib/fork.js

@@ -75,7 +75,9 @@ async function fork(hostInfo, cmd, args, timeout, outputCallback) {
     if (timeout > 0) {
       ac = watchDogTimer(timeout, cmd, ()=>{
         ptyProcess.kill();
-        reject(new Error(`watchdog timer expired ${timeout}`));
+        const err = new Error(`watchdog timer expired ${timeout}`);
+        err.code = "TIMEEXPIRE";
+        reject(err);
       });
     }
     ptyProcess.onData(buff2String.bind(null, debugVerbose));

package/lib/sshExec.js

@@ -64,7 +64,7 @@ async function canConnect(hostInfo, timeout = 60) {
  * @param {Object} hostInfo - hostinfo object
  * @returns {boolean} - true if master session exists
  */
-async function existsMaster(hostInfo) {
+async function existsMaster(hostInfo, argTimeout) {
   debugVerbose("existsMaster called");
   const args = getSshOption(hostInfo);
   args.push("-Ocheck");
@@ -74,20 +74,22 @@ async function existsMaster(hostInfo) {
     output += e;
   };
 
-  const rt = true; //if timeout occurred during ssh -Ocheck, it will turn to false
-  const timeout = hostInfo.ConnectTimeout || 60;
+  const timeout = argTimeout || hostInfo.ConnectTimeout || 60;
   debug(`check master session: ${sshCmd} ${args.join(" ")}`);
 
   try {
     await fork(hostInfo, sshCmd, args, timeout, cb);
   } catch (err) {
+    if (err.code === "TIMEEXPIRE") {
+      return false;
+    }
     if (err.rt !== 255) {
       debug("check master session failed", err);
       throw err;
     }
   }
 
-  return rt && !/Control socket connect.*: No such file or directory/.test(output);
+  return !/Control socket connect.*: No such file or directory/.test(output);
 }
 
 /**
@@ -95,7 +97,7 @@ async function existsMaster(hostInfo) {
  * @param {Object} hostInfo - hostinfo object
  */
 async function connect(hostInfo, timeout = 60) {
-  if (await existsMaster(hostInfo)) {
+  if (await existsMaster(hostInfo, timeout)) {
     debugVerbose("master connection exists");
     return;
   }
@@ -105,20 +107,22 @@ async function connect(hostInfo, timeout = 60) {
 
   debug(`create master ssh session to ${hostInfo.host}`);
 
-  const ac = watchDogTimer(timeout, "make connection", ()=>{
-    sendPty(hostInfo.masterPty, "\n", debugSendMasterPty, 137);
-    sendPty(hostInfo.masterPty, "exit\n", debugSendMasterPty, 138);
-
-    const err = new Error(`can not connect within ${timeout} sec`);
-    err.host = hostInfo.host;
-    err.user = hostInfo.user;
-    err.port = hostInfo.port;
-    throw err;
-  });
-
   const words = crypto.randomUUID();
   const re = new RegExp(`^${words}`);
+
+  let ac = null;
   const p = new Promise((resolve, reject)=>{
+    ac = watchDogTimer(timeout, "make connection", ()=>{
+      sendPty(hostInfo.masterPty, "\n", debugSendMasterPty, 137);
+      sendPty(hostInfo.masterPty, "exit\n", debugSendMasterPty, 138);
+
+      const err = new Error(`can not connect within ${timeout} sec`);
+      err.host = hostInfo.host;
+      err.user = hostInfo.user;
+      err.port = hostInfo.port;
+      reject(err);
+    });
+
     let done = false;
     hostInfo.masterPty.onData((data)=>{
       if (done) {
@@ -157,7 +161,9 @@ async function connect(hostInfo, timeout = 60) {
     await p;
     debug(`connected to ${hostInfo.host}`);
   } finally {
-    ac.abort();
+    if (ac !== null) {
+      ac.abort();
+    }
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh-client-wrapper",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "wrapper library for open ssh client and rsync",
   "keywords": [
     "ssh",