fix: Replacing the vinyl-ftp module with the basic-ftp module.

Author: stevebritton

lib/gulp/deploy.js

@@ -1,7 +1,7 @@
 'use strict';
 
 
-const ftp = require('vinyl-ftp');
+const ftp = require('basic-ftp');
 const path = require('path');
 const plumber = require('gulp-plumber');
 const size = require('gulp-size');
@@ -13,10 +13,42 @@ const { parseAsync } = require('json2csv');
 
 const vaultFields = require('./helpers/vault_fields').vaultFields;
 
-module.exports = function (gulp, options) {
+module.exports = function(gulp, options) {
 
-  function prepareVaultData (keyMessages) {
-    return new Promise(function (resolve, reject) {
+  async function ftpDeploy(files, ftpPath = '') {
+    
+    const client = new ftp.Client();
+
+    client.trackProgress(info => {
+      utils.log.log('');
+      utils.log.log('       File: ', info.name);
+      utils.log.log('       Type: ', info.type);
+      utils.log.log('       Transferred: ', info.bytes);
+      utils.log.log('       Transferred Overall: ', info.bytesOverall);
+    });
+    
+    client.ftp.verbose = options.verbose;
+    try {
+      await client.access({
+        host: options.ftp.host,
+        user: options.ftp.user,
+        password: options.ftp.pass,
+        port: options.ftp.port || 21,
+        secure: options.ftp.secure,
+        secureOptions: { rejectUnauthorized: false }
+      });
+
+      for (const file of files) {
+        await client.uploadFrom(path.join(options.paths.deploy, file), path.join(ftpPath, file));
+      }
+    } catch (err) {
+      console.log(err);
+    }
+    client.close();
+  }
+
+  function prepareVaultData(keyMessages) {
+    return new Promise(function(resolve, reject) {
       const buildArray = [];
 
       try {
@@ -57,92 +89,31 @@ module.exports = function (gulp, options) {
     });
   }
 
-  function handleFTPZips () {
-    return new Promise(function (resolve, reject) {
 
-      utils.log.log('⤷ Deploying zipped files');
+  function handleFTPZips() {
 
-      const conn = ftp.create({
-        debug: utils.log.debug,
-        host: options.ftp.host,
-        log: utils.log.verbose,
-        parallel: 4,
-        password: options.ftp.pass,
-        port: options.ftp.port || 21,
-        secure: options.ftp.secure || false,
-        secureOptions: { rejectUnauthorized: false },
-        read: false,
-        user: options.ftp.user,
-        maxConnections: 11
-      });
+    utils.log.log('   ⤷ Deploying zipped files');
 
-      /**
-       * Overide function as there's an error in the vinyl-ftp module.
-       * Error: when checking the remote's directory (based on glob's path), if there's a symbolic link (a file),
-       *        an error is thrown.
-       */
-      conn._mkdirp =  {
-        get: function (path, cb){
-          return cb();
-        }
-      };
+    return utils.getFiles(path.join(process.cwd(), options.paths.deploy))
+      .then((files) => files.filter(el => path.extname(el) === '.zip'))
+      .then(ftpDeploy);
 
-      gulp.src(path.join('**', '*.zip'), {
-        buffer: false,
-        cwd: options.paths.deploy,
-      })
-          .pipe(plumber())
-          .pipe(conn.dest(`${options.ftp.remotePath}`))
-          .on('error', function (err) {
-            reject(err);
-          })
-          .on('end', function () {
-            console.log('FTP Zips complete');
-            resolve();
-          });
-    });
   }
 
-  function handleFTPCtls () {
-    return new Promise(function (resolve, reject) {
+  function handleFTPCtls() {
 
-      utils.log.log('⤷ Deploying control files');
+    utils.log.log('');
+    utils.log.log('   ⤷ Deploying control files');
 
-      const conn = ftp.create({
-        debug: utils.log.debug,
-        host: options.ftp.host,
-        log: utils.log.verbose,
-        parallel: 4,
-        password: options.ftp.pass,
-        port: options.ftp.port || 21,
-        read: false,
-        secure: options.ftp.secure || false,
-        secureOptions: { rejectUnauthorized: false },
-        user: options.ftp.user,
-        maxConnections: 11
-      });
-
-
-      gulp.src(path.join(options.paths.deploy, '**', '*.ctl'), {
-        buffer: false
-      })
-          .pipe(plumber())
-          .pipe(conn.dest(`${options.ftp.remotePath}/ctlfile`))
-          .on('error', function (err) {
-            console.log(err);
-            reject(err);
-          })
-          .on('end', function () {
-            console.log('done ctrl ftp');
-            resolve();
-          });
-    });
+    return utils.getFiles(path.join(process.cwd(), options.paths.deploy))
+      .then((files) => files.filter(el => path.extname(el) === '.ctl'))
+      .then((files) => ftpDeploy(files, 'ctlfile'));      
   }
 
-  function handleStaging (keyMessages) {
+  function handleStaging(keyMessages) {
 
-    function keyMessageCompress (keyMessage) {
-      return new Promise(function (resolve, reject) {
+    function keyMessageCompress(keyMessage) {
+      return new Promise(function(resolve, reject) {
 
         let formattedKeyMessage = keyMessage['key_message'];
 
@@ -151,80 +122,82 @@ module.exports = function (gulp, options) {
         }
 
         gulp.src('**/*', {
-          cwd: path.join(process.cwd(), options.paths.dist, formattedKeyMessage),
-          base: options.paths.dist
-        })
-            .pipe(plumber())
-            .pipe(zip(formattedKeyMessage + '.zip'))
-            .pipe(size({
-              title: util.colors.green.bold('⤷ Zipping Key Message: ') + util.colors.yellow.bold(formattedKeyMessage),
-              showFiles: options.verbose
-            }))
-            .pipe(gulp.dest(options.paths.deploy))
-            .on('error', function (err) {
-              reject(err);
-            })
-            .on('end', function () {
-              resolve();
-            });
+            cwd: path.join(process.cwd(), options.paths.dist, formattedKeyMessage),
+            base: options.paths.dist
+          })
+          .pipe(plumber())
+          .pipe(zip(formattedKeyMessage + '.zip'))
+          .pipe(size({
+            title: util.colors.green.bold('⤷ Zipping Key Message: ') + util.colors.yellow.bold(formattedKeyMessage),
+            showFiles: options.verbose
+          }))
+          .pipe(gulp.dest(options.paths.deploy))
+          .on('error', function(err) {
+            reject(err);
+          })
+          .on('end', function() {
+            resolve();
+          });
       });
     }
-    function keyMessageControlFile (keyMessage) {
+
+    function keyMessageControlFile(keyMessage) {
       let formattedKeyMessage = keyMessage['key_message'];
 
       if (options.clm.product && options.clm.product.name) {
         formattedKeyMessage = options.clm.product.name + options.clm.product.suffix + formattedKeyMessage;
       }
 
       const controlFile = 'USER=' + options.ftp.user + '\n' +
-                'PASSWORD=' + options.ftp.pass + '\n' +
-                'EMAIL=' + options.ftp.email + '\n' +
-                'NAME=' + formattedKeyMessage + '\n' +
-                'Description_vod__c=' + keyMessage['description'] + '\n' +
-                'FILENAME=' + formattedKeyMessage + '.zip';
+        'PASSWORD=' + options.ftp.pass + '\n' +
+        'EMAIL=' + options.ftp.email + '\n' +
+        'NAME=' + formattedKeyMessage + '\n' +
+        'Description_vod__c=' + keyMessage['description'] + '\n' +
+        'FILENAME=' + formattedKeyMessage + '.zip';
 
       return utils.setFile(path.join(options.paths.deploy, formattedKeyMessage + '.ctl'), controlFile);
     }
 
     return utils.mkFolder(options.paths.deploy)
-        .then(() => {
+      .then(() => {
 
-          const promises = [];
+        const promises = [];
 
-          keyMessages.push({ key_message: 'shared' });
-          for (const km of keyMessages) {
-            promises.push(keyMessageCompress(km));
-            promises.push(keyMessageControlFile(km));
-          }
+        keyMessages.push({ key_message: 'shared' });
+        for (const km of keyMessages) {
+          promises.push(keyMessageCompress(km));
+          promises.push(keyMessageControlFile(km));
+        }
 
-          return Promise.all(promises);
-        });
+        return Promise.all(promises);
+      });
   }
 
 
-  gulp.task('deploy', function () {
+  gulp.task('deploy', function() {
 
     return handleFTPZips()
-        .then(() => handleFTPCtls())
-        .then(() => utils.log.success('Done Deploying Key Messages'));
+      .then(() => handleFTPCtls())
+      .then(() => utils.log.log(''))
+      .then(() => utils.log.success('Done Deploying Key Messages'));
 
   });
 
-  gulp.task('stage', ['clean:deploy', 'build'], function () {
+  gulp.task('stage', ['clean:deploy', 'build'], function() {
 
     return handleStaging(options.clm.key_messages)
-        .then(() => utils.log.success('Done Staging Key Messages'));
+      .then(() => utils.log.success('Done Staging Key Messages'));
   });
 
-  gulp.task('stage-vault', function () {
+  gulp.task('stage-vault', function() {
 
     utils.log.log('⤷ Generating Veeva Vault CSV file');
 
     return utils.mkFolder(options.paths.deploy)
-        .then(() => prepareVaultData(options.clm.key_messages))
-        .then((buildArray) => parseAsync(buildArray, vaultFields))
-        .then((csv) => utils.setFile(path.join(process.cwd(), options.paths.deploy, 'VAULT_CSV.csv'), csv))
-        .then(() => utils.log.success('Veeva Vault CSV file has been successfully generated'));
+      .then(() => prepareVaultData(options.clm.key_messages))
+      .then((buildArray) => parseAsync(buildArray, vaultFields))
+      .then((csv) => utils.setFile(path.join(process.cwd(), options.paths.deploy, 'VAULT_CSV.csv'), csv))
+      .then(() => utils.log.success('Veeva Vault CSV file has been successfully generated'));
   });
 
 };

package-lock.json

@@ -33,6 +33,7 @@
   "license": "MIT",
   "dependencies": {
     "assemble": "^0.24.3",
+    "basic-ftp": "^4.6.6",
     "browser-sync": "^2.26.14",
     "chalk": "^2.4.2",
     "del": "^5.0.0",
@@ -60,7 +61,6 @@
     "pdfkit": "^0.10.0",
     "puppeteer": "^1.20.0",
     "run-sequence": "^2.2.0",
-    "vinyl-ftp": "^0.6.0",
     "yamljs": "^0.3.0"
   },
   "devDependencies": {