Updating the command to use internall bower module.

Author: jarrodek

.jshintrc

@@ -2,3 +2,5 @@ language: node_js
 node_js: stable
 script:
 - npm test
+cache:
+  - "~/.cache/bower/"

.travis.yml

@@ -0,0 +1 @@
+{"name":"test","description":"test","version":"0.0.1","license":"Apache-2.0 OR CC-BY-4.0","authors":["The Advanced REST client authors <arc@mulesoft.com>"],"dependencies":{"arc-polyfills":"advanced-rest-client/arc-polyfills#latest"}}

bower.json

@@ -9,6 +9,10 @@
  * Options object for the DependendenciesManager class.
  */
 class DependenciesOptions {
+  /**
+   * @constructor
+   * @param {Object} opts User passed options.
+   */
   constructor(opts) {
     opts = opts || {};
     /**

lib/dependencies-options.js

@@ -6,11 +6,9 @@
  * @author Pawel Psztyc
  */
 const {DependenciesOptions} = require('./dependencies-options');
-const {spawn} = require('child_process');
 const fs = require('fs-extra');
 const path = require('path');
-const platform = process.platform;
-const isWin = platform !== 'darwin' && platform.indexOf('win') !== -1;
+const bower = require('bower');
 /**
  * A class responsible for installing API Console dependencies.
  *
@@ -26,10 +24,10 @@ class DependendenciesManager {
    * Constructs the processor.
    *
    * @param {String} workingDir Path to a working directory instance.
-   * @param {Winston} logger Logger to use to log debug output
-   * @param {DependenciesOptions} opts Options passed to the module
+   * @param {?DependenciesOptions} opts Options passed to the module
+   * @param {?Object} logger Logger to use to log debug output
    */
-  constructor(workingDir, logger, opts) {
+  constructor(workingDir, opts, logger) {
     if (!(opts instanceof DependenciesOptions)) {
       opts = new DependenciesOptions(opts);
     }
@@ -40,104 +38,43 @@ class DependendenciesManager {
     /**
      * Looger object to be used to pring verbose or error messages.
      */
-    this.logger = logger;
+    this.logger = this._setupLogger(logger);
     /**
      * A directory where all operations will be performed
      *
      * @type {String}
      */
     this.workingDir = workingDir;
-    /**
-     * A bower command root. It's a path to the bower command and it depends
-     * on install location.
-     *
-     * @type {String}
-     */
-    this.commandRoot = undefined;
-    /**
-     * Is updated when `installDependencies()` is called.
-     * Alters the command so bower will not fail if current user is root.
-     */
-    this.runningRoot = false;
+  }
+  /**
+   * Returns a logger object. Either passed object or `console` is used.
+   *
+   * @param {?Object} logger A logger object with common logging functions
+   * like `info`, `log`, `warn` and `error`
+   * @return {Object}
+   */
+  _setupLogger(logger) {
+    if (logger) {
+      return logger;
+    }
+    return console;
   }
   /**
    * Installs bower dependencies if the `bower.json` file exists in `workingDir`
    *
    * @return {Promise} Resolved promise when operation is completed.
    */
   installDependencies() {
-    this.__startDir = process.cwd();
-    try {
-      process.chdir(this.workingDir);
-    } catch (err) {
-      return Promise.reject(new Error(err));
-    }
-    return this.checkIsRoot()
-    .then(isRoot => {
-      this.runningRoot = isRoot;
-    })
-    .then(() => this.hasBower())
-    .then(hasFile => {
-      if (!hasFile) {
+    return fs.pathExists(path.join(this.workingDir, 'bower.json'))
+    .then((exists) => {
+      if (!exists) {
         // no bower file, exit.
         this.logger.info('No bower file. Skipping dependencies.');
         return;
       }
       return this._processDependencies();
-    })
-    .then(() => {
-      process.chdir(this.__startDir);
-    })
-    .catch(cause => {
-      process.chdir(this.__startDir);
-      throw cause;
     });
   }
-  /**
-   * Checks if bower file exists in `workingDir`.
-   *
-   * @return {Promise} A promise resolved to boolean value determining if the
-   * `bower.json` file exists.
-   */
-  hasBower() {
-    return fs.lstat('bower.json')
-    .then(stats => {
-      return stats.isFile();
-    })
-    .catch(() => {
-      return false;
-    });
-  }
-  /**
-   * Prepares bower command options depending on environment and options.
-   *
-   * @param {String} command to execute, what is after `$ bower`
-   * @return {object} Object containing the command and arguments
-   * - cmd {String} Command to call
-   * - args {Array<String>} List of arguments to send to the child process.
-   */
-  _prepareBowerCommand(...command) {
-    var args = [];
-    if (!this.opts.verbose) {
-      args.push('--quiet');
-    }
-    if (this.runningRoot) {
-      args.push('--allow-root');
-    }
-    if (command && command.length) {
-      command.forEach(item => {
-        if (item instanceof Array) {
-          args = args.concat(item);
-        } else {
-          args.push(item);
-        }
-      });
-    }
-    return {
-      cmd: this.commandRoot,
-      args: args
-    };
-  }
   /**
    * Processes dependencies installation.
    * It checks if bower is already installed in local machine and if it is
@@ -152,75 +89,20 @@ class DependendenciesManager {
    * installed.
    */
   _processDependencies() {
-    var promise;
-    if (this.commandRoot) {
-      promise = Promise.resolve();
-    } else {
-      promise = this._setBowerCommandRoot();
-    }
-    return promise.then(() => {
-      this.logger.info('Installing bower dependencies...');
-      let cmd = this._prepareBowerCommand('install');
-      return this.spawn(cmd.cmd, cmd.args);
+    this.logger.info('Installing bower dependencies...');
+    return new Promise((resolve, reject) => {
+      const factory = bower.commands.install([], {}, {
+        cwd: this.workingDir,
+        quiet: true
+      });
+      factory.on('end', () => resolve());
+      factory.on('error', (e) => reject(e));
     })
     .then(() => {
       this.logger.info('Dependencies installed.');
       return this._installAdditionalDependencies();
     });
   }
-  /**
-   * Checks if bower is installed and if not it installs it locally.
-   * After that it constructs a bower command root depending on the OS.
-   *
-   * @return {Promise} Resolved promise when command is set and bower is
-   * installed.
-   */
-  _setBowerCommandRoot() {
-    var localCommand = path.join('.', 'node_modules', '.bin', 'bower');
-    if (isWin) {
-      localCommand += '.cmd';
-    }
-    return fs.pathExists(localCommand)
-    .then(exists => {
-      if (!exists) {
-        return this._ensureNpmPackage()
-        .then(() => {
-          this.logger.info('installing bower in ' + process.cwd());
-          return this.spawn('npm', ['install', 'bower', '--no-save', '--silent']);
-        });
-      }
-    })
-    .then(() => {
-      this.commandRoot = localCommand;
-    });
-  }
-  /**
-   * Checks if `package.json` file exists in current location and creates it
-   * if it doesn't so the `npm install` command install bower in current
-   * directory.
-   */
-  _ensureNpmPackage() {
-    return fs.pathExists('package.json')
-    .then(exists => {
-      if (!exists) {
-        this.logger.info('package.json file do not exists. Creating dummy file for npm.');
-        return this._createDummyNpmPackage();
-      }
-    });
-  }
-  /**
-   * Creates a dummy `package.json` file in current directory.
-   * TODO: Some way to clean it later.
-   */
-  _createDummyNpmPackage() {
-    const content = {
-      name: 'api-console',
-      version: '0.0.1',
-      description: 'Dummy package. To be removed.',
-      license: 'CPAL-1.0'
-    };
-    return fs.writeJson('package.json', content);
-  }
   /**
    * If required (for certain types of the console build options) it installs
    * additional bower dependencies like router, parser and enhancer.
@@ -229,7 +111,7 @@ class DependendenciesManager {
    * installed.
    */
   _installAdditionalDependencies() {
-    var deps = [];
+    let deps = [];
     if (this.opts.parser) {
       deps[deps.length] = 'advanced-rest-client/raml-js-parser';
       deps[deps.length] = 'advanced-rest-client/raml-json-enhance';
@@ -240,65 +122,16 @@ class DependendenciesManager {
     if (deps.length) {
       this.logger.info('Installing additional bower dependencies...');
       this.logger.info('Installing: ', deps);
-      let cmd = this._prepareBowerCommand('install', deps);
-      return this.spawn(cmd.cmd, cmd.args);
-    }
-    return Promise.resolve();
-  }
-  /**
-   * Spawns process and execute task with output printed to the logger.
-   * @param {String} cmd Command to execute
-   * @param {Array<String>} args Arguments to pass to the command
-   * @return {Promise<String>} A promise resolved to an output of command execution.
-   */
-  spawn(cmd, args) {
-    args = args || [];
-    let log = `Executing command: ${cmd} with arguments: ${args.join(' ')} in ${process.cwd()}`;
-    this.logger.info(log);
-    return new Promise((resolve, reject) => {
-      const proc = spawn(cmd, args, {
-        shell: true
-      });
-      var result = '';
-      proc.stdout.on('data', (data) => {
-        let _res = data.toString('utf8');
-        result += _res;
-        this.logger.info(_res);
-      });
-      proc.stderr.on('data', (data) => {
-        let _res = data.toString('utf8');
-        result += _res;
-        this.logger.error(_res);
-      });
-      proc.on('close', (code) => {
-        if (code !== 0) {
-          reject('Command ' + cmd + ' failde with code ' + code);
-        } else {
-          resolve(result);
-        }
+      return new Promise((resolve, reject) => {
+        const factory = bower.commands.install(deps, {}, {
+          cwd: this.workingDir,
+          quiet: true
+        });
+        factory.on('end', () => resolve());
+        factory.on('error', (e) => reject(e));
       });
-    });
-  }
-  /**
-   * Commands executed as root will fail under linux.
-   * This checks if current user is root
-   */
-  checkIsRoot() {
-    if (isWin) {
-      return Promise.resolve(false);
     }
-    return this.spawn('id', ['-u'])
-    .then((response) => {
-      if (!response) {
-        return false;
-      }
-      response = response.trim();
-      if (response.indexOf('0') === 0) {
-        return true;
-      }
-      return false;
-    })
-    .catch(() => false);
+    return Promise.resolve();
   }
 }
 exports.DependendenciesManager = DependendenciesManager;

lib/dependencies.js

@@ -1,6 +1,6 @@
 {
   "name": "api-console-dependency-manager",
-  "version": "0.1.2",
+  "version": "1.0.0",
   "description": "Module to detect and install Mulesoft's API console dependencies.",
   "main": "main.js",
   "scripts": {
@@ -31,6 +31,7 @@
     "mocha": "^3.2.0"
   },
   "dependencies": {
+    "bower": "^1.8.4",
     "fs-extra": "^3.0.0"
   }
 }