creevey 0.9.0-beta.18 → 0.9.0-beta.19

package/lib/cjs/server/config.js

@@ -14,6 +14,7 @@ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 const defaultBrowser = exports.defaultBrowser = 'chrome';
 const defaultConfig = exports.defaultConfig = {
+  disableTelemetry: false,
   useDocker: true,
   dockerImage: 'aerokube/selenoid:latest-release',
   dockerImagePlatform: '',

package/lib/cjs/server/master/index.js

@@ -13,6 +13,7 @@ var _types = require("../../types");
 var _utils = require("../utils");
 var _messages = require("../messages");
 var _logger = require("../logger");
+var _telemetry = require("../telemetry");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const writeFileAsync = (0, _util.promisify)(_fs.writeFile);
 const copyFileAsync = (0, _util.promisify)(_fs.copyFile);
@@ -97,7 +98,7 @@ async function _default(config, options, resolveApi) {
       return;
     }
     runner.once('stop', () => {
-      var _runner6;
+      var _runner6, _runner7;
       const tests = Object.values(((_runner6 = runner) === null || _runner6 === void 0 ? void 0 : _runner6.status.tests) ?? {});
       const isSuccess = tests.filter(_types.isDefined).filter(({
         skip
@@ -107,8 +108,13 @@ async function _default(config, options, resolveApi) {
       // TODO output summary
       process.exitCode = isSuccess ? 0 : -1;
       if (!config.failFast) outputUnnecessaryImages(config.screenDir, (0, _utils.testsToImages)(tests));
-      // eslint-disable-next-line no-process-exit
-      void (0, _utils.shutdownWorkers)().then(() => process.exit());
+      (0, _telemetry.sendScreenshotsCount)(config, options, (_runner7 = runner) === null || _runner7 === void 0 ? void 0 : _runner7.status).catch(reason => {
+        const error = reason instanceof Error ? reason.stack ?? reason.message : reason;
+        _logger.logger.warn(`Can't send telemetry: ${error}`);
+      }).finally(() => {
+        // eslint-disable-next-line no-process-exit
+        void (0, _utils.shutdownWorkers)().then(() => process.exit());
+      });
     });
     // TODO grep
     runner.start(Object.keys(runner.status.tests));

package/lib/cjs/server/selenium/selenoid.js

@@ -26,15 +26,16 @@ async function createSelenoidConfig(browsers, {
   browsers.forEach(({
     browserName,
     version = 'latest',
-    dockerImage = `selenoid/${browserName}:${version}`,
+    browserVersion = version,
+    dockerImage = `selenoid/${browserName}:${browserVersion}`,
     webdriverCommand = []
   }) => {
     if (!selenoidConfig[browserName]) selenoidConfig[browserName] = {
-      default: version,
+      default: browserVersion,
       versions: {}
     };
     if (!useDocker && webdriverCommand.length == 0) throw new Error('Please specify "webdriverCommand" browser option with path to browser webdriver');
-    selenoidConfig[browserName].versions[version] = {
+    selenoidConfig[browserName].versions[browserVersion] = {
       image: useDocker ? dockerImage : webdriverCommand,
       port: '4444',
       path: !useDocker || ['chrome', 'opera', 'webkit', 'MicrosoftEdge'].includes(browserName) ? '/' : '/wd/hub'

package/lib/cjs/server/storybook/providers/browser.js

@@ -60,4 +60,5 @@ const loadStories = async (_config, _options, storiesListener) => {
     return stories;
   }
 };
-exports.loadStories = loadStories;
+exports.loadStories = loadStories;
+loadStories.providerName = 'browser';

package/lib/cjs/server/storybook/providers/hybrid.js

@@ -59,4 +59,5 @@ async function parseParams(config, listener) {
     });
   }
   return (0, _parser.default)(testFiles);
-}
+}
+loadStories.providerName = 'hybrid';

package/lib/cjs/server/telemetry.js

@@ -0,0 +1,131 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.sendScreenshotsCount = sendScreenshotsCount;
+var _path = _interopRequireDefault(require("path"));
+var _https = _interopRequireDefault(require("https"));
+var _shelljs = require("shelljs");
+var _qs = require("qs");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const konturGitHost = 'git.skbkontur.ru';
+const trackId = 232; // front_infra
+const origin = 'http://localhost/';
+const category = 'screenshots';
+const action = 'count';
+const label = 'full_run';
+function buildPathname(info) {
+  return `/track-event?${(0, _qs.stringify)({
+    id: trackId,
+    c: category,
+    a: action,
+    l: label,
+    cv: JSON.stringify(info),
+    ts: new Date().toISOString(),
+    url: origin
+  })}`;
+}
+function sanitizeGridUrl(gridUrl) {
+  const url = new URL(gridUrl);
+  url.username = url.username ? '********' : '';
+  url.password = url.password ? '********' : '';
+  return url.toString();
+}
+function tryGetRepoUrl() {
+  try {
+    const gitRemoteOutput = (0, _shelljs.exec)('git remote -v', {
+      silent: true
+    });
+    const [, repoUrl] = gitRemoteOutput.stdout.match(/origin\s+(.*)\s+\(fetch\)/) ?? [];
+    return [repoUrl, null];
+  } catch (error) {
+    return [undefined, error];
+  }
+}
+function tryGetStorybookVersion() {
+  try {
+    const storybookPackageOutput = (0, _shelljs.exec)(`node -e "console.log(JSON.stringify(require('storybook/package.json')))"`, {
+      silent: true
+    });
+    const storybookPackage = JSON.parse(storybookPackageOutput);
+    return [storybookPackage.version, null];
+  } catch (error) {
+    return [undefined, error];
+  }
+}
+function tryGetCreeveyVersion() {
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires, node/no-missing-require
+    const creeveyPackage = require('creevey/package.json');
+    return [creeveyPackage.version, null];
+  } catch (error) {
+    return [undefined, error];
+  }
+}
+async function sendScreenshotsCount(config, options, status) {
+  var _config$storiesProvid;
+  const [repoUrl] = tryGetRepoUrl();
+  const isKonturRepo = repoUrl === null || repoUrl === void 0 ? void 0 : repoUrl.includes(konturGitHost);
+  if (!isKonturRepo || config.disableTelemetry) return;
+  const [creeveyVersion, creeveyVersionError] = tryGetCreeveyVersion();
+  const [storybookVersion, storybookVersionError] = tryGetStorybookVersion();
+  const gridUrl = config.gridUrl ? sanitizeGridUrl(config.gridUrl) : undefined;
+  const info = {
+    repoUrl: repoUrl ?? 'unknown',
+    creeveyVersion: creeveyVersion ?? 'unknown',
+    storybookVersion: storybookVersion ?? 'unknown',
+    options: options._,
+    gridUrl,
+    screenDir: config.screenDir ? _path.default.relative(process.cwd(), config.screenDir) : undefined,
+    useDocker: config.useDocker,
+    dockerImage: config.dockerImage,
+    maxRetries: config.maxRetries,
+    diffOptions: config.diffOptions,
+    storiesProvider: ((_config$storiesProvid = config.storiesProvider) === null || _config$storiesProvid === void 0 ? void 0 : _config$storiesProvid.providerName) ?? 'unknown',
+    browsers: Object.fromEntries(Object.entries(config.browsers ?? {}).map(([name, browser]) => [name, typeof browser === 'object' ? {
+      name: browser.name,
+      gridUrl: browser.gridUrl ? sanitizeGridUrl(browser.gridUrl) : undefined,
+      browserName: browser.browserName,
+      browserVersion: browser.browserVersion,
+      platformName: browser.platformName,
+      viewport: browser.viewport,
+      limit: browser.limit,
+      dockerImage: browser.dockerImage,
+      'se:teamname': browser['se:teamname']
+    } : browser])),
+    tests: Object.values((status === null || status === void 0 ? void 0 : status.tests) ?? {}).filter(x => Boolean(x)).map(test => ({
+      id: test.id,
+      browser: test.browser,
+      testName: test.testName,
+      storyPath: test.storyPath,
+      status: test.status
+    })),
+    errors: [creeveyVersionError, storybookVersionError].some(Boolean) ? [creeveyVersionError ? `Error while getting creevey version: ${creeveyVersionError.message}` : undefined, storybookVersionError ? `Error while getting storybook version: ${storybookVersionError.message}` : undefined].filter(Boolean) : undefined
+  };
+  return new Promise((resolve, reject) => {
+    const req = _https.default.request({
+      host: 'metrika.kontur.ru',
+      path: buildPathname(info),
+      protocol: 'https:'
+    }, res => {
+      if (res.statusCode) {
+        if (res.statusCode >= 200 && res.statusCode < 300) {
+          resolve();
+        } else if (res.statusCode >= 300 && res.statusCode < 400) {
+          reject(new Error(`Redirection error: ${res.statusCode}`));
+        } else if (res.statusCode >= 400 && res.statusCode < 500) {
+          reject(new Error(`Client error: ${res.statusCode}`));
+        } else if (res.statusCode >= 500 && res.statusCode < 600) {
+          reject(new Error(`Server error: ${res.statusCode}`));
+        } else {
+          reject(new Error(`Unexpected status code: ${res.statusCode}`));
+        }
+      } else {
+        reject(new Error('No status code received'));
+      }
+    });
+    req.on('error', reject);
+    req.end();
+  });
+}

package/lib/esm/server/config.js

@@ -4,6 +4,7 @@ import { loadStories as browserStoriesProvider } from './storybook/providers/bro
 import { isDefined } from '../types';
 export const defaultBrowser = 'chrome';
 export const defaultConfig = {
+  disableTelemetry: false,
   useDocker: true,
   dockerImage: 'aerokube/selenoid:latest-release',
   dockerImagePlatform: '',

package/lib/esm/server/master/index.js

@@ -7,6 +7,7 @@ import { isDefined } from '../../types';
 import { shutdown, shutdownWorkers, testsToImages, readDirRecursive } from '../utils';
 import { subscribeOn } from '../messages';
 import { logger } from '../logger';
+import { sendScreenshotsCount } from '../telemetry';
 const writeFileAsync = promisify(writeFile);
 const copyFileAsync = promisify(copyFile);
 const readdirAsync = promisify(readdir);
@@ -90,7 +91,7 @@ export default async function (config, options, resolveApi) {
       return;
     }
     runner.once('stop', () => {
-      var _runner6;
+      var _runner6, _runner7;
       const tests = Object.values(((_runner6 = runner) === null || _runner6 === void 0 ? void 0 : _runner6.status.tests) ?? {});
       const isSuccess = tests.filter(isDefined).filter(({
         skip
@@ -100,8 +101,13 @@ export default async function (config, options, resolveApi) {
       // TODO output summary
       process.exitCode = isSuccess ? 0 : -1;
       if (!config.failFast) outputUnnecessaryImages(config.screenDir, testsToImages(tests));
-      // eslint-disable-next-line no-process-exit
-      void shutdownWorkers().then(() => process.exit());
+      sendScreenshotsCount(config, options, (_runner7 = runner) === null || _runner7 === void 0 ? void 0 : _runner7.status).catch(reason => {
+        const error = reason instanceof Error ? reason.stack ?? reason.message : reason;
+        logger.warn(`Can't send telemetry: ${error}`);
+      }).finally(() => {
+        // eslint-disable-next-line no-process-exit
+        void shutdownWorkers().then(() => process.exit());
+      });
     });
     // TODO grep
     runner.start(Object.keys(runner.status.tests));

package/lib/esm/server/selenium/selenoid.js

@@ -18,15 +18,16 @@ async function createSelenoidConfig(browsers, {
   browsers.forEach(({
     browserName,
     version = 'latest',
-    dockerImage = `selenoid/${browserName}:${version}`,
+    browserVersion = version,
+    dockerImage = `selenoid/${browserName}:${browserVersion}`,
     webdriverCommand = []
   }) => {
     if (!selenoidConfig[browserName]) selenoidConfig[browserName] = {
-      default: version,
+      default: browserVersion,
       versions: {}
     };
     if (!useDocker && webdriverCommand.length == 0) throw new Error('Please specify "webdriverCommand" browser option with path to browser webdriver');
-    selenoidConfig[browserName].versions[version] = {
+    selenoidConfig[browserName].versions[browserVersion] = {
       image: useDocker ? dockerImage : webdriverCommand,
       port: '4444',
       path: !useDocker || ['chrome', 'opera', 'webkit', 'MicrosoftEdge'].includes(browserName) ? '/' : '/wd/hub'

package/lib/esm/server/storybook/providers/browser.js

@@ -52,4 +52,5 @@ export const loadStories = async (_config, _options, storiesListener) => {
     });
     return stories;
   }
-};
+};
+loadStories.providerName = 'browser';

package/lib/esm/server/storybook/providers/hybrid.js

@@ -49,4 +49,5 @@ async function parseParams(config, listener) {
     });
   }
   return parse(testFiles);
-}
+}
+loadStories.providerName = 'hybrid';

package/lib/esm/server/telemetry.js

@@ -0,0 +1,124 @@
+import path from 'path';
+import https from 'https';
+import { exec } from 'shelljs';
+import { stringify } from 'qs';
+const konturGitHost = 'git.skbkontur.ru';
+const trackId = 232; // front_infra
+const origin = 'http://localhost/';
+const category = 'screenshots';
+const action = 'count';
+const label = 'full_run';
+function buildPathname(info) {
+  return `/track-event?${stringify({
+    id: trackId,
+    c: category,
+    a: action,
+    l: label,
+    cv: JSON.stringify(info),
+    ts: new Date().toISOString(),
+    url: origin
+  })}`;
+}
+function sanitizeGridUrl(gridUrl) {
+  const url = new URL(gridUrl);
+  url.username = url.username ? '********' : '';
+  url.password = url.password ? '********' : '';
+  return url.toString();
+}
+function tryGetRepoUrl() {
+  try {
+    const gitRemoteOutput = exec('git remote -v', {
+      silent: true
+    });
+    const [, repoUrl] = gitRemoteOutput.stdout.match(/origin\s+(.*)\s+\(fetch\)/) ?? [];
+    return [repoUrl, null];
+  } catch (error) {
+    return [undefined, error];
+  }
+}
+function tryGetStorybookVersion() {
+  try {
+    const storybookPackageOutput = exec(`node -e "console.log(JSON.stringify(require('storybook/package.json')))"`, {
+      silent: true
+    });
+    const storybookPackage = JSON.parse(storybookPackageOutput);
+    return [storybookPackage.version, null];
+  } catch (error) {
+    return [undefined, error];
+  }
+}
+function tryGetCreeveyVersion() {
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires, node/no-missing-require
+    const creeveyPackage = require('creevey/package.json');
+    return [creeveyPackage.version, null];
+  } catch (error) {
+    return [undefined, error];
+  }
+}
+export async function sendScreenshotsCount(config, options, status) {
+  var _config$storiesProvid;
+  const [repoUrl] = tryGetRepoUrl();
+  const isKonturRepo = repoUrl === null || repoUrl === void 0 ? void 0 : repoUrl.includes(konturGitHost);
+  if (!isKonturRepo || config.disableTelemetry) return;
+  const [creeveyVersion, creeveyVersionError] = tryGetCreeveyVersion();
+  const [storybookVersion, storybookVersionError] = tryGetStorybookVersion();
+  const gridUrl = config.gridUrl ? sanitizeGridUrl(config.gridUrl) : undefined;
+  const info = {
+    repoUrl: repoUrl ?? 'unknown',
+    creeveyVersion: creeveyVersion ?? 'unknown',
+    storybookVersion: storybookVersion ?? 'unknown',
+    options: options._,
+    gridUrl,
+    screenDir: config.screenDir ? path.relative(process.cwd(), config.screenDir) : undefined,
+    useDocker: config.useDocker,
+    dockerImage: config.dockerImage,
+    maxRetries: config.maxRetries,
+    diffOptions: config.diffOptions,
+    storiesProvider: ((_config$storiesProvid = config.storiesProvider) === null || _config$storiesProvid === void 0 ? void 0 : _config$storiesProvid.providerName) ?? 'unknown',
+    browsers: Object.fromEntries(Object.entries(config.browsers ?? {}).map(([name, browser]) => [name, typeof browser === 'object' ? {
+      name: browser.name,
+      gridUrl: browser.gridUrl ? sanitizeGridUrl(browser.gridUrl) : undefined,
+      browserName: browser.browserName,
+      browserVersion: browser.browserVersion,
+      platformName: browser.platformName,
+      viewport: browser.viewport,
+      limit: browser.limit,
+      dockerImage: browser.dockerImage,
+      'se:teamname': browser['se:teamname']
+    } : browser])),
+    tests: Object.values((status === null || status === void 0 ? void 0 : status.tests) ?? {}).filter(x => Boolean(x)).map(test => ({
+      id: test.id,
+      browser: test.browser,
+      testName: test.testName,
+      storyPath: test.storyPath,
+      status: test.status
+    })),
+    errors: [creeveyVersionError, storybookVersionError].some(Boolean) ? [creeveyVersionError ? `Error while getting creevey version: ${creeveyVersionError.message}` : undefined, storybookVersionError ? `Error while getting storybook version: ${storybookVersionError.message}` : undefined].filter(Boolean) : undefined
+  };
+  return new Promise((resolve, reject) => {
+    const req = https.request({
+      host: 'metrika.kontur.ru',
+      path: buildPathname(info),
+      protocol: 'https:'
+    }, res => {
+      if (res.statusCode) {
+        if (res.statusCode >= 200 && res.statusCode < 300) {
+          resolve();
+        } else if (res.statusCode >= 300 && res.statusCode < 400) {
+          reject(new Error(`Redirection error: ${res.statusCode}`));
+        } else if (res.statusCode >= 400 && res.statusCode < 500) {
+          reject(new Error(`Client error: ${res.statusCode}`));
+        } else if (res.statusCode >= 500 && res.statusCode < 600) {
+          reject(new Error(`Server error: ${res.statusCode}`));
+        } else {
+          reject(new Error(`Unexpected status code: ${res.statusCode}`));
+        }
+      } else {
+        reject(new Error('No status code received'));
+      }
+    });
+    req.on('error', reject);
+    req.end();
+  });
+}

package/lib/types/server/telemetry.d.ts

@@ -0,0 +1,2 @@
+import { Config, CreeveyStatus, Options } from '../types';
+export declare function sendScreenshotsCount(config: Partial<Config>, options: Options, status?: CreeveyStatus): Promise<void>;

package/lib/types/types.d.ts

@@ -72,6 +72,11 @@ export interface CreeveyStory {
 }
 export interface Capabilities {
     browserName: string;
+    browserVersion?: string;
+    platformName?: string;
+    /**
+     * @deprecated use `browserVersion` instead
+     */
     version?: string;
     [prop: string]: unknown;
 }
@@ -86,7 +91,7 @@ export declare type BrowserConfig = Capabilities & {
     _storybookGlobals?: StorybookGlobals;
     /**
      * Specify custom docker image. Used only with `useDocker == true`
-     * @default `selenoid/${browserName}:${version ?? 'latest'}`
+     * @default `selenoid/${browserName}:${browserVersion ?? 'latest'}`
      */
     dockerImage?: string;
     /**
@@ -227,10 +232,20 @@ export interface Config {
     testsRegex?: RegExp;
     testsDir?: string;
     tsConfig?: string;
+    /**
+     * Telemetry contains information about Creevey and Storybook versions, used Creevey config, browsers and tests meta.
+     * It's being sent only for projects from git.skbkontur.ru
+     * @default false
+     */
+    disableTelemetry?: boolean;
+}
+export interface StoriesProvider<T = any> {
+    (config: Config, options: T, storiesListener: (stories: Map<string, StoryInput[]>) => void): Promise<StoriesRaw>;
+    providerName?: string;
 }
-export declare type StoriesProvider<T = any> = (config: Config, options: T, storiesListener: (stories: Map<string, StoryInput[]>) => void) => Promise<StoriesRaw>;
 export declare type CreeveyConfig = Partial<Config>;
 export interface Options {
+    _: string[];
     config?: string;
     port: number;
     ui: boolean;

package/package.json

@@ -13,7 +13,7 @@
     "addon",
     "test"
   ],
-  "version": "0.9.0-beta.18",
+  "version": "0.9.0-beta.19",
   "bin": "./lib/cjs/cli.js",
   "exports": {
     ".": {
@@ -32,7 +32,8 @@
     },
     "./lib/cjs/client/addon/preview.js": {
       "default": "./lib/cjs/client/addon/preview.js"
-    }
+    },
+    "./package.json": "./package.json"
   },
   "main": "lib/cjs/index.js",
   "module": "lib/esm/index.js",