Merge pull request #180 from browserstack/CYP-870-fix-npm-console-message

Fix sticky npm console message

Author: nagpalkaran95

bin/helpers/constants.js

@@ -26,6 +26,7 @@ const userMessages = {
   MD5_CHECK_FAILED: "There was some issue while checking if zip is already uploaded.",
   ZIP_DELETE_FAILED: "Could not delete tests.zip successfully.",
   ZIP_DELETED: "Deleted tests.zip successfully.",
+  NPM_INSTALL_AND_UPLOAD: "Installing required dependencies and building the package to upload to BrowserStack",
   NPM_DELETE_FAILED: "Could not delete the dependency packages.",
   NPM_DELETED: "Deleted dependency packages successfully.",
   API_DEPRECATED: "This version of API is deprecated, please use latest version of API.",

bin/helpers/packageInstaller.js

@@ -1,14 +1,15 @@
 'use strict';
-const npm = require('npm'),
-  archiver = require("archiver"),
+  const archiver = require("archiver"),
   path = require('path'),
-  os = require('os'),
   fs = require('fs-extra'),
   fileHelpers = require('./fileHelpers'),
   logger = require("./logger").winstonLogger,
   Constants = require('./constants'),
   process = require('process'),
-  utils = require('./utils');
+  utils = require('./utils'),
+  { spawn } = require('child_process');
+
+let nodeProcess;
 
 const setupPackageFolder = (runSettings, directoryPath) => {
   return new Promise(function (resolve, reject) {
@@ -39,7 +40,7 @@ const setupPackageFolder = (runSettings, directoryPath) => {
           if (fs.existsSync(sourceNpmrc)) {
             fs.copyFileSync(sourceNpmrc, destNpmrc);
           }
-          return resolve("package file created");
+          return resolve("Package file created");
         }
         return reject("Nothing in package file");
       } catch(error) {
@@ -51,25 +52,20 @@ const setupPackageFolder = (runSettings, directoryPath) => {
 
 const packageInstall = (packageDir) => {
   return new Promise(function (resolve, reject) {
-    let savedPrefix = null;
-    let npmLoad = Constants.packageInstallerOptions.npmLoad
-    npmLoad["cache"] = fs.mkdtempSync(`${os.tmpdir()}${path.sep}`);
-    const installCallback = (err, result) => {
-      npm.prefix = savedPrefix;
-      if (err) {
-        return reject(err);
+    const nodeProcessCloseCallback = (code) => {
+      if(code == 0) {
+        resolve('Packages were installed successfully.');
+      } else {
+        reject('Packages were not installed successfully.');
       }
-      resolve(result);
     };
-    const loadCallback = (err) => {
-      if (err) {
-        return reject(err);
-      }
-      savedPrefix = npm.prefix;
-      npm.prefix = packageDir;
-      npm.commands.install(packageDir, [], installCallback);
+    const nodeProcessErrorCallback = (error) => {
+      logger.error(`Some error occurred while installing packages: ${error}`);
+      reject(`Packages were not installed successfully.`);
     };
-    npm.load(npmLoad, loadCallback);
+    nodeProcess = spawn('npm', ['install'], {cwd: packageDir});
+    nodeProcess.on('close', nodeProcessCloseCallback);
+    nodeProcess.on('error', nodeProcessErrorCallback);
   });
 };
 
@@ -113,7 +109,7 @@ const packageWrapper = (bsConfig, packageDir, packageFile, md5data, instrumentBl
     if (md5data.packageUrlPresent || !utils.isTrueString(bsConfig.run_settings.cache_dependencies)) {
       return resolve(obj);
     }
-    logger.info(`Installing required dependencies and building the package to upload to BrowserStack`);
+    logger.info(Constants.userMessages.NPM_INSTALL_AND_UPLOAD);
     instrumentBlocks.markBlockStart("packageInstaller.folderSetup");
     return setupPackageFolder(bsConfig.run_settings, packageDir).then((_result) => {
       process.env.CYPRESS_INSTALL_BINARY = 0

package.json

@@ -26,7 +26,6 @@
     "uuid": "^8.3.2",
     "winston": "^2.3.1",
     "yargs": "^14.2.3",
-    "npm": "^6.14.15",
     "axios": "^0.21.1",
     "unzipper": "^0.10.11",
     "update-notifier": "^5.1.0"

test/unit/bin/helpers/packageInstaller.js

@@ -4,7 +4,7 @@ const chai = require("chai"),
   sinon = require("sinon"),
   fs = require('fs-extra'),
   path = require('path'),
-  npm = require('npm');
+  cp = require('child_process');
 
 const logger = require("../../../../bin/helpers/logger").winstonLogger,
 fileHelpers = require("../../../../bin/helpers/fileHelpers");
@@ -150,7 +150,7 @@ describe("packageInstaller", () => {
           sinon.assert.calledOnce(pathdirnameStub);
           sinon.assert.calledThrice(pathjoinStub);
           sinon.assert.calledWith(fswriteFileSyncStub, null, packageCreated);
-          chai.assert.equal(data, "package file created");
+          chai.assert.equal(data, "Package file created");
         })
         .catch((_error) => {
           console.log(_error)
@@ -202,7 +202,7 @@ describe("packageInstaller", () => {
           sinon.assert.calledOnce(pathdirnameStub);
           sinon.assert.calledThrice(pathjoinStub);
           sinon.assert.calledWith(fswriteFileSyncStub, null, packageCreated);
-          chai.assert.equal(data, "package file created");
+          chai.assert.equal(data, "Package file created");
         })
         .catch((_error) => {
           console.log(_error)
@@ -212,80 +212,52 @@ describe("packageInstaller", () => {
   });
 
   context("packageInstall", () => {
-    let npmInstallStub;
     const packageInstaller = rewire("../../../../bin/helpers/packageInstaller");
-    beforeEach(() => {
-      npmInstallStub = sandbox.stub(npm.commands, "install").returns(null);
-    });
 
-    it("should reject if error in  npm load", () => {
-      packageInstaller.__set__({
-        npm: {
-          commands: {
-            install: npmInstallStub
-          },
-          load: (_npmLoad, loadCallback) => {
-            loadCallback("test error");
-          } 
-        },
+    it("should call npm install on directory and resolve if spawn is closed successfully", () => {
+      let spawnStub = sandbox.stub(cp, 'spawn').returns({
+        on: (_close, nodeProcessCloseCallback) => {
+          nodeProcessCloseCallback(0);
+        }
       });
-      let packageInstallrewire = packageInstaller.__get__('packageInstall');
-      let directoryPath = "/random/path";
-      return packageInstallrewire(directoryPath)
-        .then((_data) => {
-          chai.assert.fail("Promise error");
-        })
-        .catch((error) => {
-          chai.assert.equal(error, "test error")
-        });
-    });
-
-    it("should call npm install on directory", () => {
       packageInstaller.__set__({
-        npm: {
-          commands: {
-            install: (_packageDir, [], installCallback) => {
-              installCallback(null, "npm install done");
-            }
-          },
-          load: (_npmLoad, loadCallback) => {
-            loadCallback(null);
-          } 
-        },
+        nodeProcess: {},
+        spawn: spawnStub
       });
       let packageInstallrewire = packageInstaller.__get__('packageInstall');
       let directoryPath = "/random/path";
       return packageInstallrewire(directoryPath)
-        .then((data) => {
-          chai.assert.equal(data, "npm install done")
-        })
-        .catch((_error) => {
-          chai.assert.fail("Promise error");
-        });
+      .then((data) => {
+        console.log(data);
+        chai.assert.equal(data, "Packages were installed successfully.")
+        spawnStub.restore();
+      })
+      .catch((_error) => {
+        chai.assert.fail(`Promise error ${_error}`);
+      });
     });
 
-    it("should reject if error in npm install", () => {
+    it("should call npm install on directory and reject if spawn is not closed successfully", () => {
+      let spawnStub = sandbox.stub(cp, 'spawn').returns({
+        on: (_close, nodeProcessCloseCallback) => {
+          nodeProcessCloseCallback(1);
+        }
+      });
       packageInstaller.__set__({
-        npm: {
-          commands: {
-            install: (_packageDir, [], installCallback) => {
-              installCallback("test error", "npm install failed");
-            }
-          },
-          load: (_npmLoad, loadCallback) => {
-            loadCallback(null);
-          } 
-        },
+        nodeProcess: {},
+        spawn: spawnStub
       });
       let packageInstallrewire = packageInstaller.__get__('packageInstall');
       let directoryPath = "/random/path";
       return packageInstallrewire(directoryPath)
-        .then((_data) => {
-          chai.assert.fail("Promise error");
-        })
-        .catch((error) => {
-          chai.assert.equal(error, "test error")
-        });
+      .then((_data) => {
+        spawnStub.restore();
+        chai.assert.fail("Promise error");
+      })
+      .catch((error) => {
+        spawnStub.restore();
+        chai.assert.equal(error, "Packages were not installed successfully.")
+      });
     });
   });