@storybook/telemetry 7.0.0-alpha.3 → 7.0.0-alpha.33

package/dist/cjs/get-monorepo-type.js

@@ -25,7 +25,8 @@ exports.monorepoConfigs = monorepoConfigs;
 const getMonorepoType = () => {
   const projectRootPath = (0, _coreCommon.getProjectRoot)();
   if (!projectRootPath) return undefined;
-  const monorepoType = Object.keys(monorepoConfigs).find(monorepo => {
+  const keys = Object.keys(monorepoConfigs);
+  const monorepoType = keys.find(monorepo => {
     const configFile = _path.default.join(projectRootPath, monorepoConfigs[monorepo]);
 
     return _fsExtra.default.existsSync(configFile);
@@ -35,7 +36,9 @@ const getMonorepoType = () => {
     return monorepoType;
   }
 
-  if (!_fsExtra.default.existsSync(_path.default.join(projectRootPath, 'package.json'))) return undefined;
+  if (!_fsExtra.default.existsSync(_path.default.join(projectRootPath, 'package.json'))) {
+    return undefined;
+  }
 
   const packageJson = _fsExtra.default.readJsonSync(_path.default.join(projectRootPath, 'package.json'));
 

package/dist/cjs/index.js

@@ -30,7 +30,7 @@ var _notify = require("./notify");
 
 var _sanitize = require("./sanitize");
 
-const telemetry = async (eventType, payload = {}, options) => {
+const telemetry = async (eventType, payload = {}, options = {}) => {
   await (0, _notify.notify)();
   const telemetryData = {
     eventType,
@@ -38,7 +38,7 @@ const telemetry = async (eventType, payload = {}, options) => {
   };
 
   try {
-    telemetryData.metadata = await (0, _storybookMetadata.getStorybookMetadata)(options.configDir);
+    telemetryData.metadata = await (0, _storybookMetadata.getStorybookMetadata)(options === null || options === void 0 ? void 0 : options.configDir);
   } catch (error) {
     if (!telemetryData.payload.error) telemetryData.payload.error = error;
   } finally {

package/dist/cjs/storybook-metadata.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.metaFrameworks = exports.getStorybookMetadata = exports.computeStorybookMetadata = void 0;
+exports.sanitizeAddonName = exports.metaFrameworks = exports.getStorybookMetadata = exports.computeStorybookMetadata = void 0;
 
 var _readPkgUp = _interopRequireDefault(require("read-pkg-up"));
 
@@ -15,6 +15,8 @@ var _packageVersions = require("./package-versions");
 
 var _getMonorepoType = require("./get-monorepo-type");
 
+var _sanitize = require("./sanitize");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const metaFrameworks = {
@@ -39,10 +41,16 @@ const getFrameworkOptions = mainConfig => {
   }
 
   return undefined;
+};
+
+const sanitizeAddonName = name => {
+  return (0, _sanitize.cleanPaths)(name).replace(/\/dist\/.*/, '').replace(/\.[mc]?[tj]?s[x]?$/, '').replace(/\/register$/, '').replace(/\/manager$/, '').replace(/\/preset$/, '');
 }; // Analyze a combination of information from main.js and package.json
 // to provide telemetry over a Storybook project
 
 
+exports.sanitizeAddonName = sanitizeAddonName;
+
 const computeStorybookMetadata = async ({
   packageJson,
   mainConfig
@@ -123,17 +131,17 @@ const computeStorybookMetadata = async ({
 
   if (mainConfig.addons) {
     mainConfig.addons.forEach(addon => {
-      let result;
+      let addonName;
       let options;
 
       if (typeof addon === 'string') {
-        result = addon.replace('/register', '').replace('/preset', '');
+        addonName = sanitizeAddonName(addon);
       } else {
         options = addon.options;
-        result = addon.name;
+        addonName = sanitizeAddonName(addon.name);
       }
 
-      addons[result] = {
+      addons[addonName] = {
         options,
         version: undefined
       };
@@ -164,7 +172,9 @@ const computeStorybookMetadata = async ({
     storybookPackages[name].version = version;
   });
   const language = allDependencies.typescript ? 'typescript' : 'javascript';
-  const hasStorybookEslint = !!allDependencies['eslint-plugin-storybook'];
+  const hasStorybookEslint = !!allDependencies['eslint-plugin-storybook']; // FIXME: resolve framework/renderer split in 7.0
+  //        OR should be getting this from mainConfig instead?
+
   const storybookInfo = (0, _coreCommon.getStorybookInfo)(packageJson);
   const storybookVersion = ((_storybookPackages$st = storybookPackages[storybookInfo.frameworkPackage]) === null || _storybookPackages$st === void 0 ? void 0 : _storybookPackages$st.version) || storybookInfo.version;
   return Object.assign({}, metadata, {
@@ -184,15 +194,19 @@ exports.computeStorybookMetadata = computeStorybookMetadata;
 let cachedMetadata;
 
 const getStorybookMetadata = async _configDir => {
+  var _packageJson$scripts;
+
   if (cachedMetadata) {
     return cachedMetadata;
   }
 
-  const packageJson = _readPkgUp.default.sync({
-    cwd: process.cwd()
-  }).packageJson;
-
-  const configDir = (_configDir || (0, _coreCommon.getStorybookConfiguration)(packageJson.scripts.storybook, '-c', '--config-dir')) ?? '.storybook';
+  const {
+    packageJson = {}
+  } = _readPkgUp.default.sync({
+    cwd: process.cwd(),
+    normalize: false
+  }) || {};
+  const configDir = (_configDir || (0, _coreCommon.getStorybookConfiguration)((packageJson === null || packageJson === void 0 ? void 0 : (_packageJson$scripts = packageJson.scripts) === null || _packageJson$scripts === void 0 ? void 0 : _packageJson$scripts.storybook) || '', '-c', '--config-dir')) ?? '.storybook';
   const mainConfig = (0, _coreCommon.loadMainConfig)({
     configDir
   });

package/dist/cjs/telemetry.js

@@ -64,7 +64,7 @@ async function sendTelemetry(data, options = {
       },
       retries: 3,
       retryOn: [503, 504],
-      retryDelay: attempt => 2 ** attempt * options.retryDelay
+      retryDelay: attempt => 2 ** attempt * (typeof (options === null || options === void 0 ? void 0 : options.retryDelay) === 'number' && !Number.isNaN(options === null || options === void 0 ? void 0 : options.retryDelay) ? options.retryDelay : 1000)
     });
     tasks.push(request);
 

package/dist/esm/get-monorepo-type.js

@@ -11,7 +11,8 @@ export const monorepoConfigs = {
 export const getMonorepoType = () => {
   const projectRootPath = getProjectRoot();
   if (!projectRootPath) return undefined;
-  const monorepoType = Object.keys(monorepoConfigs).find(monorepo => {
+  const keys = Object.keys(monorepoConfigs);
+  const monorepoType = keys.find(monorepo => {
     const configFile = path.join(projectRootPath, monorepoConfigs[monorepo]);
     return fs.existsSync(configFile);
   });
@@ -20,7 +21,10 @@ export const getMonorepoType = () => {
     return monorepoType;
   }
 
-  if (!fs.existsSync(path.join(projectRootPath, 'package.json'))) return undefined;
+  if (!fs.existsSync(path.join(projectRootPath, 'package.json'))) {
+    return undefined;
+  }
+
   const packageJson = fs.readJsonSync(path.join(projectRootPath, 'package.json'));
 
   if (packageJson?.workspaces) {

package/dist/esm/index.js

@@ -4,7 +4,7 @@ import { sendTelemetry } from './telemetry';
 import { notify } from './notify';
 import { sanitizeError } from './sanitize';
 export * from './storybook-metadata';
-export const telemetry = async (eventType, payload = {}, options) => {
+export const telemetry = async (eventType, payload = {}, options = {}) => {
   await notify();
   const telemetryData = {
     eventType,
@@ -12,7 +12,7 @@ export const telemetry = async (eventType, payload = {}, options) => {
   };
 
   try {
-    telemetryData.metadata = await getStorybookMetadata(options.configDir);
+    telemetryData.metadata = await getStorybookMetadata(options?.configDir);
   } catch (error) {
     if (!telemetryData.payload.error) telemetryData.payload.error = error;
   } finally {

package/dist/esm/storybook-metadata.js

@@ -3,6 +3,7 @@ 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';
+import { cleanPaths } from './sanitize';
 export const metaFrameworks = {
   next: 'Next',
   'react-scripts': 'CRA',
@@ -23,10 +24,13 @@ const getFrameworkOptions = mainConfig => {
   }
 
   return undefined;
+};
+
+export const sanitizeAddonName = name => {
+  return cleanPaths(name).replace(/\/dist\/.*/, '').replace(/\.[mc]?[tj]?s[x]?$/, '').replace(/\/register$/, '').replace(/\/manager$/, '').replace(/\/preset$/, '');
 }; // Analyze a combination of information from main.js and package.json
 // to provide telemetry over a Storybook project
 
-
 export const computeStorybookMetadata = async ({
   packageJson,
   mainConfig
@@ -105,17 +109,17 @@ export const computeStorybookMetadata = async ({
 
   if (mainConfig.addons) {
     mainConfig.addons.forEach(addon => {
-      let result;
+      let addonName;
       let options;
 
       if (typeof addon === 'string') {
-        result = addon.replace('/register', '').replace('/preset', '');
+        addonName = sanitizeAddonName(addon);
       } else {
         options = addon.options;
-        result = addon.name;
+        addonName = sanitizeAddonName(addon.name);
       }
 
-      addons[result] = {
+      addons[addonName] = {
         options,
         version: undefined
       };
@@ -146,7 +150,9 @@ export const computeStorybookMetadata = async ({
     storybookPackages[name].version = version;
   });
   const language = allDependencies.typescript ? 'typescript' : 'javascript';
-  const hasStorybookEslint = !!allDependencies['eslint-plugin-storybook'];
+  const hasStorybookEslint = !!allDependencies['eslint-plugin-storybook']; // FIXME: resolve framework/renderer split in 7.0
+  //        OR should be getting this from mainConfig instead?
+
   const storybookInfo = getStorybookInfo(packageJson);
   const storybookVersion = storybookPackages[storybookInfo.frameworkPackage]?.version || storybookInfo.version;
   return Object.assign({}, metadata, {
@@ -167,10 +173,13 @@ export const getStorybookMetadata = async _configDir => {
     return cachedMetadata;
   }
 
-  const packageJson = readPkgUp.sync({
-    cwd: process.cwd()
-  }).packageJson;
-  const configDir = (_configDir || getStorybookConfiguration(packageJson.scripts.storybook, '-c', '--config-dir')) ?? '.storybook';
+  const {
+    packageJson = {}
+  } = readPkgUp.sync({
+    cwd: process.cwd(),
+    normalize: false
+  }) || {};
+  const configDir = (_configDir || getStorybookConfiguration(packageJson?.scripts?.storybook || '', '-c', '--config-dir')) ?? '.storybook';
   const mainConfig = loadMainConfig({
     configDir
   });

package/dist/esm/telemetry.js

@@ -50,7 +50,7 @@ export async function sendTelemetry(data, options = {
       },
       retries: 3,
       retryOn: [503, 504],
-      retryDelay: attempt => 2 ** attempt * options.retryDelay
+      retryDelay: attempt => 2 ** attempt * (typeof options?.retryDelay === 'number' && !Number.isNaN(options?.retryDelay) ? options.retryDelay : 1000)
     });
     tasks.push(request);
 

package/dist/types/storybook-metadata.d.ts

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

package/dist/types/types.d.ts

@@ -3,7 +3,7 @@ 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;
+    version: string | undefined;
 }
 export interface StorybookAddon extends Dependency {
     options: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/telemetry",
-  "version": "7.0.0-alpha.3",
+  "version": "7.0.0-alpha.33",
   "description": "Telemetry logging for crash reports and usage statistics",
   "keywords": [
     "storybook"
@@ -30,24 +30,25 @@
     "*.d.ts"
   ],
   "scripts": {
-    "prepare": "node ../../scripts/prepare.js"
+    "check": "tsc --noEmit",
+    "prep": "node ../../../scripts/prepare.js"
   },
   "dependencies": {
-    "@storybook/client-logger": "7.0.0-alpha.3",
-    "@storybook/core-common": "7.0.0-alpha.3",
+    "@storybook/client-logger": "7.0.0-alpha.33",
+    "@storybook/core-common": "7.0.0-alpha.33",
     "chalk": "^4.1.0",
-    "core-js": "^3.8.2",
     "detect-package-manager": "^2.0.1",
     "fetch-retry": "^5.0.2",
     "fs-extra": "^9.0.1",
-    "global": "^4.4.0",
     "isomorphic-unfetch": "^3.1.0",
     "nanoid": "^3.3.1",
-    "read-pkg-up": "^7.0.1",
-    "regenerator-runtime": "^0.13.7"
+    "read-pkg-up": "^7.0.1"
+  },
+  "devDependencies": {
+    "typescript": "~4.6.3"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "629b056190993bcee6445471b8cb27208eb401a9"
+  "gitHead": "5da5b0fabd04cc5cd5771e8242a960f05d03234a"
 }

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 Kadira Inc. <hello@kadira.io>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.