creevey 0.9.2 → 0.10.0-beta.1

package/src/types.ts

@@ -1,10 +1,11 @@
 import type { StoryContextForEnhancers, DecoratorFunction } from '@storybook/csf';
-import type { IKey } from 'selenium-webdriver/lib/input.js';
 import type { Worker as ClusterWorker } from 'cluster';
-import type { until, WebDriver, WebElementPromise } from 'selenium-webdriver';
 import type Pixelmatch from 'pixelmatch';
-import type { Context } from 'mocha';
+import type { ODiffOptions } from 'odiff-bin';
 import type { expect } from 'chai';
+import type EventEmitter from 'events';
+import type Logger from 'loglevel';
+// import type { Browser } from 'playwright-core';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 export type DiffOptions = typeof Pixelmatch extends (
@@ -80,19 +81,30 @@ export interface CreeveyStory {
   };
 }
 
-export interface Capabilities {
+// TODO Rework browser config
+/*
+export class ChromeConfig {
+  browserName: 'chrome'
+
+  constructor({ limit, version, ... })
+}
+*/
+export interface BrowserConfigObject {
   browserName: string;
+  /**
+   * Browser version. Ignored with Playwright webdriver
+   */
   browserVersion?: string;
-  platformName?: string;
   /**
-   * @deprecated use `browserVersion` instead
+   * Operation system name. Ignored with Playwright webdriver
    */
-  version?: string;
-  [prop: string]: unknown;
-}
-
-export type BrowserConfig = Capabilities & {
+  platformName?: string;
+  // customizeBuilder?: (builder: Builder) => Builder;
   limit?: number;
+  /**
+   * Selenium grid url
+   * @default config.gridUrl
+   */
   gridUrl?: string;
   storybookUrl?: string;
   /**
@@ -102,7 +114,7 @@ export type BrowserConfig = Capabilities & {
   _storybookGlobals?: StorybookGlobals;
   /**
    * Specify custom docker image. Used only with `useDocker == true`
-   * @default `selenoid/${browserName}:${browserVersion ?? 'latest'}`
+   * @default `selenoid/${browserName}:${browserVersion ?? 'latest'}` or `mcr.microsoft.com/playwright:${playwrightVersion}`
    */
   dockerImage?: string;
   /**
@@ -110,12 +122,36 @@ export type BrowserConfig = Capabilities & {
    * Used only with `useDocker == false`
    */
   webdriverCommand?: string[];
+  // TODO Check version compatibility
+  // playwrightVersion?: string;
+  // /**
+  //  * Use to start standalone playwright browser
+  //  */
+  // playwrightBrowser?: () => Promise<Browser>;
   viewport?: { width: number; height: number };
-};
+
+  [name: string]: unknown;
+}
 
 export type StorybookGlobals = Record<string, unknown>;
 
-export type Browser = boolean | string | BrowserConfig;
+export type BrowserConfig = boolean | string | BrowserConfigObject;
+
+export type CreeveyWebdriverConstructor = new (
+  browser: string,
+  gridUrl: string,
+  config: Config,
+  options: Options,
+) => CreeveyWebdriver;
+
+export interface CreeveyWebdriver {
+  getSessionId(): Promise<string>;
+  openBrowser(fresh?: boolean): Promise<CreeveyWebdriver | null>;
+  closeBrowser(): Promise<void>;
+  loadStoriesFromBrowser(): Promise<StoriesRaw>;
+  switchStory(story: StoryInput, context: BaseCreeveyTestContext, logger: Logger.Logger): Promise<CreeveyTestContext>;
+  afterTest(test: ServerTest): Promise<void>;
+}
 
 export interface HookConfig {
   before?: () => unknown;
@@ -131,6 +167,9 @@ export interface DockerAuth {
   serveraddress?: string;
 }
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type BaseReporter = new (runner: EventEmitter, options: { reporterOptions: any }) => void;
+
 export interface Config {
   /**
    * Url to Selenium grid hub or standalone selenium.
@@ -156,21 +195,40 @@ export interface Config {
    * @default path.join(process.cwd(), './report')
    */
   reportDir: string;
+  /**
+   * Specify a custom reporter for test results. Creevey accepts only mocha-like reporters
+   * @optional
+   */
+  reporter: BaseReporter;
+  /**
+   * Options which are used by reporter
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  reporterOptions?: Record<string, any>;
   /**
    * How much test would be retried
    * @default 0
    */
   maxRetries: number;
+  /**
+   * How much time should be spent on each test
+   * @default 30000
+   */
+  testTimeout: number;
   /**
    * Define pixelmatch diff options
-   * @default { threshold: 0, includeAA: true }
+   * @default { threshold: 0.05, includeAA: false }
    */
   diffOptions: DiffOptions;
+  /**
+   *
+   */
+  odiffOptions: ODiffOptions; // TODO Update description
   /**
    * Browser capabilities
    * @default { chrome: true }
    */
-  browsers: Record<string, Browser>;
+  browsers: Record<string, BrowserConfig>;
   /**
    * Hooks that allow run custom script before and after creevey start
    */
@@ -204,11 +262,11 @@ export interface Config {
    * }
    * ```
    */
-  storiesProvider: StoriesProvider;
+  storiesProvider: StoriesProvider; // TODO Update description
   /**
-   * Define custom babel options for load stories transformation
+   *
    */
-  babelOptions: (options: Record<string, unknown>) => Record<string, unknown>;
+  webdriver: CreeveyWebdriverConstructor; // TODO Update description
   /**
    * Allows you to start selenoid without docker
    * and use standalone browsers
@@ -240,7 +298,6 @@ export interface Config {
   dockerImagePlatform: string;
   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
@@ -249,9 +306,12 @@ export interface Config {
   disableTelemetry?: boolean;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export interface StoriesProvider<T = any> {
-  (config: Config, options: T, storiesListener: (stories: Map<string, StoryInput[]>) => void): Promise<StoriesRaw>;
+export interface StoriesProvider {
+  (
+    config: Config,
+    storiesListener: (stories: Map<string, StoryInput[]>) => void,
+    webdriver?: CreeveyWebdriver,
+  ): Promise<StoriesRaw>;
   providerName?: string;
 }
 
@@ -265,17 +325,25 @@ export interface Options {
   update: boolean | string;
   debug: boolean;
   trace: boolean;
-  tests: boolean;
   browser?: string;
+  /**
+   * @deprecated use {@link Config.reporter} instead
+   */
   reporter?: string;
   screenDir?: string;
   reportDir?: string;
+  gridUrl?: string;
   storybookUrl?: string;
-  saveReport: boolean;
   failFast?: boolean;
+  odiff?: boolean;
 }
 
-export type WorkerMessage = { type: 'ready'; payload?: never } | { type: 'error'; payload: { error: string } };
+export type WorkerError = 'browser' | 'test' | 'unknown';
+
+export type WorkerMessage =
+  | { type: 'ready'; payload?: never }
+  | { type: 'port'; payload: { port: number } }
+  | { type: 'error'; payload: { subtype: WorkerError; error: string } };
 
 export type StoriesMessage =
   | { type: 'get'; payload?: never }
@@ -287,29 +355,17 @@ export type TestMessage =
   | { type: 'start'; payload: { id: string; path: string[]; retries: number } }
   | { type: 'end'; payload: TestResult };
 
-export type WebpackMessage =
-  | { type: 'success'; payload?: never }
-  | { type: 'fail'; payload?: never }
-  | { type: 'rebuild succeeded'; payload?: never }
-  | { type: 'rebuild failed'; payload?: never };
-
-export type DockerMessage = { type: 'start'; payload?: never } | { type: 'success'; payload: { gridUrl: string } };
-
 export type ShutdownMessage = object;
 
 export type ProcessMessage =
   | (WorkerMessage & { scope: 'worker' })
   | (StoriesMessage & { scope: 'stories' })
   | (TestMessage & { scope: 'test' })
-  | (WebpackMessage & { scope: 'webpack' })
-  | (DockerMessage & { scope: 'docker' })
   | (ShutdownMessage & { scope: 'shutdown' });
 
 export type WorkerHandler = (message: WorkerMessage) => void;
 export type StoriesHandler = (message: StoriesMessage) => void;
 export type TestHandler = (message: TestMessage) => void;
-export type WebpackHandler = (message: WebpackMessage) => void;
-export type DockerHandler = (message: DockerMessage) => void;
 export type ShutdownHandler = (message: ShutdownMessage) => void;
 
 export interface Worker extends ClusterWorker {
@@ -334,8 +390,8 @@ export interface TestResult {
   error?: string;
 }
 
-export interface ImagesError extends Error {
-  images: string | Partial<Record<string, string>>;
+export class ImagesError extends Error {
+  images?: string | Partial<Record<string, string>>;
 }
 
 export interface TestMeta {
@@ -354,9 +410,65 @@ export interface TestData extends TestMeta {
   approved?: Partial<Record<string, number>> | null;
 }
 
+export interface BaseCreeveyTestContext {
+  browserName: string;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  webdriver: any;
+  /**
+   * @deprecated Usually for screenshot testing you don't need other type of assertions except matching images, but if you really need it, please use external `expect` libs
+   */
+  expect: typeof expect;
+  /**
+   * @internal
+   */
+  screenshots: { imageName?: string; screenshot: Buffer }[];
+  matchImage: (image: Buffer, imageName?: string) => Promise<void>;
+  matchImages: (images: Record<string, Buffer>) => Promise<void>;
+}
+
+export interface CreeveyTestContext extends BaseCreeveyTestContext {
+  takeScreenshot: () => Promise<Buffer>;
+  updateStoryArgs: (updatedArgs: Record<string, unknown>) => Promise<void>;
+  captureElement: string | null;
+}
+
+export enum TEST_EVENTS {
+  RUN_BEGIN = 'start',
+  RUN_END = 'end',
+  TEST_BEGIN = 'test',
+  TEST_END = 'test end',
+  TEST_FAIL = 'fail',
+  TEST_PASS = 'pass',
+}
+
 export interface ServerTest extends TestData {
   story: StoryInput;
-  fn: (this: Context) => Promise<void>;
+  fn: CreeveyTestFunction;
+}
+
+export interface FakeSuite {
+  title: string;
+  fullTitle: () => string;
+  titlePath: () => string[];
+  tests: FakeTest[];
+}
+
+// NOTE: Mocha-like test interface, used specifically for reporting
+export interface FakeTest {
+  parent: FakeSuite;
+  title: string;
+  fullTitle: () => string;
+  titlePath: () => string[];
+  currentRetry: () => number;
+  retires: () => number;
+  slow: () => number;
+  duration?: number;
+  state?: 'failed' | 'passed';
+  // NOTE > duration, > duration / 2, > 0
+  speed?: 'slow' | 'medium' | 'fast';
+  err?: unknown;
+  // NOTE: image files
+  attachments?: string[];
 }
 
 export interface CreeveyStatus {
@@ -381,17 +493,7 @@ export interface SkipOption {
 
 export type SkipOptions = boolean | string | Record<string, SkipOption | SkipOption[]>;
 
-export interface CreeveyTestController {
-  browser: WebDriver;
-  until: typeof until;
-  keys: IKey;
-  expect: typeof expect;
-  takeScreenshot: () => Promise<string>;
-  updateStoryArgs: (updatedArgs: Record<string, unknown>) => Promise<void>;
-  readonly captureElement?: WebElementPromise;
-}
-
-export type CreeveyTestFunction = (this: CreeveyTestController) => Promise<void>;
+export type CreeveyTestFunction = (context: CreeveyTestContext) => Promise<void>;
 
 export interface CaptureOptions {
   imageName?: string;
@@ -474,7 +576,7 @@ export function isFunction(x: unknown): x is (...args: any[]) => any {
 }
 
 export function isImageError(error: unknown): error is ImagesError {
-  return error instanceof Error && 'images' in error;
+  return error instanceof ImagesError && 'images' in error;
 }
 
 export function isProcessMessage(message: unknown): message is ProcessMessage {
@@ -492,11 +594,3 @@ export function isStoriesMessage(message: unknown): message is StoriesMessage {
 export function isTestMessage(message: unknown): message is TestMessage {
   return isProcessMessage(message) && message.scope == 'test';
 }
-
-export function isWebpackMessage(message: unknown): message is WebpackMessage {
-  return isProcessMessage(message) && message.scope == 'webpack';
-}
-
-export function isDockerMessage(message: unknown): message is DockerMessage {
-  return isProcessMessage(message) && message.scope == 'docker';
-}

package/types/playwright-context.d.ts

@@ -0,0 +1,7 @@
+import { Page } from 'playwright-core';
+
+declare module 'creevey' {
+  interface CreeveyTestContext {
+    webdriver: Page;
+  }
+}

package/types/selenium-context.d.ts

@@ -0,0 +1,7 @@
+import { WebDriver } from 'selenium-webdriver';
+
+declare module 'creevey' {
+  interface CreeveyTestContext {
+    webdriver: WebDriver;
+  }
+}

package/dist/client/web/202.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkcreevey=self.webpackChunkcreevey||[]).push([[202],{47202:(e,t,i)=>{i.r(t),i.d(t,{WithToolTipState:()=>o.vb,WithTooltip:()=>o.vb,WithTooltipPure:()=>o.o4});var o=i(31461)}}]);