ssh-client-wrapper 2.2.4 → 2.2.7

package/lib/fork.js

@@ -11,8 +11,8 @@ const nodePtyOpt = {
   windowsHide: true
 };
 
-function sshLoginCallback(output, ptyProcess, pw, ph, logger = debugSendPty) {
-  return new Promise((resolve, reject)=>{
+function sshLoginCallback (output, ptyProcess, pw, ph, logger = debugSendPty) {
+  return new Promise((resolve, reject) => {
     if (reNewHostPrompt.test(output)) {
       sendPty(ptyProcess, "yes\n", logger, 17);
       resolve();
@@ -26,10 +26,10 @@ function sshLoginCallback(output, ptyProcess, pw, ph, logger = debugSendPty) {
       if (typeof pw === "function") {
         debug("call password callback function");
         pw()
-          .then((v)=>{
+          .then((v) => {
             sendPty(ptyProcess, `${v}\n`, logger, 30);
           })
-          .catch((e)=>{
+          .catch((e) => {
             reject(e);
           });
         resolve();
@@ -44,10 +44,10 @@ function sshLoginCallback(output, ptyProcess, pw, ph, logger = debugSendPty) {
       if (typeof ph === "function") {
         debug("call passphrase callback function");
         ph()
-          .then((v)=>{
+          .then((v) => {
             sendPty(ptyProcess, `${v}\n`, logger, 45);
           })
-          .catch((e)=>{
+          .catch((e) => {
             reject(e);
           });
       }
@@ -58,7 +58,7 @@ function sshLoginCallback(output, ptyProcess, pw, ph, logger = debugSendPty) {
 /**
  * create pty for master ssh session and store to hostInfo.masterPty
  */
-function createMasterPty(hostInfo) {
+function createMasterPty (hostInfo) {
   debug("fork pty for master connection");
 
   if (hostInfo.masterPty) {
@@ -69,13 +69,13 @@ function createMasterPty(hostInfo) {
   hostInfo.masterPty = ptyProcess;
 }
 
-async function fork(hostInfo, cmd, args, timeout, outputCallback) {
-  return new Promise((resolve, reject)=>{
+async function fork (hostInfo, cmd, args, timeout, outputCallback) {
+  return new Promise((resolve, reject) => {
     debug(`cmd=${cmd}: args=${args}`);
     const ptyProcess = spawn(cmd, args, nodePtyOpt);
     let ac = null;
     if (timeout > 0) {
-      ac = watchDogTimer(timeout, cmd, ()=>{
+      ac = watchDogTimer(timeout, cmd, () => {
         ptyProcess.kill();
         const err = new Error(`watchdog timer expired ${timeout}`);
         err.code = "TIMEEXPIRE";
@@ -85,7 +85,7 @@ async function fork(hostInfo, cmd, args, timeout, outputCallback) {
     ptyProcess.onData(buff2String.bind(null, debugVerbose));
 
     if (hostInfo !== null) {
-      ptyProcess.onData(async (data)=>{
+      ptyProcess.onData(async (data) => {
         const output = data.toString();
         sshLoginCallback(output, ptyProcess, hostInfo.password, hostInfo.passphrase)
           .catch(reject);
@@ -102,7 +102,7 @@ async function fork(hostInfo, cmd, args, timeout, outputCallback) {
     if (typeof outputCallback === "function") {
       ptyProcess.onData(buff2String.bind(null, outputCallback));
     }
-    ptyProcess.onExit(({ exitCode, signal })=>{
+    ptyProcess.onExit(({ exitCode, signal }) => {
       debug("onExit", exitCode, signal);
 
       if (ac !== null) {

package/lib/index.js

@@ -32,7 +32,7 @@ const { isArrayOfString, sanityCheck } = require("./util.js");
  * @param {string[]} hostInfo.sshOpt - additional options for ssh
  */
 
-const logAndReject = (message)=>{
+const logAndReject = (message) => {
   debug(message);
   return Promise.reject(new Error(message));
 };
@@ -42,11 +42,11 @@ const logAndReject = (message)=>{
  * @constructor
  */
 class SshClientWrapper {
-  constructor(hostInfo) {
+  constructor (hostInfo) {
     debug("constructor called for", hostInfo.host);
     debugVerbose("hostInfo=", hostInfo);
-    sanityCheck(hostInfo);
     this.hostInfo = { ...hostInfo };
+    sanityCheck(this.hostInfo);
     this.hostInfo.masterPty = null;
     this.hostInfo.rsyncVersion = null;
 
@@ -68,7 +68,7 @@ class SshClientWrapper {
    * @param { Function } outputCallback - call back routine for output
    * @returns {Integer} - Return code of cmd.
    */
-  async exec(cmd, timeout = 0, outputCallback = null) {
+  async exec (cmd, timeout = 0, outputCallback = null) {
     debug("exec called", cmd);
 
     if (typeof cmd !== "string" || cmd === "") {
@@ -77,7 +77,6 @@ class SshClientWrapper {
     return sshExec(this.hostInfo, cmd, timeout, outputCallback);
   }
 
-
   /**
    * execute ls command and return output
    * @param {string} target - file or directory path to watch
@@ -85,7 +84,7 @@ class SshClientWrapper {
    * @param {Integer} timeout - timeout in secconds
    * @returns {string[]} - output from ls
    */
-  async ls(target, lsOpt = [], timeout = 0) {
+  async ls (target, lsOpt = [], timeout = 0) {
     debug("ls called", target, lsOpt);
     return ls(this.hostInfo, target, lsOpt, timeout);
   }
@@ -98,13 +97,13 @@ class SshClientWrapper {
    * @param {Integer} timeout - timeout in secconds
    * @returns {Promise} - Resolved with undefined when file transfer is done.
    */
-  async send(src, dst, opt = [], timeout = 0) {
+  async send (src, dst, opt = [], timeout = 0) {
     debug("send called", src, dst, opt);
 
     if (!isArrayOfString(src)) {
       return logAndReject("src must be array of string");
     }
-    if (!src.some((e)=>{
+    if (!src.some((e) => {
       return e !== "";
     })) {
       return logAndReject("src must contain non-empty string");
@@ -129,13 +128,13 @@ class SshClientWrapper {
    * @param {Integer} timeout - timeout in secconds
    * @returns {Promise} - Resolved with undefined when file transfer is done.
    */
-  async recv(src, dst, opt = [], timeout = 0) {
+  async recv (src, dst, opt = [], timeout = 0) {
     debug("recv called", src, dst, opt);
 
     if (!isArrayOfString(src)) {
       return logAndReject("src must be array of string");
     }
-    if (!src.some((e)=>{
+    if (!src.some((e) => {
       return e !== "";
     })) {
       return logAndReject("src must contain non-empty string");
@@ -157,7 +156,7 @@ class SshClientWrapper {
    * @param {Integer} timeout - timeout in secconds
    * @returns {Promise} - Resolved with true on success, otherwise rejected with Error.
    */
-  async canConnect(timeout = 60) {
+  async canConnect (timeout = 60) {
     debug("canConnect called with timeout=", timeout);
     debugVerbose("hostInfo=", this.hostInfo);
 
@@ -170,7 +169,7 @@ class SshClientWrapper {
   /**
    * Disconnect master session
    */
-  async disconnect() {
+  async disconnect () {
     debug(`disconnect from ${this.hostInfo.host} called`);
     disconnect(this.hostInfo);
   }

package/lib/rsyncExec.js

@@ -9,9 +9,9 @@ const { fork } = require("./fork.js");
 
 const { sshCmd, rsyncCmd, getSshOption } = require("./util.js");
 
-async function checkRsyncVersion(timeout) {
+async function checkRsyncVersion (timeout) {
   const rt = {};
-  await fork(null, rsyncCmd, ["--version"], timeout, (output)=>{
+  await fork(null, rsyncCmd, ["--version"], timeout, (output) => {
     const result = /^rsync *version *(\d+)\.(\d+)\.(\d+).*$/m.exec(output);
 
     if (result) {
@@ -33,13 +33,13 @@ async function checkRsyncVersion(timeout) {
  *
  * this function execute rsync -avv --copy-unsafe-links  src rsync://[user@]host[:port]/dst
  */
-async function send(hostInfo, argSrc, dst, rsyncOpt, timeout) {
+async function send (hostInfo, argSrc, dst, rsyncOpt, timeout) {
   await connect(hostInfo);
-  const promises = await Promise.allSettled(argSrc.map((e)=>{
+  const promises = await Promise.allSettled(argSrc.map((e) => {
     return glob(e);
   }));
   const src = promises
-    .map((e, i)=>{
+    .map((e, i) => {
       if (e.status !== "fulfilled") {
         return null;
       }
@@ -48,10 +48,10 @@ async function send(hostInfo, argSrc, dst, rsyncOpt, timeout) {
       }
       return e.value;
     })
-    .filter((e)=>{
+    .filter((e) => {
       return e !== null;
     })
-    .flatMap((e)=>{
+    .flatMap((e) => {
       return e;
     });
 
@@ -87,7 +87,7 @@ async function send(hostInfo, argSrc, dst, rsyncOpt, timeout) {
  * @param {Object} hostInfo - hostinfo object
  * @returns {boolean} - rsync command version is higher than 3.2.4 or not
  */
-async function isNewRsync(hostInfo) {
+async function isNewRsync (hostInfo) {
   if (!hostInfo.rsyncVersion ||
     !Number.isInteger(hostInfo.rsyncVersion.major) ||
     !Number.isInteger(hostInfo.rsyncVersion.minor) ||
@@ -107,7 +107,7 @@ async function isNewRsync(hostInfo) {
  *
  * this function execute rsync -av --copy-unsafe-links  rsync://[user@]host[:port]/src dst
  */
-async function recv(hostInfo, argSrc, dst, rsyncOpt, timeout) {
+async function recv (hostInfo, argSrc, dst, rsyncOpt, timeout) {
   await connect(hostInfo);
   const src = `${hostInfo.host}:${argSrc.join(" ")}`;
   const sshArgs = getSshOption(hostInfo, true);

package/lib/sshExec.js

@@ -14,7 +14,7 @@ const { fork, createMasterPty, sshLoginCallback } = require("./fork.js");
  * @param {number} timeout - timeout (in sec.)
  * @param {Function} outputCallback - Callback routine for stdout and stderr.
  */
-async function sshExec(hostInfo, cmd, timeout, outputCallback) {
+async function sshExec (hostInfo, cmd, timeout, outputCallback) {
   debug("sshExec called");
   await connect(hostInfo);
   debug("exec", cmd, "on remote server");
@@ -46,14 +46,14 @@ async function sshExec(hostInfo, cmd, timeout, outputCallback) {
  * @param {Object} hostInfo - hostinfo object
  * @param {Integer} timeout - timeout in secconds
  */
-async function canConnect(hostInfo, timeout = 60) {
+async function canConnect (hostInfo, timeout = 60) {
   debug("canConnect called");
   sanityCheck(hostInfo);
 
   await connect(hostInfo, timeout);
   await disconnect(hostInfo);
-  //if connection fail, Error is throwed.
-  //so, if we reach here, connection must be succeeded
+  // if connection fail, Error is throwed.
+  // so, if we reach here, connection must be succeeded
   return true;
 }
 
@@ -62,13 +62,13 @@ async function canConnect(hostInfo, timeout = 60) {
  * @param {Object} hostInfo - hostinfo object
  * @returns {boolean} - true if master session exists
  */
-async function existsMaster(hostInfo, argTimeout) {
+async function existsMaster (hostInfo, argTimeout) {
   debugVerbose("existsMaster called");
   const args = getSshOption(hostInfo);
   args.push("-Ocheck");
 
   let output = "";
-  const cb = (e)=>{
+  const cb = (e) => {
     output += e;
   };
 
@@ -94,7 +94,7 @@ async function existsMaster(hostInfo, argTimeout) {
  * create master ssh connection
  * @param {Object} hostInfo - hostinfo object
  */
-async function connect(hostInfo, timeout = 60) {
+async function connect (hostInfo, timeout = 60) {
   debug("connect called");
 
   if (await existsMaster(hostInfo, timeout)) {
@@ -110,8 +110,8 @@ async function connect(hostInfo, timeout = 60) {
   const re = new RegExp(`^${words}`);
 
   let ac = null;
-  const p = new Promise((resolve, reject)=>{
-    ac = watchDogTimer(timeout, "make connection", ()=>{
+  const p = new Promise((resolve, reject) => {
+    ac = watchDogTimer(timeout, "make connection", () => {
       sendPty(hostInfo.masterPty, "\n", debugSendMasterPty, 137);
       sendPty(hostInfo.masterPty, "exit\n", debugSendMasterPty, 138);
 
@@ -123,9 +123,9 @@ async function connect(hostInfo, timeout = 60) {
     });
 
     let done = false;
-    hostInfo.masterPty.onData((data)=>{
+    hostInfo.masterPty.onData((data) => {
       if (done) {
-        //safeguard
+        // safeguard
         return;
       }
       const output = data.toString();
@@ -145,12 +145,12 @@ async function connect(hostInfo, timeout = 60) {
         reject(new Error("Operation timed out"));
       }
     });
-    hostInfo.masterPty.onData((data)=>{
+    hostInfo.masterPty.onData((data) => {
       const output = data.toString();
       sshLoginCallback(output, hostInfo.masterPty, hostInfo.password, hostInfo.passphrase, debugSendMasterPty)
         .catch(reject);
     });
-    hostInfo.masterPty.onExit((e)=>{
+    hostInfo.masterPty.onExit((e) => {
       debug("master pty exit", e);
       resolve(e);
     });
@@ -175,7 +175,7 @@ async function connect(hostInfo, timeout = 60) {
  * remove master session
  * @param {Object} hostInfo - hostinfo object
  */
-async function disconnect(hostInfo) {
+async function disconnect (hostInfo) {
   debug("disconnect called");
 
   if (await existsMaster(hostInfo)) {
@@ -183,7 +183,7 @@ async function disconnect(hostInfo) {
     args.push("-Oexit");
 
     let output = "";
-    const cb = (e)=>{
+    const cb = (e) => {
       output += e;
     };
     try {
@@ -218,20 +218,21 @@ async function disconnect(hostInfo) {
  * @param {number} timeout - timeout (in sec.)
  * @returns {string[]} - output from ls
  */
-async function ls(hostInfo, target, lsOpt, timeout) {
+async function ls (hostInfo, target, lsOpt, timeout) {
   debug("ls called");
   const outputArray = [];
   try {
-    await sshExec(hostInfo, `ls ${lsOpt.join(" ")} ${target}`, timeout, (data)=>{
+    await sshExec(hostInfo, `ls ${lsOpt.join(" ")} ${target}`, timeout, (data) => {
       outputArray.push(data);
     });
   } catch (e) {
-    //non-zero retrun should be allowed
+    // non-zero retrun should be allowed
     if (typeof e.rt === "undefined" || e.rt < 0) {
       throw e;
     }
   }
-  return outputArray.length === 0 ? []
+  return outputArray.length === 0
+    ? []
     : outputArray
       .join("\n")
       .replace(/\n+/g, "\n")
@@ -243,13 +244,13 @@ async function ls(hostInfo, target, lsOpt, timeout) {
  * retry fork() if it throw retryable error
  * @param {Function}  func - function to be wrapped
  */
-async function retryWrapper(func, hostInfo) {
+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 promiseRetry({ retries, minTimeout, maxTimeout }, (retry, number) => {
     return func()
-      .catch((e)=>{
+      .catch((e) => {
         if (e.retryable) {
           debug(`retrying: ${number} times`);
           disconnect(hostInfo).then(retry);
@@ -259,7 +260,6 @@ async function retryWrapper(func, hostInfo) {
   });
 }
 
-
 module.exports = {
   sshExec,
   canConnect,

package/lib/util.js

@@ -25,7 +25,7 @@ const ajv = new Ajv({
 });
 require("ajv-keywords")(ajv, "transform");
 
-//never validate password and passphrase value to avoid security insident
+// never validate password and passphrase value to avoid security insident
 const hostInfoSchema = {
   type: "object",
   properties: {
@@ -64,7 +64,7 @@ const validate = ajv.compile(hostInfoSchema);
  * @param {Function} func - function
  * @param {data} data - binary data which can be converted to string
  */
-const buff2String = (func, data)=>{
+const buff2String = (func, data) => {
   func(data.toString().replace(/\r\n/g, EOL));
 };
 
@@ -72,12 +72,12 @@ const buff2String = (func, data)=>{
  * check if given hostInfo object is OK
  * @param { Object } hostInfo - host information object defined in index.js
  */
-const sanityCheck = (hostInfo)=>{
+const sanityCheck = (hostInfo) => {
   debug("sanityCheck called", hostInfo);
-  //keep password, passphrase, and masterPty before validate.
-  //these properties can have invalid value for JSON.
-  //ajv will remove that at validation pahse becase of additionalProperties setting
-  //so we keep them here and put back later.
+  // keep password, passphrase, and masterPty before validate.
+  // these properties can have invalid value for JSON.
+  // ajv will remove that at validation pahse becase of additionalProperties setting
+  // so we keep them here and put back later.
   const { password, passphrase, masterPty } = hostInfo;
   validate(hostInfo);
 
@@ -99,7 +99,7 @@ const sanityCheck = (hostInfo)=>{
       }
       if (prop.startsWith("sshOpt")) {
         debug("remove empty member of sshOpt");
-        hostInfo.sshOpt = hostInfo.sshOpt.filter((opt)=>{
+        hostInfo.sshOpt = hostInfo.sshOpt.filter((opt) => {
           return opt !== "";
         });
         continue;
@@ -123,7 +123,7 @@ const sanityCheck = (hostInfo)=>{
     hostInfo.password = password;
   }
   if (["string", "function"].includes(typeof passphrase)) {
-    hostInfo.password = password;
+    hostInfo.passphrase = passphrase;
   }
   if (masterPty === null || typeof masterPty === "function") {
     hostInfo.masterPty = masterPty;
@@ -136,7 +136,7 @@ const sanityCheck = (hostInfo)=>{
  * @param { Object} hostInfo - host information object defined in index.js
  * @param {boolean} withoutDestination - return except for hostname
  */
-const getSshOption = (hostInfo, withoutDestination)=>{
+const getSshOption = (hostInfo, withoutDestination) => {
   debug("getSshOption called");
   const args = [];
 
@@ -189,19 +189,19 @@ const getSshOption = (hostInfo, withoutDestination)=>{
     args.push(`-oConnectTimeout=${hostInfo.ConnectTimeout}`);
   }
   if (Array.isArray(hostInfo.sshOpt)) {
-    args.push(...hostInfo.sshOpt.filter((e)=>{
+    args.push(...hostInfo.sshOpt.filter((e) => {
       return typeof e === "string";
     }));
   }
   return args;
 };
 
-const isArrayOfString = (target)=>{
+const isArrayOfString = (target) => {
   if (!Array.isArray(target)) {
     return false;
   }
-  return !target.some((e)=>{
-    //target has non string member
+  return !target.some((e) => {
+    // target has non string member
     return typeof e !== "string";
   });
 };
@@ -213,7 +213,7 @@ const isArrayOfString = (target)=>{
  * @param {Function} logger - logging function
  * @param {string} label - where this function is called
  */
-const sendPty = async (pty, message, logger, label)=>{
+const sendPty = async (pty, message, logger, label) => {
   logger(`${label}: ${message}`);
   pty.write(message);
 };
@@ -225,15 +225,15 @@ const sendPty = async (pty, message, logger, label)=>{
  * @param {Function} cb - call back function which will be called after timeout
  * @returns {AbortController} - ac to stop watch dog timer
  */
-const watchDogTimer = (timeout, label, cb)=>{
+const watchDogTimer = (timeout, label, cb) => {
   const ac = new AbortController();
   const signal = ac.signal;
   setTimeoutPromise(timeout * 1000, "neverUsedValue", { signal })
-    .then(()=>{
+    .then(() => {
       debug(`can not finish ${label} within ${timeout} sec`);
       return typeof cb === "function" ? cb() : true;
     })
-    .catch((err)=>{
+    .catch((err) => {
       if (err.name === "AbortError") {
         debug(`timeout was aborted because ${label} has finished or canceled`);
       } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh-client-wrapper",
-  "version": "2.2.4",
+  "version": "2.2.7",
   "description": "wrapper library for open ssh client and rsync",
   "keywords": [
     "ssh",
@@ -46,7 +46,6 @@
     "chai-as-promised": "^7.1.1",
     "chai-fs": "^2.0.0",
     "eslint": "^8.38.0",
-    "eslint-config-eslint": "^7.0.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-chai-expect": "^3.0.0",
     "eslint-plugin-chai-friendly": "^0.7.4",