creevey 0.10.0-beta.23 → 0.10.0-beta.24

package/src/server/utils.ts

@@ -1,5 +1,6 @@
 import fs from 'fs';
-import { get } from 'https';
+import https from 'https';
+import http from 'http';
 import cluster from 'cluster';
 import { dirname } from 'path';
 import { fileURLToPath, pathToFileURL } from 'url';
@@ -7,6 +8,7 @@ import { register as esmRegister } from 'tsx/esm/api';
 import { register as cjsRegister } from 'tsx/cjs/api';
 import { SkipOptions, SkipOption, isDefined, TestData, noop, ServerTest, Worker } from '../types.js';
 import { emitShutdownMessage, sendShutdownMessage } from './messages.js';
+import assert from 'assert';
 
 const importMetaUrl = pathToFileURL(__filename).href;
 
@@ -14,6 +16,19 @@ export const isShuttingDown = { current: false };
 
 export const configExt = ['.js', '.mjs', '.ts', '.cjs', '.mts', '.cts'];
 
+const browserTypes = {
+  chromium: 'chromium',
+  'chromium-headless-shell': 'chromium',
+  chrome: 'chromium',
+  'chrome-beta': 'chromium',
+  msedge: 'chromium',
+  'msedge-beta': 'chromium',
+  'msedge-dev': 'chromium',
+  'bidi-chromium': 'chromium',
+  firefox: 'firefox',
+  webkit: 'webkit',
+} as const;
+
 export const skipOptionKeys = ['in', 'kinds', 'stories', 'tests', 'reason'];
 
 function matchBy(pattern: string | string[] | RegExp | undefined, value: string): boolean {
@@ -106,6 +121,23 @@ export function gracefullyKill(worker: Worker): void {
   sendShutdownMessage(worker);
 }
 
+export function shutdown(): void {
+  process.exit();
+}
+
+export function shutdownWithError(): void {
+  process.exit(1);
+}
+
+export function resolvePlaywrightBrowserType(browserName: string): (typeof browserTypes)[keyof typeof browserTypes] {
+  assert(
+    browserName in browserTypes,
+    new Error(`Failed to match browser name "${browserName}" to playwright browserType`),
+  );
+
+  return browserTypes[browserName as keyof typeof browserTypes];
+}
+
 export async function getCreeveyCache(): Promise<string | undefined> {
   const { default: findCacheDir } = await import('find-cache-dir');
   return findCacheDir({ name: 'creevey', cwd: dirname(fileURLToPath(importMetaUrl)) });
@@ -141,11 +173,12 @@ export function testsToImages(tests: (TestData | undefined)[]): Set<string> {
 
 // https://tuhrig.de/how-to-know-you-are-inside-a-docker-container/
 export const isInsideDocker =
-  fs.existsSync('/proc/1/cgroup') && fs.readFileSync('/proc/1/cgroup', 'utf-8').includes('docker');
+  (fs.existsSync('/proc/1/cgroup') && fs.readFileSync('/proc/1/cgroup', 'utf-8').includes('docker')) ||
+  process.env.DOCKER === 'true';
 
 export const downloadBinary = (downloadUrl: string, destination: string): Promise<void> =>
   new Promise((resolve, reject) =>
-    get(downloadUrl, (response) => {
+    https.get(downloadUrl, (response) => {
       if (response.statusCode == 302) {
         const { location } = response.headers;
         if (!location) {
@@ -214,3 +247,26 @@ export async function loadThroughTSX<T>(
 
   return result;
 }
+
+export function waitOnUrl(url: string, timeout: number, delay: number) {
+  const startTime = Date.now();
+  return new Promise<void>((resolve, reject) => {
+    const interval = setInterval(() => {
+      http
+        .get(url, (response) => {
+          if (response.statusCode === 200) {
+            clearInterval(interval);
+            resolve();
+          }
+        })
+        .on('error', () => {
+          // Ignore HTTP errors
+        });
+
+      if (Date.now() - startTime > timeout) {
+        clearInterval(interval);
+        reject(new Error(`${url} didn't respond within ${timeout / 1000} seconds`));
+      }
+    }, delay);
+  });
+}

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 { LaunchOptions } from 'playwright-core';
+import type { LaunchOptions } from 'playwright-core';
 // import type { Browser } from 'playwright-core';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -145,7 +145,14 @@ export interface BrowserConfigObject {
     [name: string]: unknown;
   };
 
-  playwrightOptions?: Omit<LaunchOptions, 'logger'>;
+  playwrightOptions?: Omit<LaunchOptions, 'logger'> & {
+    trace?: {
+      screenshots?: boolean;
+      snapshots?: boolean;
+      sources?: boolean;
+      path: string;
+    };
+  };
 }
 
 export type StorybookGlobals = Record<string, unknown>;
@@ -200,6 +207,11 @@ export interface Config {
    * Url where storybook hosted on
    */
   resolveStorybookUrl?: () => Promise<string>;
+  /**
+   * Command to automatically start Storybook if it is not running.
+   * For example, `npm run storybook`, `yarn run storybook` etc.
+   */
+  storybookAutorunCmd?: string;
   /**
    * Absolute path to directory with reference images
    * @default path.join(process.cwd(), './images')
@@ -354,6 +366,8 @@ export interface Options {
   reportDir?: string;
   gridUrl?: string;
   storybookUrl?: string;
+  storybookAutorunCmd?: string;
+  saveReport: boolean;
   failFast?: boolean;
   odiff?: boolean;
 }