ssh2-sftp-client 9.1.0 → 10.0.0

package/src/utils.js

@@ -1,5 +1,5 @@
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 const { errorCode } = require('./constants');
 
 /**
@@ -40,29 +40,21 @@ function globalListener(client, evt) {
   };
 }
 
-function endListener(client, name, reject) {
+function endListener(client, name) {
   const fn = function () {
     client.sftp = undefined;
     if (client.endCalled || client.endHandled || client.errorHandled) {
       // end event already handled - ignore
-      client.debugMsg(`${name} endListener - ignoring handled error`);
+      client.debugMsg(`${name} endListener - handled end event`);
       return;
     }
     client.endHandled = true;
-    client.debugMsg(`${name} Unexpected end event - ignoring`);
-    // Don't reject/throw error, just log it and move on
-    // after invalidating the connection
-    // const err = new Error(`${name} Unexpected end event raised`);
-    // if (reject) {
-    //   reject(err);
-    // } else {
-    //   throw err;
-    // }
+    client.debugMsg(`${name} Unexpected end event`);
   };
   return fn;
 }
 
-function closeListener(client, name, reject) {
+function closeListener(client, name) {
   const fn = function () {
     client.sftp = undefined;
     if (
@@ -72,27 +64,19 @@ function closeListener(client, name, reject) {
       client.endHandled
     ) {
       // handled or expected close event - ignore
-      client.debugMsg(`${name} closeListener - ignoring handled error`);
+      client.debugMsg(`${name} closeListener - handled close event`);
       return;
     }
     client.closeHandled = true;
-    client.debugMsg(`${name} Unexpected close event raised - ignoring`);
-    // Don't throw/reject on close events. Just invalidate the connection
-    // and move on.
-    // const err = new Error(`${name}: Unexpected close event raised`);
-    // if (reject) {
-    //   reject(err);
-    // } else {
-    //   throw err;
-    // }
+    client.debugMsg(`${name} Unexpected close event`);
   };
   return fn;
 }
 
 function addTempListeners(client, name, reject) {
   const listeners = {
-    end: endListener(client, name, reject),
-    close: closeListener(client, name, reject),
+    end: endListener(client, name),
+    close: closeListener(client, name),
     error: errorListener(client, name, reject),
   };
   client.on('end', listeners.end);
@@ -170,32 +154,36 @@ function haveLocalAccess(filePath, mode = 'r') {
     };
   } catch (err) {
     switch (err.errno) {
-      case -2:
+      case -2: {
         return {
           status: false,
           type: null,
           details: 'not exist',
           code: -2,
         };
-      case -13:
+      }
+      case -13: {
         return {
           status: false,
           type: localExists(filePath),
           details: 'permission denied',
           code: -13,
         };
-      case -20:
+      }
+      case -20: {
         return {
           status: false,
           type: null,
           details: 'parent not a directory',
         };
-      default:
+      }
+      default: {
         return {
           status: false,
           type: null,
           details: err.message,
         };
+      }
     }
   }
 }
@@ -211,38 +199,41 @@ function haveLocalAccess(filePath, mode = 'r') {
  */
 function haveLocalCreate(filePath) {
   const { status, details, type } = haveLocalAccess(filePath, 'w');
-  if (!status && details === 'permission denied') {
-    //throw new Error(`Bad path: ${filePath}: permission denied`);
-    return {
-      status,
-      details,
-      type,
-    };
-  } else if (!status) {
-    const dirPath = path.dirname(filePath);
-    const localCheck = haveLocalAccess(dirPath, 'w');
-    if (localCheck.status && localCheck.type !== 'd') {
-      //throw new Error(`Bad path: ${dirPath}: not a directory`);
+  if (!status) {
+    // filePath does not exist. Can we create it?
+    if (details === 'permission denied') {
+      // don't have permission
       return {
-        status: false,
-        details: `${dirPath}: not a directory`,
-        type: null,
+        status,
+        details,
+        type,
       };
-    } else if (!localCheck.status) {
-      //throw new Error(`Bad path: ${dirPath}: ${localCheck.details}`);
+    }
+    // to create it, parent must be directory and writeable
+    const dirPath = path.dirname(filePath);
+    const localCheck = haveLocalAccess(dirPath, 'w');
+    if (!localCheck.status) {
+      // no access to parent directory
       return {
         status: localCheck.status,
         details: `${dirPath}: ${localCheck.details}`,
         type: null,
       };
-    } else {
+    }
+    // exists, is it a directory?
+    if (localCheck.type !== 'd') {
       return {
-        status: true,
-        details: 'access OK',
+        status: false,
+        details: `${dirPath}: not a directory`,
         type: null,
-        code: 0,
       };
     }
+    return {
+      status: true,
+      details: 'access OK',
+      type: null,
+      code: 0,
+    };
   }
   return { status, details, type };
 }
@@ -289,8 +280,8 @@ function haveConnection(client, name, reject) {
 function sleep(ms) {
   return new Promise((resolve, reject) => {
     try {
-      if (isNaN(ms) || ms < 0) {
-        reject('Argument must be  anumber >= 0');
+      if (Number.isNaN(Number.parseInt(ms)) || ms < 0) {
+        reject('Argument must be a number >= 0');
       } else {
         setTimeout(() => {
           resolve(true);
@@ -302,6 +293,19 @@ function sleep(ms) {
   });
 }
 
+function partition(input, size) {
+  let output = [];
+
+  if (size < 1) {
+    throw new Error('Partition size must be greater than zero');
+  }
+
+  for (let i = 0; i < input.length; i += size) {
+    output[output.length] = input.slice(i, i + size);
+  }
+  return output;
+}
+
 module.exports = {
   globalListener,
   errorListener,
@@ -315,4 +319,5 @@ module.exports = {
   localExists,
   haveConnection,
   sleep,
+  partition,
 };