@atlaskit/dependency-version-analytics 0.4.2 → 1.1.0

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

@@ -6,7 +6,7 @@ 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';
 const getUpgradeEventsFromPkgChange = (oldDeps, newDeps, {
   date,
   commitHash
@@ -15,9 +15,9 @@ const getUpgradeEventsFromPkgChange = (oldDeps, newDeps, {
     version,
     type
   }]) => {
-    const prevDep = oldDeps[name]; // Only treat a dependency as previous if the dependency type matches
+    const prevDep = oldDeps[name];
+    // Only treat a dependency as previous if the dependency type matches
     // Otherwise, we want separate add/remove events
-
     const prevVersion = prevDep && prevDep.type === type ? prevDep.version : undefined;
     return createUpgradeEvent(name, version, prevVersion, date, {
       commitHash,
@@ -27,7 +27,8 @@ const getUpgradeEventsFromPkgChange = (oldDeps, newDeps, {
   }).filter(e => e != null);
   const removeEvents = Object.entries(oldDeps).filter(([name, {
     type
-  }]) => // Treat the same dep under a different dependency type as a new dep
+  }]) =>
+  // Treat the same dep under a different dependency type as a new dep
   newDeps[name] == null || newDeps[name].type !== type).map(([name, {
     version,
     type
@@ -40,23 +41,19 @@ const getUpgradeEventsFromPkgChange = (oldDeps, newDeps, {
   }).filter(e => e != null);
   return [...addOrUpgradeEvents, ...removeEvents];
 };
-
 const getEventsFromHistory = async (packageChangesLog, prevRunHash, {
   cwd
 }) => {
   const allPackageChanges = [];
-  const allUpgradeEvents = [];
+  let allUpgradeEvents = [];
   assert(packageChangesLog.all.length > 0, '');
   let dependencyStore = new DependencyStore(cwd);
   let dependencies = await dependencyStore.initialise(prevRunHash);
-
   for (let i = 0; i < packageChangesLog.all.length; i++) {
     let item = packageChangesLog.all[i];
-
     if (allPackageChanges.length > 0) {
       dependencies = allPackageChanges[allPackageChanges.length - 1].akDeps;
     }
-
     const newDependencies = await dependencyStore.update(item);
     const packageChange = {
       date: new Date(item.date).toISOString(),
@@ -66,69 +63,71 @@ const getEventsFromHistory = async (packageChangesLog, prevRunHash, {
       date: packageChange.date,
       commitHash: item.hash
     });
-
     if (upgradeEvents.length > 0) {
       allUpgradeEvents.push(...upgradeEvents);
       allPackageChanges.push(packageChange);
     }
   }
-
+  // add dist-tags to upgrade event
+  allUpgradeEvents = await Promise.all(allUpgradeEvents.map(async upgradeEvent => {
+    var _distTags$hotfix, _distTags$latest, _distTags$next;
+    const getPackageTags = await getPackageVersionHistoryAndTags(upgradeEvent.dependencyName);
+    const distTags = getPackageTags['dist-tags'];
+    Object.keys(distTags).forEach(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 upgradeEvent;
+  }));
   return {
     allPackageChanges,
     allUpgradeEvents
   };
 };
-
 async function getSinceRef(flags) {
   if (flags.statlas) {
     const meta = await statlas.getMeta(flags.product);
-
     if (!meta || !meta.lastRunHash) {
       throw new Error(chalk.red(`Missing or invalid metadata file for ${flags.product}. Must use --reset for populating from start of history`));
     }
-
     return meta.lastRunHash;
   } else {
     const tag = flags.tag || DEFAULT_TAG;
     await refetchTag(tag);
     const tagExists = await doesTagExist(tag);
-
     if (!tagExists) {
       throw new Error(chalk.red(`Tag '${tag}' does not exist. Must use --reset for populating from start of history.`));
     }
-
     return tag;
   }
 }
-
 export default async function populateProduct(flags) {
   const cwd = flags.cwd || process.cwd();
   const sinceRef = flags.reset ? undefined : await getSinceRef(flags);
   const log = await getChangesSince(sinceRef);
-
   if (log.all.length === 0) {
     console.log(`No package.json changes found since '${sinceRef}'.`);
     return;
   }
-
   const {
     allPackageChanges,
     allUpgradeEvents
   } = await getEventsFromHistory(log, sinceRef, {
     cwd
   });
-
   if (flags.csv) {
     const csv = generateCSV(allPackageChanges);
     console.log(csv);
     return;
   }
-
   if (flags.dryRun) {
     console.log(JSON.stringify(allUpgradeEvents));
     return;
   }
-
   if (allUpgradeEvents.length > 0) {
     await sendAnalytics(allUpgradeEvents, {
       dev: flags.dev,
@@ -139,7 +138,6 @@ export default async function populateProduct(flags) {
   } else {
     console.log(`Found no AK dependency changes since last run from ref "${sinceRef}"'`);
   }
-
   if (flags.statlas) {
     // Upload latest commit to statlas
     const currentCommit = await getHash('HEAD');

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

@@ -8,16 +8,14 @@ export const generateCSV = packageChanges => {
       version
     }]) => {
       let depColumnIndex = csvData.findIndex(item => item[0] === name);
-
       if (depColumnIndex === -1) {
         depColumnIndex = csvData.push([name]) - 1;
-      } // console.log(csvData)
-
+      }
 
+      // console.log(csvData)
       csvData[depColumnIndex][currentRow] = version;
     });
   });
-
   for (let i = 0; i < csvData.length; i++) {
     for (let j = 0; j < csvData.length; j++) {
       if (typeof csvData[i][j] !== 'string') {
@@ -25,23 +23,18 @@ export const generateCSV = packageChanges => {
         csvData[i][j] = '';
       }
     }
-
     if (i !== 0 && csvData[0].length < csvData[i].length) {}
   }
-
   const csvStrings = [];
   csvData.forEach(column => {
     if (!column) {
       return;
     }
-
     for (let rowIndex = 0; rowIndex < csvData[0].length; rowIndex++) {
       const rowItem = column[rowIndex] || '';
-
       if (typeof csvStrings[rowIndex] !== 'string') {
         csvStrings[rowIndex] = '';
       }
-
       csvStrings[rowIndex] += `"${rowItem}",`;
     }
   });

package/dist/es2019/util/analytics.js

@@ -1,12 +1,10 @@
-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';
@@ -15,12 +13,10 @@ function getUpgradeType(version, previousVersion) {
   } else if (previousVersion != null && version != null && previousVersion !== version) {
     const coercedPrevious = semver.coerce(previousVersion);
     const coercedNew = semver.coerce(version);
-
     if (coercedNew == null) {
       console.error(`Found invalid version "${version}", skipping`);
       return null;
     }
-
     if (coercedPrevious != null && semver.lt(coercedNew, coercedPrevious)) {
       return 'downgrade';
     } else {
@@ -30,39 +26,39 @@ function getUpgradeType(version, previousVersion) {
     return null;
   }
 }
-
 function getUpgradeSubType(version, previousVersion) {
   let upgradeSubType = null;
-
   if (version == null || previousVersion == null) {
     return upgradeSubType;
   }
-
   const parsedOld = semver.coerce(previousVersion);
   const parsedNew = semver.coerce(version);
-
   if (parsedOld && parsedNew) {
     upgradeSubType = semver.diff(parsedOld.version, parsedNew.version);
   }
-
   return upgradeSubType;
 }
-
 export function createUpgradeEvent(name, version, previousVersion, date, optionalArgs = {}) {
+  var _optionalArgs$tags, _ref, _tags$next, _tags$hotfix, _ref2;
   if (Number.isNaN(Date.parse(date))) {
     throw new Error(`Invalid date: '${date}'`);
   }
-
   const upgradeType = getUpgradeType(version, previousVersion);
-
   if (!upgradeType) {
     // Not an upgrade for this dependency, return null
     return null;
   }
-
   const upgradeSubType = getUpgradeSubType(version, previousVersion);
   const eventVersion = upgradeType !== 'remove' ? version : previousVersion;
   const parsedVersion = semver.coerce(eventVersion);
+  let rcKey = null;
+  const tags = (_optionalArgs$tags = optionalArgs === null || optionalArgs === void 0 ? void 0 : optionalArgs.tags) !== null && _optionalArgs$tags !== void 0 ? _optionalArgs$tags : {};
+  Object.keys(tags).forEach(key => {
+    if (key.startsWith('rc')) {
+      rcKey = key;
+      return;
+    }
+  });
   return {
     cliVersion: packageVersion,
     dependencyName: name,
@@ -73,6 +69,10 @@ export function createUpgradeEvent(name, version, previousVersion, date, optiona
     date: new Date(date).toISOString(),
     upgradeType,
     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
   };
 }
@@ -88,7 +88,6 @@ export async function sendAnalytics(analyticsEvents, {
     env: dev ? 'dev' : 'prod',
     product: product
   });
-
   if (!skipPrompt) {
     const answers = await inquirer.prompt([{
       type: 'confirm',
@@ -96,13 +95,11 @@ export async function sendAnalytics(analyticsEvents, {
       message: `Are you sure you want to send ${eventsToSend.length} historical analytics events to '${analyticsEnv}' env for product '${product}?`,
       default: false
     }]);
-
     if (!answers.continue) {
       console.log('Aborting');
       process.exit(0);
     }
   }
-
   try {
     const promises = await Promise.all(eventsToSend.map(event => {
       return client.sendTrackEvent({
@@ -112,7 +109,8 @@ export async function sendAnalytics(analyticsEvents, {
           source: '@atlaskit/dependency-version-analytics',
           action: 'upgraded',
           actionSubject: 'akDependency',
-          attributes: { ...event
+          attributes: {
+            ...event
           },
           origin: 'console',
           platform: 'bot'

package/dist/es2019/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/es2019/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
 const FiveMBBuffer = 1024 * 5000;
 export default function getFileHistoryFromGit(fileName) {
   return new Promise((resolve, reject) => {
@@ -9,11 +10,9 @@ export default function getFileHistoryFromGit(fileName) {
       if (error) {
         reject(error);
       }
-
       if (stderr) {
         reject(stderr);
       }
-
       resolve(stdout);
     });
   });

package/dist/es2019/util/get-package-version-history.js

@@ -1,23 +1,23 @@
 import { exec } from 'child_process';
-export default function getPackageVersionHistory(packageName) {
+export default function getPackageVersionHistoryAndTags(packageName) {
   return new Promise((resolve, reject) => {
-    exec(`yarn info ${packageName} --json time`, (error, stdout, stderr) => {
+    exec(`yarn info ${packageName} --json`, (error, stdout, stderr) => {
       if (error) {
         reject(error);
       }
-
       if (stderr) {
         reject(stderr);
       }
-
       let json;
-
       try {
-        json = JSON.parse(stdout).data;
+        const parseData = JSON.parse(stdout).data;
+        json = {
+          time: parseData['time'],
+          'dist-tags': parseData['dist-tags']
+        };
       } catch (e) {
         reject(`Error parsing json output: ${e}`);
       }
-
       resolve(json);
     });
   });

package/dist/es2019/util/git.js

@@ -1,35 +1,40 @@
 // @ts-ignore
+
 import git from 'simple-git';
 import { assert } from './assert';
 export async function getChangesSince(since) {
   const revisionRange = since ? [`${since}..`] : [];
-  const listLogSummary = await git().log([// Only commits on mainline master
-  '--first-parent', // Show merge commit contents
-  '-m', // Reverse the order
-  '--reverse', // Show filename changes - simple-git parses --stat flag but not --name-only unfortunately
-  '--stat=4096', // Make +- graph width as small as possible to maximise filename length
-  '--stat-graph-width=1', ...revisionRange, // Any commit that modifies a package.json
+  const listLogSummary = await git().log([
+  // Only commits on mainline master
+  '--first-parent',
+  // Show merge commit contents
+  '-m',
+  // Reverse the order
+  '--reverse',
+  // Show filename changes - simple-git parses --stat flag but not --name-only unfortunately
+  '--stat=4096',
+  // Make +- graph width as small as possible to maximise filename length
+  '--stat-graph-width=1', ...revisionRange,
+  // Any commit that modifies a package.json
   ':(glob)**/package.json']);
-  return { ...listLogSummary,
+  return {
+    ...listLogSummary,
     all: listLogSummary.all.map(logLine => parseLogLine(logLine))
   };
 }
-
 function parseLogLine(logLine) {
   if (!logLine.diff) {
     return logLine;
-  } // Split files into separate entries when a rename has occurred so both old and new files are processed
-
+  }
 
+  // Split files into separate entries when a rename has occurred so both old and new files are processed
   const parsedDiffFiles = logLine.diff.files.reduce((acc, curr) => {
     const renameArrowCount = curr.file.match(/ => /g);
-
     if (renameArrowCount == null) {
       return [...acc, curr];
-    } // Multiple rename parts are not supported. They most likely don't exist in git but we check
+    }
+    // Multiple rename parts are not supported. They most likely don't exist in git but we check
     // for them anyway just in case
-
-
     assert(renameArrowCount.length === 1, `Multiple rename parts detected: ${curr.file}`);
     /* Matches:
      * - '{new-frontend/src => src}/package.json'
@@ -37,25 +42,28 @@ function parseLogLine(logLine) {
      * - 'src/{ => platform}/analytics/package.json'
      * - 'src/packages/spa/{main => }/package.json'
      */
-
     const renameMatch = curr.file.match(/\{?([^{]+)? => ([^}]+)?\}?/);
     assert(renameMatch != null, `Invalid rename format ${curr.file}`);
-    const oldFile = curr.file.replace(renameMatch[0], renameMatch[1] || '') // If the previous name segment is empty, we will have a double slash
+    const oldFile = curr.file.replace(renameMatch[0], renameMatch[1] || '')
+    // If the previous name segment is empty, we will have a double slash
     .replace('//', '/');
     const newFile = curr.file.replace(renameMatch[0], renameMatch[2] || '').replace('//', '/');
-    return [...acc, { ...curr,
+    return [...acc, {
+      ...curr,
       file: oldFile
-    }, { ...curr,
+    }, {
+      ...curr,
       file: newFile
     }];
   }, []);
-  return { ...logLine,
-    diff: { ...logLine.diff,
+  return {
+    ...logLine,
+    diff: {
+      ...logLine.diff,
       files: parsedDiffFiles
     }
   };
 }
-
 export async function tagCommit(tag) {
   return git().tag(['-f', tag]);
 }
@@ -74,9 +82,7 @@ export async function refetchTag(tag) {
       throw e;
     }
   }
-
   let fetchTagResult;
-
   try {
     fetchTagResult = await git().fetch(['origin', 'tag', tag]);
   } catch (e) {
@@ -85,7 +91,6 @@ export async function refetchTag(tag) {
       throw e;
     }
   }
-
   return {
     fetchTagResult
   };

package/dist/es2019/util/statlas.js

@@ -9,25 +9,20 @@ export function uploadMeta(product, lastRunHash) {
     lastRunHash
   });
 }
-
 function getProductMetaPath(product) {
   return `product/${product}.json`;
 }
-
 async function retrieveJSON(filepath) {
   const response = await fetch(`${STATLAS_BASE_URL}/${filepath}?statlasredirect`);
   let json = null;
-
   if (response.ok) {
     json = await response.json();
   }
-
   return {
     json,
     rawResponse: response
   };
 }
-
 async function uploadJSON(filepath, json) {
   const res = await fetch(`${STATLAS_BASE_URL}/${filepath}`, {
     method: 'PUT',
@@ -36,7 +31,6 @@ async function uploadJSON(filepath, json) {
       Authorization: `Bearer ${process.env.bamboo_JWT_TOKEN}`
     }
   });
-
   if (!res.ok) {
     throw new Error(`Statlas upload failed: ${res.statusText}`);
   }

package/dist/es2019/util/yarn.js

@@ -6,7 +6,6 @@ const rootPackageJsonPath = 'package.json';
 const debug = debugModule('atlaskit:yarn');
 export async function getWorkspaceGlobs(ref, cwd) {
   let file;
-
   try {
     file = await git.showFile(ref, rootPackageJsonPath, {
       cwd
@@ -15,23 +14,18 @@ export async function getWorkspaceGlobs(ref, cwd) {
     debug(`${rootPackageJsonPath} does not exist`);
     return new Set([]);
   }
-
   let rootPackageJsonFile;
-
   try {
     rootPackageJsonFile = JSON.parse(file);
   } catch (e) {
     console.error(`Error parsing ${file}@${ref}: ${e}`);
     return null;
   }
-
   const workspaces = rootPackageJsonFile.workspaces;
-
   if (!workspaces) {
     return new Set([rootPackageJsonPath]);
-  } // There are actually two formats for workspaces and they are poorly documented
-
-
+  }
+  // There are actually two formats for workspaces and they are poorly documented
   const workspacePackages = Array.isArray(workspaces) ? workspaces : workspaces.packages;
   return new Set([rootPackageJsonPath, ...workspacePackages.map(glob => path.join(glob, 'package.json'))]);
 }
@@ -39,15 +33,12 @@ export async function getWorkspacePaths(ref, workspaceGlobs, cwd) {
   if (workspaceGlobs.size === 0) {
     return [];
   }
-
   const workspacePackageJsons = await git.getFiles(ref, '**/package.json', {
     cwd
   });
   const matchedWorkspaces = micromatch(workspacePackageJsons, [...workspaceGlobs]);
-
   if (matchedWorkspaces.length === 0) {
     throw new Error(`Could not find any workspace or package.json under ${cwd}`);
   }
-
   return matchedWorkspaces;
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/dependency-version-analytics",
-	"version": "0.4.2",
+	"version": "1.1.0",
 	"sideEffects": false
 }

package/dist/esm/cli.js

@@ -1,9 +1,11 @@
 import _toArray from "@babel/runtime/helpers/toArray";
 /// <reference lib="es2017.object" />
+
 import chalk from 'chalk';
 import meow from 'meow';
-import { populateProduct, populatePackage } from './commands/populate-historic-data'; // prettier-ignore
+import { populateProduct, populatePackage } from './commands/populate-historic-data';
 
+// prettier-ignore
 var HELP_MSG = "\n".concat(chalk.green('Global options'), "\n     ").concat(chalk.yellow('--dev'), "            Send analytics to dev analytics pipeline instead of prod\n     ").concat(chalk.yellow('--dryRun'), "         Performs a dry run, prints analytics events to console in JSON format instead of sending them\n     ").concat(chalk.yellow('--limit'), "          Limit the number of events sent, used for validation purposes\n     ").concat(chalk.yellow('--no-interactive'), " Disable any interactive prompts\n\n").concat(chalk.yellow.bold('[populate-product] <product>'), "\n   Sends analytics events for atlaskit dependency versions changes in package.json.\n\n   Detects changes since the last time the tool was run by storing the last run in either statlas (--statlas flag) or using the\n   'atlaskit-dependency-version-analytics-last-run' git tag.\n   If running the tool for the first time (last run does not exist), --reset must be used to detect changes since the beginning of the repo.\n\n   ").concat(chalk.green('Options'), "\n     ").concat(chalk.yellow('--csv'), "         Prints AK dependency history in CSV format\n     ").concat(chalk.yellow('--reset'), "       Reset change detection to detect changes from the beginning of time\n     ").concat(chalk.yellow('--tag'), "         Specify a different tag to mark when the tool was last run\n     ").concat(chalk.yellow('--statlas'), "     Use statlas rather than git tags for storing and sourcing last run info\n\n   ").concat(chalk.green('Examples'), "\n     ").concat(chalk.dim('$ atlaskit-version-analytics populate-product jira'), "\n\n").concat(chalk.yellow.bold('[populate-package] <package>'), "\n   Sends analytics events for published versions of the specified atlaskit package.\n\n   ").concat(chalk.green('Options'), "\n     ").concat(chalk.yellow('--since'), "       Only publish versions since the following JS date string (exclusive)\n\n   ").concat(chalk.green('Examples'), "\n     ").concat(chalk.dim('$ atlaskit-version-analytics populate-package @atlaskit/button'), "\n");
 export function run(_ref) {
   var dev = _ref.dev;
@@ -40,21 +42,16 @@ export function run(_ref) {
       }
     }
   });
-
   var _cli$input = _toArray(cli.input),
-      command = _cli$input[0],
-      inputs = _cli$input.slice(1);
-
+    command = _cli$input[0],
+    inputs = _cli$input.slice(1);
   var limit = cli.flags.limit != null ? +cli.flags.limit : undefined;
-
   if (command === 'populate-product') {
     var product = inputs[0];
-
     if (!product) {
       console.error(chalk.red('Must pass a product parameter'));
       process.exit(1);
     }
-
     return populateProduct({
       csv: cli.flags.csv || false,
       dev: dev || cli.flags.dev || false,
@@ -68,12 +65,10 @@ export function run(_ref) {
     });
   } else if (command === 'populate-package') {
     var pkg = inputs[0];
-
     if (!pkg) {
       console.error(chalk.red('Must pass a package parameter'));
       process.exit(1);
     }
-
     return populatePackage({
       dev: dev || cli.flags.dev || false,
       dryRun: cli.flags.dryRun || false,
@@ -83,8 +78,7 @@ export function run(_ref) {
       since: cli.flags.since
     });
   }
-  /* eslint-disable no-console */
-
 
+  /* eslint-disable no-console */
   return Promise.resolve(console.log(cli.help));
 }