Merge pull request #21999 from storybookjs/shilman/cli-version-telemetry

Telemetry: Add CLI version to context

Author: shilman

code/frameworks/angular/package.json

@@ -49,6 +49,7 @@
     "@storybook/manager-api": "7.1.0-alpha.0",
     "@storybook/node-logger": "7.1.0-alpha.0",
     "@storybook/preview-api": "7.1.0-alpha.0",
+    "@storybook/telemetry": "7.1.0-alpha.0",
     "@storybook/types": "7.1.0-alpha.0",
     "@types/node": "^16.0.0",
     "@types/react": "^16.14.34",

code/frameworks/angular/src/builders/build-storybook/index.ts

@@ -13,7 +13,8 @@ import { sync as readUpSync } from 'read-pkg-up';
 import { BrowserBuilderOptions, StylePreprocessorOptions } from '@angular-devkit/build-angular';
 
 import { CLIOptions } from '@storybook/types';
-import { getEnvConfig } from '@storybook/cli';
+import { getEnvConfig, versions } from '@storybook/cli';
+import { addToGlobalContext } from '@storybook/telemetry';
 
 import { buildStaticStandalone, withTelemetry } from '@storybook/core-server';
 import {
@@ -24,6 +25,8 @@ import { StandaloneOptions } from '../utils/standalone-options';
 import { runCompodoc } from '../utils/run-compodoc';
 import { errorSummary, printErrorDetails } from '../utils/error-handler';
 
+addToGlobalContext('cliVersion', versions.storybook);
+
 export type StorybookBuilderOptions = JsonObject & {
   browserTarget?: string | null;
   tsConfig?: string;

code/frameworks/angular/src/builders/start-storybook/index.ts

@@ -13,8 +13,8 @@ import { sync as findUpSync } from 'find-up';
 import { sync as readUpSync } from 'read-pkg-up';
 
 import { CLIOptions } from '@storybook/types';
-import { getEnvConfig } from '@storybook/cli';
-
+import { getEnvConfig, versions } from '@storybook/cli';
+import { addToGlobalContext } from '@storybook/telemetry';
 import { buildDevStandalone, withTelemetry } from '@storybook/core-server';
 import {
   AssetPattern,
@@ -24,6 +24,8 @@ import { StandaloneOptions } from '../utils/standalone-options';
 import { runCompodoc } from '../utils/run-compodoc';
 import { printErrorDetails, errorSummary } from '../utils/error-handler';
 
+addToGlobalContext('cliVersion', versions.storybook);
+
 export type StorybookBuilderOptions = JsonObject & {
   browserTarget?: string | null;
   tsConfig?: string;

code/lib/cli/src/generate.ts

@@ -6,6 +6,7 @@ import leven from 'leven';
 import { sync as readUpSync } from 'read-pkg-up';
 
 import { logger } from '@storybook/node-logger';
+import { addToGlobalContext } from '@storybook/telemetry';
 
 import type { CommandOptions } from './generators/types';
 import { initiate } from './initiate';
@@ -20,6 +21,9 @@ import { generateStorybookBabelConfigInCWD } from './babel-config';
 import { dev } from './dev';
 import { build } from './build';
 import { parseList, getEnvConfig } from './utils';
+import versions from './versions';
+
+addToGlobalContext('cliVersion', versions.storybook);
 
 const pkg = readUpSync({ cwd: __dirname }).packageJson;
 const consoleLogger = console;

code/lib/cli/src/index.ts

@@ -1,2 +1,6 @@
+import versions from './versions';
+
+export { versions };
+
 export * from './js-package-manager';
 export * from './utils';

code/lib/telemetry/src/index.ts

@@ -15,6 +15,8 @@ export { getStorybookCoreVersion } from './package-json';
 
 export { getPrecedingUpgrade } from './event-cache';
 
+export { addToGlobalContext } from './telemetry';
+
 export const telemetry = async (
   eventType: EventType,
   payload: Payload = {},

code/lib/telemetry/src/telemetry.ts

@@ -16,6 +16,18 @@ let tasks: Promise<any>[] = [];
 // send telemetry
 const sessionId = nanoid();
 
+export const addToGlobalContext = (key: string, value: any) => {
+  globalContext[key] = value;
+};
+
+// context info sent with all events, provided
+// by the app. currently:
+// - cliVersion
+const globalContext = {
+  inCI: Boolean(process.env.CI),
+  isTTY: process.stdout.isTTY,
+} as Record<string, any>;
+
 export async function sendTelemetry(
   data: TelemetryData,
   options: Partial<Options> = { retryDelay: 1000, immediate: false }
@@ -27,11 +39,10 @@ export async function sendTelemetry(
   // flatten the data before we send it
   const { eventType, payload, metadata, ...rest } = data;
   const context = options.stripMetadata
-    ? {}
+    ? globalContext
     : {
+        ...globalContext,
         anonymousId: getAnonymousProjectId(),
-        inCI: Boolean(process.env.CI),
-        isTTY: process.stdout.isTTY,
       };
   const eventId = nanoid();
   const body = { ...rest, eventType, eventId, sessionId, metadata, payload, context };

code/yarn.lock

@@ -5636,6 +5636,7 @@ __metadata:
     "@storybook/manager-api": 7.1.0-alpha.0
     "@storybook/node-logger": 7.1.0-alpha.0
     "@storybook/preview-api": 7.1.0-alpha.0
+    "@storybook/telemetry": 7.1.0-alpha.0
     "@storybook/types": 7.1.0-alpha.0
     "@types/node": ^16.0.0
     "@types/react": ^16.14.34

scripts/event-log-checker.ts

@@ -3,6 +3,7 @@ import chalk from 'chalk';
 import assert from 'assert';
 import fetch from 'node-fetch';
 import { allTemplates } from '../code/lib/cli/src/sandbox-templates';
+import versions from '../code/lib/cli/src/versions';
 import { oneWayHash } from '../code/lib/telemetry/src/one-way-hash';
 
 const PORT = process.env.PORT || 6007;
@@ -48,6 +49,12 @@ 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);
+    });
+
     test(`Should log a boot event with a payload of type ${eventType}`, () => {
       assert.equal(bootEvent.eventType, 'boot');
       assert.equal(bootEvent.payload?.eventType, eventType);