ssh2-sftp-client 11.0.0 → 12.0.1

package/src/index.js

@@ -2,7 +2,6 @@
 const { Client } = require('ssh2');
 const fs = require('node:fs');
 const concat = require('concat-stream');
-const promiseRetry = require('promise-retry');
 const { join, parse } = require('node:path');
 const {
   globalListener,
@@ -26,7 +25,7 @@ class SftpClient {
       close: () => console.log('Global close listener: close event raised'),
     },
   ) {
-    this.version = '11.0.0';
+    this.version = '12.0.1';
     this.client = new Client();
     this.sftp = undefined;
     this.clientName = clientName;
@@ -58,35 +57,32 @@ class SftpClient {
   fmtError(err, name = 'sftp', eCode, retryCount) {
     let msg = '';
     let code = '';
-    const retry = retryCount
-      ? ` after ${retryCount} ${retryCount > 1 ? 'attempts' : 'attempt'}`
-      : '';
 
     if (err === undefined) {
       msg = `${name}: Undefined error - probably a bug!`;
       code = errorCode.generic;
     } else if (typeof err === 'string') {
-      msg = `${name}: ${err}${retry}`;
+      msg = `${name}: ${err}`;
       code = eCode || errorCode.generic;
     } else if (err.custom) {
-      msg = `${name}->${err.message}${retry}`;
+      msg = `${name}->${err.message}`;
       code = err.code;
     } else {
       switch (err.code) {
         case 'ENOTFOUND': {
-          msg = `${name}: Address lookup failed for host${retry}`;
+          msg = `${name}: Address lookup failed for host`;
           break;
         }
         case 'ECONNREFUSED': {
-          msg = `${name}: Remote host refused connection${retry}`;
+          msg = `${name}: Remote host refused connection`;
           break;
         }
         case 'ECONNRESET': {
-          msg = `${name}: Remote host has reset the connection: ${err.message}${retry}`;
+          msg = `${name}: Remote host has reset the connection: ${err.message}`;
           break;
         }
         default: {
-          msg = `${name}: ${err.message}${retry}`;
+          msg = `${name}: ${err.message}`;
         }
       }
       code = err.code || errorCode.generic;
@@ -122,118 +118,61 @@ class SftpClient {
   }
 
   /**
-   * @async
    *
-   * Create a new SFTP connection to a remote SFTP server
+   * Create a new SFTP connection to a remote SFTP server.
+   * The connection options are the same as those offered
+   * by the underlying SSH2 module.
    *
    * @param {Object} config - an SFTP configuration object
    *
    * @return {Promise<Object>} which will resolve to an sftp client object
    */
-  getConnection(config) {
+  connect(config) {
     let doReady, listeners;
     return new Promise((resolve, reject) => {
       listeners = addTempListeners(this, 'getConnection', reject);
+      if (config.debug) {
+        this.debug = config.debug;
+        this.debugMsg('connect: Debugging turned on');
+        this.debugMsg(`ssh2-sftp-client Version: ${this.version} `, process.versions);
+      }
+      this.promiseLimit = config.promiseLimit ?? 10;
+
       doReady = () => {
-        resolve(true);
+        this.client.sftp((err, sftp) => {
+          if (err) {
+            reject(this.fmtError(err));
+          } else {
+            this.sftp = sftp;
+            resolve(sftp);
+          }
+        });
       };
       this.on('ready', doReady);
+
       try {
-        this.client.connect(config);
+        if (this.sftp) {
+          reject(
+            this.fmtError(
+              'An existing SFTP connection is already defined',
+              'connect',
+              errorCode.connect,
+            ),
+          );
+        } else {
+          this.client.connect(config);
+        }
       } catch (err) {
+        this.end();
         reject(err);
       }
     }).finally(() => {
       this.removeListener('ready', doReady);
       removeTempListeners(this, listeners, 'getConnection');
+      this._resetEventFlags();
     });
   }
 
-  getSftpChannel() {
-    return new Promise((resolve, reject) => {
-      this.client.sftp((err, sftp) => {
-        if (err) {
-          reject(this.fmtError(err, 'getSftpChannel', err.code));
-        } else {
-          this.sftp = sftp;
-          resolve(sftp);
-        }
-      });
-    });
-  }
-
-  /**
-   * @async
-   *
-   * Create a new SFTP connection to a remote SFTP server.
-   * The connection options are the same as those offered
-   * by the underlying SSH2 module.
-   *
-   * @param {Object} config - an SFTP configuration object
-   *
-   * @return {Promise<Object>} which will resolve to an sftp client object
-   */
-  async connect(config) {
-    let listeners;
-
-    try {
-      listeners = addTempListeners(this, 'connect');
-      if (config.debug) {
-        this.debug = config.debug;
-        this.debugMsg('connect: Debugging turned on');
-        this.debugMsg(`ssh2-sftp-client Version: ${this.version} `, process.versions);
-      }
-      this.promiseLimit = config.promiseLimit ?? 10;
-      if (this.sftp) {
-        throw this.fmtError(
-          'An existing SFTP connection is already defined',
-          'connect',
-          errorCode.connect,
-        );
-      }
-      const retryOpts = {
-        retries: config.retries ?? 1,
-        factor: config.retry_factor ?? 2,
-        minTimeout: config.retry_minTimeout ?? 25000,
-      };
-      await promiseRetry(retryOpts, async (retry, attempt) => {
-        try {
-          this.debugMsg(`connect: Connect attempt ${attempt}`);
-          await this.getConnection(config);
-        } catch (err) {
-          switch (err.code) {
-            case 'ENOTFOUND':
-            case 'ECONNREFUSED':
-            case 'ERR_SOCKET_BAD_PORT': {
-              throw err;
-            }
-            case undefined: {
-              if (
-                err.message.endsWith('All configured authentication methods failed') ||
-                err.message.startsWith('Cannot parse privateKey')
-              ) {
-                throw err;
-              }
-              retry(err);
-              break;
-            }
-            default: {
-              retry(err);
-            }
-          }
-        }
-      });
-      const sftp = await this.getSftpChannel();
-      this.endCalled = false;
-      return sftp;
-    } catch (err) {
-      this.end();
-      throw err.custom ? err : this.fmtError(err, 'connect');
-    } finally {
-      removeTempListeners(this, listeners, 'connect');
-    }
-  }
-
   /**
    * @async
    *
@@ -265,6 +204,7 @@ class SftpClient {
     }).finally(() => {
       if (addListeners) {
         removeTempListeners(this, listeners, 'realPath');
+        this._resetEventFlags();
       }
     });
   }
@@ -329,6 +269,7 @@ class SftpClient {
     }).finally(() => {
       if (addListeners) {
         removeTempListeners(this, listeners, '_xstat');
+        this._resetEventFlags();
       }
     });
   }
@@ -459,6 +400,7 @@ class SftpClient {
     }).finally(() => {
       if (addListeners) {
         removeTempListeners(this, listeners, 'list');
+        this._resetEventFlags();
       }
     });
   }
@@ -499,7 +441,7 @@ class SftpClient {
           pipeOptions: { ...options?.pipeOptions, end: true },
         };
         rdr = this.sftp.createReadStream(remotePath, options.readStreamOptions);
-        rdr.once('error', (err) => {
+        rdr.on('error', (err) => {
           if (dst && typeof dst === 'string' && wtr && !wtr.destroyed) {
             wtr.destroy();
           }
@@ -507,13 +449,11 @@ class SftpClient {
         });
         if (dst === undefined) {
           // no dst specified, return buffer of data
-          this.debugMsg('get resolving with buffer of data');
           wtr = concat((buff) => {
             resolve(buff);
           });
         } else if (typeof dst === 'string') {
           // dst local file path
-          this.debugMsg(`get called with file path destination ${dst}`);
           const localCheck = haveLocalCreate(dst);
           if (localCheck.status) {
             wtr = fs.createWriteStream(dst, options.writeStreamOptions);
@@ -527,10 +467,9 @@ class SftpClient {
             );
           }
         } else {
-          this.debugMsg('get called with stream destination');
           wtr = dst;
         }
-        wtr.once('error', (err) => {
+        wtr.on('error', (err) => {
           reject(
             this.fmtError(
               `${err.message} ${typeof dst === 'string' ? dst : '<stream>'}`,
@@ -554,6 +493,7 @@ class SftpClient {
       }
       if (addListeners) {
         removeTempListeners(this, listeners, 'get');
+        this._resetEventFlags();
       }
     });
   }
@@ -589,6 +529,7 @@ class SftpClient {
     }).finally(() => {
       if (addListeners) {
         removeTempListeners(this, listeners, '_fastGet');
+        this._resetEventFlags();
       }
     });
   }
@@ -655,6 +596,7 @@ class SftpClient {
     }).finally(() => {
       if (addListeners) {
         removeTempListeners(this, listeners, '_fastPut');
+        this._resetEventFlags();
       }
     });
   }
@@ -711,7 +653,7 @@ class SftpClient {
       };
       if (haveConnection(this, '_put', reject)) {
         wtr = this.sftp.createWriteStream(rPath, opts.writeStreamOptions);
-        wtr.once('error', (err) => {
+        wtr.on('error', (err) => {
           if (typeof lPath === 'string' && rdr && !rdr.destroyed) {
             rdr.destroy();
           }
@@ -727,17 +669,14 @@ class SftpClient {
           resolve(`Uploaded data stream to ${rPath}`);
         });
         if (lPath instanceof Buffer) {
-          this.debugMsg('put source is a buffer');
           wtr.end(lPath);
         } else {
           if (typeof lPath === 'string') {
-            this.debugMsg('put source is string path');
             rdr = fs.createReadStream(lPath, opts.readStreamOptions);
           } else {
-            this.debugMsg('put source is a stream');
             rdr = lPath;
           }
-          rdr.once('error', (err) => {
+          rdr.on('error', (err) => {
             reject(
               this.fmtError(
                 `Read stream error: ${err.message} ${
@@ -757,6 +696,7 @@ class SftpClient {
       }
       if (addListeners) {
         removeTempListeners(this, listeners, '_put');
+        this._resetEventFlags();
       }
     });
   }
@@ -812,6 +752,7 @@ class SftpClient {
     }).finally(() => {
       if (addListeners) {
         removeTempListeners(this, listeners, '_append');
+        this._resetEventFlags();
       }
     });
   }
@@ -883,6 +824,7 @@ class SftpClient {
     }).finally(() => {
       if (addListeners) {
         removeTempListeners(this, listeners, '_doMkdir');
+        this._resetEventFlags();
       }
     });
   }
@@ -956,6 +898,7 @@ class SftpClient {
         });
       }).finally(() => {
         removeTempListeners(this, listeners, '_rmdir');
+        this._resetEventFlags();
       });
     };
 
@@ -1045,6 +988,7 @@ class SftpClient {
     }).finally(() => {
       if (addListeners) {
         removeTempListeners(this, listeners, 'delete');
+        this._resetEventFlags();
       }
     });
   }
@@ -1083,6 +1027,7 @@ class SftpClient {
     }).finally(() => {
       if (addListeners) {
         removeTempListeners(this, listeners, 'rename');
+        this._resetEventFlags();
       }
     });
   }
@@ -1121,6 +1066,7 @@ class SftpClient {
       }
     }).finally(() => {
       removeTempListeners(this, listeners, 'posixRename');
+      this._resetEventFlags();
     });
   }
 
@@ -1152,6 +1098,7 @@ class SftpClient {
     }).finally(() => {
       if (addListeners) {
         removeTempListeners(this, listeners, 'chmod');
+        this._resetEventFlags();
       }
     });
   }
@@ -1237,6 +1184,7 @@ class SftpClient {
         throw this.fmtError(`${e.message} ${srcDir} to ${dstDir}`, 'uploadFiles', e.code);
       } finally {
         removeTempListeners(this, listeners, uploadFiles);
+        this._resetEventFlags();
       }
     };
 
@@ -1362,6 +1310,7 @@ class SftpClient {
         );
       } finally {
         removeTempListeners(this, listeners, 'downloadFiles');
+        this._resetEventFlags();
       }
     };
 
@@ -1408,7 +1357,8 @@ class SftpClient {
     } catch (err) {
       throw err.custom ? err : this.fmtError(err.message, 'createReadStream', err.code);
     } finally {
-      removeTempListeners(this, listeners, 'createReadStreame');
+      removeTempListeners(this, listeners, 'createReadStream');
+      this._resetEventFlags();
     }
   }
 
@@ -1434,6 +1384,7 @@ class SftpClient {
       throw err.custom ? err : this.fmtError(err.message, 'createWriteStream', err.code);
     } finally {
       removeTempListeners(this, listeners, 'createWriteStream');
+      this._resetEventFlags();
     }
   }
 
@@ -1497,6 +1448,7 @@ class SftpClient {
       throw err.custom ? err : this.fmtError(err, 'rcopy');
     } finally {
       removeTempListeners(this, listeners, 'rcopy');
+      this._resetEventFlags();
     }
   }
   /**
@@ -1528,6 +1480,7 @@ class SftpClient {
     }).finally(() => {
       removeTempListeners(this, listeners, 'end');
       this.removeListener('close', endCloseHandler);
+      this._resetEventFlags();
     });
   }
 }

package/src/utils.js

@@ -88,7 +88,7 @@ function endListener(client, name, reject) {
     client.endHandled = true;
     client.debugMsg(`${name} endListener - handling unexpected end event`);
     const newError = new Error(`${name}: Unexpected end event`);
-    newError.code = errorCode.ERR_GENERIC_CLIENT;
+    newError.code = errorCode.generic;
     if (reject) {
       reject(newError);
     } else {
@@ -109,7 +109,7 @@ function closeListener(client, name, reject) {
     client.closeHandled = true;
     client.debugMsg(`${name} closeListener - handling unexpected close event`);
     const newError = new Error(`${name}: Unexpected close event`);
-    newError.code = errorCode.ERR_GENERIC_CLIENT;
+    newError.code = errorCode.generic;
     if (reject) {
       reject(newError);
     } else {