creevey 0.9.0-beta.2 → 0.9.0-beta.21

package/package.json

@@ -1,6 +1,22 @@
 {
   "name": "creevey",
   "description": "Cross-browser screenshot testing tool for Storybook with fancy UI Runner",
+  "version": "0.9.0-beta.21",
+  "type": "commonjs",
+  "bin": "./dist/cli.js",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./manager": "./dist/client/addon/manager.js",
+    "./preview": "./dist/client/addon/preview.js",
+    "./preset": "./dist/client/addon/preset.js",
+    "./dist/client/addon/manager.js": "./dist/client/addon/manager.js",
+    "./dist/client/addon/preview.js": "./dist/client/addon/preview.js",
+    "./package.json": "./package.json"
+  },
+  "author": "Dmitriy Lazarev <w@kich.dev>",
+  "repository": "github.com:creevey/creevey",
   "keywords": [
     "testing",
     "storybook",
@@ -13,203 +29,159 @@
     "addon",
     "test"
   ],
-  "version": "0.9.0-beta.2",
-  "bin": {
-    "creevey": "./lib/cjs/cli.js"
-  },
-  "main": "lib/cjs/index.js",
-  "module": "lib/esm/index.js",
-  "types": "lib/types/index.d.ts",
-  "author": "Dmitriy Lazarev <w@kich.dev>",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/wKich/creevey.git"
-  },
   "license": "MIT",
   "scripts": {
     "commit": "git-cz",
-    "clean": "rimraf lib",
-    "lint": "run-p --continue-on-error lint:*",
+    "clean": "rimraf dist",
+    "lint": "redrun -p \"lint:*\"",
     "lint:tsc": "tsc --noEmit",
-    "lint:eslint": "eslint --ext .js,.ts,.tsx ./",
-    "lint:prettier": "prettier --check *.{md,json,js,ts} ./**/*.{js,ts,tsx}",
-    "pretest:e2e": "yarn build && yarn pack -f creevey.tgz",
-    "bootstrap:storybook": "cd ../storybook && yarn install && yarn bootstrap --core",
-    "test": "run-p test:*",
-    "test:unit": "mocha ./tests/{client,server}/**/*.test.ts ./tests/*.test.ts",
-    "test:e2e": "mocha ./tests/e2e/*.test.ts",
-    "start": "run-p start:*",
+    "lint:eslint": "eslint",
+    "lint:prettier": "prettier --check .",
+    "test": "vitest",
+    "start": "redrun -p \"start:*\"",
     "start:client": "webpack-dev-server",
-    "start:storybook": "start-storybook --ci -p 6006",
+    "start:storybook": "storybook dev --ci -p 6006",
     "start:creevey": "yarn creevey --ui",
-    "start:creevey:github": "yarn creevey:github --ui",
-    "creevey": "node --require ./scripts/babel-register -- src/cli",
+    "creevey": "tsx ./src/cli",
     "creevey:github": "yarn creevey --config .creevey/github.config.ts",
     "creevey:gitlab": "yarn creevey --config .creevey/gitlab.config.ts",
     "creevey:hybrid": "yarn creevey --config .creevey/hybrid.config.ts",
-    "fix": "run-s fix:*",
-    "fix:eslint": "eslint --fix ./",
+    "fix": "redrun \"fix:*\"",
+    "fix:eslint": "eslint --fix",
     "fix:prettier": "prettier --write .",
-    "prebuild": "yarn clean && mkdir lib",
-    "build": "run-p --continue-on-error build:*",
-    "build:types": "tsc --emitDeclarationOnly -p scripts/tsconfig.prod.json",
-    "build:creevey": "run-p \"build:creevey:* --extensions .ts,.tsx --ignore src/client/web\"",
-    "build:creevey:cjs": "cross-env BABEL_MODE=cjs babel src --out-dir lib/cjs",
-    "build:creevey:esm": "cross-env BABEL_MODE=esm babel src --out-dir lib/esm",
-    "build:client": "webpack --mode production",
-    "postbuild": "run-p copy:*",
-    "copy:index": "cpx scripts/dist/types/* lib/types/",
-    "copy:html": "cpx src/client/web/index.html lib/cjs/client/web",
+    "prebuild": "yarn clean && mkdir dist",
+    "build": "yarn prebuild && yarn build:client && yarn build:creevey && yarn postbuild",
+    "build:client": "webpack --mode production && cpx src/client/web/index.html dist/client/web",
+    "build:creevey": "tsc --build tsconfig.prod.json",
+    "postbuild": "cpx \"scripts/dist/*\" dist/",
     "version": "conventional-changelog -p angular -i CHANGELOG.md -s && git add CHANGELOG.md",
-    "build-storybook": "build-storybook",
+    "build-storybook": "storybook build",
     "chromatic": "npx chromatic --project-token t3010eknrh",
     "prepare": "husky install"
   },
   "engines": {
-    "node": ">=10.10"
+    "node": ">=18.0"
   },
   "dependencies": {
-    "@babel/code-frame": "^7.12.13",
-    "@babel/generator": "^7.15.0",
-    "@babel/helpers": "^7.15.3",
-    "@babel/parser": "^7.15.3",
-    "@babel/plugin-transform-runtime": "^7.15.0",
-    "@babel/preset-env": "^7.15.0",
-    "@babel/preset-typescript": "^7.15.0",
-    "@babel/register": "^7.15.3",
-    "@babel/runtime-corejs3": "^7.15.3",
-    "@babel/traverse": "^7.15.0",
-    "@babel/types": "^7.15.0",
-    "@koa/cors": "^3.2.0",
-    "@octokit/core": "^3.3.1",
-    "@storybook/components": "^6.4.19",
-    "@storybook/csf": "0.0.2--canary.87bc651.0",
-    "@storybook/testing-library": "^0.0.9",
-    "@storybook/theming": "^6.4.19",
-    "@types/chai": "^4.2.15",
-    "@types/selenium-webdriver": "^4.0.12",
-    "airbnb-js-shims": "^2.2.1",
-    "babel-plugin-tsconfig-paths": "^1.0.3",
-    "chai": "^4.3.4",
-    "chalk": "^4.1.2",
-    "chokidar": "^3.5.1",
-    "core-js": "^3.16.3",
-    "dockerode": "^3.2.1",
-    "event-source-polyfill": "1.0.25",
-    "find-cache-dir": "^3.3.1",
-    "get-tsconfig": "^4.2.0",
-    "global-jsdom": "8.3.0",
-    "jsdom": "^16.5.2",
-    "koa": "^2.13.1",
-    "koa-bodyparser": "^4.3.0",
-    "koa-mount": "^4.0.0",
-    "koa-static": "^5.0.0",
-    "loader-utils": "^2.0.0",
-    "lodash": "^4.17.21",
-    "loglevel": "^1.7.1",
-    "loglevel-plugin-prefix": "^0.8.4",
-    "micromatch": "^4.0.4",
-    "minimist": "^1.2.5",
-    "mocha": "~9.1.0",
-    "null-loader": "^4.0.1",
-    "ora": "^5.4.0",
-    "pirates": "^4.0.1",
-    "pixelmatch": "^5.2.1",
-    "pngjs": "^6.0.0",
-    "polished": "^4.1.1",
-    "qs": "^6.10.1",
-    "regenerator-runtime": "^0.13.7",
-    "resolve-from": "^5.0.0",
-    "schema-utils": "^3.0.0",
-    "selenium-webdriver": "^4.0.0-beta.3",
-    "shelljs": "^0.8.4",
-    "ts-node": "^10.9.1",
-    "tsconfig-paths": "^3.11.0",
-    "webpack-node-externals": "^3.0.0",
-    "ws": "^7.4.6"
-  },
-  "devDependencies": {
-    "@babel/cli": "^7.13.14",
-    "@babel/core": "^7.15.0",
-    "@babel/plugin-proposal-class-properties": "^7.13.0",
-    "@babel/preset-react": "^7.13.13",
-    "@mdx-js/mdx": "^1.6.22",
-    "@storybook/addon-essentials": "^6.4.19",
-    "@storybook/addon-postcss": "^2.0.0",
-    "@storybook/addons": "^6.4.19",
-    "@storybook/api": "^6.4.19",
-    "@storybook/channels": "^6.4.19",
-    "@storybook/client-api": "^6.4.19",
-    "@storybook/client-logger": "^6.4.19",
-    "@storybook/core": "^6.4.19",
-    "@storybook/core-client": "^6.4.19",
-    "@storybook/core-common": "^6.4.19",
-    "@storybook/core-events": "^6.4.19",
-    "@storybook/core-server": "^6.4.19",
-    "@storybook/preview-web": "^6.4.19",
-    "@storybook/react": "^6.4.19",
-    "@types/babel__code-frame": "^7.0.2",
-    "@types/babel__generator": "^7.6.2",
-    "@types/babel__traverse": "^7.11.1",
-    "@types/dockerode": "^3.2.3",
+    "@koa/cors": "^3.3.0",
+    "@octokit/core": "^4.0.4",
+    "@storybook/components": "^7.6.20",
+    "@storybook/core-events": "^7.6.20",
+    "@storybook/csf": "^0.1.2",
+    "@storybook/manager-api": "^7.6.20",
+    "@storybook/preview-api": "^7.6.20",
+    "@storybook/theming": "^7.6.20",
+    "@types/chai": "^4.3.19",
+    "@types/dockerode": "^3.3.31",
     "@types/find-cache-dir": "^3.2.0",
     "@types/koa": "^2.13.1",
     "@types/koa-bodyparser": "^4.3.7",
     "@types/koa-mount": "^4.0.1",
     "@types/koa-static": "^4.0.1",
-    "@types/koa__cors": "^3.1.1",
-    "@types/loader-utils": "^2.0.2",
-    "@types/lodash": "^4.14.172",
+    "@types/koa__cors": "^3.3.0",
+    "@types/lodash": "^4.14.182",
     "@types/micromatch": "^4.0.1",
     "@types/minimist": "^1.2.1",
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^14.14.37",
+    "@types/mocha": "^9.1.1",
     "@types/pixelmatch": "^5.2.2",
     "@types/pngjs": "^6.0.0",
     "@types/qs": "^6.9.6",
     "@types/react": "^17.0.19",
     "@types/react-dom": "^17.0.3",
-    "@types/resize-observer-browser": "^0.1.5",
-    "@types/shelljs": "^0.8.8",
-    "@types/tmp": "^0.2.0",
-    "@types/webpack": "^4.41.26",
-    "@types/webpack-dev-server": "^3.11.3",
-    "@types/webpack-node-externals": "^2.5.1",
-    "@types/ws": "^7.4.0",
-    "@typescript-eslint/eslint-plugin": "^4.29.3",
-    "@typescript-eslint/parser": "^4.29.3",
-    "babel-loader": "^8.2.1",
-    "browserstack-local": "^1.4.8",
-    "chromatic": "^5.7.0",
-    "conventional-changelog-cli": "^2.1.1",
-    "cpx": "1.5.0",
+    "@types/selenium-webdriver": "^4.1.26",
+    "@types/shelljs": "^0.8.15",
+    "@types/uuid": "^10",
+    "@types/ws": "^8.5.3",
+    "chai": "^4.5.0",
+    "chalk": "^4.1.2",
+    "chokidar": "^3.5.3",
+    "dockerode": "^4.0.2",
+    "find-cache-dir": "^3.3.1",
+    "koa": "^2.13.4",
+    "koa-bodyparser": "^4.3.0",
+    "koa-mount": "^4.0.0",
+    "koa-static": "^5.0.0",
+    "lodash": "^4.17.21",
+    "loglevel": "^1.8.0",
+    "loglevel-plugin-prefix": "^0.8.4",
+    "micromatch": "^4.0.5",
+    "minimist": "^1.2.6",
+    "mocha": "~10.0.0",
+    "ora": "^5.4.1",
+    "pixelmatch": "^5.3.0",
+    "pngjs": "^6.0.0",
+    "polished": "^4.2.2",
+    "qs": "^6.11.0",
+    "selenium-webdriver": "^4.25.0",
+    "shelljs": "^0.8.5",
+    "tsx": "^4.17.0",
+    "uuid": "^10.0.0",
+    "ws": "^8.8.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.25.2",
+    "@babel/preset-env": "^7.25.4",
+    "@babel/preset-react": "^7.24.7",
+    "@babel/preset-typescript": "^7.24.7",
+    "@eslint/js": "^9.9.1",
+    "@storybook/addon-essentials": "^7.6.20",
+    "@storybook/addon-interactions": "^7.6.20",
+    "@storybook/addon-links": "^7.6.20",
+    "@storybook/addon-onboarding": "^1.0.10",
+    "@storybook/addons": "^7.6.20",
+    "@storybook/api": "^7.6.20",
+    "@storybook/channels": "^7.6.20",
+    "@storybook/client-api": "^7.6.20",
+    "@storybook/client-logger": "^7.6.20",
+    "@storybook/core-client": "^7.6.20",
+    "@storybook/core-common": "^7.6.20",
+    "@storybook/core-server": "^7.6.20",
+    "@storybook/preview-web": "^7.6.20",
+    "@storybook/react": "^7.6.20",
+    "@storybook/react-vite": "^7.6.20",
+    "@storybook/testing-library": "^0.2.2",
+    "@types/cpx": "^1.5.5",
+    "@types/eslint": "^9.6.1",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^18.19.50",
+    "@types/resize-observer-browser": "^0.1.7",
+    "@types/tmp": "^0.2.3",
+    "babel-loader": "^8.2.5",
+    "browserstack-local": "^1.5.1",
+    "chromatic": "^6.7.0",
+    "conventional-changelog-cli": "^2.2.2",
+    "core-js": "^3.23.4",
+    "cpx": "^1.5.0",
     "cross-env": "7.0.3",
-    "dotenv": "^10.0.0",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.1.0",
-    "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-jsx-a11y": "^6.4.1",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.4.1",
-    "eslint-plugin-react": "^7.23.1",
-    "eslint-plugin-react-hooks": "^4.2.0",
-    "git-cz": "^4.7.4",
-    "husky": "^7.0.2",
-    "immer": "^9.0.1",
-    "lint-staged": "^11.1.2",
-    "npm-run-all": "^4.1.5",
-    "pinst": "^2.1.6",
-    "prettier": "^2.2.0",
+    "dotenv": "^16.0.1",
+    "eslint": "^9.9.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-react": "^7.35.0",
+    "git-cz": "^4.9.0",
+    "globals": "^15.9.0",
+    "husky": "^8.0.1",
+    "immer": "^9.0.15",
+    "jiti": "^1.21.6",
+    "lint-staged": "^13.0.3",
+    "pinst": "^3.0.0",
+    "prettier": "^3.3.3",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-is": "^17.0.2",
+    "redrun": "^11.0.5",
+    "regenerator-runtime": "^0.13.7",
     "rimraf": "^3.0.2",
+    "storybook": "^7.6.20",
     "tmp": "^0.2.1",
-    "typescript": "~4.4.2",
-    "use-immer": "^0.6.0",
-    "webpack": "^4.44.2",
-    "webpack-cli": "^3.3.12",
-    "webpack-dev-server": "^3.11.2"
+    "typescript": "~5.5.4",
+    "typescript-eslint": "^8.3.0",
+    "use-immer": "^0.7.0",
+    "vite": "^5.4.2",
+    "vitest": "^2.0.5",
+    "webpack": "^5.94.0",
+    "webpack-cli": "^5.1.4",
+    "webpack-dev-server": "^5.0.4"
   },
   "config": {
     "commitizen": {
@@ -217,7 +189,7 @@
     }
   },
   "lint-staged": {
-    "**/*.(j|t)s?(x)": [
+    "**/*.?(c|m)(j|t)s?(x)": [
       "eslint --fix",
       "prettier --write"
     ],
@@ -229,7 +201,7 @@
     "displayName": "Creevey"
   },
   "volta": {
-    "node": "14.19.0",
-    "yarn": "1.22.17"
+    "node": "20.16.0",
+    "yarn": "4.4.0"
   }
 }

package/preset/README.md

@@ -0,0 +1,3 @@
+This is a fallback for package.json's `exports.addon` field. It's required for outdated environments (like node 11 and typescript with the "node" moduleResolution) to resolve imports from `creevey/addon` properly.
+
+See https://github.com/andrewbranch/example-subpath-exports-ts-compat. The fallback uses the "package-json-redirects" startegy.

package/preset/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "../dist/client/addon/preset.js"
+}

package/preview/README.md

@@ -0,0 +1,3 @@
+This is a fallback for package.json's `exports.addon` field. It's required for outdated environments (like node 11 and typescript with the "node" moduleResolution) to resolve imports from `creevey/addon` properly.
+
+See https://github.com/andrewbranch/example-subpath-exports-ts-compat. The fallback uses the "package-json-redirects" startegy.

package/preview/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "../dist/client/addon/preview.js"
+}

package/src/cli.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import './creevey.js';

package/src/client/addon/components/Addon.tsx

@@ -0,0 +1,53 @@
+import React, { useEffect, useState } from 'react';
+import { Placeholder } from '@storybook/components';
+import { TestData } from '../../../types.js';
+import { Panel } from './Panel.js';
+import { CreeveyController } from '../controller.js';
+
+interface AddonProps {
+  active?: boolean;
+  browser: string;
+  controller: CreeveyController;
+}
+export const Addon = ({ active, browser, controller }: AddonProps): JSX.Element | null => {
+  const [tests, setTests] = useState<TestData[]>([]);
+
+  const [selectedTestId, setSelectedTestId] = useState(controller.selectedTestId);
+
+  useEffect(() => {
+    if (active) {
+      controller.setActiveBrowser(browser);
+      const browserTests = controller.getTestsByStoryIdAndBrowser(controller.activeBrowser);
+      setTests(browserTests);
+    }
+  }, [active, browser, controller]);
+
+  useEffect(() => {
+    const unsubscribe = controller.onChangeTest((testId) => {
+      setSelectedTestId(testId);
+      const status = controller.getTestsByStoryIdAndBrowser(controller.activeBrowser);
+      setTests(status);
+    });
+    return unsubscribe;
+  }, [controller]);
+
+  useEffect(() => {
+    const unsubscribe = controller.onUpdateStatus(() => {
+      setTests(controller.getTestsByStoryIdAndBrowser(controller.activeBrowser));
+    });
+    return unsubscribe;
+  }, [controller, browser]);
+
+  return active ? (
+    tests.length ? (
+      <Panel
+        tests={tests}
+        selectedTestId={selectedTestId}
+        onChangeTest={controller.setSelectedTestId}
+        onImageApprove={controller.onImageApprove}
+      />
+    ) : (
+      <Placeholder>No test results</Placeholder>
+    )
+  ) : null;
+};

package/src/client/addon/components/Icons.tsx

@@ -0,0 +1,28 @@
+import React from 'react';
+
+interface IconProps {
+  width?: number;
+  height?: number;
+}
+
+export const NextIcon = ({ width, height }: IconProps): JSX.Element => {
+  return (
+    <svg version="1.1" width={width} height={height} viewBox="0 0 306 306">
+      <path d="M0,306l216.75-153L0,0V306z M255,0v306h51V0H255z" fill="currentColor" />
+    </svg>
+  );
+};
+
+export const ForwardIcon = ({ width, height }: IconProps): JSX.Element => {
+  return (
+    <svg version="1.1" width={width} height={height} viewBox="0 0 512 512">
+      <path
+        fill="currentColor"
+        d="M460.9,246.8l-209-164.2c-7.8-6.1-19.2-0.6-19.2,9.2v328.4c0,9.8,11.4,15.3,19.2,9.2l209-164.2c5.1-4,6-11.4,2-16.5
+		C462.4,248,461.7,247.3,460.9,246.8L460.9,246.8z M228.2,246.8L19.2,82.5C11.4,76.4,0,82,0,91.8v328.4c0,9.8,11.4,15.3,19.2,9.2
+		l209-164.2c3-2.3,4.5-5.8,4.5-9.2C232.7,252.6,231.2,249.1,228.2,246.8z M507.3,64h-37.2c-2.5,0-4.7,2-4.7,4.4v375.3
+		c0,2.4,2.1,4.4,4.7,4.4h37.2c2.5,0,4.7-2,4.7-4.4V68.4C512,66,509.9,64,507.3,64z"
+      />
+    </svg>
+  );
+};

package/src/client/addon/components/Panel.tsx

@@ -0,0 +1,53 @@
+import React from 'react';
+import { Loader } from '@storybook/components';
+import { styled } from '@storybook/theming';
+import { TestData } from '../../../types.js';
+import { ResultsPage } from '../../shared/components/ResultsPage.js';
+import { getTestPath } from '../../shared/helpers.js';
+import TestSelect from './TestSelect.js';
+interface PanelProps {
+  tests: TestData[];
+  selectedTestId: string;
+  onChangeTest: (testId: string) => void;
+  onImageApprove: (id: string, retry: number, image: string) => void;
+}
+
+const Wrapper = styled.div<{ isRunning: boolean }>(({ isRunning }) => ({
+  opacity: isRunning ? 0.5 : 1,
+  height: '100%',
+}));
+
+const TestSelectContainer = styled.div(({ theme }) => ({
+  padding: '8px',
+  border: `1px solid ${theme.appBorderColor}`,
+}));
+
+export const Panel = ({ tests, selectedTestId, onChangeTest, onImageApprove }: PanelProps): JSX.Element => {
+  const result = tests.find((x) => x.id === selectedTestId);
+
+  const isRunning = result?.status === 'running';
+
+  return (
+    <div>
+      {tests.length > 1 && (
+        <TestSelectContainer>
+          <TestSelect tests={tests} selectedTestId={selectedTestId} onChangeTest={onChangeTest} />
+        </TestSelectContainer>
+      )}
+      {isRunning && <Loader />}
+      {result?.results?.length ? (
+        <Wrapper isRunning={isRunning}>
+          <ResultsPage
+            height={'100%'}
+            key={`${result.id}_${result.results.length}`} // TODO
+            id={result.id}
+            path={getTestPath(result)} // TODO Memo?
+            results={result.results}
+            approved={result.approved}
+            onImageApprove={onImageApprove}
+          />
+        </Wrapper>
+      ) : null}
+    </div>
+  );
+};

package/src/client/addon/components/TestSelect.tsx

@@ -0,0 +1,48 @@
+import React from 'react';
+import { Button, Icons, TooltipLinkList, WithTooltip } from '@storybook/components';
+import { styled } from '@storybook/theming';
+import { TestData } from '../../../types.js';
+import { getEmojiByTestStatus } from '../utils.js';
+
+interface TestSelectProps {
+  tests: TestData[];
+  selectedTestId: string;
+  onChangeTest: (testId: string) => void;
+}
+
+const LinkIconContainer = styled.span(({ theme }) => ({
+  display: 'inline-block',
+  width: '20px',
+  color: theme.color.defaultText,
+  textAlign: 'center',
+}));
+
+export default function TestSelect(props: TestSelectProps): JSX.Element {
+  const testName = props.tests.find((x) => x.id === props.selectedTestId)?.testName ?? '';
+  return (
+    <WithTooltip
+      trigger="click"
+      placement="bottom"
+      closeOnClick
+      tooltip={({ onHide }) => (
+        <TooltipLinkList
+          links={props.tests.map((x) => ({
+            id: x.id,
+            title: x.testName ?? '',
+            active: props.selectedTestId === x.id,
+            onClick: () => {
+              props.onChangeTest(x.id);
+              onHide();
+            },
+            left: <LinkIconContainer>{getEmojiByTestStatus(x.status, x.skip)}</LinkIconContainer>,
+          }))}
+        />
+      )}
+    >
+      <Button outline small>
+        <Icons icon="menu" />
+        {testName}
+      </Button>
+    </WithTooltip>
+  );
+}