ssh2-sftp-client 7.0.3 → 7.0.4

package/README.md

@@ -61,7 +61,7 @@ an SFTP client for node.js, a wrapper around [SSH2](https://github.com/mscdex/ss
 
 Documentation on the methods and available options in the underlying modules can be found on the [SSH2](https://github.com/mscdex/ssh2) project pages.
 
-Current stable release is **v7.0.3**.
+Current stable release is **v7.0.4**.
 
 Code has been tested against Node versions 12.22.1, 14.17.0 and 16.2.0
 

package/README.org

@@ -9,7 +9,7 @@ convenience abstraction as well as a Promise based API.
 Documentation on the methods and available options in the underlying modules can
 be found on the [[https://github.com/mscdex/ssh2][SSH2]] project pages.
 
-Current stable release is *v7.0.3*.
+Current stable release is *v7.0.4*.
 
 Code has been tested against Node versions 12.22.1, 14.17.0 and 16.2.0
 

package/package.json

@@ -1,17 +1,24 @@
 {
   "name": "ssh2-sftp-client",
-  "version": "7.0.3",
+  "version": "7.0.4",
   "description": "ssh2 sftp client for node",
   "main": "src/index.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/theophilusx/ssh2-sftp-client"
   },
-  "keywords": ["sftp", "nodejs", "promises"],
+  "keywords": [
+    "sftp",
+    "nodejs",
+    "promises"
+  ],
   "scripts": {
     "test": "mocha",
     "coverage": "nyc npm run test",
-    "lint": "eslint \"src/**/*.js\" --quiet"
+    "lint": "eslint \"src/**/*.js\" \"test/**/*.js\""
+  },
+  "engines": {
+    "node": ">=10.24.1"
   },
   "author": "Tim Cross",
   "email": "theophilusx@gmail.com",
@@ -25,7 +32,7 @@
   "dependencies": {
     "concat-stream": "^2.0.0",
     "promise-retry": "^2.0.1",
-    "ssh2": "^1.2.0"
+    "ssh2": "^1.4.0"
   },
   "devDependencies": {
     "chai": "^4.2.0",
@@ -33,9 +40,16 @@
     "chai-subset": "^1.6.0",
     "checksum": "^1.0.0",
     "dotenv": "^10.0.0",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-mocha": "^9.0.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-unicorn": "^35.0.0",
     "mocha": "^9.0.2",
     "moment": "^2.29.1",
     "nyc": "^15.1.0",
+    "prettier": "^2.3.2",
     "through2": "^4.0.2",
     "winston": "^3.3.3"
   }

package/src/constants.js

@@ -1,12 +1,10 @@
-'use strict';
-
 const errorCode = {
   generic: 'ERR_GENERIC_CLIENT',
   connect: 'ERR_NOT_CONNECTED',
   badPath: 'ERR_BAD_PATH',
   permission: 'EACCES',
   notexist: 'ENOENT',
-  notdir: 'ENOTDIR'
+  notdir: 'ENOTDIR',
 };
 
 const targetType = {
@@ -15,10 +13,10 @@ const targetType = {
   writeDir: 3,
   readDir: 4,
   readObj: 5,
-  writeObj: 6
+  writeObj: 6,
 };
 
 module.exports = {
   errorCode,
-  targetType
+  targetType,
 };

package/src/index.js

@@ -133,13 +133,12 @@ class SftpClient {
         // .catch((err) => {
         //   return Promise.reject(err);
         // })
-        .finally(async (resp) => {
+        .finally(async () => {
           this.debugMsg('getConnection: finally clause fired');
           await sleep(500);
           this.removeListener('ready', doReady);
           removeTempListeners(this, 'getConnection');
           this._resetEventFlags();
-          return resp;
         })
     );
   }
@@ -158,7 +157,7 @@ class SftpClient {
           resolve(sftp);
         }
       });
-    }).finally((resp) => {
+    }).finally(() => {
       this.debugMsg('getSftpChannel: finally clause fired');
       removeTempListeners(this, 'getSftpChannel');
       this._resetEventFlags();
@@ -244,10 +243,9 @@ class SftpClient {
           resolve(absPath);
         });
       }
-    }).finally((rsp) => {
+    }).finally(() => {
       removeTempListeners(this, 'realPath');
       this._resetEventFlags();
-      return rsp;
     });
   }
 
@@ -302,9 +300,8 @@ class SftpClient {
             resolve(result);
           }
         });
-      }).finally((rsp) => {
+      }).finally(() => {
         removeTempListeners(this, 'stat');
-        return rsp;
       });
     };
 
@@ -404,15 +401,15 @@ class SftpClient {
             if (fileList) {
               newList = fileList.map((item) => {
                 return {
-                  type: item.longname.substr(0, 1),
+                  type: item.longname.slice(0, 1),
                   name: item.filename,
                   size: item.attrs.size,
                   modifyTime: item.attrs.mtime * 1000,
                   accessTime: item.attrs.atime * 1000,
                   rights: {
-                    user: item.longname.substr(1, 3).replace(reg, ''),
-                    group: item.longname.substr(4, 3).replace(reg, ''),
-                    other: item.longname.substr(7, 3).replace(reg, ''),
+                    user: item.longname.slice(1, 4).replace(reg, ''),
+                    group: item.longname.slice(4, 7).replace(reg, ''),
+                    other: item.longname.slice(7, 10).replace(reg, ''),
                   },
                   owner: item.attrs.uid,
                   group: item.attrs.gid,
@@ -433,10 +430,9 @@ class SftpClient {
           }
         });
       }
-    }).finally((rsp) => {
+    }).finally(() => {
       removeTempListeners(this, 'list');
       this._resetEventFlags();
-      return rsp;
     });
   }
 
@@ -521,7 +517,7 @@ class SftpClient {
         }
         rdr.pipe(wtr, options.pipeOptions ? options.pipeOptions : {});
       }
-    }).finally((rsp) => {
+    }).finally(() => {
       removeTempListeners(this, 'get');
       this._resetEventFlags();
       if (
@@ -539,7 +535,6 @@ class SftpClient {
       ) {
         wtr.destroy();
       }
-      return rsp;
     });
   }
 
@@ -589,9 +584,8 @@ class SftpClient {
             resolve(`${remotePath} was successfully download to ${localPath}!`);
           });
         }
-      }).finally((rsp) => {
+      }).finally(() => {
         removeTempListeners(this, 'fastGet');
-        return rsp;
       });
     } catch (err) {
       this._resetEventFlags();
@@ -654,10 +648,9 @@ class SftpClient {
           resolve(`${localPath} was successfully uploaded to ${remotePath}!`);
         });
       }
-    }).finally((rsp) => {
+    }).finally(() => {
       removeTempListeners(this, 'fastPut');
       this._resetEventFlags();
-      return rsp;
     });
   }
 
@@ -737,7 +730,7 @@ class SftpClient {
           rdr.pipe(wtr, options.pipeOptions ? options.pipeOptions : {});
         }
       }
-    }).finally((resp) => {
+    }).finally(() => {
       removeTempListeners(this, 'put');
       this._resetEventFlags();
       if (
@@ -755,7 +748,6 @@ class SftpClient {
       ) {
         wtr.destroy();
       }
-      return resp;
     });
   }
 
@@ -767,47 +759,44 @@ class SftpClient {
    * @param  {Object} options
    * @return {Promise}
    */
-  append(input, remotePath, options = {}) {
-    return this.exists(remotePath).then((fileType) => {
-      if (fileType && fileType === 'd') {
-        return Promise.reject(
-          fmtError(
-            `Bad path: ${remotePath}: cannot append to a directory`,
-            'append',
-            errorCode.badPath
-          )
-        );
-      }
-      return new Promise((resolve, reject) => {
-        if (haveConnection(this, 'append', reject)) {
-          if (typeof input === 'string') {
-            reject(fmtError('Cannot append one file to another', 'append'));
+
+  async append(input, remotePath, options = {}) {
+    const fileType = await this.exists(remotePath);
+    if (fileType && fileType === 'd') {
+      throw fmtError(
+        `Bad path: ${remotePath}: cannot append to a directory`,
+        'append',
+        errorCode.badPath
+      );
+    }
+    return await new Promise((resolve, reject) => {
+      if (haveConnection(this, 'append', reject)) {
+        if (typeof input === 'string') {
+          reject(fmtError('Cannot append one file to another', 'append'));
+        } else {
+          this.debugMsg(`append -> remote: ${remotePath} `, options);
+          addTempListeners(this, 'append', reject);
+          options.flags = 'a';
+          let stream = this.sftp.createWriteStream(remotePath, options);
+          stream.on('error', (err_1) => {
+            reject(
+              fmtError(`${err_1.message} ${remotePath}`, 'append', err_1.code)
+            );
+          });
+          stream.on('finish', () => {
+            resolve(`Appended data to ${remotePath}`);
+          });
+          if (input instanceof Buffer) {
+            stream.write(input);
+            stream.end();
           } else {
-            this.debugMsg(`append -> remote: ${remotePath} `, options);
-            addTempListeners(this, 'append', reject);
-            options.flags = 'a';
-            let stream = this.sftp.createWriteStream(remotePath, options);
-            stream.on('error', (err) => {
-              reject(
-                fmtError(`${err.message} ${remotePath}`, 'append', err.code)
-              );
-            });
-            stream.on('finish', () => {
-              resolve(`Appended data to ${remotePath}`);
-            });
-            if (input instanceof Buffer) {
-              stream.write(input);
-              stream.end();
-            } else {
-              input.pipe(stream);
-            }
+            input.pipe(stream);
           }
         }
-      }).finally((rsp) => {
-        removeTempListeners(this, 'append');
-        this._resetEventFlags();
-        return rsp;
-      });
+      }
+    }).finally(() => {
+      removeTempListeners(this, 'append');
+      this._resetEventFlags();
     });
   }
 
@@ -847,10 +836,9 @@ class SftpClient {
             resolve(`${p} directory created`);
           }
         });
-      }).finally((rsp) => {
+      }).finally(() => {
         removeTempListeners(this, '_mkdir');
         this._resetEventFlags();
-        return rsp;
       });
     };
 
@@ -899,9 +887,8 @@ class SftpClient {
           }
           resolve('Successfully removed directory');
         });
-      }).finally((rsp) => {
+      }).finally(() => {
         removeTempListeners(this, 'rmdir');
-        return rsp;
       });
     };
 
@@ -962,10 +949,9 @@ class SftpClient {
           resolve(`Successfully deleted ${remotePath}`);
         });
       }
-    }).finally((rsp) => {
+    }).finally(() => {
       removeTempListeners(this, 'delete');
       this._resetEventFlags();
-      return rsp;
     });
   }
 
@@ -999,10 +985,9 @@ class SftpClient {
           resolve(`Successfully renamed ${fromPath} to ${toPath}`);
         });
       }
-    }).finally((rsp) => {
+    }).finally(() => {
       removeTempListeners(this, 'rename');
       this._resetEventFlags();
-      return rsp;
     });
   }
 
@@ -1037,10 +1022,9 @@ class SftpClient {
           resolve(`Successful POSIX rename ${fromPath} to ${toPath}`);
         });
       }
-    }).finally((rsp) => {
+    }).finally(() => {
       removeTempListeners(this, 'posixRename');
       this._resetEventFlags();
-      return rsp;
     });
   }
 
@@ -1064,10 +1048,9 @@ class SftpClient {
         }
         resolve('Successfully change file mode');
       });
-    }).finally((rsp) => {
+    }).finally(() => {
       removeTempListeners(this, 'chmod');
       this._resetEventFlags();
-      return rsp;
     });
   }
 
@@ -1209,13 +1192,12 @@ class SftpClient {
         this.debugMsg('end: Have connection - calling end()');
         this.client.end();
       }
-    }).finally((resp) => {
+    }).finally(() => {
       this.debugMsg('end: finally clause fired');
       removeTempListeners(this, 'end');
       this.removeListener('close', endCloseHandler);
       this.endCalled = false;
       this._resetEventFlags();
-      return resp;
     });
   }
 }

package/src/utils.js

@@ -203,29 +203,33 @@ function haveLocalAccess(filePath, mode = 'r') {
       code: 0,
     };
   } catch (err) {
-    if (err.errno === -2) {
-      return {
-        status: false,
-        type: null,
-        details: 'not exist',
-        code: -2,
-      };
-    } else if (err.errno === -13) {
-      const type = localExists(filePath);
-      return {
-        status: false,
-        type: type,
-        details: 'permission denied',
-        code: -13,
-      };
-    } else if (err.errno === -20) {
-      return {
-        status: false,
-        type: null,
-        details: 'parent not a directory',
-      };
-    } else {
-      throw err;
+    switch (err.errno) {
+      case -2:
+        return {
+          status: false,
+          type: null,
+          details: 'not exist',
+          code: -2,
+        };
+      case -13:
+        return {
+          status: false,
+          type: localExists(filePath),
+          details: 'permission denied',
+          code: -13,
+        };
+      case -20:
+        return {
+          status: false,
+          type: null,
+          details: 'parent not a directory',
+        };
+      default:
+        return {
+          status: false,
+          type: null,
+          details: err.message,
+        };
     }
   }
 }
@@ -281,10 +285,10 @@ async function normalizeRemotePath(client, aPath) {
   try {
     if (aPath.startsWith('..')) {
       let root = await client.realPath('..');
-      return root + client.remotePathSep + aPath.substring(3);
+      return root + client.remotePathSep + aPath.slice(3);
     } else if (aPath.startsWith('.')) {
       let root = await client.realPath('.');
-      return root + client.remotePathSep + aPath.substring(2);
+      return root + client.remotePathSep + aPath.slice(2);
     }
     return aPath;
   } catch (err) {