Как проверить снимок изображения компонента React с использованием HTML5 canvas?

Question

Я пытаюсь заставить тестирование снимка изображения работать (т.е. не поддразнивать) с компонентом React, который визуализирует холст HTML5. Я использую Jest, React Testing Library, Node Canvas, Puppeteer и Jest Image Snapshot.

Учитывая следующие компоненты React render():

  public render(): React.ReactElement<TestCanvas> {
    const { innerWidth, innerHeight } = window;

    return (
      <div id="canvas" style={{ height: `${innerHeight}px`, width: `${innerWidth}px` }}>
        <canvas ref={this.canvasRef} />
      </div>
    );
  }

Вот как может выглядеть тест Jest:

  it('should render a <TestCanvas/> component', async () => {
    const { container } = render(<TestCanvas />);

    const page: puppeteer.Page = await browser.newPage();
    await page.setContent(container.outerHTML);
    const image: string = await page.screenshot();

    expect(image).toMatchImageSnapshot();
  });

Однако этот тест генерирует пустое белое изображение PNG размером 800x600 в качестве базовой линии.

Однако, если я изменю тест на это:

  it('should render a <TestCanvas/> component', async () => {
    const { container } = render(<TestCanvas />);

    const canvas: HTMLCanvasElement = container.querySelector('canvas') as HTMLCanvasElement;
    const img = document.createElement('img');
    img.src = canvas.toDataURL();

    const page: puppeteer.Page = await browser.newPage();
    await page.setContent(img.outerHTML);
    const image: string = await page.screenshot();

    expect(image).toMatchImageSnapshot();
  });

Он генерирует базовый снимок PNG на основе моего компонента React просто отлично.

В настоящее время я пытаюсь отладить, где в конвейере дела идут плохо.

Answer 1

Я сделал снимок изображения холста html5 с помощью метода, который не использует кукольник, но метод кукловода интересен. Вот метод, который я использовал

  test('canvas image snapshot', async () => {
    const { getByTestId } = render(
      <MyComponent />,
    )

    const canvas = await waitForElement(() =>
      getByTestId('mycanvas'),
    )

    const img = canvas.toDataURL()
    const data = img.replace(/^data:image\/\w+;base64,/, '')
    const buf = Buffer.from(data, 'base64')
    // may need to do fuzzy image comparison because, at least for me, on
    // travis-ci it was sometimes 2 pixel diff or more for font related stuff
    expect(buf).toMatchImageSnapshot({
      failureThreshold: 0.5,
      failureThresholdType: 'percent',
    })
  })

Answer 2

Ответ от @Colin выше - это то, что нужно сделать. А именно, удалите кодировку изображения из URL-адреса холста, потому что [очевидно] оно предназначено для браузера. Вот что мы сделали:

it('should scroll down', () => {
  const { getByTestId } = render(<PaneDrawerTestWrapper />);

  const mouseHandler = getByTestId(mouseHandlerId);
  act(() => {
    fireEvent.wheel(mouseHandler, { deltaY: 100 });
  });

  const canvas = getByTestId(canvasId) as HTMLCanvasElement;
  const image = stripEncoding(canvas.toDataURL());
  expect(image).toMatchImageSnapshot();
});

где stripEncoding выглядит как:

export function stripEncoding(canvasImageUrl: string): string {
  return canvasImageUrl.replace(/^data:image\/(png|jpg);base64,/, '');
}