creevey 0.9.0-beta.20 → 0.9.0-beta.21

package/src/client/shared/components/PageFooter/Paging.tsx

@@ -0,0 +1,105 @@
+import React from 'react';
+import { Button, Icons } from '@storybook/components';
+import { styled } from '@storybook/theming';
+import { noop } from '../../../../types.js';
+
+export interface PagingProps {
+  activePage: number;
+  onPageChange: (pageNumber: number) => void;
+  pagesCount: number;
+}
+
+export type ItemType = number | '.' | 'forward';
+
+const StyledButton = styled(Button)({
+  transform: 'none',
+  marginLeft: '8px',
+});
+
+export function Paging(props: PagingProps): JSX.Element {
+  const renderItem = (item: ItemType, index: number): JSX.Element => {
+    switch (item) {
+      case '.': {
+        return (
+          <StyledButton disabled key={`dots${index < 5 ? 'Left' : 'Right'}`}>
+            {'...'}
+          </StyledButton>
+        );
+      }
+      case 'forward': {
+        const disabled = props.activePage === props.pagesCount;
+        return (
+          <StyledButton
+            outline
+            disabled={disabled}
+            onClick={
+              disabled
+                ? noop
+                : () => {
+                    goToPage(props.activePage + 1);
+                  }
+            }
+            key="forward"
+          >
+            <span>
+              Next <Icons icon="arrowright" />
+            </span>
+          </StyledButton>
+        );
+      }
+      default: {
+        return (
+          <StyledButton
+            outline
+            secondary={props.activePage === item}
+            key={item}
+            onClick={() => {
+              goToPage(item);
+            }}
+          >
+            {item}
+          </StyledButton>
+        );
+      }
+    }
+  };
+
+  const goToPage = (pageNumber: number): void => {
+    if (1 <= pageNumber && pageNumber !== props.activePage && pageNumber <= props.pagesCount) {
+      props.onPageChange(pageNumber);
+    }
+  };
+
+  return <div>{getItems(props.activePage, props.pagesCount).map(renderItem)}</div>;
+}
+
+function getItems(active: number, total: number): ItemType[] {
+  const result: ItemType[] = [];
+
+  const left = Math.max(Math.min(active - 2, total - 4), 1);
+  const right = Math.min(Math.max(5, active + 2), total);
+
+  const hasLeftDots = left > 3;
+  const from = hasLeftDots ? left : 1;
+
+  const hasRightDots = right < total - 2;
+  const to = hasRightDots ? right : total;
+
+  if (hasLeftDots) {
+    result.push(1, '.');
+  }
+
+  for (let i = from; i <= to; ++i) {
+    result.push(i);
+  }
+
+  if (hasRightDots) {
+    result.push('.');
+  }
+
+  if (hasRightDots && isFinite(total)) {
+    result.push(total);
+  }
+
+  return result.concat('forward');
+}

package/src/client/shared/components/PageHeader/ImagePreview.tsx

@@ -0,0 +1,82 @@
+import React from 'react';
+import { styled, withTheme, Theme } from '@storybook/theming';
+
+const IMG_SIZE = 64;
+const DIAG_LENGTH = (2 * (IMG_SIZE - 8) ** 2) ** (1 / 2);
+
+interface ImageSwapProps {
+  url: string;
+  isActive: boolean;
+  onClick: (imageName: string) => void;
+  imageName: string;
+  theme: Theme;
+  error?: boolean;
+}
+
+const Button = styled.button<{ borderColor?: string }>(({ borderColor }) => ({
+  appearance: 'none',
+  background: 'none',
+  color: 'inherit',
+  font: 'inherit',
+  cursor: 'pointer',
+  outline: 'none',
+  zIndex: 1,
+  margin: '0 10px',
+  border: '2px solid transparent',
+  borderColor: borderColor ?? 'transparent',
+
+  '&:first-of-type': {
+    marginLeft: 0,
+  },
+}));
+
+const Image = withTheme(
+  styled.img<{ hasBorder?: boolean; backgroundColor: string; theme: Theme }>(
+    ({ hasBorder, backgroundColor, theme }) => ({
+      maxHeight: `${IMG_SIZE}px`,
+      width: `${IMG_SIZE}px`,
+      overflow: 'hidden',
+      transform: hasBorder ? 'translateY(2px)' : undefined,
+
+      '&::before': {
+        content: "' '",
+        display: 'block',
+        height: `${IMG_SIZE - 8}px`,
+        width: `${IMG_SIZE - 8}px`,
+        margin: '4px',
+        backgroundColor: backgroundColor,
+        backgroundImage: `linear-gradient(
+      45deg,
+      rgba(0, 0, 0, 0) ${DIAG_LENGTH / 2 - 0.5}px,
+      ${theme.color.medium} ${DIAG_LENGTH / 2 - 0.5}px,
+      ${theme.color.medium} ${DIAG_LENGTH / 2 + 0.5}px,
+      rgba(0, 0, 0, 0) ${DIAG_LENGTH / 2 + 0.5}px
+    ),
+    linear-gradient(
+      315deg,
+      rgba(0, 0, 0, 0) ${DIAG_LENGTH / 2 + 0.2}px,
+      ${theme.color.medium} ${DIAG_LENGTH / 2 + 0.2}px,
+      ${theme.color.medium} ${DIAG_LENGTH / 2 + 1.2}px,
+      rgba(0, 0, 0, 0) ${DIAG_LENGTH / 2 + 1.2}px
+    )`,
+      },
+    }),
+  ),
+);
+
+export const ImagePreview = withTheme(
+  ({ isActive, onClick, imageName, url, theme, error }: ImageSwapProps): JSX.Element => {
+    const handleClick = (): void => {
+      onClick(imageName);
+    };
+
+    return (
+      <Button
+        onClick={handleClick}
+        borderColor={isActive ? theme.barSelectedColor : error ? theme.color.negative : undefined}
+      >
+        <Image hasBorder={isActive || error} src={url} alt={imageName} backgroundColor={theme.background.content} />
+      </Button>
+    );
+  },
+);

package/src/client/shared/components/PageHeader/PageHeader.tsx

@@ -0,0 +1,123 @@
+import React, { useState } from 'react';
+import { Icons, Tabs } from '@storybook/components';
+import { styled, withTheme, Theme } from '@storybook/theming';
+import { ImagesViewMode, Images } from '../../../../types.js';
+import { getImageUrl } from '../../helpers.js';
+import { ImagePreview } from './ImagePreview.js';
+import { viewModes } from '../../viewMode.js';
+
+interface PageHeaderProps {
+  title: string[];
+  images?: Partial<Record<string, Images>>;
+  errorMessage?: string | null;
+  showViewModes: boolean;
+  showTitle?: boolean;
+  viewMode: ImagesViewMode;
+  imagesWithError?: string[];
+  onImageChange: (name: string) => void;
+  onViewModeChange: (viewMode: ImagesViewMode) => void;
+}
+
+const Container = styled.div({
+  margin: '24px 44px 0',
+});
+
+const ErrorContainer = withTheme(
+  styled.div<{ theme: Theme }>(({ theme }) => ({
+    marginTop: '8px',
+    padding: '8px',
+    background: theme.background.negative,
+    color: theme.color.negative,
+    borderRadius: '2px',
+    display: 'flex',
+    alignItems: 'baseline',
+
+    '& svg': {
+      margin: '0 5px',
+      width: 8,
+      height: 8,
+    },
+
+    '& pre': {
+      margin: '0 4px',
+      padding: 0,
+      lineHeight: '22px',
+    },
+  })),
+);
+
+const H1 = styled.h1({
+  margin: 0,
+  marginBottom: '8px',
+});
+
+const HeaderDivider = withTheme(
+  styled.span<{ theme: Theme }>(({ theme }) => ({
+    padding: '0 8px',
+    color: theme.color.mediumdark,
+  })),
+);
+
+const ImagesEntriesContainer = styled.div({
+  display: 'flex',
+  margin: '16px 0 8px',
+});
+
+export function PageHeader({
+  title,
+  images = {},
+  errorMessage,
+  showViewModes,
+  showTitle,
+  viewMode,
+  imagesWithError = [],
+  onImageChange,
+  onViewModeChange,
+}: PageHeaderProps): JSX.Element | null {
+  const imageEntires = Object.entries(images) as [string, Images][];
+  const [imageName, setImageName] = useState(imageEntires.at(0)?.[0] ?? '');
+
+  const handleImageChange = (name: string): void => {
+    setImageName(name);
+    onImageChange(name);
+  };
+  const handleViewModeChange = (mode: string): void => {
+    onViewModeChange(mode as ImagesViewMode);
+  };
+  const error = errorMessage || imagesWithError.includes(imageName) ? (images[imageName]?.error ?? errorMessage) : null;
+
+  return showTitle || error || imageEntires.length > 1 || showViewModes ? (
+    <Container>
+      {showTitle && (
+        <H1>{title.flatMap((token) => [token, <HeaderDivider key={token}>/</HeaderDivider>]).slice(0, -1)}</H1>
+      )}
+      {error && (
+        <ErrorContainer>
+          <Icons icon="closeAlt" />
+          <pre>{error}</pre>
+        </ErrorContainer>
+      )}
+      {imageEntires.length > 1 ? (
+        <ImagesEntriesContainer>
+          {imageEntires.map(([name, image]: [string, Images]) => (
+            <ImagePreview
+              key={name}
+              imageName={name}
+              url={`${getImageUrl(title, name)}/${image.actual}`}
+              isActive={name === imageName}
+              onClick={handleImageChange}
+              error={imagesWithError.includes(name)}
+            />
+          ))}
+        </ImagesEntriesContainer>
+      ) : null}
+      {showViewModes && (
+        <Tabs selected={viewMode} actions={{ onSelect: handleViewModeChange }}>
+          {viewModes.map((x) => (
+            <div key={x} id={x} title={x} />
+          ))}
+        </Tabs>
+      )}
+    </Container>
+  ) : null;
+}

package/src/client/shared/components/ResultsPage.tsx

@@ -0,0 +1,135 @@
+import React, { useState, useEffect } from 'react';
+import { Placeholder, ScrollArea } from '@storybook/components';
+import { styled, withTheme, Theme } from '@storybook/theming';
+import { ImagesView } from './ImagesView/ImagesView.js';
+import { PageHeader } from './PageHeader/PageHeader.js';
+import { PageFooter } from './PageFooter/PageFooter.js';
+import { getImageUrl } from '../helpers.js';
+import { getViewMode, VIEW_MODE_KEY } from '../viewMode.js';
+import { ImagesViewMode, TestResult } from '../../../types.js';
+
+interface TestResultsProps {
+  id: string;
+  path: string[];
+  results?: TestResult[];
+  approved?: Partial<Record<string, number>>;
+  showTitle?: boolean;
+  onImageApprove: (id: string, retry: number, image: string) => void;
+  theme: Theme;
+  height?: string;
+}
+
+const Wrapper = styled.div({
+  width: '100%',
+  height: '100%',
+  boxSizing: 'border-box',
+  display: 'flex',
+  flexDirection: 'column',
+});
+
+const ImagesViewContainer = styled.div(({ theme }) => ({
+  background: theme.base == 'light' ? theme.color.mediumlight : theme.color.darker,
+  flexGrow: 1,
+  padding: '20px 0',
+}));
+
+const HeaderContainer = styled.div({ position: 'sticky', top: 0, zIndex: 1 });
+
+const BodyContainer = styled.div({ flexGrow: 1, minHeight: 0 });
+
+const FooterContainer = styled.div({
+  position: 'sticky',
+  bottom: 0,
+  zIndex: 1,
+});
+
+const Container = styled.div<{ height?: string }>(({ height = '100vh' }) => ({
+  height,
+  width: '100%',
+  overflowY: 'hidden',
+  display: 'flex',
+  flexDirection: 'column',
+}));
+
+export function ResultsPageInternal({
+  id,
+  path,
+  results = [],
+  approved = {},
+  theme,
+  onImageApprove,
+  showTitle = false,
+  height,
+}: TestResultsProps): JSX.Element {
+  const [retry, setRetry] = useState(results.length);
+  const result = results[retry - 1] ?? {};
+  const [imageName, setImageName] = useState(Object.keys(result.images ?? {})[0] ?? '');
+  const [viewMode, setViewMode] = useState<ImagesViewMode>(getViewMode());
+
+  useEffect(() => {
+    setRetry(results.length);
+  }, [results.length]);
+
+  const url = getImageUrl(path, imageName);
+  const image = result.images?.[imageName];
+  const canApprove = Boolean(image && approved[imageName] != retry - 1 && result.status != 'success');
+  const hasDiffAndExpect = canApprove && Boolean(image?.diff && image.expect);
+  const imagesWithError = result.images
+    ? Object.keys(result.images).filter(
+        (imageName) =>
+          result.status != 'success' && approved[imageName] != retry - 1 && result.images?.[imageName]?.error != null,
+      )
+    : [];
+
+  const handleApprove = (): void => {
+    onImageApprove(id, retry - 1, imageName);
+  };
+  const handleChangeViewMode = (mode: ImagesViewMode): void => {
+    localStorage.setItem(VIEW_MODE_KEY, mode);
+    setViewMode(mode);
+  };
+
+  return (
+    <Container height={height}>
+      <HeaderContainer>
+        <PageHeader
+          title={path}
+          images={result.images}
+          errorMessage={result.error}
+          showViewModes={hasDiffAndExpect}
+          viewMode={viewMode}
+          onViewModeChange={handleChangeViewMode}
+          onImageChange={setImageName}
+          showTitle={showTitle}
+          imagesWithError={imagesWithError}
+        />
+      </HeaderContainer>
+      <BodyContainer>
+        <ScrollArea vertical>
+          <Wrapper>
+            <ImagesViewContainer theme={theme}>
+              {image ? (
+                <ImagesView url={url} image={image} canApprove={canApprove} mode={viewMode} />
+              ) : (
+                <Placeholder>{`Image ${imageName} not found`}</Placeholder>
+              )}
+            </ImagesViewContainer>
+          </Wrapper>
+        </ScrollArea>
+      </BodyContainer>
+      {results.length ? (
+        <FooterContainer>
+          <PageFooter
+            canApprove={canApprove}
+            retry={retry}
+            retriesCount={results.length}
+            onRetryChange={setRetry}
+            onApprove={handleApprove}
+          />
+        </FooterContainer>
+      ) : null}
+    </Container>
+  );
+}
+
+export const ResultsPage = withTheme(ResultsPageInternal);

package/src/client/shared/creeveyClientApi.ts

@@ -0,0 +1,64 @@
+import { Response, Request, CreeveyUpdate, CreeveyStatus, noop } from '../../types.js';
+import { getConnectionUrl } from './helpers.js';
+
+export interface CreeveyClientApi {
+  start: (ids: string[]) => void;
+  stop: () => void;
+  approve: (id: string, retry: number, image: string) => void;
+  onUpdate: (fn: (update: CreeveyUpdate) => void) => () => void;
+  readonly status: Promise<CreeveyStatus>;
+}
+
+export async function initCreeveyClientApi(): Promise<CreeveyClientApi> {
+  let clientApiResolver: (api: CreeveyClientApi) => void = noop;
+  const updateListeners = new Set<(update: CreeveyUpdate) => void>();
+  let statusRequest: Promise<CreeveyStatus> | null = null;
+  let statusResolver: (status: CreeveyStatus) => void = noop;
+
+  const ws = new WebSocket(`ws://${getConnectionUrl()}`);
+
+  function send(request: Request): void {
+    ws.send(JSON.stringify(request));
+  }
+
+  ws.addEventListener('open', () => {
+    clientApiResolver({
+      start(ids: string[]) {
+        send({ type: 'start', payload: ids });
+      },
+      stop() {
+        send({ type: 'stop' });
+      },
+      approve(id: string, retry: number, image: string) {
+        send({ type: 'approve', payload: { id, retry, image } });
+      },
+      onUpdate(fn: (update: CreeveyUpdate) => void) {
+        updateListeners.add(fn);
+        return () => updateListeners.delete(fn);
+      },
+      get status() {
+        if (statusRequest) return statusRequest;
+
+        send({ type: 'status' });
+
+        return (statusRequest = new Promise<CreeveyStatus>((resolve) => (statusResolver = resolve)));
+      },
+    });
+  });
+  ws.addEventListener('message', (message: MessageEvent<string>) => {
+    const data = JSON.parse(message.data) as Response;
+
+    if (data.type == 'update')
+      updateListeners.forEach((fn) => {
+        fn(data.payload);
+      });
+    if (data.type == 'status') {
+      statusResolver(data.payload);
+      statusResolver = noop;
+      statusRequest = null;
+    }
+  });
+  // TODO Reconnect
+
+  return new Promise((resolve) => (clientApiResolver = resolve));
+}