creevey 0.10.0-beta.2 → 0.10.0-beta.20

package/src/server/webdriver.ts

@@ -1,8 +1,7 @@
-import Logger from 'loglevel';
 import chalk from 'chalk';
 import { networkInterfaces } from 'os';
-import { logger as defaultLogger } from './logger.js';
-import { Args } from '@storybook/csf';
+import { logger } from './logger.js';
+import type { Args } from '@storybook/csf';
 import {
   isDefined,
   StoryInput,
@@ -22,15 +21,15 @@ const DOCKER_INTERNAL = 'host.docker.internal';
 export async function resolveStorybookUrl(
   storybookUrl: string,
   checkUrl: (url: string) => Promise<boolean>,
-  logger: Logger.Logger = defaultLogger,
 ): Promise<string> {
-  logger.debug('Resolving storybook url');
+  logger().debug('Resolving storybook url');
   const addresses = getAddresses();
+  // TODO Use Promise.race?
   for (const ip of addresses) {
     const resolvedUrl = storybookUrl.replace(LOCALHOST_REGEXP, ip);
-    logger.debug(`Checking storybook availability on ${chalk.magenta(resolvedUrl)}`);
+    logger().debug(`Checking storybook availability on ${chalk.magenta(resolvedUrl)}`);
     if (await checkUrl(resolvedUrl)) {
-      logger.debug(`Resolved storybook url ${chalk.magenta(resolvedUrl)}`);
+      logger().debug(`Resolved storybook url ${chalk.magenta(resolvedUrl)}`);
       return resolvedUrl;
     }
   }
@@ -74,11 +73,7 @@ export abstract class CreeveyWebdriverBase implements CreeveyWebdriver {
 
   abstract afterTest(test: ServerTest): Promise<void>;
 
-  async switchStory(
-    story: StoryInput,
-    context: BaseCreeveyTestContext,
-    logger: Logger.Logger,
-  ): Promise<CreeveyTestContext> {
+  async switchStory(story: StoryInput, context: BaseCreeveyTestContext): Promise<CreeveyTestContext> {
     const { id, title, name, parameters } = story;
     const {
       captureElement = `#${storybookRootID}`,
@@ -86,7 +81,7 @@ export abstract class CreeveyWebdriverBase implements CreeveyWebdriver {
       ignoreElements,
     } = (parameters.creevey ?? {}) as CreeveyStoryParams;
 
-    logger.debug(`Switching to story ${chalk.cyan(title)}/${chalk.cyan(name)} by id ${chalk.magenta(id)}`);
+    logger().debug(`Switching to story ${chalk.cyan(title)}/${chalk.cyan(name)} by id ${chalk.magenta(id)}`);
 
     let storyPlayResolver: (isCompleted: boolean) => void;
     let waitForComplete = new Promise<boolean>((resolve) => (storyPlayResolver = resolve));
@@ -107,7 +102,7 @@ export abstract class CreeveyWebdriverBase implements CreeveyWebdriver {
     const isCaptureCalled = await this.selectStory(id, waitForReady);
 
     if (isCaptureCalled) {
-      logger.debug(`Capturing screenshots from ${chalk.magenta(id)} story's \`play()\` function`);
+      logger().debug(`Capturing screenshots from ${chalk.magenta(id)} story's \`play()\` function`);
       while (!(await waitForComplete)) {
         waitForComplete = new Promise<boolean>((resolve) => (storyPlayResolver = resolve));
       }
@@ -115,8 +110,8 @@ export abstract class CreeveyWebdriverBase implements CreeveyWebdriver {
 
     unsubscribe();
 
-    if (isCaptureCalled) logger.debug(`Story ${chalk.magenta(id)} completed capturing`);
-    else logger.debug(`Story ${chalk.magenta(id)} ready for capturing`);
+    if (isCaptureCalled) logger().debug(`Story ${chalk.magenta(id)} completed capturing`);
+    else logger().debug(`Story ${chalk.magenta(id)} ready for capturing`);
 
     return Object.assign(
       {

package/src/server/worker/chai-image.ts

@@ -1,8 +1,8 @@
-import Logger from 'loglevel';
+import { logger } from '../logger';
+
 export default function (
   matchImage: (image: Buffer, imageName?: string) => Promise<void>,
   matchImages: (images: Record<string, Buffer>) => Promise<void>,
-  logger: Logger.Logger,
 ) {
   let isWarningShown = false;
   return function chaiImage({ Assertion }: Chai.ChaiStatic, utils: Chai.ChaiUtils): void {
@@ -11,7 +11,7 @@ export default function (
       'matchImage',
       async function (this: Record<string, unknown>, imageName?: string) {
         if (!isWarningShown) {
-          logger.warn(
+          logger().warn(
             '`expect(...).to.matchImage()` is deprecated and will be removed in the next major release. Please use `context.matchImage()` instead.',
           );
           isWarningShown = true;
@@ -23,7 +23,7 @@ export default function (
 
     utils.addMethod(Assertion.prototype, 'matchImages', async function (this: Record<string, unknown>) {
       if (!isWarningShown) {
-        logger.warn(
+        logger().warn(
           '`expect(...).to.matchImages()` is deprecated and will be removed in the next major release. Please use `context.matchImages()` instead.',
         );
         isWarningShown = true;

package/src/server/worker/match-image.ts

@@ -21,6 +21,10 @@ interface ImagePaths {
   reportImageDir: string;
 }
 
+function toBuffer(bufferOrBase64: Buffer | string) {
+  return typeof bufferOrBase64 === 'string' ? Buffer.from(bufferOrBase64, 'base64') : bufferOrBase64;
+}
+
 async function getStat(filePath: string): Promise<Stats | null> {
   try {
     return await stat(filePath);
@@ -228,17 +232,17 @@ export async function getMatchers(ctx: ImageContext, config: Config) {
   }
 
   return {
-    matchImage: async (image: Buffer, imageName?: string) => {
-      const errorMessage = await assertImage(image, imageName);
+    matchImage: async (image: Buffer | string, imageName?: string) => {
+      const errorMessage = await assertImage(toBuffer(image), imageName);
       if (errorMessage) {
         throw createImageError(imageName ? { [imageName]: errorMessage } : errorMessage);
       }
     },
-    matchImages: async (images: Record<string, Buffer>) => {
+    matchImages: async (images: Record<string, Buffer | string>) => {
       const errors: Record<string, string> = {};
       await Promise.all(
         Object.entries(images).map(async ([imageName, image]) => {
-          const errorMessage = await assertImage(image, imageName);
+          const errorMessage = await assertImage(toBuffer(image), imageName);
           if (errorMessage) {
             errors[imageName] = errorMessage;
           }
@@ -279,17 +283,17 @@ export function getOdiffMatchers(ctx: ImageContext, config: Config) {
   }
 
   return {
-    matchImage: async (image: Buffer, imageName?: string) => {
-      const errorMessage = await assertImage(image, imageName);
+    matchImage: async (image: Buffer | string, imageName?: string) => {
+      const errorMessage = await assertImage(toBuffer(image), imageName);
       if (errorMessage) {
         throw createImageError(imageName ? { [imageName]: errorMessage } : errorMessage);
       }
     },
-    matchImages: async (images: Record<string, Buffer>) => {
+    matchImages: async (images: Record<string, Buffer | string>) => {
       const errors: Record<string, string> = {};
       await Promise.all(
         Object.entries(images).map(async ([imageName, image]) => {
-          const errorMessage = await assertImage(image, imageName);
+          const errorMessage = await assertImage(toBuffer(image), imageName);
           if (errorMessage) {
             errors[imageName] = errorMessage;
           }

package/src/server/worker/start.ts

@@ -1,6 +1,4 @@
 import chai from 'chai';
-import chalk from 'chalk';
-import Logger from 'loglevel';
 import EventEmitter from 'events';
 import {
   BaseCreeveyTestContext,
@@ -86,7 +84,7 @@ function runHandler(browserName: string, images: Partial<Record<string, Images>>
 
 async function setupWebdriver(webdriver: CreeveyWebdriver): Promise<[string, CreeveyWebdriver] | undefined> {
   if ((await webdriver.openBrowser(true)) == null) {
-    logger.error('Failed to start browser');
+    logger().error('Failed to start browser');
     emitWorkerMessage({
       type: 'error',
       payload: { subtype: 'browser', error: 'Failed to start browser' },
@@ -125,8 +123,6 @@ export async function start(browser: string, gridUrl: string, config: Config, op
 
   if (!webdriver || !sessionId) return;
 
-  const workerLogger = Logger.getLogger(`${browser}:${chalk.gray(sessionId)}`);
-
   const reporterOptions = {
     ...config.reporterOptions,
     creevey: {
@@ -150,13 +146,13 @@ export async function start(browser: string, gridUrl: string, config: Config, op
   const { matchImage, matchImages } = options.odiff
     ? getOdiffMatchers(imagesContext, config)
     : await getMatchers(imagesContext, config);
-  chai.use(chaiImage(matchImage, matchImages, workerLogger));
+  chai.use(chaiImage(matchImage, matchImages));
 
   const tests = await (async () => {
     try {
       return await getTestsFromStories(config, browser, webdriver);
     } catch (error) {
-      workerLogger.error('Failed to get tests from stories:', error);
+      logger().error('Failed to get tests from stories:', error);
       emitWorkerMessage({
         type: 'error',
         payload: { subtype: 'browser', error: serializeError(error) },
@@ -174,7 +170,7 @@ export async function start(browser: string, gridUrl: string, config: Config, op
 
     if (!test) {
       const error = `Test with id ${message.payload.id} not found`;
-      workerLogger.error(error);
+      logger().error(error);
       emitWorkerMessage({
         type: 'error',
         payload: { subtype: 'test', error },
@@ -226,16 +222,20 @@ export async function start(browser: string, gridUrl: string, config: Config, op
       runner.emit(TEST_EVENTS.RUN_BEGIN);
       runner.emit(TEST_EVENTS.TEST_BEGIN, fakeTest);
 
+      let timeout;
+      let isRejected = false;
       const start = Date.now();
       try {
         await Promise.race([
-          new Promise((reject) =>
-            setTimeout(() => {
-              reject(`Timeout of ${config.testTimeout}ms exceeded`);
-            }, config.testTimeout),
+          new Promise(
+            (_, reject) =>
+              (timeout = setTimeout(() => {
+                isRejected = true;
+                reject(new Error(`Timeout of ${config.testTimeout}ms exceeded`));
+              }, config.testTimeout)),
           ),
           (async () => {
-            const context = await webdriver.switchStory(test.story, baseContext, workerLogger);
+            const context = await webdriver.switchStory(test.story, baseContext);
             await test.fn(context);
           })(),
         ]);
@@ -244,6 +244,7 @@ export async function start(browser: string, gridUrl: string, config: Config, op
         fakeTest.err = error;
       }
       const duration = Date.now() - start;
+      clearTimeout(timeout);
       fakeTest.attachments = imagesContext.attachments;
       fakeTest.state = error ? 'failed' : 'passed';
       fakeTest.duration = duration;
@@ -259,9 +260,17 @@ export async function start(browser: string, gridUrl: string, config: Config, op
 
       await webdriver.afterTest(test);
 
-      runHandler(baseContext.browserName, imagesContext.images, error);
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      if (isRejected) {
+        emitWorkerMessage({
+          type: 'error',
+          payload: { subtype: 'unknown', error: serializeError(error) },
+        });
+      } else {
+        runHandler(baseContext.browserName, imagesContext.images, error);
+      }
     })().catch((error: unknown) => {
-      workerLogger.error('Unexpected error:', error);
+      logger().error('Unexpected error:', error);
       emitWorkerMessage({
         type: 'error',
         payload: { subtype: 'test', error: serializeError(error) },
@@ -269,7 +278,7 @@ export async function start(browser: string, gridUrl: string, config: Config, op
     });
   });
 
-  workerLogger.info('Browser is ready');
+  logger().info('Browser is ready');
 
   emitWorkerMessage({ type: 'ready' });
 }

package/src/shared/index.ts

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import { Parameters } from '@storybook/csf';
+import type { Parameters } from '@storybook/csf';
 import { SetStoriesData, StoriesRaw, CreeveyStoryParams, StoryInput } from '../types.js';
 import { deserializeRegExp, isSerializedRegExp, isRegExp, serializeRegExp } from './serializeRegExp.js';
 

package/src/types.ts

@@ -4,7 +4,7 @@ import type Pixelmatch from 'pixelmatch';
 import type { ODiffOptions } from 'odiff-bin';
 import type { expect } from 'chai';
 import type EventEmitter from 'events';
-import type Logger from 'loglevel';
+import { LaunchOptions } from 'playwright-core';
 // import type { Browser } from 'playwright-core';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -41,6 +41,18 @@ export interface StoryMeta {
   };
 }
 
+export enum StorybookEvents {
+  SET_STORIES = 'setStories',
+  SET_CURRENT_STORY = 'setCurrentStory',
+  FORCE_REMOUNT = 'forceRemount',
+  STORY_RENDERED = 'storyRendered',
+  STORY_ERRORED = 'storyErrored',
+  STORY_THREW_EXCEPTION = 'storyThrewException',
+  UPDATE_STORY_ARGS = 'updateStoryArgs',
+  SET_GLOBALS = 'setGlobals',
+  UPDATE_GLOBALS = 'updateGlobals',
+}
+
 export interface CreeveyMeta {
   parameters?: {
     creevey?: CreeveyStoryParams;
@@ -90,15 +102,8 @@ export class ChromeConfig {
 }
 */
 export interface BrowserConfigObject {
+  // TODO Restrict browser names for playwright images
   browserName: string;
-  /**
-   * Browser version. Ignored with Playwright webdriver
-   */
-  browserVersion?: string;
-  /**
-   * Operation system name. Ignored with Playwright webdriver
-   */
-  platformName?: string;
   // customizeBuilder?: (builder: Builder) => Builder;
   limit?: number;
   /**
@@ -122,15 +127,25 @@ export interface BrowserConfigObject {
    * 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;
+  seleniumCapabilities?: {
+    /**
+     * Browser version. Ignored with Playwright webdriver
+     */
+    browserVersion?: string;
+    /**
+     * Operation system name. Ignored with Playwright webdriver
+     */
+    platformName?: string;
+    [name: string]: unknown;
+  };
+
+  playwrightOptions?: Omit<LaunchOptions, 'logger'>;
 }
 
 export type StorybookGlobals = Record<string, unknown>;
@@ -149,7 +164,7 @@ export interface CreeveyWebdriver {
   openBrowser(fresh?: boolean): Promise<CreeveyWebdriver | null>;
   closeBrowser(): Promise<void>;
   loadStoriesFromBrowser(): Promise<StoriesRaw>;
-  switchStory(story: StoryInput, context: BaseCreeveyTestContext, logger: Logger.Logger): Promise<CreeveyTestContext>;
+  switchStory(story: StoryInput, context: BaseCreeveyTestContext): Promise<CreeveyTestContext>;
   afterTest(test: ServerTest): Promise<void>;
 }
 
@@ -292,6 +307,11 @@ export interface Config {
    * The `--ui` CLI option ignores this option
    */
   failFast: boolean;
+  /**
+   * Start workers in sequential queue
+   * @default false
+   */
+  useWorkerQueue: boolean;
   /**
    * Specify platform for docker images
    */
@@ -422,8 +442,8 @@ export interface BaseCreeveyTestContext {
    * @internal
    */
   screenshots: { imageName?: string; screenshot: Buffer }[];
-  matchImage: (image: Buffer, imageName?: string) => Promise<void>;
-  matchImages: (images: Record<string, Buffer>) => Promise<void>;
+  matchImage: (image: Buffer | string, imageName?: string) => Promise<void>;
+  matchImages: (images: Record<string, Buffer | string>) => Promise<void>;
 }
 
 export interface CreeveyTestContext extends BaseCreeveyTestContext {

package/types/global.d.ts

@@ -1,5 +1,6 @@
 /* eslint-disable no-var */
 
+declare var __CREEVEY_ENV__: boolean;
 declare var __CREEVEY_SERVER_HOST__: string;
 declare var __CREEVEY_SERVER_PORT__: number | null;
 declare var __CREEVEY_CLIENT_PORT__: number | null;

package/.yarnrc.yml

@@ -1 +0,0 @@
-nodeLinker: node-modules

package/chromatic.config.json

@@ -1,5 +0,0 @@
-{
-  "onlyChanged": true,
-  "projectId": "Project:5fd73972015e660021b97564",
-  "zip": true
-}