Merge pull request #31577 from storybookjs/tom/refactor-storybookId-in-telemetry

Telemetry: Use version from our package.json for `storybookVersion`

Author: shilman

code/core/src/cli/bin/index.ts

@@ -1,4 +1,4 @@
-import { getEnvConfig, parseList, versions } from 'storybook/internal/common';
+import { getEnvConfig, parseList } from 'storybook/internal/common';
 import { logger } from 'storybook/internal/node-logger';
 import { addToGlobalContext } from 'storybook/internal/telemetry';
 
@@ -14,7 +14,7 @@ import { buildIndex as index } from '../buildIndex';
 import { dev } from '../dev';
 import { globalSettings } from '../globalSettings';
 
-addToGlobalContext('cliVersion', versions.storybook);
+addToGlobalContext('cliVersion', version);
 
 const consoleLogger = console;
 

code/core/src/telemetry/storybook-metadata.ts

@@ -13,6 +13,7 @@ import type { PackageJson, StorybookConfig } from 'storybook/internal/types';
 import { findPackage, findPackagePath } from 'fd-package-json';
 import { detect } from 'package-manager-detector';
 
+import { version } from '../../package.json';
 import { globalSettings } from '../cli/globalSettings';
 import { getApplicationFileCount } from './get-application-file-count';
 import { getChromaticVersionSpecifier } from './get-chromatic-version';
@@ -227,7 +228,6 @@ export const computeStorybookMetadata = async ({
     // gracefully handle error, as it's not critical information and AST parsing can cause trouble
   }
 
-  const storybookVersion = storybookPackages[storybookInfo.frameworkPackage]?.version;
   const portableStoriesFileCount = await getPortableStoriesFileCount();
   const applicationFileCount = await getApplicationFileCount(dirname(packageJsonPath));
 
@@ -236,7 +236,7 @@ export const computeStorybookMetadata = async ({
     ...frameworkInfo,
     portableStoriesFileCount,
     applicationFileCount,
-    storybookVersion,
+    storybookVersion: version,
     storybookVersionSpecifier: storybookInfo.version,
     language,
     storybookPackages,

code/core/src/telemetry/telemetry.ts

@@ -4,6 +4,7 @@ import * as os from 'node:os';
 import retry from 'fetch-retry';
 import { nanoid } from 'nanoid';
 
+import { version } from '../../package.json';
 import { getAnonymousProjectId } from './anonymous-id';
 import { set as saveToCache } from './event-cache';
 import { fetch } from './fetch';
@@ -48,6 +49,7 @@ const globalContext = {
   isTTY: process.stdout.isTTY,
   platform: getOperatingSystem(),
   nodeVersion: process.versions.node,
+  storybookVersion: version,
 } as Record<string, any>;
 
 const prepareRequest = async (data: TelemetryData, context: Record<string, any>, options: any) => {

scripts/event-log-checker.ts

@@ -55,10 +55,18 @@ async function run() {
 
     const [bootEvent, mainEvent] = events;
 
-    test(`both events should have cliVersion in context`, () => {
-      const cliVersion = versions.storybook;
-      assert.equal(bootEvent.context.cliVersion, cliVersion);
-      assert.equal(mainEvent.context.cliVersion, cliVersion);
+    const storybookVersion = versions.storybook;
+    test('boot event should have cliVersion and storybookVersion in context', () => {
+      assert.equal(bootEvent.context.cliVersion, storybookVersion);
+      assert.equal(bootEvent.context.storybookVersion, storybookVersion);
+    });
+
+    test(`main event should have storybookVersion in context`, () => {
+      assert.equal(mainEvent.context.storybookVersion, storybookVersion);
+    });
+
+    test(`main event should have storybookVersion in metadata`, () => {
+      assert.equal(mainEvent.metadata.storybookVersion, storybookVersion);
     });
 
     test(`Should log a boot event with a payload of type ${eventType}`, () => {