@internetarchive/bookreader 5.0.0-10-alpha-1 → 5.0.0-100

package/tests/BookReader/utils.test.js

@@ -1,109 +0,0 @@
-import sinon from 'sinon';
-import {
-  clamp,
-  cssPercentage,
-  debounce,
-  decodeURIComponentPlus,
-  encodeURIComponentPlus,
-  escapeHTML,
-  polyfillCustomEvent,
-  PolyfilledCustomEvent,
-  sleep,
-} from '../../src/BookReader/utils.js';
-
-test('clamp function returns Math.min(Math.max(value, min), max)', () => {
-  expect(clamp(2,1,3)).toEqual(2);
-});
-
-test('calculate a percentage suitable for CSS', () => {
-  expect(cssPercentage(2,1)).toEqual('200%');
-});
-
-test('escapeHTML function which replaces the string', () => {
-  expect(escapeHTML('Me & You')).toEqual('Me & You');
-  expect(escapeHTML('Me > You')).toEqual('Me > You');
-  expect(escapeHTML('Me < You')).toEqual('Me &lt; You');
-  expect(escapeHTML('Me " You')).toEqual('Me &quot; You');
-});
-
-test('Decodes a URI component and converts + to emptyStr', () => {
-  expect(decodeURIComponentPlus("https%3A%2F%2Farchive.org%2Fskr+")).toEqual("https://archive.org/skr ");
-  expect(decodeURIComponentPlus("%3Fx%3D+test")).toEqual("?x= test");
-});
-
-test('Encodes a URI component and converts emptyStr to +', () => {
-  expect(encodeURIComponentPlus("?x=test ")).toEqual("%3Fx%3Dtest+");
-  expect(encodeURIComponentPlus("ABC abc 123")).toEqual("ABC+abc+123");
-});
-
-let clock;
-
-beforeEach(() => {
-  clock = sinon.useFakeTimers();
-});
-
-afterEach(() => {
-  clock.restore();
-});
-
-test('testing debounce', () => {
-  const func = jest.fn();
-  const debouncedFunc = debounce(func, 1000);
-  // Call it immediately
-  debouncedFunc();
-  expect(func).toHaveBeenCalledTimes(0); // func not called
-
-  // Call it several times with 500ms between each call
-  for (let i = 0; i < 10; i++) {
-    clock.tick(500);
-    debouncedFunc();
-  }
-  expect(func).toHaveBeenCalledTimes(0); // func not called
-
-  // wait 1000ms
-  clock.tick(1000);
-  expect(func).toHaveBeenCalledTimes(1);  // func called
-});
-
-
-describe('polyfillCustomEvent', () => {
-  test('Overrides when missing', () => {
-    const win = {};
-    polyfillCustomEvent(win);
-    expect(win).toHaveProperty('CustomEvent');
-  });
-
-  test('Overrides when not a function', () => {
-    const win = { CustomEvent: {} };
-    polyfillCustomEvent(win);
-    expect(typeof win.CustomEvent).toBe('function');
-  });
-});
-
-describe('PolyfilledCustomEvent', () => {
-  test('Can be called as a constructor', () => {
-    new PolyfilledCustomEvent('foo');
-  });
-
-  test('Calls deprecated browser methods', () => {
-    const createEventSpy = sinon.spy(document, 'createEvent');
-    const initCustomEventSpy = sinon.spy(CustomEvent.prototype, 'initCustomEvent');
-    new PolyfilledCustomEvent('foo');
-    expect(createEventSpy.callCount).toBe(1);
-    expect(initCustomEventSpy.callCount).toBe(1);
-  });
-});
-
-describe('sleep', () => {
-  test('can set sleep in ms', async () => {
-    jest.useFakeTimers();
-
-    const sleepTimeMS = 11;
-    await sleep(sleepTimeMS);
-
-    expect(setTimeout).toHaveBeenCalledTimes(1);
-    expect(setTimeout).toHaveBeenLastCalledWith(undefined, sleepTimeMS);
-
-    jest.clearAllTimers();
-  });
-});

package/tests/BookReader.options.test.js

@@ -1,39 +0,0 @@
-
-import BookReader from '../src/BookReader.js';
-
-beforeAll(() => {
-  document.body.innerHTML = '<div id="BookReader">';
-});
-
-afterEach(() => {
-  jest.clearAllMocks();
-});
-
-describe('BookReader options', () => {
-  describe('`autoResize`', () => {
-    it('is on by default', () => {
-      const br = new BookReader();
-      br.init();
-      expect(br.options.autoResize).toBe(true);
-    });
-  });
-
-  describe('`startFullscreen`', () => {
-    it('initializes BookReader to fullscreen', () => {
-      const br = new BookReader({
-        startFullscreen: true
-      });
-      br.init();
-
-      expect(document.getElementById('BookReader').classList.contains('br-ui-full')).toBe(true);
-    });
-  });
-
-  describe('`useSrcSet`', () => {
-    it('is on by default', () => {
-      const br = new BookReader();
-      br.init();
-      expect(br.options.autoResize).toBe(true);
-    });
-  });
-});

package/tests/BookReader.test.js

@@ -1,301 +0,0 @@
-
-import BookReader from '../src/BookReader.js';
-import '../src/plugins/plugin.resume.js';
-import '../src/plugins/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');
-});
-
-test('_getPageURISrcset with 0 page book', () => {
-  br._models.book.getNumLeafs = jest.fn(() => 0);
-  br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
-  br.init();
-  expect(br._getPageURISrcset(5, undefined, undefined)).toBe("");
-});
-
-test('_getPageURISrcset with negative index', () => {
-  br._models.book.getNumLeafs = jest.fn(() => 0);
-  br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
-  br.init();
-  expect(br._getPageURISrcset(-7, undefined, undefined)).toBe("");
-});
-
-test('_getPageURISrcset with 0 elements in srcset', () => {
-  br._models.book.getNumLeafs = jest.fn(() => 30);
-  br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
-  br.init();
-  expect(br._getPageURISrcset(5, 1, undefined)).toBe("");
-});
-
-test('_getPageURISrcset with 2 elements in srcset', () => {
-  br._models.book.getNumLeafs = jest.fn(() => 30);
-  br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
-  br.init();
-  expect(br._getPageURISrcset(5, 5, undefined)).toBe("correctURL.png&scale=2 2x, correctURL.png&scale=1 4x");
-});
-
-test('_getPageURISrcset with the most elements in srcset', () => {
-  br._models.book.getNumLeafs = jest.fn(() => 30);
-  br._models.book.getPageURI = jest.fn((index, scale, rotate) => "correctURL.png&scale=" + scale);
-  br.init();
-  expect(br._getPageURISrcset(5, 35, undefined)).toBe("correctURL.png&scale=16 2x, correctURL.png&scale=8 4x, correctURL.png&scale=4 8x, correctURL.png&scale=2 16x, correctURL.png&scale=1 32x");
-});
-
-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);
-    });
-  });
-});

package/tests/e2e/README.md

@@ -1,75 +0,0 @@
-# TestCafe End to End (e2e) Testing
-
-## Running
-
-To run all tests in all browsers currently specified, run
-
-`npm run test:e2e`
-
-The list of browsers TestCafe will attempt to use are stored in
-`.testcaferc.json`.
-
-The test runner will pick up any file within the tests/e2e directory or
-subdirectories that ends in `test.js`. If you would like to abstract some code
-and place it alongside the test fixtures, as long as the file name does not
-end in this suffix, the test runner won't pick it up and attempt to set up a
-test fixture.
-
-### Testing a specific browser
-
-To run all tests in one or more specified browsers, supply the names of the
-application executables after the command above. For example, if you only want
-to run tests in Chrome, run `npm run test:e2e chrome`. To run
-in both Chrome and Safari, run `npm run test:e2e chrome,safari`.
-
-### Testing in Chrome using device emulation
-
-You can specify device presets or specify custom parameters for Chrome's
-device emulation when starting tests. For example:
-
-`npm run test:e2e "chrome:emulation:width=414;height=736;mobile=true;orientation=vertical;touch=true"`
-
-### Testing on remote devices
-
-If you need to run tests on other devices like a phone, tablet, or other
-computer, you can specify the number of browsers on the remote devices you'd
-like to connect to the test runner. For example, to test Chrome on both a
-phone and tablet, you'd specify '2' remote browsers. If you're only testing
-on a phone, but are testing in Chrome and Safari, you'd also specify '2'.
-
-`npm test:e2e remote:2`
-
-This will provide you with a URL that you then visit in each browser. The URL
-will look something like `http://127.0.0.1:52902/browser/connect`.
-
-### Running a specific fixture
-
-To run a particular fixture, add the path to the file at the end of your arguments list.
-
-`npm run test:e2e chrome tests/e2e/example.test.js`
-
-## Pending (skip) tests
-
-You can skip any tests by calling the method `.skip` on the test object rather
-than call the test function directly. If you have a test definition like:
-
-```
-test('Subnav opened when primary nav category clicked', async (t) => {
-  const textsTophat = Selector('.row.texts');
-  await t.expect(await textsTophat.visible).notOk();
-  await t.click('[data-top-kind=texts]');
-  await t.expect(await textsTophat.visible).ok();
-});
-```
-
-You would skip it by changing the `test` call to `test.skip`.
-
-## Running only one test
-
-Similarly, you can use the `.only` method to skip all other tests and only run
-the one specified.
-
-```
-test.only('Subnav opened when primary nav category clicked', async (t) => {
-```
-

package/tests/e2e/autoplay.test.js

@@ -1,13 +0,0 @@
-import { ClientFunction } from 'testcafe';
-
-const { BASE_URL } = process.env;
-const getLocationHref = ClientFunction(() => window.location.href.toString());
-const FLIP_SPEED = 1000;
-const FIRST_PAGE_DELAY = 2000;
-
-fixture `Autoplay plugin`.page `${BASE_URL}demo-autoplay.html`;
-
-test('page auto-advances after allotted flip speed and delay', async t => {
-  await t.wait(2 * FLIP_SPEED + FIRST_PAGE_DELAY);
-  await t.expect(getLocationHref()).match(/page\/n3/);
-});

package/tests/e2e/base.test.js

@@ -1,35 +0,0 @@
-import { runBaseTests } from './helpers/base';
-import BookReader from './models/BookReader';
-import { runDesktopSearchTests } from './helpers/desktopSearch';
-// import { runMobileSearchTests } from './helpers/mobileSearch';
-
-
-const { BASE_URL } = process.env;
-const OCAIDS = [
-  'theworksofplato01platiala',
-  // Removed because failing test 'Canonical URL with cookie shows paramters'
-  // in tests/e2e/helpers/base.js
-  // Cookie path should be:
-  //   /BookReaderDemo/demo-ia-olivertwist.html
-  // Cookie path is:
-  // /BookReaderDemo/demo-ia-olivertwist.html/page/n13/mode/2up
-  // 'demo-ia-olivertwist.html',
-];
-const DEMO_PATH  = 'demo-internetarchive.html?ocaid=';
-
-OCAIDS.forEach(ocaid => {
-  const url = `${BASE_URL}${DEMO_PATH }${ocaid}`;
-
-  fixture `Base Tests for: ${ocaid}`.page `${url}`;
-  runBaseTests(new BookReader());
-
-  fixture `Desktop Search Tests for: ${ocaid}`
-    .page `${url}`;
-  runDesktopSearchTests(new BookReader());
-
-  // fixture `Mobile Search Tests for: ${ocaid}`
-  //   .page `${url}`
-  // runMobileSearchTests(new BookReader());
-
-
-});