@storybook/telemetry 6.5.0-beta.2

package/dist/modern/index.js

@@ -0,0 +1,39 @@
+import { logger } from '@storybook/client-logger';
+import { getStorybookMetadata } from './storybook-metadata';
+import { sendTelemetry } from './telemetry';
+import { notify } from './notify';
+import { sanitizeError } from './sanitize';
+export * from './storybook-metadata';
+export const telemetry = async (eventType, payload = {}, options) => {
+  await notify();
+  const telemetryData = {
+    eventType,
+    payload
+  };
+
+  try {
+    telemetryData.metadata = await getStorybookMetadata(options.configDir);
+  } catch (error) {
+    if (!telemetryData.payload.error) telemetryData.payload.error = error;
+  } finally {
+    const {
+      error
+    } = telemetryData.payload;
+
+    if (error) {
+      // make sure to anonymise possible paths from error messages
+      telemetryData.payload.error = sanitizeError(error);
+    }
+
+    if (!telemetryData.payload.error || options.enableCrashReports) {
+      var _process$env;
+
+      if ((_process$env = process.env) !== null && _process$env !== void 0 && _process$env.STORYBOOK_DEBUG_TELEMETRY) {
+        logger.info('\n[telemetry]');
+        logger.info(JSON.stringify(telemetryData, null, 2));
+      } else {
+        await sendTelemetry(telemetryData, options);
+      }
+    }
+  }
+};

package/dist/modern/notify.js

@@ -0,0 +1,22 @@
+import chalk from 'chalk';
+import { cache } from '@storybook/core-common';
+const TELEMETRY_KEY_NOTIFY_DATE = 'telemetry-notification-date';
+const logger = console;
+export const notify = async () => {
+  const telemetryNotifyDate = await cache.get(TELEMETRY_KEY_NOTIFY_DATE, null); // The end-user has already been notified about our telemetry integration. We
+  // don't need to constantly annoy them about it.
+  // We will re-inform users about the telemetry if significant changes are
+  // ever made.
+
+  if (telemetryNotifyDate) {
+    return;
+  }
+
+  cache.set(TELEMETRY_KEY_NOTIFY_DATE, Date.now());
+  logger.log();
+  logger.log(`${chalk.magenta.bold('attention')} => Storybook now collects completely anonymous telemetry regarding usage.`);
+  logger.log(`This information is used to shape Storybook's roadmap and prioritize features.`);
+  logger.log(`You can learn more, including how to opt-out if you'd not like to participate in this anonymous program, by visiting the following URL:`);
+  logger.log(chalk.cyan('https://storybook.js.org/telemetry'));
+  logger.log();
+};

package/dist/modern/one-way-hash.js

@@ -0,0 +1,11 @@
+import { createHash } from 'crypto';
+export const oneWayHash = payload => {
+  const hash = createHash('sha256'); // Always prepend the payload value with salt. This ensures the hash is truly
+  // one-way.
+
+  hash.update('storybook-telemetry-salt'); // Update is an append operation, not a replacement. The salt from the prior
+  // update is still present!
+
+  hash.update(payload);
+  return hash.digest('hex');
+};

package/dist/modern/package-versions.js

@@ -0,0 +1,21 @@
+import path from 'path';
+export const getActualPackageVersions = async packages => {
+  const packageNames = Object.keys(packages);
+  return Promise.all(packageNames.map(getActualPackageVersion));
+};
+export const getActualPackageVersion = async packageName => {
+  try {
+    // eslint-disable-next-line import/no-dynamic-require,global-require
+    const packageJson = require(path.join(packageName, 'package.json'));
+
+    return {
+      name: packageName,
+      version: packageJson.version
+    };
+  } catch (err) {
+    return {
+      name: packageName,
+      version: null
+    };
+  }
+};

package/dist/modern/sanitize.js

@@ -0,0 +1,32 @@
+/* eslint-disable no-param-reassign */
+import { sep } from 'path';
+
+// Removes all user paths
+function regexpEscape(str) {
+  return str.replace(/[-[/{}()*+?.\\^$|]/g, `\\$&`);
+}
+
+export function cleanPaths(str, separator = sep) {
+  if (!str) return str;
+  const stack = process.cwd().split(separator);
+
+  while (stack.length > 1) {
+    const currentPath = stack.join(separator);
+    const currentRegex = new RegExp(regexpEscape(currentPath), `g`);
+    str = str.replace(currentRegex, `$SNIP`);
+    const currentPath2 = stack.join(separator + separator);
+    const currentRegex2 = new RegExp(regexpEscape(currentPath2), `g`);
+    str = str.replace(currentRegex2, `$SNIP`);
+    stack.pop();
+  }
+
+  return str;
+} // Takes an Error and returns a sanitized JSON String
+
+export function sanitizeError(error, pathSeparator = sep) {
+  // Hack because Node
+  error = JSON.parse(JSON.stringify(error, Object.getOwnPropertyNames(error))); // Removes all user paths
+
+  const errorString = cleanPaths(JSON.stringify(error), pathSeparator);
+  return JSON.parse(errorString);
+}

package/dist/modern/storybook-metadata.js

@@ -0,0 +1,188 @@
+import "core-js/modules/es.array.reduce.js";
+import readPkgUp from 'read-pkg-up';
+import { detect, getNpmVersion } from 'detect-package-manager';
+import { loadMainConfig, getStorybookInfo, getStorybookConfiguration, getProjectRoot } from '@storybook/core-common';
+import { getActualPackageVersion, getActualPackageVersions } from './package-versions';
+import { getMonorepoType } from './get-monorepo-type';
+let cachedMetadata;
+export const getStorybookMetadata = async _configDir => {
+  var _ref;
+
+  if (cachedMetadata) {
+    return cachedMetadata;
+  }
+
+  const packageJson = readPkgUp.sync({
+    cwd: process.cwd()
+  }).packageJson;
+  const configDir = (_ref = _configDir || getStorybookConfiguration(packageJson.scripts.storybook, '-c', '--config-dir')) !== null && _ref !== void 0 ? _ref : '.storybook';
+  const mainConfig = loadMainConfig({
+    configDir
+  });
+  cachedMetadata = await computeStorybookMetadata({
+    mainConfig,
+    packageJson
+  });
+  return cachedMetadata;
+};
+export const metaFrameworks = {
+  next: 'Next',
+  'react-scripts': 'CRA',
+  gatsby: 'Gatsby',
+  '@nuxtjs/storybook': 'nuxt',
+  '@nrwl/storybook': 'nx',
+  '@vue/cli-service': 'vue-cli',
+  '@sveltejs/kit': 'svelte-kit'
+}; // @TODO: This should be removed in 7.0 as the framework.options field in main.js will replace this
+
+const getFrameworkOptions = mainConfig => {
+  const possibleOptions = ['angular', 'ember', 'html', 'preact', 'react', 'server', 'svelte', 'vue', 'vue3', 'webComponents'].map(opt => `${opt}Options`); // eslint-disable-next-line no-restricted-syntax
+
+  for (const opt of possibleOptions) {
+    if (opt in mainConfig) {
+      return mainConfig[opt];
+    }
+  }
+
+  return undefined;
+}; // Analyze a combination of information from main.js and package.json
+// to provide telemetry over a Storybook project
+
+
+export const computeStorybookMetadata = async ({
+  packageJson,
+  mainConfig
+}) => {
+  var _mainConfig$core;
+
+  const metadata = {
+    generatedAt: new Date().getTime(),
+    builder: {
+      name: 'webpack4'
+    },
+    hasCustomBabel: false,
+    hasCustomWebpack: false,
+    hasStaticDirs: false,
+    hasStorybookEslint: false,
+    refCount: 0
+  };
+  const allDependencies = Object.assign({}, packageJson === null || packageJson === void 0 ? void 0 : packageJson.dependencies, packageJson === null || packageJson === void 0 ? void 0 : packageJson.devDependencies, packageJson === null || packageJson === void 0 ? void 0 : packageJson.peerDependencies);
+  const metaFramework = Object.keys(allDependencies).find(dep => !!metaFrameworks[dep]);
+
+  if (metaFramework) {
+    const {
+      version
+    } = await getActualPackageVersion(metaFramework);
+    metadata.metaFramework = {
+      name: metaFrameworks[metaFramework],
+      packageName: metaFramework,
+      version
+    };
+  }
+
+  const monorepoType = getMonorepoType();
+
+  if (monorepoType) {
+    metadata.monorepo = monorepoType;
+  }
+
+  try {
+    const packageManagerType = await detect({
+      cwd: getProjectRoot()
+    });
+    const packageManagerVerson = await getNpmVersion(packageManagerType);
+    metadata.packageManager = {
+      type: packageManagerType,
+      version: packageManagerVerson
+    }; // Better be safe than sorry, some codebases/paths might end up breaking with something like "spawn pnpm ENOENT"
+    // so we just set the package manager if the detection is successful
+    // eslint-disable-next-line no-empty
+  } catch (err) {}
+
+  metadata.hasCustomBabel = !!mainConfig.babel;
+  metadata.hasCustomWebpack = !!mainConfig.webpackFinal;
+  metadata.hasStaticDirs = !!mainConfig.staticDirs;
+
+  if (mainConfig.typescript) {
+    metadata.typescriptOptions = mainConfig.typescript;
+  }
+
+  if ((_mainConfig$core = mainConfig.core) !== null && _mainConfig$core !== void 0 && _mainConfig$core.builder) {
+    var _builder$options;
+
+    const {
+      builder
+    } = mainConfig.core;
+    metadata.builder = {
+      name: typeof builder === 'string' ? builder : builder.name,
+      options: typeof builder === 'string' ? undefined : (_builder$options = builder === null || builder === void 0 ? void 0 : builder.options) !== null && _builder$options !== void 0 ? _builder$options : undefined
+    };
+  }
+
+  if (mainConfig.refs) {
+    metadata.refCount = Object.keys(mainConfig.refs).length;
+  }
+
+  if (mainConfig.features) {
+    metadata.features = mainConfig.features;
+  }
+
+  const addons = {};
+
+  if (mainConfig.addons) {
+    mainConfig.addons.forEach(addon => {
+      let result;
+      let options;
+
+      if (typeof addon === 'string') {
+        result = addon.replace('/register', '');
+      } else {
+        options = addon.options;
+        result = addon.name;
+      }
+
+      addons[result] = {
+        options,
+        version: undefined
+      };
+    });
+  }
+
+  const addonVersions = await getActualPackageVersions(addons);
+  addonVersions.forEach(({
+    name,
+    version
+  }) => {
+    addons[name].version = version;
+  });
+  const addonNames = Object.keys(addons); // all Storybook deps minus the addons
+
+  const storybookPackages = Object.keys(allDependencies).filter(dep => dep.includes('storybook') && !addonNames.includes(dep)).reduce((acc, dep) => {
+    return Object.assign({}, acc, {
+      [dep]: {
+        version: undefined
+      }
+    });
+  }, {});
+  const storybookPackageVersions = await getActualPackageVersions(storybookPackages);
+  storybookPackageVersions.forEach(({
+    name,
+    version
+  }) => {
+    storybookPackages[name].version = version;
+  });
+  const language = allDependencies.typescript ? 'typescript' : 'javascript';
+  const hasStorybookEslint = !!allDependencies['eslint-plugin-storybook'];
+  const storybookInfo = getStorybookInfo(packageJson);
+  return Object.assign({}, metadata, {
+    storybookVersion: storybookInfo.version,
+    language,
+    storybookPackages,
+    framework: {
+      name: storybookInfo.framework,
+      options: getFrameworkOptions(mainConfig)
+    },
+    addons,
+    hasStorybookEslint
+  });
+};

package/dist/modern/telemetry.js

@@ -0,0 +1,66 @@
+const _excluded = ["payload", "metadata"];
+
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+
+import originalFetch from 'isomorphic-unfetch';
+import retry from 'fetch-retry';
+import { nanoid } from 'nanoid';
+import { getAnonymousProjectId } from './anonymous-id';
+const URL = 'https://storybook.js.org/event-log';
+const fetch = retry(originalFetch);
+let tasks = []; // getStorybookMetadata -> packagejson + Main.js
+// event specific data: sessionId, ip, etc..
+// send telemetry
+
+const sessionId = nanoid();
+export async function sendTelemetry(data, options = {
+  retryDelay: 1000,
+  immediate: false
+}) {
+  // We use this id so we can de-dupe events that arrive at the index multiple times due to the
+  // use of retries. There are situations in which the request "5xx"s (or times-out), but
+  // the server actually gets the request and stores it anyway.
+  // flatten the data before we send it
+  const {
+    payload,
+    metadata
+  } = data,
+        rest = _objectWithoutPropertiesLoose(data, _excluded);
+
+  const context = {
+    anonymousId: getAnonymousProjectId(),
+    inCI: process.env.CI === 'true'
+  };
+  const eventId = nanoid();
+  const body = Object.assign({}, rest, {
+    eventId,
+    sessionId,
+    metadata,
+    payload,
+    context
+  });
+  let request;
+
+  try {
+    request = fetch(URL, {
+      method: 'POST',
+      body: JSON.stringify(body),
+      headers: {
+        'Content-Type': 'application/json'
+      },
+      retries: 3,
+      retryOn: [503, 504],
+      retryDelay: attempt => 2 ** attempt * options.retryDelay
+    });
+    tasks.push(request);
+
+    if (options.immediate) {
+      await Promise.all(tasks);
+    } else {
+      await request;
+    }
+  } catch (err) {//
+  } finally {
+    tasks = tasks.filter(task => task !== request);
+  }
+}

package/dist/modern/types.js

@@ -0,0 +1 @@
+export {};

package/dist/ts3.4/anonymous-id.d.ts

@@ -0,0 +1 @@
+export declare const getAnonymousProjectId: () => string;

package/dist/ts3.4/get-monorepo-type.d.ts

@@ -0,0 +1,9 @@
+export declare const monorepoConfigs: {
+    readonly Nx: "nx.json";
+    readonly Turborepo: "turbo.json";
+    readonly Lerna: "lerna.json";
+    readonly Rush: "rush.json";
+    readonly Lage: "lage.config.json";
+};
+export declare type MonorepoType = keyof typeof monorepoConfigs | 'Workspaces' | undefined;
+export declare const getMonorepoType: () => MonorepoType;

package/dist/ts3.4/index.d.ts

@@ -0,0 +1,3 @@
+import { EventType, Payload, Options } from './types';
+export * from './storybook-metadata';
+export declare const telemetry: (eventType: EventType, payload?: Payload, options?: Partial<Options>) => Promise<void>;

package/dist/ts3.4/notify.d.ts

@@ -0,0 +1 @@
+export declare const notify: () => Promise<void>;

package/dist/ts3.4/one-way-hash.d.ts

@@ -0,0 +1,2 @@
+import { BinaryLike } from 'crypto';
+export declare const oneWayHash: (payload: BinaryLike) => string;

package/dist/ts3.4/package-versions.d.ts

@@ -0,0 +1,9 @@
+import { Dependency } from './types';
+export declare const getActualPackageVersions: (packages: Record<string, Partial<Dependency>>) => Promise<{
+    name: string;
+    version: any;
+}[]>;
+export declare const getActualPackageVersion: (packageName: string) => Promise<{
+    name: string;
+    version: any;
+}>;

package/dist/ts3.4/sanitize.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+export interface IErrorWithStdErrAndStdOut {
+    stderr?: Buffer | string;
+    stdout?: Buffer | string;
+    [key: string]: unknown;
+}
+export declare function cleanPaths(str: string, separator?: string): string;
+export declare function sanitizeError(error: Error, pathSeparator?: string): string;

package/dist/ts3.4/storybook-metadata.d.ts

@@ -0,0 +1,8 @@
+import { StorybookConfig, PackageJson } from '@storybook/core-common';
+import { StorybookMetadata } from './types';
+export declare const getStorybookMetadata: (_configDir: string) => Promise<StorybookMetadata>;
+export declare const metaFrameworks: Record<string, string>;
+export declare const computeStorybookMetadata: ({ packageJson, mainConfig, }: {
+    packageJson: PackageJson;
+    mainConfig: StorybookConfig & Record<string, any>;
+}) => Promise<StorybookMetadata>;

package/dist/ts3.4/telemetry.d.ts

@@ -0,0 +1,2 @@
+import { Options, TelemetryData } from './types';
+export declare function sendTelemetry(data: TelemetryData, options?: Partial<Options>): Promise<void>;

package/dist/ts3.4/types.d.ts

@@ -0,0 +1,56 @@
+import { StorybookConfig, TypescriptOptions } from '@storybook/core-common';
+import { PM } from 'detect-package-manager';
+import { MonorepoType } from './get-monorepo-type';
+export declare type EventType = 'start' | 'build' | 'upgrade' | 'init' | 'error-build' | 'error-dev' | 'error-metadata';
+export interface Dependency {
+    version: string;
+}
+export interface StorybookAddon extends Dependency {
+    options: any;
+}
+export declare type StorybookMetadata = {
+    storybookVersion: string;
+    generatedAt?: number;
+    language: 'typescript' | 'javascript';
+    framework: {
+        name: string;
+        options?: any;
+    };
+    builder?: {
+        name: string;
+        options?: Record<string, any>;
+    };
+    monorepo?: MonorepoType;
+    packageManager?: {
+        type: PM;
+        version: string;
+    };
+    typescriptOptions?: Partial<TypescriptOptions>;
+    addons?: Record<string, StorybookAddon>;
+    storybookPackages?: Record<string, Dependency>;
+    metaFramework?: {
+        name: string;
+        packageName: string;
+        version: string;
+    };
+    hasStorybookEslint?: boolean;
+    hasStaticDirs?: boolean;
+    hasCustomWebpack?: boolean;
+    hasCustomBabel?: boolean;
+    features?: StorybookConfig['features'];
+    refCount?: number;
+};
+export interface Payload {
+    [key: string]: any;
+}
+export interface Options {
+    retryDelay: number;
+    immediate: boolean;
+    configDir?: string;
+    enableCrashReports?: boolean;
+}
+export interface TelemetryData {
+    eventType: EventType;
+    payload: Payload;
+    metadata?: StorybookMetadata;
+}

package/dist/ts3.9/anonymous-id.d.ts

@@ -0,0 +1 @@
+export declare const getAnonymousProjectId: () => string;

package/dist/ts3.9/get-monorepo-type.d.ts

@@ -0,0 +1,9 @@
+export declare const monorepoConfigs: {
+    readonly Nx: "nx.json";
+    readonly Turborepo: "turbo.json";
+    readonly Lerna: "lerna.json";
+    readonly Rush: "rush.json";
+    readonly Lage: "lage.config.json";
+};
+export declare type MonorepoType = keyof typeof monorepoConfigs | 'Workspaces' | undefined;
+export declare const getMonorepoType: () => MonorepoType;

package/dist/ts3.9/index.d.ts

@@ -0,0 +1,3 @@
+import type { EventType, Payload, Options } from './types';
+export * from './storybook-metadata';
+export declare const telemetry: (eventType: EventType, payload?: Payload, options?: Partial<Options>) => Promise<void>;

package/dist/ts3.9/notify.d.ts

@@ -0,0 +1 @@
+export declare const notify: () => Promise<void>;

package/dist/ts3.9/one-way-hash.d.ts

@@ -0,0 +1,2 @@
+import { BinaryLike } from 'crypto';
+export declare const oneWayHash: (payload: BinaryLike) => string;

package/dist/ts3.9/package-versions.d.ts

@@ -0,0 +1,9 @@
+import { Dependency } from './types';
+export declare const getActualPackageVersions: (packages: Record<string, Partial<Dependency>>) => Promise<{
+    name: string;
+    version: any;
+}[]>;
+export declare const getActualPackageVersion: (packageName: string) => Promise<{
+    name: string;
+    version: any;
+}>;

package/dist/ts3.9/sanitize.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+export interface IErrorWithStdErrAndStdOut {
+    stderr?: Buffer | string;
+    stdout?: Buffer | string;
+    [key: string]: unknown;
+}
+export declare function cleanPaths(str: string, separator?: string): string;
+export declare function sanitizeError(error: Error, pathSeparator?: string): string;

package/dist/ts3.9/storybook-metadata.d.ts

@@ -0,0 +1,8 @@
+import type { StorybookConfig, PackageJson } from '@storybook/core-common';
+import type { StorybookMetadata } from './types';
+export declare const getStorybookMetadata: (_configDir: string) => Promise<StorybookMetadata>;
+export declare const metaFrameworks: Record<string, string>;
+export declare const computeStorybookMetadata: ({ packageJson, mainConfig, }: {
+    packageJson: PackageJson;
+    mainConfig: StorybookConfig & Record<string, any>;
+}) => Promise<StorybookMetadata>;

package/dist/ts3.9/telemetry.d.ts

@@ -0,0 +1,2 @@
+import { Options, TelemetryData } from './types';
+export declare function sendTelemetry(data: TelemetryData, options?: Partial<Options>): Promise<void>;

package/dist/ts3.9/types.d.ts

@@ -0,0 +1,56 @@
+import type { StorybookConfig, TypescriptOptions } from '@storybook/core-common';
+import type { PM } from 'detect-package-manager';
+import type { MonorepoType } from './get-monorepo-type';
+export declare type EventType = 'start' | 'build' | 'upgrade' | 'init' | 'error-build' | 'error-dev' | 'error-metadata';
+export interface Dependency {
+    version: string;
+}
+export interface StorybookAddon extends Dependency {
+    options: any;
+}
+export declare type StorybookMetadata = {
+    storybookVersion: string;
+    generatedAt?: number;
+    language: 'typescript' | 'javascript';
+    framework: {
+        name: string;
+        options?: any;
+    };
+    builder?: {
+        name: string;
+        options?: Record<string, any>;
+    };
+    monorepo?: MonorepoType;
+    packageManager?: {
+        type: PM;
+        version: string;
+    };
+    typescriptOptions?: Partial<TypescriptOptions>;
+    addons?: Record<string, StorybookAddon>;
+    storybookPackages?: Record<string, Dependency>;
+    metaFramework?: {
+        name: string;
+        packageName: string;
+        version: string;
+    };
+    hasStorybookEslint?: boolean;
+    hasStaticDirs?: boolean;
+    hasCustomWebpack?: boolean;
+    hasCustomBabel?: boolean;
+    features?: StorybookConfig['features'];
+    refCount?: number;
+};
+export interface Payload {
+    [key: string]: any;
+}
+export interface Options {
+    retryDelay: number;
+    immediate: boolean;
+    configDir?: string;
+    enableCrashReports?: boolean;
+}
+export interface TelemetryData {
+    eventType: EventType;
+    payload: Payload;
+    metadata?: StorybookMetadata;
+}