CLI: Add upgrade telemetry details

code/lib/cli/src/automigrate/index.ts

@@ -9,29 +9,44 @@ import { fixes } from './fixes';
 
 const logger = console;
 
+type FixId = string;
+
 interface FixOptions {
-  fixId?: string;
+  fixId?: FixId;
   yes?: boolean;
   dryRun?: boolean;
   useNpm?: boolean;
   force?: PackageManagerName;
 }
 
+enum FixStatus {
+  CHECK_FAILED = 'check_failed',
+  UNNECESSARY = 'unnecessary',
+  SKIPPED = 'skipped',
+  SUCCEEDED = 'succeeded',
+  FAILED = 'failed',
+}
+
 export const automigrate = async ({ fixId, dryRun, yes, useNpm, force }: FixOptions = {}) => {
   const packageManager = JsPackageManagerFactory.getPackageManager({ useNpm, force });
   const filtered = fixId ? fixes.filter((f) => f.id === fixId) : fixes;
 
   logger.info('🔎 checking possible migrations..');
+  const fixResults = {} as Record<FixId, FixStatus>;
 
   for (let i = 0; i < filtered.length; i += 1) {
     const f = fixes[i] as Fix;
     let result;
+    let fixStatus;
     try {
       result = await f.check({ packageManager });
     } catch (e) {
+      fixStatus = FixStatus.CHECK_FAILED;
       logger.info(`failed to check fix: ${f.id}`);
     }
-    if (result) {
+    if (!result) {
+      fixStatus = FixStatus.UNNECESSARY;
+    } else {
       logger.info(`🔎 found a '${chalk.cyan(f.id)}' migration:`);
       logger.info();
       const message = f.prompt(result);
@@ -58,22 +73,29 @@ export const automigrate = async ({ fixId, dryRun, yes, useNpm, force }: FixOpti
         try {
           await f.run({ result, packageManager, dryRun });
           logger.info(`✅ ran ${chalk.cyan(f.id)} migration`);
+          fixStatus = FixStatus.SUCCEEDED;
         } catch (error) {
+          fixStatus = FixStatus.FAILED;
           logger.info(`❌ error when running ${chalk.cyan(f.id)} migration:`);
           logger.info(error);
           logger.info();
         }
       } else {
+        fixStatus = FixStatus.SKIPPED;
         logger.info(`Skipping the ${chalk.cyan(f.id)} migration.`);
         logger.info();
         logger.info(
           `If you change your mind, run '${chalk.cyan('npx storybook@next automigrate')}'`
         );
       }
     }
+
+    fixResults[f.id] = fixStatus;
   }
 
   logger.info();
   logger.info('✅ migration check successfully ran');
   logger.info();
+
+  return fixResults;
 };

code/lib/cli/src/generate.ts

@@ -189,12 +189,12 @@ program
   .option('-n --dry-run', 'Only check for fixes, do not actually run them')
   .option('--package-manager <npm|pnpm|yarn1|yarn2>', 'Force package manager')
   .option('-N --use-npm', 'Use npm as package manager (deprecated)')
-  .action((fixId, options) =>
-    automigrate({ fixId, ...options }).catch((e) => {
+  .action(async (fixId, options) => {
+    await automigrate({ fixId, ...options }).catch((e) => {
       logger.error(e);
       process.exit(1);
-    })
-  );
+    });
+  });
 
 program
   .command('dev')

code/lib/cli/src/upgrade.ts

@@ -1,5 +1,5 @@
 import { sync as spawnSync } from 'cross-spawn';
-import { telemetry } from '@storybook/telemetry';
+import { telemetry, getStorybookCoreVersion } from '@storybook/telemetry';
 import semver from 'semver';
 import { logger } from '@storybook/node-logger';
 import { withTelemetry } from '@storybook/core-server';
@@ -159,10 +159,9 @@ export const doUpgrade = async ({
   }
   const packageManager = JsPackageManagerFactory.getPackageManager({ useNpm, force: pkgMgr });
 
+  const beforeVersion = await getStorybookCoreVersion();
+
   commandLog(`Checking for latest versions of '@storybook/*' packages`);
-  if (!options.disableTelemetry) {
-    telemetry('upgrade', { prerelease });
-  }
 
   let flags = [];
   if (!dryRun) flags.push('--upgrade');
@@ -180,9 +179,15 @@ export const doUpgrade = async ({
     packageManager.installDependencies();
   }
 
+  let automigrationResults;
   if (!skipCheck) {
     checkVersionConsistency();
-    await automigrate({ dryRun, yes, useNpm, force: pkgMgr });
+    automigrationResults = await automigrate({ dryRun, yes, useNpm, force: pkgMgr });
+  }
+
+  if (!options.disableTelemetry) {
+    const afterVersion = await getStorybookCoreVersion();
+    telemetry('upgrade', { prerelease, automigrationResults, beforeVersion, afterVersion });
   }
 };
 

code/lib/telemetry/src/index.ts

@@ -9,6 +9,8 @@ export * from './storybook-metadata';
 
 export * from './types';
 
+export { getStorybookCoreVersion } from './package-json';
+
 export const telemetry = async (
   eventType: EventType,
   payload: Payload = {},

code/lib/telemetry/src/package-json.ts

@@ -1,3 +1,4 @@
+import { readJson } from 'fs-extra';
 import path from 'path';
 
 import type { Dependency } from './types';
@@ -20,7 +21,17 @@ export const getActualPackageVersion = async (packageName: string) => {
 };
 
 export const getActualPackageJson = async (packageName: string) => {
-  // eslint-disable-next-line import/no-dynamic-require,global-require
-  const packageJson = require(path.join(packageName, 'package.json'));
+  const resolvedPackageJson = require.resolve(path.join(packageName, 'package.json'), {
+    paths: [process.cwd()],
+  });
+  const packageJson = await readJson(resolvedPackageJson);
   return packageJson;
 };
+
+// Note that this probably doesn't work in PNPM mode
+export const getStorybookCoreVersion = async () => {
+  const coreVersions = await Promise.all(
+    ['@storybook/core-common', '@storybook/core-server'].map(getActualPackageVersion)
+  );
+  return coreVersions.find((v) => v.version)?.version;
+};