@atlaskit/dependency-version-analytics 0.4.2 → 1.1.0

package/dist/esm/commands/populate-historic-data/product.js

@@ -10,20 +10,19 @@ import * as statlas from '../../util/statlas';
 import { generateCSV } from './util/generate-csv';
 import { assert } from '../../util/assert';
 import { DependencyStore } from './lib/dependency-store';
-
+import getPackageVersionHistoryAndTags from '../../util/get-package-version-history';
 var getUpgradeEventsFromPkgChange = function getUpgradeEventsFromPkgChange(oldDeps, newDeps, _ref) {
   var date = _ref.date,
-      commitHash = _ref.commitHash;
+    commitHash = _ref.commitHash;
   var addOrUpgradeEvents = Object.entries(newDeps).map(function (_ref2) {
     var _ref3 = _slicedToArray(_ref2, 2),
-        name = _ref3[0],
-        _ref3$ = _ref3[1],
-        version = _ref3$.version,
-        type = _ref3$.type;
-
-    var prevDep = oldDeps[name]; // Only treat a dependency as previous if the dependency type matches
+      name = _ref3[0],
+      _ref3$ = _ref3[1],
+      version = _ref3$.version,
+      type = _ref3$.type;
+    var prevDep = oldDeps[name];
+    // Only treat a dependency as previous if the dependency type matches
     // Otherwise, we want separate add/remove events
-
     var prevVersion = prevDep && prevDep.type === type ? prevDep.version : undefined;
     return createUpgradeEvent(name, version, prevVersion, date, {
       commitHash: commitHash,
@@ -35,19 +34,18 @@ var getUpgradeEventsFromPkgChange = function getUpgradeEventsFromPkgChange(oldDe
   });
   var removeEvents = Object.entries(oldDeps).filter(function (_ref4) {
     var _ref5 = _slicedToArray(_ref4, 2),
-        name = _ref5[0],
-        type = _ref5[1].type;
-
-    return (// Treat the same dep under a different dependency type as a new dep
+      name = _ref5[0],
+      type = _ref5[1].type;
+    return (
+      // Treat the same dep under a different dependency type as a new dep
       newDeps[name] == null || newDeps[name].type !== type
     );
   }).map(function (_ref6) {
     var _ref7 = _slicedToArray(_ref6, 2),
-        name = _ref7[0],
-        _ref7$ = _ref7[1],
-        version = _ref7$.version,
-        type = _ref7$.type;
-
+      name = _ref7[0],
+      _ref7$ = _ref7[1],
+      version = _ref7$.version,
+      type = _ref7$.type;
     return createUpgradeEvent(name, undefined, version, date, {
       commitHash: commitHash,
       dependencyType: type,
@@ -58,43 +56,36 @@ var getUpgradeEventsFromPkgChange = function getUpgradeEventsFromPkgChange(oldDe
   });
   return [].concat(_toConsumableArray(addOrUpgradeEvents), _toConsumableArray(removeEvents));
 };
-
 var getEventsFromHistory = /*#__PURE__*/function () {
-  var _ref9 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(packageChangesLog, prevRunHash, _ref8) {
-    var cwd, allPackageChanges, allUpgradeEvents, dependencyStore, dependencies, i, item, newDependencies, packageChange, upgradeEvents;
-    return _regeneratorRuntime.wrap(function _callee$(_context) {
+  var _ref9 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(packageChangesLog, prevRunHash, _ref8) {
+    var cwd, allPackageChanges, allUpgradeEvents, dependencyStore, dependencies, i, item, newDependencies, packageChange, upgradeEvents, _allUpgradeEvents;
+    return _regeneratorRuntime.wrap(function _callee2$(_context2) {
       while (1) {
-        switch (_context.prev = _context.next) {
+        switch (_context2.prev = _context2.next) {
           case 0:
             cwd = _ref8.cwd;
             allPackageChanges = [];
             allUpgradeEvents = [];
             assert(packageChangesLog.all.length > 0, '');
             dependencyStore = new DependencyStore(cwd);
-            _context.next = 7;
+            _context2.next = 7;
             return dependencyStore.initialise(prevRunHash);
-
           case 7:
-            dependencies = _context.sent;
+            dependencies = _context2.sent;
             i = 0;
-
           case 9:
             if (!(i < packageChangesLog.all.length)) {
-              _context.next = 21;
+              _context2.next = 21;
               break;
             }
-
             item = packageChangesLog.all[i];
-
             if (allPackageChanges.length > 0) {
               dependencies = allPackageChanges[allPackageChanges.length - 1].akDeps;
             }
-
-            _context.next = 14;
+            _context2.next = 14;
             return dependencyStore.update(item);
-
           case 14:
-            newDependencies = _context.sent;
+            newDependencies = _context2.sent;
             packageChange = {
               date: new Date(item.date).toISOString(),
               akDeps: newDependencies
@@ -103,229 +94,218 @@ var getEventsFromHistory = /*#__PURE__*/function () {
               date: packageChange.date,
               commitHash: item.hash
             });
-
             if (upgradeEvents.length > 0) {
-              allUpgradeEvents.push.apply(allUpgradeEvents, _toConsumableArray(upgradeEvents));
+              (_allUpgradeEvents = allUpgradeEvents).push.apply(_allUpgradeEvents, _toConsumableArray(upgradeEvents));
               allPackageChanges.push(packageChange);
             }
-
           case 18:
             i++;
-            _context.next = 9;
+            _context2.next = 9;
             break;
-
           case 21:
-            return _context.abrupt("return", {
+            _context2.next = 23;
+            return Promise.all(allUpgradeEvents.map( /*#__PURE__*/function () {
+              var _ref10 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(upgradeEvent) {
+                var _distTags$hotfix, _distTags$latest, _distTags$next;
+                var getPackageTags, distTags;
+                return _regeneratorRuntime.wrap(function _callee$(_context) {
+                  while (1) {
+                    switch (_context.prev = _context.next) {
+                      case 0:
+                        _context.next = 2;
+                        return getPackageVersionHistoryAndTags(upgradeEvent.dependencyName);
+                      case 2:
+                        getPackageTags = _context.sent;
+                        distTags = getPackageTags['dist-tags'];
+                        Object.keys(distTags).forEach(function (key) {
+                          if (key.startsWith('rc')) {
+                            upgradeEvent.rcTag = distTags[key];
+                          }
+                        });
+                        upgradeEvent.hotfixTag = (_distTags$hotfix = distTags['hotfix']) !== null && _distTags$hotfix !== void 0 ? _distTags$hotfix : null;
+                        upgradeEvent.latestTag = (_distTags$latest = distTags['latest']) !== null && _distTags$latest !== void 0 ? _distTags$latest : null;
+                        upgradeEvent.nextTag = (_distTags$next = distTags['next']) !== null && _distTags$next !== void 0 ? _distTags$next : null;
+                        return _context.abrupt("return", upgradeEvent);
+                      case 9:
+                      case "end":
+                        return _context.stop();
+                    }
+                  }
+                }, _callee);
+              }));
+              return function (_x4) {
+                return _ref10.apply(this, arguments);
+              };
+            }()));
+          case 23:
+            allUpgradeEvents = _context2.sent;
+            return _context2.abrupt("return", {
               allPackageChanges: allPackageChanges,
               allUpgradeEvents: allUpgradeEvents
             });
-
-          case 22:
+          case 25:
           case "end":
-            return _context.stop();
+            return _context2.stop();
         }
       }
-    }, _callee);
+    }, _callee2);
   }));
-
   return function getEventsFromHistory(_x, _x2, _x3) {
     return _ref9.apply(this, arguments);
   };
 }();
-
-function getSinceRef(_x4) {
+function getSinceRef(_x5) {
   return _getSinceRef.apply(this, arguments);
 }
-
 function _getSinceRef() {
-  _getSinceRef = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(flags) {
+  _getSinceRef = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(flags) {
     var meta, tag, tagExists;
-    return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+    return _regeneratorRuntime.wrap(function _callee3$(_context3) {
       while (1) {
-        switch (_context2.prev = _context2.next) {
+        switch (_context3.prev = _context3.next) {
           case 0:
             if (!flags.statlas) {
-              _context2.next = 9;
+              _context3.next = 9;
               break;
             }
-
-            _context2.next = 3;
+            _context3.next = 3;
             return statlas.getMeta(flags.product);
-
           case 3:
-            meta = _context2.sent;
-
+            meta = _context3.sent;
             if (!(!meta || !meta.lastRunHash)) {
-              _context2.next = 6;
+              _context3.next = 6;
               break;
             }
-
             throw new Error(chalk.red("Missing or invalid metadata file for ".concat(flags.product, ". Must use --reset for populating from start of history")));
-
           case 6:
-            return _context2.abrupt("return", meta.lastRunHash);
-
+            return _context3.abrupt("return", meta.lastRunHash);
           case 9:
             tag = flags.tag || DEFAULT_TAG;
-            _context2.next = 12;
+            _context3.next = 12;
             return refetchTag(tag);
-
           case 12:
-            _context2.next = 14;
+            _context3.next = 14;
             return doesTagExist(tag);
-
           case 14:
-            tagExists = _context2.sent;
-
+            tagExists = _context3.sent;
             if (tagExists) {
-              _context2.next = 17;
+              _context3.next = 17;
               break;
             }
-
             throw new Error(chalk.red("Tag '".concat(tag, "' does not exist. Must use --reset for populating from start of history.")));
-
           case 17:
-            return _context2.abrupt("return", tag);
-
+            return _context3.abrupt("return", tag);
           case 18:
           case "end":
-            return _context2.stop();
+            return _context3.stop();
         }
       }
-    }, _callee2);
+    }, _callee3);
   }));
   return _getSinceRef.apply(this, arguments);
 }
-
-export default function populateProduct(_x5) {
+export default function populateProduct(_x6) {
   return _populateProduct.apply(this, arguments);
 }
-
 function _populateProduct() {
-  _populateProduct = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(flags) {
+  _populateProduct = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(flags) {
     var cwd, sinceRef, log, _yield$getEventsFromH, allPackageChanges, allUpgradeEvents, csv, currentCommit;
-
-    return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+    return _regeneratorRuntime.wrap(function _callee4$(_context4) {
       while (1) {
-        switch (_context3.prev = _context3.next) {
+        switch (_context4.prev = _context4.next) {
           case 0:
             cwd = flags.cwd || process.cwd();
-
             if (!flags.reset) {
-              _context3.next = 5;
+              _context4.next = 5;
               break;
             }
-
-            _context3.t0 = undefined;
-            _context3.next = 8;
+            _context4.t0 = undefined;
+            _context4.next = 8;
             break;
-
           case 5:
-            _context3.next = 7;
+            _context4.next = 7;
             return getSinceRef(flags);
-
           case 7:
-            _context3.t0 = _context3.sent;
-
+            _context4.t0 = _context4.sent;
           case 8:
-            sinceRef = _context3.t0;
-            _context3.next = 11;
+            sinceRef = _context4.t0;
+            _context4.next = 11;
             return getChangesSince(sinceRef);
-
           case 11:
-            log = _context3.sent;
-
+            log = _context4.sent;
             if (!(log.all.length === 0)) {
-              _context3.next = 15;
+              _context4.next = 15;
               break;
             }
-
             console.log("No package.json changes found since '".concat(sinceRef, "'."));
-            return _context3.abrupt("return");
-
+            return _context4.abrupt("return");
           case 15:
-            _context3.next = 17;
+            _context4.next = 17;
             return getEventsFromHistory(log, sinceRef, {
               cwd: cwd
             });
-
           case 17:
-            _yield$getEventsFromH = _context3.sent;
+            _yield$getEventsFromH = _context4.sent;
             allPackageChanges = _yield$getEventsFromH.allPackageChanges;
             allUpgradeEvents = _yield$getEventsFromH.allUpgradeEvents;
-
             if (!flags.csv) {
-              _context3.next = 24;
+              _context4.next = 24;
               break;
             }
-
             csv = generateCSV(allPackageChanges);
             console.log(csv);
-            return _context3.abrupt("return");
-
+            return _context4.abrupt("return");
           case 24:
             if (!flags.dryRun) {
-              _context3.next = 27;
+              _context4.next = 27;
               break;
             }
-
             console.log(JSON.stringify(allUpgradeEvents));
-            return _context3.abrupt("return");
-
+            return _context4.abrupt("return");
           case 27:
             if (!(allUpgradeEvents.length > 0)) {
-              _context3.next = 32;
+              _context4.next = 32;
               break;
             }
-
-            _context3.next = 30;
+            _context4.next = 30;
             return sendAnalytics(allUpgradeEvents, {
               dev: flags.dev,
               limit: flags.limit,
               product: flags.product,
               skipPrompt: !flags.interactive
             });
-
           case 30:
-            _context3.next = 33;
+            _context4.next = 33;
             break;
-
           case 32:
             console.log("Found no AK dependency changes since last run from ref \"".concat(sinceRef, "\"'"));
-
           case 33:
             if (!flags.statlas) {
-              _context3.next = 42;
+              _context4.next = 42;
               break;
             }
-
-            _context3.next = 36;
+            _context4.next = 36;
             return getHash('HEAD');
-
           case 36:
-            currentCommit = _context3.sent;
-            _context3.next = 39;
+            currentCommit = _context4.sent;
+            _context4.next = 39;
             return statlas.uploadMeta(flags.product, currentCommit);
-
           case 39:
             console.log('Finished');
-            _context3.next = 46;
+            _context4.next = 46;
             break;
-
           case 42:
             console.log('Updating tag to current commit...');
-            _context3.next = 45;
+            _context4.next = 45;
             return tagCommit(DEFAULT_TAG);
-
           case 45:
             console.log("Finished. Run 'git push origin tag ".concat(sinceRef, "'."));
-
           case 46:
           case "end":
-            return _context3.stop();
+            return _context4.stop();
         }
       }
-    }, _callee3);
+    }, _callee4);
   }));
   return _populateProduct.apply(this, arguments);
 }

package/dist/esm/commands/populate-historic-data/util/generate-csv.js

@@ -1,5 +1,4 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
-
 /** Generates a CSV of product package changes over time */
 export var generateCSV = function generateCSV(packageChanges) {
   var csvData = [['']];
@@ -8,22 +7,19 @@ export var generateCSV = function generateCSV(packageChanges) {
     var currentRow = firstColumn.push(packageChange.date) - 1;
     Object.entries(packageChange.akDeps).forEach(function (_ref) {
       var _ref2 = _slicedToArray(_ref, 2),
-          name = _ref2[0],
-          version = _ref2[1].version;
-
+        name = _ref2[0],
+        version = _ref2[1].version;
       var depColumnIndex = csvData.findIndex(function (item) {
         return item[0] === name;
       });
-
       if (depColumnIndex === -1) {
         depColumnIndex = csvData.push([name]) - 1;
-      } // console.log(csvData)
-
+      }
 
+      // console.log(csvData)
       csvData[depColumnIndex][currentRow] = version;
     });
   });
-
   for (var i = 0; i < csvData.length; i++) {
     for (var j = 0; j < csvData.length; j++) {
       if (typeof csvData[i][j] !== 'string') {
@@ -31,23 +27,18 @@ export var generateCSV = function generateCSV(packageChanges) {
         csvData[i][j] = '';
       }
     }
-
     if (i !== 0 && csvData[0].length < csvData[i].length) {}
   }
-
   var csvStrings = [];
   csvData.forEach(function (column) {
     if (!column) {
       return;
     }
-
     for (var rowIndex = 0; rowIndex < csvData[0].length; rowIndex++) {
       var rowItem = column[rowIndex] || '';
-
       if (typeof csvStrings[rowIndex] !== 'string') {
         csvStrings[rowIndex] = '';
       }
-
       csvStrings[rowIndex] += "\"".concat(rowItem, "\",");
     }
   });

package/dist/esm/util/analytics.js

@@ -1,20 +1,15 @@
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
-
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
-import chalk from 'chalk'; // @ts-ignore
-
+import chalk from 'chalk';
+// @ts-ignore
 import inquirer from 'inquirer';
 import semver from 'semver';
 /* eslint-disable-next-line import/no-unresolved */
-
 import { analyticsClient } from '@atlassiansox/analytics-node-client';
 import { version as packageVersion } from '../version.json';
-
 function getUpgradeType(version, previousVersion) {
   if (previousVersion == null && version != null) {
     return 'add';
@@ -23,12 +18,10 @@ function getUpgradeType(version, previousVersion) {
   } else if (previousVersion != null && version != null && previousVersion !== version) {
     var coercedPrevious = semver.coerce(previousVersion);
     var coercedNew = semver.coerce(version);
-
     if (coercedNew == null) {
       console.error("Found invalid version \"".concat(version, "\", skipping"));
       return null;
     }
-
     if (coercedPrevious != null && semver.lt(coercedNew, coercedPrevious)) {
       return 'downgrade';
     } else {
@@ -38,41 +31,40 @@ function getUpgradeType(version, previousVersion) {
     return null;
   }
 }
-
 function getUpgradeSubType(version, previousVersion) {
   var upgradeSubType = null;
-
   if (version == null || previousVersion == null) {
     return upgradeSubType;
   }
-
   var parsedOld = semver.coerce(previousVersion);
   var parsedNew = semver.coerce(version);
-
   if (parsedOld && parsedNew) {
     upgradeSubType = semver.diff(parsedOld.version, parsedNew.version);
   }
-
   return upgradeSubType;
 }
-
 export function createUpgradeEvent(name, version, previousVersion, date) {
+  var _optionalArgs$tags, _ref, _tags$next, _tags$hotfix, _ref2;
   var optionalArgs = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
-
   if (Number.isNaN(Date.parse(date))) {
     throw new Error("Invalid date: '".concat(date, "'"));
   }
-
   var upgradeType = getUpgradeType(version, previousVersion);
-
   if (!upgradeType) {
     // Not an upgrade for this dependency, return null
     return null;
   }
-
   var upgradeSubType = getUpgradeSubType(version, previousVersion);
   var eventVersion = upgradeType !== 'remove' ? version : previousVersion;
   var parsedVersion = semver.coerce(eventVersion);
+  var rcKey = null;
+  var tags = (_optionalArgs$tags = optionalArgs === null || optionalArgs === void 0 ? void 0 : optionalArgs.tags) !== null && _optionalArgs$tags !== void 0 ? _optionalArgs$tags : {};
+  Object.keys(tags).forEach(function (key) {
+    if (key.startsWith('rc')) {
+      rcKey = key;
+      return;
+    }
+  });
   return _objectSpread({
     cliVersion: packageVersion,
     dependencyName: name,
@@ -82,33 +74,34 @@ export function createUpgradeEvent(name, version, previousVersion, date) {
     patch: parsedVersion ? "".concat(parsedVersion.patch) : null,
     date: new Date(date).toISOString(),
     upgradeType: upgradeType,
-    upgradeSubType: upgradeSubType
+    upgradeSubType: upgradeSubType,
+    latestTag: (_ref = tags && tags['latest']) !== null && _ref !== void 0 ? _ref : null,
+    nextTag: (_tags$next = tags['next']) !== null && _tags$next !== void 0 ? _tags$next : null,
+    hotfixTag: (_tags$hotfix = tags['hotfix']) !== null && _tags$hotfix !== void 0 ? _tags$hotfix : null,
+    rcTag: (_ref2 = rcKey && tags[rcKey]) !== null && _ref2 !== void 0 ? _ref2 : null
   }, optionalArgs);
 }
 export function sendAnalytics(_x, _x2) {
   return _sendAnalytics.apply(this, arguments);
 }
-
 function _sendAnalytics() {
-  _sendAnalytics = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(analyticsEvents, _ref) {
+  _sendAnalytics = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(analyticsEvents, _ref3) {
     var dev, limit, product, skipPrompt, analyticsEnv, eventsToSend, client, answers, promises;
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
           case 0:
-            dev = _ref.dev, limit = _ref.limit, product = _ref.product, skipPrompt = _ref.skipPrompt;
+            dev = _ref3.dev, limit = _ref3.limit, product = _ref3.product, skipPrompt = _ref3.skipPrompt;
             analyticsEnv = dev ? 'dev' : 'prod';
             eventsToSend = limit != null ? analyticsEvents.slice(0, limit) : analyticsEvents;
             client = analyticsClient({
               env: dev ? 'dev' : 'prod',
               product: product
             });
-
             if (skipPrompt) {
               _context.next = 9;
               break;
             }
-
             _context.next = 7;
             return inquirer.prompt([{
               type: 'confirm',
@@ -116,15 +109,12 @@ function _sendAnalytics() {
               message: "Are you sure you want to send ".concat(eventsToSend.length, " historical analytics events to '").concat(analyticsEnv, "' env for product '").concat(product, "?"),
               default: false
             }]);
-
           case 7:
             answers = _context.sent;
-
             if (!answers.continue) {
               console.log('Aborting');
               process.exit(0);
             }
-
           case 9:
             _context.prev = 9;
             _context.next = 12;
@@ -142,20 +132,17 @@ function _sendAnalytics() {
                 }
               });
             }));
-
           case 12:
             promises = _context.sent;
             console.log(chalk.green("Sent ".concat(promises.length, " dependency version upgrade analytics events")));
             _context.next = 21;
             break;
-
           case 16:
             _context.prev = 16;
             _context.t0 = _context["catch"](9);
             console.error(chalk.red('Sending analytics failed'));
             console.error(_context.t0);
             process.exit(1);
-
           case 21:
           case "end":
             return _context.stop();

package/dist/esm/util/env-with-guard.js

@@ -2,6 +2,5 @@ export default function (name) {
   if (!process.env.hasOwnProperty(name) || !process.env[name] || typeof process.env[name] !== 'string') {
     return null;
   }
-
   return process.env[name];
 }

package/dist/esm/util/get-file-history-from-git.js

@@ -1,5 +1,6 @@
-import { exec } from 'child_process'; // Lock files tend to be huge
+import { exec } from 'child_process';
 
+// Lock files tend to be huge
 var FiveMBBuffer = 1024 * 5000;
 export default function getFileHistoryFromGit(fileName) {
   return new Promise(function (resolve, reject) {
@@ -9,11 +10,9 @@ export default function getFileHistoryFromGit(fileName) {
       if (error) {
         reject(error);
       }
-
       if (stderr) {
         reject(stderr);
       }
-
       resolve(stdout);
     });
   });