readest/apps/readest-app/src/__tests__/utils/reference-pages.test.ts

import { describe, expect, it } from 'vitest';
import { getReferencePageInfo } from '@/utils/progress';

const makePageList = (labels: string[]) => labels.map((label) => ({ label, href: '#' }));

describe('getReferencePageInfo', () => {
  describe('with a page list from the book (issue #672)', () => {
    it('uses the current page item label and the highest numeric label as total', () => {
      const pageList = makePageList(['1', '2', '3', '4', '5']);
      const info = getReferencePageInfo({
        pageList,
        pageItem: { label: '3' },
        fraction: 0.5,
        referencePageCount: 0,
      });
      expect(info).toEqual({ current: '3', total: 5 });
    });

    it('keeps non-numeric current labels (front matter roman numerals) as-is', () => {
      const pageList = makePageList(['i', 'ii', '1', '2', '3']);
      const info = getReferencePageInfo({
        pageList,
        pageItem: { label: 'ii' },
        fraction: 0.1,
        referencePageCount: 0,
      });
      expect(info).toEqual({ current: 'ii', total: 3 });
    });

    it('ignores trailing non-numeric labels when computing the total', () => {
      // Reported in #672: a book ends with an index page labeled "XII" after
      // page 553 — the total must stay 553, not "XII".
      const pageList = makePageList(['551', '552', '553', 'XII']);
      const info = getReferencePageInfo({
        pageList,
        pageItem: { label: '552' },
        fraction: 0.6,
        referencePageCount: 0,
      });
      expect(info).toEqual({ current: '552', total: 553 });
    });

    it('falls back to the entry count when no label is numeric', () => {
      const pageList = makePageList(['i', 'ii', 'iii']);
      const info = getReferencePageInfo({
        pageList,
        pageItem: { label: 'iii' },
        fraction: 0.9,
        referencePageCount: 0,
      });
      expect(info).toEqual({ current: 'iii', total: 3 });
    });

    it('counts pages in nested subitems', () => {
      const pageList = [
        { label: '1', href: '#', subitems: makePageList(['2', '3']) },
        { label: '4', href: '#' },
      ];
      const info = getReferencePageInfo({
        pageList,
        pageItem: { label: '2' },
        fraction: 0.3,
        referencePageCount: 0,
      });
      expect(info).toEqual({ current: '2', total: 4 });
    });

    it('estimates the current page linearly when no page item is resolved yet', () => {
      // e.g. on the cover, before the first page anchor
      const pageList = makePageList(['1', '2', '3', '4', '5', '6', '7', '8', '9', '10']);
      const info = getReferencePageInfo({
        pageList,
        pageItem: null,
        fraction: 0.45,
        referencePageCount: 0,
      });
      expect(info).toEqual({ current: '5', total: 10 });
    });

    it('prefers the page list over a user-entered page count', () => {
      const pageList = makePageList(['1', '2', '3']);
      const info = getReferencePageInfo({
        pageList,
        pageItem: { label: '2' },
        fraction: 0.5,
        referencePageCount: 999,
      });
      expect(info).toEqual({ current: '2', total: 3 });
    });
  });

  describe('with a user-entered page count (issue #4542)', () => {
    it('maps the reading fraction linearly onto the page count', () => {
      const info = getReferencePageInfo({
        pageList: null,
        pageItem: null,
        fraction: 0.5,
        referencePageCount: 350,
      });
      expect(info).toEqual({ current: '175', total: 350 });
    });

    it('shows page 1 at the start of the book', () => {
      const info = getReferencePageInfo({
        pageList: undefined,
        pageItem: null,
        fraction: 0,
        referencePageCount: 350,
      });
      expect(info).toEqual({ current: '1', total: 350 });
    });

    it('shows the last page at the end of the book', () => {
      const info = getReferencePageInfo({
        pageList: [],
        pageItem: null,
        fraction: 1,
        referencePageCount: 350,
      });
      expect(info).toEqual({ current: '350', total: 350 });
    });
  });

  it('returns null when the book has no page list and no page count is set', () => {
    expect(
      getReferencePageInfo({
        pageList: null,
        pageItem: null,
        fraction: 0.5,
        referencePageCount: 0,
      }),
    ).toBeNull();
  });
});