@elibrary-inno/bookreader/tests/jest/BookReader.test.js

The Internet Archive BookReader.

import BookReader, {_modeStringToNumber} from '@/src/BookReader.js';
import '@/src/plugins/plugin.resume.js';
import '@/src/plugins/url/plugin.url.js';

let br;
beforeAll(() => {
  document.body.innerHTML = '<div id="BookReader">';
  br = new BookReader();
});

afterEach(() => {
  jest.clearAllMocks();
});

test('has registered PostInit events', () => {
  expect(BookReader.eventNames.PostInit).toBeTruthy();
});

test('has registered zoom events', () => {
  expect(BookReader.eventNames.zoomIn).toBeTruthy();
  expect(BookReader.eventNames.zoomOut).toBeTruthy();
});

test('has registered view type selected events', () => {
  expect(BookReader.eventNames['1PageViewSelected']).toBeTruthy();
  expect(BookReader.eventNames['2PageViewSelected']).toBeTruthy();
  expect(BookReader.eventNames['3PageViewSelected']).toBeTruthy();
});

test('has registered fullscreen toggle event', () => {
  expect(BookReader.eventNames.fullscreenToggled).toBeTruthy();
});

test('checks cookie when initParams called', () => {
  br.getResumeValue = jest.fn(() => 15);
  br.urlReadFragment = jest.fn(() => '');

  const params = br.initParams();
  expect(br.getResumeValue).toHaveBeenCalledTimes(1);
  expect(params.init).toBe(true);
  expect(params.index).toBe(15);
  expect(params.fragmentChange).toBe(true);
});

test('does not check cookie when initParams called', () => {
  br.getResumeValue = jest.fn(() => null);
  br.urlReadFragment = jest.fn(() => '');
  br.options.enablePageResume = false;

  const params = br.initParams();
  expect(br.getResumeValue).toHaveBeenCalledTimes(0);
  expect(params.init).toBe(true);
  expect(params.index).toBe(0);
  expect(params.fragmentChange).toBe(false);
});

test('gets index from fragment when both fragment and cookie when InitParams called', () => {
  br.getResumeValue = jest.fn(() => 15);
  br.urlReadFragment = jest.fn(() => 'page/n4');
  br.options.enablePageResume = true;

  const params = br.initParams();
  expect(br.getResumeValue).toHaveBeenCalledTimes(1);
  expect(params.init).toBe(true);
  expect(params.index).toBe(4);
  expect(params.fragmentChange).toBe(true);
});

test('sets prevReadMode when init called', () => {
  br.init();
  expect(br.prevReadMode).toBeTruthy();
});

// Default behavior same in
//   BookReader.prototype.drawLeafsThumbnail
//   BookReader.prototype.getPrevReadMode
test('sets prevPageMode if initial mode is thumb', () => {
  br.urlReadFragment = jest.fn(() => 'page/n4/mode/thumb');

  br.init();
  expect(br.prevReadMode).toBe(BookReader.constMode1up);
});

test('calls switchMode with init option when init called', () => {
  br.switchMode = jest.fn();

  br.init();
  expect(br.switchMode.mock.calls[0][1])
    .toHaveProperty('init', true);
});

test('has suppressFragmentChange true when init with no input', () => {
  br.getResumeValue = jest.fn(() => null);
  br.urlReadFragment = jest.fn(() => '');
  br.urlReadHashFragment = jest.fn(() => '');
  br.switchMode = jest.fn();

  br.init();
  expect(br.switchMode.mock.calls[0][1])
    .toHaveProperty('suppressFragmentChange', true);
});

test('has suppressFragmentChange false when init with cookie', () => {
  br.getResumeValue = jest.fn(() => 5);
  br.urlReadFragment = jest.fn(() => '');
  br.switchMode = jest.fn();

  br.init();
  expect(br.switchMode.mock.calls[0][1])
    .toHaveProperty('suppressFragmentChange', false);
});

test('has suppressFragmentChange false when init with fragment', () => {
  br.getResumeValue = jest.fn(() => null);
  br.urlReadFragment = jest.fn(() => 'mode/1up');
  br.switchMode = jest.fn();

  br.init();
  expect(br.switchMode.mock.calls[0][1])
    .toHaveProperty('suppressFragmentChange', false);
});

test('has suppressFragmentChange false when init with hash fragment', () => {
  br.getResumeValue = jest.fn(() => null);
  br.urlReadFragment = jest.fn(() => '');
  br.urlReadHashFragment = jest.fn(() => 'mode/1up');
  br.switchMode = jest.fn();
  br.options.urlMode = 'history',

  br.init();
  expect(br.switchMode.mock.calls[0][1])
    .toHaveProperty('suppressFragmentChange', false);
});

test('adds q= term to urlMode=history query string', () => {
  expect(br.queryStringFromParams(
    { search: 'test value' },
    'name=value',
    'history'
  )).toBe('?name=value&q=test+value');
});

test('replaces q= term in urlMode=history query string', () => {
  expect(br.queryStringFromParams(
    { search: 'test+value' },
    'q=foo&a=1&b=2&c=3',
    'history'
  )).toBe('?q=test%2Bvalue&a=1&b=2&c=3');
});

test('does not add q= term to urlMode=hash query string', () => {
  expect(br.queryStringFromParams(
    { search: 'test value' },
    'name=value',
    'hash'
  )).toBe('?name=value');
});

describe('Navigation Bars', () => {
  test('Standard navigation is being used by default', () => {
    br.initNavbar = jest.fn();
    br.options.ui = '';
    br.init();
    expect(br.initNavbar).toHaveBeenCalledTimes(1);
  });
  test('Standard navigation is being used by default - when bookreader is embedded', () => {
    br.initNavbar = jest.fn();
    br.options.ui = 'embed';
    br.init();
    expect(br.initNavbar).toHaveBeenCalledTimes(1);
    expect(br.options.ui).toEqual('embed');
  });
});

describe('quantizeReduce', () => {
  const quantizeReduce = BookReader.prototype.quantizeReduce;
  const SAMPLE_FACTORS = [
    { reduce: 0.5 },
    { reduce: 1 },
    { reduce: 2 },
    { reduce: 3 },
    { reduce: 4 },
    { reduce: 6 },
  ];
  test('Number larger than max', () => {
    expect(quantizeReduce(10, SAMPLE_FACTORS)).toBe(6);
  });

  test('Number lower than max', () => {
    expect(quantizeReduce(0.25, SAMPLE_FACTORS)).toBe(0.5);
  });

  test('Number directly between two reduction factors chooses first factor', () => {
    expect(quantizeReduce(5, SAMPLE_FACTORS)).toBe(4);
  });

  test('Exact match', () => {
    expect(quantizeReduce(2, SAMPLE_FACTORS)).toBe(2);
  });

  test('Closer to a lower boundary', () => {
    expect(quantizeReduce(1.115, SAMPLE_FACTORS)).toBe(1);
  });

  test('Closer to an upper bound', () => {
    expect(quantizeReduce(1.95, SAMPLE_FACTORS)).toBe(2);
  });

  test('Only one reduction factor', () => {
    expect(quantizeReduce(17, [{reduce: 10}])).toBe(10);
  });
});


describe('nextReduce', () => {
  describe('Test matrix', () => {
    const nextReduce = BookReader.prototype.nextReduce;
    const SAMPLE_FACTORS = [
      { reduce: 0.5 },
      { reduce: 1 },
      { reduce: 2 },
      { reduce: 3 },
      { reduce: 3.3, autofit: "width" },
      { reduce: 4 },
      { reduce: 6 },
      { reduce: 6.1, autofit: "height" },
      // auto doesn't get read by nextReduce (bug)
      // It looks like width/height are set for 1up, and auto is set for 2up,
      // and neither is set for thumb
      { reduce: 6.2, autofit: "auto" }
    ];

    const currentReduces = [
      { name: 'Exact match', value: 2 },
      { name: 'In-between', value: 4.5 },
      { name: '< Min', value: 0.25 },
      { name: '> Max', value: 10 },

      { name: '= Min', value: 0.5 },
      { name: '= Max', value: 6.2 },
    ];

    const directions = [ 'in', 'out', 'width', 'height', 'auto' ];

    const expectations = [
      // currentReduces <->
      // v^ directions
      /*                2, 4.5, 0.25,  10,  0.5,  6.2   */
      /* in     */  [   1,   4,  0.5, 6.2,  0.5,  6.1  ],
      /* out    */  [   3,   6,  0.5, 6.2,    1,  6.2  ],
      /* width  */  [ 3.3, 3.3,  3.3, 3.3,  3.3,  3.3  ],
      /* height */  [ 6.1, 6.1,  6.1, 6.1,  6.1,  6.1  ],
      /* auto   */  [ 6.2, 6.2,  6.2, 6.2,  6.2,  6.2  ],
    ];

    for (const [y, row] of expectations.entries()) {
      for (const [x, expectedValue] of row.entries()) {
        test(`${currentReduces[x].name} ${directions[y]}`, () => {
          expect(nextReduce(currentReduces[x].value, directions[y], SAMPLE_FACTORS).reduce)
            .toBe(expectedValue);
        });
      }
    }
  });

  describe('No matching reduction', () => {
    const nextReduce = BookReader.prototype.nextReduce;
    const SAMPLE_FACTORS = [
      { reduce: 0.5 },
      { reduce: 1 },
      { reduce: 2 },
      { reduce: 3 },
    ];

    test('Returns first reduction when no match found', () => {
      expect(nextReduce(2, 'width', SAMPLE_FACTORS).reduce).toBe(0.5);
      expect(nextReduce(2, 'height', SAMPLE_FACTORS).reduce).toBe(0.5);
      expect(nextReduce(2, 'auto', SAMPLE_FACTORS).reduce).toBe(0.5);
    });
  });
});

describe('_modeStringToNumber', () => {
  test('Returns correct number', () => {
    expect(_modeStringToNumber('mode/1up')).toBe(1);
    expect(_modeStringToNumber('mode/2up')).toBe(2);
    expect(_modeStringToNumber('mode/thumb')).toBe(3);
  });
});