Merge pull request #182 from browserstack/instrument_size

Instrument zip sizes

Author: nagpalkaran95

bin/commands/runs.js

@@ -1,4 +1,6 @@
 'use strict';
+const path = require('path');
+
 const archiver = require("../helpers/archiver"),
   zipUploader = require("../helpers/zipUpload"),
   build = require("../helpers/build"),
@@ -114,6 +116,9 @@ module.exports = function run(args) {
           return archiver.archive(bsConfig.run_settings, config.fileName, args.exclude, md5data).then(function (data) {
             markBlockEnd('zip.archive');
 
+            let test_zip_size = utils.fetchZipSize(path.join(process.cwd(), config.fileName));
+            let npm_zip_size = utils.fetchZipSize(path.join(process.cwd(), config.packageFileName));
+
             // Uploaded zip file
             markBlockStart('zip.zipUpload');
             return zipUploader.zipUpload(bsConfig, md5data, packageData).then(async function (zip) {
@@ -186,6 +191,8 @@ module.exports = function run(args) {
                   package_error: utils.checkError(packageData),
                   checkmd5_error: utils.checkError(md5data),
                   build_id: data.build_id,
+                  test_zip_size: test_zip_size,
+                  npm_zip_size: npm_zip_size,
                 };
                 if (bsConfig && bsConfig.connection_settings) {
                   if (bsConfig.connection_settings.local_mode) {

bin/helpers/utils.js

@@ -1012,3 +1012,13 @@ async function processExitHandler(exitData){
   await this.stopLocalBinary(exitData.bsConfig, exitData.bsLocalInstance, exitData.args);
   process.exit(0);
 }
+
+exports.fetchZipSize = (fileName) => {
+  try {
+    let stats = fs.statSync(fileName)
+    return stats.size; // in bytes
+  }
+  catch(err) {
+    return 0;
+  }
+}

test/unit/bin/commands/runs.js

@@ -391,6 +391,7 @@ describe("runs", () => {
       setConfigStub = sandbox.stub();
       setBrowsersStub = sandbox.stub();
       setCLIModeStub = sandbox.stub();
+      fetchZipSizeStub = sandbox.stub();
     });
 
     afterEach(() => {
@@ -431,7 +432,8 @@ describe("runs", () => {
           setLocalConfigFile: setLocalConfigFileStub,
           setBrowsers: setBrowsersStub,
           setConfig: setConfigStub,
-          setCLIMode: setCLIModeStub
+          setCLIMode: setCLIModeStub,
+          fetchZipSize: fetchZipSizeStub,
         },
         '../helpers/capabilityHelper': {
           validate: capabilityValidatorStub,
@@ -461,6 +463,7 @@ describe("runs", () => {
       packageInstallerStub.returns(Promise.resolve({ packageArchieveCreated: false }));
       archiverStub.returns(Promise.resolve("Zipping completed"));
       zipUploadStub.returns(Promise.reject("random-error"));
+      fetchZipSizeStub.returns(123);
 
       return runs(args)
         .then(function (_bsConfig) {
@@ -469,6 +472,7 @@ describe("runs", () => {
         .catch((error) => {
           sinon.assert.calledOnce(getConfigPathStub);
           sinon.assert.calledOnce(getConfigPathStub);
+          sinon.assert.calledTwice(fetchZipSizeStub);
           sinon.assert.calledOnce(setLocalModeStub);
           sinon.assert.calledOnce(setLocalConfigFileStub);
           sinon.assert.calledOnce(getNumberOfSpecFilesStub);
@@ -546,6 +550,7 @@ describe("runs", () => {
       setConfigStub = sandbox.stub();
       setBrowsersStub = sandbox.stub();
       setCLIModeStub = sandbox.stub();
+      fetchZipSizeStub = sandbox.stub();
     });
 
     afterEach(() => {
@@ -587,7 +592,8 @@ describe("runs", () => {
           setLocalConfigFile: setLocalConfigFileStub,
           setBrowsers: setBrowsersStub,
           setConfig: setConfigStub,
-          setCLIMode: setCLIModeStub
+          setCLIMode: setCLIModeStub,
+          fetchZipSize: fetchZipSizeStub,
         },
         '../helpers/capabilityHelper': {
           validate: capabilityValidatorStub,
@@ -624,6 +630,7 @@ describe("runs", () => {
       zipUploadStub.returns(Promise.resolve("zip uploaded"));
       stopLocalBinaryStub.returns(Promise.resolve("nothing"));
       createBuildStub.returns(Promise.reject("random-error"));
+      fetchZipSizeStub.returns(123);
 
       return runs(args)
         .then(function (_bsConfig) {
@@ -632,6 +639,7 @@ describe("runs", () => {
         .catch((error) => {
           sinon.assert.calledOnce(getConfigPathStub);
           sinon.assert.calledOnce(getConfigPathStub);
+          sinon.assert.calledTwice(fetchZipSizeStub);
           sinon.assert.calledOnce(setLocalConfigFileStub);
           sinon.assert.calledOnce(setLocalModeStub);
           sinon.assert.calledOnce(setupLocalTestingStub);
@@ -694,6 +702,9 @@ describe("runs", () => {
         return "end";
       });
       dashboardUrl = "dashboard-url";
+      packageDirName = "package-dir";
+      packageFileName = "package-file";
+      fileName = "file-name";
       capabilityValidatorStub = sandbox.stub();
       archiverStub = sandbox.stub();
       zipUploadStub = sandbox.stub();
@@ -724,6 +735,7 @@ describe("runs", () => {
       nonEmptyArrayStub = sandbox.stub();
       setCLIModeStub = sandbox.stub();
       setProcessHooksStub = sandbox.stub();
+      fetchZipSizeStub = sandbox.stub();
     });
 
     afterEach(() => {
@@ -736,7 +748,7 @@ describe("runs", () => {
       let errorCode = null;
       let message = `Success! ${Constants.userMessages.BUILD_CREATED} with build id: random_build_id`;
       let dashboardLink = `${Constants.userMessages.VISIT_DASHBOARD} ${dashboardUrl}`;
-      let data = {time_components: {}, unique_id: 'random_hash', package_error: 'test', checkmd5_error: 'test', build_id: 'random_build_id'}
+      let data = {time_components: {}, unique_id: 'random_hash', package_error: 'test', checkmd5_error: 'test', build_id: 'random_build_id', test_zip_size: 123, npm_zip_size: 123}
 
       const runs = proxyquire('../../../../bin/commands/runs', {
         '../helpers/utils': {
@@ -773,7 +785,8 @@ describe("runs", () => {
           nonEmptyArray: nonEmptyArrayStub,
           checkError: checkErrorStub,
           setCLIMode: setCLIModeStub,
-          setProcessHooks: setProcessHooksStub
+          setProcessHooks: setProcessHooksStub,
+          fetchZipSize: fetchZipSizeStub,
         },
         '../helpers/capabilityHelper': {
           validate: capabilityValidatorStub,
@@ -793,6 +806,9 @@ describe("runs", () => {
         },
         '../helpers/config': {
           dashboardUrl: dashboardUrl,
+          packageDirName: packageDirName,
+          packageFileName: packageFileName,
+          fileName: fileName,
         },
         '../helpers/checkUploaded': {
           checkUploadedMd5: checkUploadedStub,
@@ -821,6 +837,7 @@ describe("runs", () => {
       stopLocalBinaryStub.returns(Promise.resolve("nothing"));
       nonEmptyArrayStub.returns(false);
       checkErrorStub.returns('test');
+      fetchZipSizeStub.returns(123);
       createBuildStub.returns(Promise.resolve({ message: 'Success', build_id: 'random_build_id', dashboard_url: dashboardUrl }));
 
       return runs(args)
@@ -836,6 +853,7 @@ describe("runs", () => {
           sinon.assert.calledOnce(getNumberOfSpecFilesStub);
           sinon.assert.calledOnce(setParallelsStub);
           sinon.assert.calledOnce(warnSpecLimitStub);
+          sinon.assert.calledTwice(fetchZipSizeStub);
           sinon.assert.calledOnce(setLocalStub);
           sinon.assert.calledOnce(setLocalModeStub);
           sinon.assert.calledOnce(setupLocalTestingStub);

test/unit/bin/helpers/utils.js

@@ -2663,4 +2663,16 @@ describe('utils', () => {
       process.exit.restore();
     });
   });
+
+  describe('fetchZipSize', () => {
+    it('should return size in bytes if file is present', () => {
+      sinon.stub(fs, 'statSync').returns({size: 123});
+      expect(utils.fetchZipSize('unknown.zip')).to.be.eql(123);
+      fs.statSync.restore();
+    });
+
+    it('handle file not present', () => {
+      expect(utils.fetchZipSize('unknown.tar.gz')).to.be.eql(0);
+    });
+  });
 });