Files
med-notes/.pnpm-store/v10/files/cc/9fc3511fb42e973c35f5a6e5e828e0f4f0688ae9d4d911d3a9b09bc2ff16b7e05a57d230fa10e7b4928dc16fb5259cd55b1f3daaa1eb69ba7ea2fd76b5c42b
2025-05-09 05:30:08 +02:00

629 lines
20 KiB
Plaintext

import { beforeAll, describe, expect, it, vi } from 'vitest';
import { createRef } from 'react';
import { fireEvent, render } from '@testing-library/react';
import { pdfjs } from './index.test.js';
import Thumbnail from './Thumbnail.js';
import failingPdf from '../../../__mocks__/_failing_pdf.js';
import silentlyFailingPdf from '../../../__mocks__/_silently_failing_pdf.js';
import { loadPDF, makeAsyncCallback, muteConsole, restoreConsole } from '../../../test-utils.js';
import DocumentContext from './DocumentContext.js';
import type { PDFDocumentProxy, PDFPageProxy } from 'pdfjs-dist';
import type { DocumentContextType, PageCallback } from './shared/types.js';
const pdfFile = loadPDF('./../../__mocks__/_pdf.pdf');
const pdfFile2 = loadPDF('./../../__mocks__/_pdf2.pdf');
function renderWithContext(children: React.ReactNode, context: Partial<DocumentContextType>) {
const { rerender, ...otherResult } = render(
<DocumentContext.Provider value={context as DocumentContextType}>
{children}
</DocumentContext.Provider>,
);
return {
...otherResult,
rerender: (
nextChildren: React.ReactNode,
nextContext: Partial<DocumentContextType> = context,
) =>
rerender(
<DocumentContext.Provider value={nextContext as DocumentContextType}>
{nextChildren}
</DocumentContext.Provider>,
),
};
}
describe('Thumbnail', () => {
// Loaded PDF file
let pdf: PDFDocumentProxy;
let pdf2: PDFDocumentProxy;
// Object with basic loaded page information that shall match after successful loading
const desiredLoadedThumbnail: Partial<PDFPageProxy> = {};
const desiredLoadedThumbnail2: Partial<PDFPageProxy> = {};
const desiredLoadedThumbnail3: Partial<PDFPageProxy> = {};
beforeAll(async () => {
pdf = await pdfjs.getDocument({ data: pdfFile.arrayBuffer }).promise;
const page = await pdf.getPage(1);
desiredLoadedThumbnail._pageIndex = page._pageIndex;
desiredLoadedThumbnail._pageInfo = page._pageInfo;
const page2 = await pdf.getPage(2);
desiredLoadedThumbnail2._pageIndex = page2._pageIndex;
desiredLoadedThumbnail2._pageInfo = page2._pageInfo;
pdf2 = await pdfjs.getDocument({ data: pdfFile2.arrayBuffer }).promise;
const page3 = await pdf2.getPage(1);
desiredLoadedThumbnail3._pageIndex = page3._pageIndex;
desiredLoadedThumbnail3._pageInfo = page3._pageInfo;
});
describe('loading', () => {
it('loads a page and calls onLoadSuccess callback properly when placed inside Document', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } = makeAsyncCallback();
renderWithContext(<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={0} />, { pdf });
expect.assertions(1);
await expect(onLoadSuccessPromise).resolves.toMatchObject([desiredLoadedThumbnail]);
});
it('loads a page and calls onLoadSuccess callback properly when pdf prop is passed', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } = makeAsyncCallback();
render(<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={0} pdf={pdf} />);
expect.assertions(1);
await expect(onLoadSuccessPromise).resolves.toMatchObject([desiredLoadedThumbnail]);
});
it('returns all desired parameters in onLoadSuccess callback', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } =
makeAsyncCallback<[PageCallback]>();
renderWithContext(<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={0} />, { pdf });
expect.assertions(5);
const [page] = await onLoadSuccessPromise;
expect(page.width).toBeDefined();
expect(page.height).toBeDefined();
expect(page.originalWidth).toBeDefined();
expect(page.originalHeight).toBeDefined();
// Example of a method that got stripped away in the past
expect(page.getTextContent).toBeInstanceOf(Function);
});
it('calls onLoadError when failed to load a page', async () => {
const { func: onLoadError, promise: onLoadErrorPromise } = makeAsyncCallback();
muteConsole();
renderWithContext(<Thumbnail onLoadError={onLoadError} pageIndex={0} />, { pdf: failingPdf });
expect.assertions(1);
await expect(onLoadErrorPromise).resolves.toMatchObject([expect.any(Error)]);
restoreConsole();
});
it('loads page when given pageIndex', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } = makeAsyncCallback();
renderWithContext(<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={0} />, { pdf });
expect.assertions(1);
const [page] = await onLoadSuccessPromise;
expect(page).toMatchObject(desiredLoadedThumbnail);
});
it('loads page when given pageNumber', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } = makeAsyncCallback();
renderWithContext(<Thumbnail onLoadSuccess={onLoadSuccess} pageNumber={1} />, { pdf });
expect.assertions(1);
const [page] = await onLoadSuccessPromise;
expect(page).toMatchObject(desiredLoadedThumbnail);
});
it('loads page of a given number when given conflicting pageNumber and pageIndex', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } = makeAsyncCallback();
renderWithContext(<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={1} pageNumber={1} />, {
pdf,
});
expect.assertions(1);
const [page] = await onLoadSuccessPromise;
expect(page).toMatchObject(desiredLoadedThumbnail);
});
it('replaces a page properly when pdf is changed', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } = makeAsyncCallback();
const { rerender } = renderWithContext(
<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={0} />,
{
pdf,
},
);
expect.assertions(2);
await expect(onLoadSuccessPromise).resolves.toMatchObject([desiredLoadedThumbnail]);
const { func: onLoadSuccess2, promise: onLoadSuccessPromise2 } = makeAsyncCallback();
rerender(<Thumbnail onLoadSuccess={onLoadSuccess2} pageIndex={0} />, { pdf: pdf2 });
await expect(onLoadSuccessPromise2).resolves.toMatchObject([desiredLoadedThumbnail3]);
});
it('replaces a page properly when pageNumber is changed', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } = makeAsyncCallback();
const { rerender } = renderWithContext(
<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={0} />,
{
pdf,
},
);
expect.assertions(2);
await expect(onLoadSuccessPromise).resolves.toMatchObject([desiredLoadedThumbnail]);
const { func: onLoadSuccess2, promise: onLoadSuccessPromise2 } = makeAsyncCallback();
rerender(<Thumbnail onLoadSuccess={onLoadSuccess2} pageIndex={1} />, { pdf });
await expect(onLoadSuccessPromise2).resolves.toMatchObject([desiredLoadedThumbnail2]);
});
it('throws an error when placed outside Document without pdf prop passed', () => {
muteConsole();
expect(() => render(<Thumbnail pageIndex={0} />)).toThrow();
restoreConsole();
});
});
describe('rendering', () => {
it('applies className to its wrapper when given a string', () => {
const className = 'testClassName';
const { container } = renderWithContext(<Thumbnail className={className} pageIndex={0} />, {
pdf,
});
const wrapper = container.querySelector('.react-pdf__Thumbnail');
expect(wrapper).toHaveClass(className);
});
it('passes container element to inputRef properly', () => {
const inputRef = createRef<HTMLDivElement>();
renderWithContext(<Thumbnail inputRef={inputRef} pageIndex={1} />, {
pdf: silentlyFailingPdf,
});
expect(inputRef.current).toBeInstanceOf(HTMLDivElement);
});
it('passes canvas element to ThumbnailCanvas properly', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } = makeAsyncCallback();
const canvasRef = createRef<HTMLCanvasElement>();
const { container } = renderWithContext(
<Thumbnail canvasRef={canvasRef} onLoadSuccess={onLoadSuccess} pageIndex={0} />,
{ pdf },
);
expect.assertions(1);
await onLoadSuccessPromise;
const pageCanvas = container.querySelector('.react-pdf__Thumbnail__page__canvas');
expect(canvasRef.current).toBe(pageCanvas);
});
it('renders "No page specified." when given neither pageIndex nor pageNumber', () => {
muteConsole();
const { container } = renderWithContext(<Thumbnail />, { pdf });
const noData = container.querySelector('.react-pdf__message');
expect(noData).toBeInTheDocument();
expect(noData).toHaveTextContent('No page specified.');
restoreConsole();
});
it('renders custom no data message when given nothing and noData is given', () => {
muteConsole();
const { container } = renderWithContext(<Thumbnail noData="Nothing here" />, { pdf });
const noData = container.querySelector('.react-pdf__message');
expect(noData).toBeInTheDocument();
expect(noData).toHaveTextContent('Nothing here');
restoreConsole();
});
it('renders custom no data message when given nothing and noData is given as a function', () => {
muteConsole();
const { container } = renderWithContext(<Thumbnail noData={() => 'Nothing here'} />, { pdf });
const noData = container.querySelector('.react-pdf__message');
expect(noData).toBeInTheDocument();
expect(noData).toHaveTextContent('Nothing here');
restoreConsole();
});
it('renders "Loading page…" when loading a page', async () => {
const { container } = renderWithContext(<Thumbnail pageIndex={0} />, { pdf });
const loading = container.querySelector('.react-pdf__message');
expect(loading).toBeInTheDocument();
expect(loading).toHaveTextContent('Loading page…');
});
it('renders custom loading message when loading a page and loading prop is given', async () => {
const { container } = renderWithContext(<Thumbnail loading="Loading" pageIndex={0} />, {
pdf,
});
const loading = container.querySelector('.react-pdf__message');
expect(loading).toBeInTheDocument();
expect(loading).toHaveTextContent('Loading');
});
it('renders custom loading message when loading a page and loading prop is given as a function', async () => {
const { container } = renderWithContext(
<Thumbnail loading={() => 'Loading'} pageIndex={0} />,
{
pdf,
},
);
const loading = container.querySelector('.react-pdf__message');
expect(loading).toBeInTheDocument();
expect(loading).toHaveTextContent('Loading');
});
it('ignores pageIndex when given pageIndex and pageNumber', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } = makeAsyncCallback();
renderWithContext(<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={1} pageNumber={1} />, {
pdf,
});
expect.assertions(1);
const [page] = await onLoadSuccessPromise;
expect(page).toMatchObject(desiredLoadedThumbnail);
});
it('requests page to be rendered with default rotation when given nothing', async () => {
const { func: onRenderSuccess, promise: onRenderSuccessPromise } =
makeAsyncCallback<[PageCallback]>();
const { container } = renderWithContext(
<Thumbnail onRenderSuccess={onRenderSuccess} pageIndex={0} />,
{ pdf },
);
const [page] = await onRenderSuccessPromise;
const pageCanvas = container.querySelector(
'.react-pdf__Thumbnail__page__canvas',
) as HTMLCanvasElement;
const { width, height } = window.getComputedStyle(pageCanvas);
const viewport = page.getViewport({ scale: 1 });
// Expect the canvas layer not to be rotated
expect(Number.parseInt(width, 10)).toBe(Math.floor(viewport.width));
expect(Number.parseInt(height, 10)).toBe(Math.floor(viewport.height));
});
it('requests page to be rendered with given rotation when given rotate prop', async () => {
const { func: onRenderSuccess, promise: onRenderSuccessPromise } =
makeAsyncCallback<[PageCallback]>();
const rotate = 90;
const { container } = renderWithContext(
<Thumbnail onRenderSuccess={onRenderSuccess} pageIndex={0} rotate={rotate} />,
{ pdf },
);
const [page] = await onRenderSuccessPromise;
const pageCanvas = container.querySelector(
'.react-pdf__Thumbnail__page__canvas',
) as HTMLCanvasElement;
const { width, height } = window.getComputedStyle(pageCanvas);
const viewport = page.getViewport({ scale: 1, rotation: rotate });
// Expect the canvas layer to be rotated
expect(Number.parseInt(width, 10)).toBe(Math.floor(viewport.width));
expect(Number.parseInt(height, 10)).toBe(Math.floor(viewport.height));
});
it('requests page to be rendered in canvas mode by default', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } = makeAsyncCallback();
const { container } = renderWithContext(
<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={0} />,
{ pdf },
);
expect.assertions(1);
await onLoadSuccessPromise;
const pageCanvas = container.querySelector('.react-pdf__Thumbnail__page__canvas');
expect(pageCanvas).toBeInTheDocument();
});
it('requests page not to be rendered when given renderMode = "none"', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } = makeAsyncCallback();
const { container } = renderWithContext(
<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={0} renderMode="none" />,
{ pdf },
);
expect.assertions(1);
await onLoadSuccessPromise;
const pageCanvas = container.querySelector('.react-pdf__Thumbnail__page__canvas');
expect(pageCanvas).not.toBeInTheDocument();
});
it('requests page to be rendered in canvas mode when given renderMode = "canvas"', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } = makeAsyncCallback();
const { container } = renderWithContext(
<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={0} renderMode="canvas" />,
{ pdf },
);
expect.assertions(1);
await onLoadSuccessPromise;
const pageCanvas = container.querySelector('.react-pdf__Thumbnail__page__canvas');
expect(pageCanvas).toBeInTheDocument();
});
it('requests page to be rendered in custom mode when given renderMode = "custom"', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } = makeAsyncCallback();
function CustomRenderer() {
return <div className="custom-renderer" />;
}
const { container } = renderWithContext(
<Thumbnail
customRenderer={CustomRenderer}
onLoadSuccess={onLoadSuccess}
pageIndex={0}
renderMode="custom"
/>,
{ pdf },
);
expect.assertions(1);
await onLoadSuccessPromise;
const customRenderer = container.querySelector('.custom-renderer');
expect(customRenderer).toBeInTheDocument();
});
});
it('requests page to be rendered at its original size given nothing', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } =
makeAsyncCallback<[PageCallback]>();
renderWithContext(<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={0} />, { pdf });
expect.assertions(1);
const [page] = await onLoadSuccessPromise;
expect(page.width).toEqual(page.originalWidth);
});
it('requests page to be rendered with a proper scale when given scale', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } =
makeAsyncCallback<[PageCallback]>();
const scale = 1.5;
renderWithContext(<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={0} scale={scale} />, {
pdf,
});
expect.assertions(1);
const [page] = await onLoadSuccessPromise;
expect(page.width).toEqual(page.originalWidth * scale);
});
it('requests page to be rendered with a proper scale when given width', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } =
makeAsyncCallback<[PageCallback]>();
const width = 600;
renderWithContext(<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={0} width={width} />, {
pdf,
});
expect.assertions(1);
const [page] = await onLoadSuccessPromise;
expect(page.width).toEqual(width);
});
it('requests page to be rendered with a proper scale when given width and scale (multiplies)', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } =
makeAsyncCallback<[PageCallback]>();
const width = 600;
const scale = 1.5;
renderWithContext(
<Thumbnail onLoadSuccess={onLoadSuccess} pageIndex={0} scale={scale} width={width} />,
{
pdf,
},
);
expect.assertions(1);
const [page] = await onLoadSuccessPromise;
expect(page.width).toBeCloseTo(width * scale);
});
it('requests page to be rendered with a proper scale when given height', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } =
makeAsyncCallback<[PageCallback]>();
const height = 850;
renderWithContext(<Thumbnail height={height} onLoadSuccess={onLoadSuccess} pageIndex={0} />, {
pdf,
});
expect.assertions(1);
const [page] = await onLoadSuccessPromise;
expect(page.height).toEqual(height);
});
it('requests page to be rendered with a proper scale when given height and scale (multiplies)', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } =
makeAsyncCallback<[PageCallback]>();
const height = 850;
const scale = 1.5;
renderWithContext(
<Thumbnail height={height} onLoadSuccess={onLoadSuccess} pageIndex={0} scale={scale} />,
{
pdf,
},
);
expect.assertions(1);
const [page] = await onLoadSuccessPromise;
expect(page.height).toBeCloseTo(height * scale);
});
it('requests page to be rendered with a proper scale when given width and height (ignores height)', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } =
makeAsyncCallback<[PageCallback]>();
const width = 600;
const height = 100;
renderWithContext(
<Thumbnail height={height} onLoadSuccess={onLoadSuccess} pageIndex={0} width={width} />,
{
pdf,
},
);
expect.assertions(2);
const [page] = await onLoadSuccessPromise;
expect(page.width).toEqual(width);
// Expect proportions to be correct even though invalid height was provided
expect(page.height).toEqual(page.originalHeight * (page.width / page.originalWidth));
});
it('requests page to be rendered with a proper scale when given width, height and scale (ignores height, multiplies)', async () => {
const { func: onLoadSuccess, promise: onLoadSuccessPromise } =
makeAsyncCallback<[PageCallback]>();
const width = 600;
const height = 100;
const scale = 1.5;
renderWithContext(
<Thumbnail
height={height}
onLoadSuccess={onLoadSuccess}
pageIndex={0}
scale={scale}
width={width}
/>,
{ pdf },
);
expect.assertions(2);
const [page] = await onLoadSuccessPromise;
expect(page.width).toBeCloseTo(width * scale);
// Expect proportions to be correct even though invalid height was provided
expect(page.height).toEqual(page.originalHeight * (page.width / page.originalWidth));
});
it('calls onTouchStart callback when touched a page (sample of touch events family)', () => {
const onTouchStart = vi.fn();
const { container } = renderWithContext(<Thumbnail onTouchStart={onTouchStart} />, { pdf });
const page = container.querySelector('.react-pdf__Thumbnail__page') as HTMLDivElement;
fireEvent.touchStart(page);
expect(onTouchStart).toHaveBeenCalled();
});
});