ssh-client-wrapper 2.2.10 → 2.4.0

package/lib/fork.js

@@ -69,7 +69,7 @@ function createMasterPty (hostInfo) {
   hostInfo.masterPty = ptyProcess;
 }
 
-async function fork (hostInfo, cmd, args, timeout, outputCallback) {
+async function fork (hostInfo, cmd, args, timeout, outputCallback, retryableExitCodes = []) {
   return new Promise((resolve, reject) => {
     debug(`cmd=${cmd}: args=${args}`);
     const ptyProcess = spawn(cmd, args, nodePtyOpt);
@@ -119,6 +119,9 @@ async function fork (hostInfo, cmd, args, timeout, outputCallback) {
       }
       const err = new Error("exit with non-zero");
       err.rt = exitCode;
+      if (retryableExitCodes.includes(exitCode)) {
+        err.retryable = true;
+      }
       return reject(err);
     });
   });

package/lib/index.js

@@ -27,8 +27,7 @@ const { isArrayOfString, sanityCheck } = require("./util.js");
  * @param {Integer} hostInfo.ControlPersist=180 - how long keep master connection after last client connection has been closed (sec).
  * @param {Integer} hostInfo.ConnectTimeout=60 - timeout used when connectiong to ths SSH server
  * @param {Integer} hostInfo.maxRetry=3 - max number of retry
- * @param {Integer} hostInfo.retryMinTimeout=60 - minimum duration before first retry
- * @param {Integer} hostInfo.retryMaxTimeout=300 - maximum duration between each retry
+ * @param {Integer} hostInfo.retryDuration=1000 - duration time (msec) between each retry
  * @param {string[]} hostInfo.sshOpt - additional options for ssh
  */
 

package/lib/rsyncExec.js

@@ -79,7 +79,7 @@ async function send (hostInfo, argSrc, dst, rsyncOpt, timeout) {
   }
   debug(`send ${src} to ${hostInfo.host}:${dst}`);
   debugVerbose(`send: ${rsyncCmd} ${args.join(" ")}`);
-  return retryWrapper(fork.bind(null, hostInfo, rsyncCmd, args, timeout), hostInfo);
+  return retryWrapper(fork.bind(null, hostInfo, rsyncCmd, args, timeout, null, [12]), hostInfo);
 }
 
 /**
@@ -119,7 +119,7 @@ async function recv (hostInfo, argSrc, dst, rsyncOpt, timeout) {
 
   debug(`recv ${src} to ${dst}`);
   debugVerbose(`recv: ${rsyncCmd} ${args.join(" ")}`);
-  return retryWrapper(fork.bind(null, hostInfo, rsyncCmd, args, timeout), hostInfo);
+  return retryWrapper(fork.bind(null, hostInfo, rsyncCmd, args, timeout, null, [12]), hostInfo);
 }
 module.exports = {
   checkRsyncVersion,

package/lib/sshExec.js

@@ -1,6 +1,6 @@
 "use strict";
 const crypto = require("crypto");
-const promiseRetry = require("promise-retry");
+const { setTimeout: setTimeoutPromise } = require("timers/promises");
 const debug = require("debug")("sshClientWrapper:debug:sshExec");
 const debugVerbose = require("debug")("sshClientWrapper:verbose:sshExec");
 const debugSendMasterPty = require("debug")("sshClientWrapper:insecure:sshExec_masterPty");
@@ -242,22 +242,36 @@ async function ls (hostInfo, target, lsOpt, timeout) {
 
 /**
  * retry fork() if it throw retryable error
- * @param {Function}  func - function to be wrapped
+ * @param {Function} func - function to be wrapped
+ * @param {Object} hostInfo - hostinfo object
+ * @param {Integer} argMaxRetry - max retry number
  */
-async function retryWrapper (func, hostInfo) {
-  const minTimeout = hostInfo.retryMinTimeout * 1000 || 1000;
-  const maxTimeout = hostInfo.retryMaxTimeout * 1000 || 5000;
-  const retries = hostInfo.maxRetry || 1;
-  return promiseRetry({ retries, minTimeout, maxTimeout }, (retry, number) => {
-    return func()
-      .catch((e) => {
-        if (e.retryable) {
-          debug(`retrying: ${number} times`);
-          disconnect(hostInfo).then(retry);
-        }
+async function retryWrapper (func, hostInfo, argMaxRetry, argDuration) {
+  const maxRetry = argMaxRetry || hostInfo.maxRetry || 1;
+  const duration = argDuration || hostInfo.retryDuration || 1000;
+  if (maxRetry === 1) {
+    return func();
+  }
+  let retryCount = 0;
+  while (true) {
+    let rt;
+    try {
+      rt = await func();
+      return rt;
+    } catch (e) {
+      if (!e.retryable) {
         throw e;
-      });
-  });
+      }
+      if (retryCount > maxRetry) {
+        debug(`max retry count exceeded: ${retryCount}`);
+        throw e;
+      }
+      retryCount++;
+      debug(`retryable error occurred ${e.message}`);
+      debug(`retrying: ${retryCount} times`);
+      await setTimeoutPromise(duration, true);
+    }
+  }
 }
 
 module.exports = {

package/lib/util.js

@@ -16,6 +16,7 @@ const Ajv = require("ajv");
 const ajv = new Ajv({
   allErrors: true,
   coerceTypes: true,
+  useDefaults: "empty",
   logger: {
     log: debug,
     warn: debug,
@@ -33,11 +34,10 @@ const hostInfoSchema = {
     port: { type: "number", minimum: 0, maximum: 65535 },
     keyFile: { type: "string", pattern: "\\S+", transform: ["trim"] },
     noStrictHostkeyChecking: { type: "boolean" },
-    ControlPersist: { type: "number", minimum: 0 },
+    ControlPersist: { type: "number", minimum: 0, default: 180 },
     ConnectTimeout: { type: "number", minimum: 0 },
-    maxRetry: { type: "number", minimum: 0 },
-    retryMinTimeout: { type: "number", minimum: 0 },
-    retryMaxTimeout: { type: "number", minimum: 0 },
+    maxRetry: { type: "number", minimum: 0, default: 3 },
+    retryDuration: { type: "number", minimum: 0, default: 1000 },
     sshOpt: { type: "array", minItems: 1, items: { type: "string", pattern: "\\S+", transform: ["trim"] } }
   },
   required: ["host"]
@@ -51,8 +51,7 @@ const numberOptions = [
   "ControlPersist",
   "ConnectTimeout",
   "maxRetry",
-  "retryMinTimeout",
-  "retryMaxTimeout"
+  "retryDuration"
 ];
 
 const validate = ajv.compile(hostInfoSchema);

package/package.json

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

package/run_test_all.sh

@@ -1,4 +1,12 @@
 #!/bin/bash
+
+function cleanup(){
+  docker-compose rm --stop --force testbed
+}
+
+trap cleanup EXIT
+set -e -o pipefail
+
 docker-compose up testbed -d
 export TEST_HOST=localhost
 export TEST_USER=testuser
@@ -7,27 +15,13 @@ export TEST_PORT=4000
 ssh-keygen -R '[localhost]:4000'
 
 npm run test
-if [ $? -ne 0 ];then
-  echo local test failed
-  exit 1
-fi
+echo local test success
 
 docker-compose run --build --rm tester
-if [ $? -ne 0 ];then
-  echo test on latest ubuntu failed
-  exit 2
-fi
+echo test on latest ubuntu success
 
 docker-compose run --build --rm tester-bullseye
-if [ $? -ne 0 ];then
-  echo test on bullseye failed
-  exit 3
-fi
+echo test on bullseye success
 
 docker-compose run --build --rm tester-buster
-if [ $? -ne 0 ];then
-  echo test on buster failed
-  exit 4
-fi
-
-docker-compose rm --stop --force testbed
+echo test on buster success

package/test/interface.js

@@ -49,7 +49,12 @@ describe("test for interface", () => {
   });
   describe("test for public method", () => {
     let ssh;
-    const hostInfoOrg = { host: "hoge" };
+    const hostInfoOrg = {
+      host: "hoge",
+      ControlPersist: 180,
+      maxRetry: 3,
+      retryDuration: 1000
+    };
     const hostInfo = { ...hostInfoOrg, masterPty: null, rsyncVersion: null };
     beforeEach(() => {
       ssh = new SshClientWrapper(hostInfoOrg);

package/test/util.js

@@ -11,6 +11,11 @@ const { sanityCheck } = require("../lib/util.js");
 
 describe("test for sanityCheck", () => {
   const host = "testHostName";
+  const defaultValues = {
+    ControlPersist: 180,
+    maxRetry: 3,
+    retryDuration: 1000
+  };
   it("should throw error for empty host", () => {
     expect(sanityCheck.bind(null, { host: "   ", user: "   ", port: 22 })).to.throw(/empty host is not allowed/);
   });
@@ -18,10 +23,29 @@ describe("test for sanityCheck", () => {
     expect(sanityCheck.bind(null, { user: "   ", port: 22 })).to.throw(/host is required/);
   });
   it("should just remove empty string props", () => {
-    expect(sanityCheck({ host, user: "   ", port: 22 })).to.deep.equal({ host, port: 22 });
+    expect(sanityCheck({
+      host,
+      user: "   ",
+      port: 22
+    })).to.deep.equal({
+      host,
+      ...defaultValues,
+      port: 22
+    });
   });
   it("should remove empty string member in sshOpt", () => {
-    expect(sanityCheck({ host, sshOpt: ["foo", "  ", "bar"], user: "user", port: 33 })).to.deep.equal({ host, sshOpt: ["foo", "bar"], user: "user", port: 33 });
+    expect(sanityCheck({
+      host,
+      sshOpt: ["foo", "  ", "bar"],
+      user: "user",
+      port: 33
+    })).to.deep.equal({
+      host,
+      ...defaultValues,
+      sshOpt: ["foo", "bar"],
+      user: "user",
+      port: 33
+    });
   });
   it("should just change type if string value specified for number", () => {
     expect(sanityCheck({
@@ -30,16 +54,14 @@ describe("test for sanityCheck", () => {
       ControlPersist: "22",
       ConnectTimeout: "33",
       maxRetry: "44",
-      retryMinTimeout: "55",
-      retryMaxTimeout: "66"
+      retryDuration: "55"
     })).to.deep.equal({
       host,
       port: 11,
       ControlPersist: 22,
       ConnectTimeout: 33,
       maxRetry: 44,
-      retryMinTimeout: 55,
-      retryMaxTimeout: 66
+      retryDuration: 55
     });
   });
   it("should remove out of range members", () => {
@@ -48,8 +70,7 @@ describe("test for sanityCheck", () => {
       ControlPersist: "-1",
       ConnectTimeout: "-1",
       maxRetry: "-1",
-      retryMinTimeout: "-1",
-      retryMaxTimeout: "-1"
+      retryDuration: "-1"
     })).to.deep.equal({
       host
     });
@@ -60,6 +81,7 @@ describe("test for sanityCheck", () => {
       noStrictHostkeyChecking: "true"
     })).to.deep.equal({
       host,
+      ...defaultValues,
       noStrictHostkeyChecking: true
     });
   });
@@ -69,6 +91,7 @@ describe("test for sanityCheck", () => {
       noStrictHostkeyChecking: 0
     })).to.deep.equal({
       host,
+      ...defaultValues,
       noStrictHostkeyChecking: false
     });
   });