🎨 added instrumentation for package diff and pushing package.json

Author: Archish27

bin/commands/runs.js

@@ -19,7 +19,8 @@ const archiver = require("../helpers/archiver"),
   downloadBuildArtifacts = require('../helpers/buildArtifacts').downloadBuildArtifacts,
   downloadBuildStacktrace = require('../helpers/downloadBuildStacktrace').downloadBuildStacktrace,
   updateNotifier = require('update-notifier'),
-  pkg = require('../../package.json');
+  pkg = require('../../package.json'),
+  packageDiff = require('../helpers/package-diff');
 const { getStackTraceUrl } = require('../helpers/sync/syncSpecsLogs');
 
 module.exports = function run(args, rawArgs) {
@@ -164,7 +165,14 @@ module.exports = function run(args, rawArgs) {
 
             let test_zip_size = utils.fetchZipSize(path.join(process.cwd(), config.fileName));
             let npm_zip_size = utils.fetchZipSize(path.join(process.cwd(), config.packageFileName));
-
+            
+            //Package diff
+            let isPackageDiff = false;
+            if(!md5data.zipUrlPresent){
+              isPackageDiff = packageDiff.run(`package.json`, `${config.packageDirName}/package.json`);
+              logger.debug(`Package difference was ${isPackageDiff ? `found` : `not found`}`);
+            }
+            
             // Uploaded zip file
             logger.debug("Started uploading the test suite zip");
             logger.debug("Started uploading the node_module zip");
@@ -270,6 +278,9 @@ module.exports = function run(args, rawArgs) {
                   test_suite_zip_upload: md5data.zipUrlPresent ? 0 : 1,
                   package_zip_upload: md5data.packageUrlPresent ? 0 : 1
                 };
+                if(dataToSend.test_suite_zip_upload === 1 ){
+                  dataToSend['is_package_diff'] = isPackageDiff;
+                }
 
                 if (!md5data.zipUrlPresent && zip.tests_upload_time) {
                   dataToSend.test_suite_zip_size = parseFloat((test_zip_size / 1024).toFixed(2));

bin/helpers/archiver.js

@@ -1,4 +1,5 @@
 'use strict';
+const config = require('./config.js');
 const fs = require("fs"),
     path = require("path");
 
@@ -76,6 +77,14 @@ const archiveSpecs = (runSettings, filePath, excludeFiles, md5data) => {
       archive.append(packageJSONString, {name: `${cypressAppendFilesZipLocation}browserstack-package.json`});
     }
 
+    //Create copy of package.json
+    if(fs.existsSync('package.json')){
+      let originalPackageJson = JSON.parse(fs.readFileSync('package.json'));
+      let originalPackageJsonString = JSON.stringify(originalPackageJson, null, 4);
+      archive.append(originalPackageJsonString, {name: `${cypressAppendFilesZipLocation}userPackage.json`});
+      logger.debug(`Created copy of package.json in ${config.packageDirName} folder`)
+    }
+
     // do not add cypress.json if arg provided is false
     if (
       runSettings.cypress_config_file &&

bin/helpers/package-diff.js

@@ -0,0 +1,71 @@
+'use strict'
+const fs = require('fs')
+const path = require('path')
+const logger = require("./logger").winstonLogger;
+
+exports.run = (basePath, comparePath)  => {
+    if (!basePath || !comparePath) {
+        logger.debug('Skipping package difference check.')
+    }
+
+    const base = readModules(basePath)
+    const compare = readModules(comparePath)
+
+    let isDiff = false;
+    Object.keys(base.deps).forEach(baseKey => {
+        if (baseKey in compare.deps) {
+            if (base.deps[baseKey] === compare.deps[baseKey]) {
+                //ignore this check
+            } else {
+                isDiff = true;
+                return;
+            }
+        } else {
+            isDiff = true;
+            return;
+        }
+    })
+    return isDiff;
+}
+const readModules =  (location) =>  {
+    const table = {}
+  
+    // Resolve package dependencies
+    if (location.indexOf('package.json') !== -1) {
+      const data = fs.readFileSync(location.replace(':dev', ''), 'utf-8')
+      let parsed
+      try { parsed = JSON.parse(data) } catch (e) { parsed = false }
+      if (!parsed) { return }
+  
+      const depsKey = location.indexOf(':dev') !== -1 ? 'devDependencies' : 'dependencies'
+      const deps = parsed[depsKey] ? parsed[depsKey] : (parsed.dependencies || parsed.devDependencies)
+  
+      Object.keys(deps).forEach(key => {
+        deps[key] = deps[key].replace(/\^|~/g, '')
+      })
+      return {
+        name: `${location} {${depsKey}}`,
+        deps,
+      }
+    }
+  
+    fs.readdirSync(location)
+    .filter(name => name !== '.bin')
+    .map(name => {
+        const pkg = path.join(location, name, 'package.json')
+        const exists = fs.existsSync(pkg)
+        if (!exists) { return }
+
+        const data = fs.readFileSync(pkg, 'utf-8')
+        let parsed
+
+        try { parsed = JSON.parse(data) } catch (e) { parsed = false }
+        if (!parsed) { return }
+
+        table[name] = parsed.version
+    })
+    return {
+    name: location,
+    deps: table,
+}
+}