@internetarchive/bookreader 5.0.0-3 → 5.0.0-30-d

package/tests/e2e/base.test.js

@@ -2,10 +2,9 @@ import { runBaseTests } from './helpers/base';
 import BookReader from './models/BookReader';
 import { runDesktopSearchTests } from './helpers/desktopSearch';
 // import { runMobileSearchTests } from './helpers/mobileSearch';
+import params from './helpers/params';
 
-
-const { BASE_URL } = process.env;
-const OCAIDS = [
+const ocaids = params.ocaids || [
   'theworksofplato01platiala',
   // Removed because failing test 'Canonical URL with cookie shows paramters'
   // in tests/e2e/helpers/base.js
@@ -15,16 +14,15 @@ const OCAIDS = [
   // /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}`;
+ocaids.forEach(ocaid => {
+  const url = params.getArchiveUrl(ocaid);
 
   fixture `Base Tests for: ${ocaid}`.page `${url}`;
   runBaseTests(new BookReader());
 
   fixture `Desktop Search Tests for: ${ocaid}`
-    .page `${url}`
+    .page `${url}`;
   runDesktopSearchTests(new BookReader());
 
   // fixture `Mobile Search Tests for: ${ocaid}`

package/tests/e2e/helpers/base.js

@@ -96,7 +96,7 @@ export function runBaseTests (br) {
 
     if (await usesResume()) {
       await t.expect(isPageInUrl()).eql(true, initialUrl);
-      await t.expect(isModeInUrl('2up')).eql(true, initialUrl)
+      await t.expect(isModeInUrl('2up')).eql(true, initialUrl);
     } else {
       // No plugin, no br-resume cookie
       await t.expect(getUrl()).notContains('#page/');
@@ -138,7 +138,7 @@ export function runBaseTests (br) {
 
     // we aren't showing the same image in the new pages
     await t.expect(prevImg1Src).notEql(prevImg2Src);
-  })
+  });
 
   test('2up mode - Clicking `Next page` changes the page', async t => {
     // Note: this will fail on a R to L book if at front cover
@@ -168,7 +168,7 @@ export function runBaseTests (br) {
 
     // we aren't showing the same image in the new pages
     await t.expect(nextImg1Src).notEql(nextImg2Src);
-  })
+  });
 
   test('Clicking `page flip buttons` updates location', async t => {
     const { nav } = br;
@@ -191,6 +191,11 @@ export function runBaseTests (br) {
   test('Clicking `1 page view` brings up 1 at a time', async t => {
     const { nav } = br;
     await t.click(nav.desktop.mode1Up);
+
+    // Flip away from cover
+    await t.click(nav.desktop.goNext);
+    await t.wait(PAGE_FLIP_WAIT_TIME);
+
     // we usually pre-fetch the page in question & the 2 after it
     await t.expect(Selector('.BRpagecontainer').count).gte(3);
   });

package/tests/e2e/helpers/debug.js

@@ -10,4 +10,4 @@
  */
 export default async (t) => {
   await t.debug().setNativeDialogHandler(() => true);
-}
+};

package/tests/e2e/helpers/desktopSearch.js

@@ -43,7 +43,7 @@ export function runDesktopSearchTests(br) {
       await t.expect(getPageUrl()).contains(PAGE_FIRST_RESULT);
 
       //checks highlight on result page is visible
-      const highlight = br.shell.find(".BookReaderSearchHilite");
+      const highlight = br.shell.find(".searchHiliteLayer rect");
       await t.expect(highlight.visible).ok();
 
     });

package/tests/e2e/helpers/mobileSearch.js

@@ -15,7 +15,7 @@ export function runMobileSearchTests(br) {
 
   test
     .requestHooks(mockFound)('Mobile search - successful search', async t => {
-      await t.resizeWindowToFitDevice('Sony Xperia Z', {portraitOrientation: true})
+      await t.resizeWindowToFitDevice('Sony Xperia Z', {portraitOrientation: true});
       const nav = br.nav.mobile;
 
       //opening side menu and search
@@ -47,7 +47,7 @@ export function runMobileSearchTests(br) {
       await t.expect(getPageUrl()).contains(PAGE_FIRST_RESULT);
 
       //checks highlight on result page is visible
-      const highlight = br.shell.find(".BookReaderSearchHilite");
+      const highlight = br.shell.find(".searchHiliteLayer rect");
       await t.expect(highlight.visible).ok();
 
       await t.maximizeWindow();
@@ -55,7 +55,7 @@ export function runMobileSearchTests(br) {
 
   test
     .requestHooks(mockNotFound)('Mobile search - unsuccessful search', async t => {
-      await t.resizeWindowToFitDevice('Sony Xperia Z', {portraitOrientation: true})
+      await t.resizeWindowToFitDevice('Sony Xperia Z', {portraitOrientation: true});
       const nav = br.nav.mobile;
 
       //opening side menu and search

package/tests/e2e/helpers/params.js

@@ -0,0 +1,17 @@
+// @ts-check
+class TestParams {
+  baseUrl = process.env.BASE_URL?.replace(/\/+$/, '') ?? 'http://127.0.0.1:8000'
+  ocaids = process.env.OCAIDS?.split(',') ?? [];
+  /** Whether the url we're testing is a prod (or near prod) IA url, or a demos url */
+  isIA = new URL(this.baseUrl).hostname.endsWith('archive.org');
+
+  /** @param {string} ocaid */
+  getArchiveUrl(ocaid) {
+    return this.isIA ? `${this.baseUrl}/details/${ocaid}`
+      // Otherwise it's a demo page
+      : `${this.baseUrl}/BookReaderDemo/demo-internetarchive.html?ocaid=${ocaid}`;
+  }
+}
+
+const params = new TestParams();
+export default params;

package/tests/e2e/rightToLeft.test.js

@@ -1,16 +1,15 @@
 import { runBaseTests } from './helpers/base';
 import { runRightToLeftTests } from './helpers/rightToLeft';
+import params from './helpers/params';
 
 import BookReader from './models/BookReader';
 
-const { BASE_URL } = process.env;
-const DEMO_PATH = 'demo-internetarchive.html?ocaid=';
-const OCAIDS = [
+const ocaids = params.ocaids || [
   'gendaitankashu00meijuoft', // Right to Left book
 ];
 
-OCAIDS.forEach(ocaid => {
-  const url = `${BASE_URL}${DEMO_PATH}${ocaid}`;
+ocaids.forEach(ocaid => {
+  const url = `${params.baseUrl}/BookReaderDemo/demo-internetarchive.html?ocaid=${ocaid}`;
 
   fixture `Base Tests for right to left book: ${ocaid}`.page `${url}`;
   runBaseTests(new BookReader({ pageProgression: 'rl' }));

package/tests/e2e/viewmode.test.js

@@ -1,37 +1,36 @@
-import { Selector } from 'testcafe';
-import BookReader from './models/BookReader';
+// import { Selector } from 'testcafe';
+// import BookReader from './models/BookReader';
+// import params from './helpers/params';
 
-const { BASE_URL } = process.env;
+// fixture `Viewmode carousel`.page `${params.baseUrl}/BookReaderDemo/viewmode-cycle.html`;
 
-fixture `Viewmode carousel`.page `${BASE_URL}viewmode-cycle.html`;
+// test('Clicking `view mode` cycles through view modes', async t => {
+//   const { nav } = (new BookReader());
 
-test('Clicking `view mode` cycles through view modes', async t => {
-  const { nav } = (new BookReader());
+//   // viewmode button only appear on mobile devices
+//   await t.resizeWindow(400, 800);
+//   // Flip forward one
+//   await t.pressKey('right');
 
-  // viewmode button only appear on mobile devices
-  await t.resizeWindow(400, 800);
-  // Flip forward one
-  await t.pressKey('right');
+//   // 2up to thumb
+//   await t.click(nav.desktop.viewmode);
+//   const thumbnailContainer = Selector('.BRmodeThumb');
+//   await t.expect(thumbnailContainer.visible).ok();
+//   const thumbImages = thumbnailContainer.find('.BRpageview img');
+//   await t.expect(thumbImages.count).gt(0);
 
-  // 2up to thumb
-  await t.click(nav.desktop.viewmode);
-  const thumbnailContainer = Selector('.BRmodeThumb');
-  await t.expect(thumbnailContainer.visible).ok();
-  const thumbImages = thumbnailContainer.find('.BRpageview img');
-  await t.expect(thumbImages.count).gt(0);
+//   // thumb to 1up
+//   await t.click(nav.desktop.viewmode);
+//   const onePageViewContainer = Selector('br-mode-1up');
+//   await t.expect(onePageViewContainer.visible).ok();
+//   const onePageImages = onePageViewContainer.find('.BRmode1up .BRpagecontainer');
+//   // we usually pre-fetch the page in question & 1 before/after it
+//   await t.expect(onePageImages.count).gte(3);
 
-  // thumb to 1up
-  await t.click(nav.desktop.viewmode);
-  const onePageViewContainer = Selector('.BRpageview');
-  await t.expect(onePageViewContainer.visible).ok();
-  const onePageImages = onePageViewContainer.find('.BRmode1up .BRpagecontainer');
-  // we usually pre-fetch the page in question & 1 before/after it
-  await t.expect(onePageImages.count).gte(3);
-
-  // 1up to 2up
-  await t.click(nav.desktop.viewmode);
-  const twoPageContainer = Selector('.BRtwopageview');
-  await t.expect(twoPageContainer.visible).ok();
-  const twoPageImages = twoPageContainer.find('img.BRpageimage');
-  await t.expect(twoPageImages.count).gte(2);
-});
+//   // 1up to 2up
+//   await t.click(nav.desktop.viewmode);
+//   const twoPageContainer = Selector('.BRtwopageview');
+//   await t.expect(twoPageContainer.visible).ok();
+//   const twoPageImages = twoPageContainer.find('img.BRpageimage');
+//   await t.expect(twoPageImages.count).gte(2);
+// });

package/tests/{BookReader → jest/BookReader}/BookModel.test.js

@@ -1,7 +1,7 @@
 import sinon from 'sinon';
 import { deepCopy } from '../utils.js';
-import { BookModel } from '../../src/BookReader/BookModel.js';
-/** @typedef {import('../../src/BookReader/options.js').BookReaderOptions} BookReaderOptions */
+import { BookModel } from '@/src/BookReader/BookModel.js';
+/** @typedef {import('@/src/BookReader/options.js').BookReaderOptions} BookReaderOptions */
 
 afterEach(() => {
   sinon.restore();
@@ -190,7 +190,7 @@ describe('pagesIterator', () => {
 describe('_getDataFlattened', () => {
   test('Assigns correct page sides', () => {
     const bm = new BookModel({ data: SAMPLE_DATA });
-    expect(bm._getDataFlattened().map(page => page.pageSide)).toEqual(['R', 'L', 'R', 'L'])
+    expect(bm._getDataFlattened().map(page => page.pageSide)).toEqual(['R', 'L', 'R', 'L']);
   });
 
   test('Memoized based on data length', () => {

package/tests/jest/BookReader/BookReaderPublicFunctions.test.js

@@ -0,0 +1,176 @@
+import BookReader from '@/src/BookReader';
+import { sleep } from '@/src/plugins/tts/utils';
+import sinon from 'sinon';
+
+beforeAll(() => {
+  global.alert = sinon.fake();
+});
+afterEach(() => {
+  sinon.restore();
+});
+
+describe('BookReader.prototype.toggleFullscreen', ()  => {
+  test('uses `isFullscreen` to check fullscreen state', () => {
+    const isFSmock = sinon.fake();
+    // isFSmock.mockReturnValueOnce(false);
+    const br = new BookReader();
+    br.mode = br.constMode1up;
+    br.enterFullscreen = sinon.fake();
+    br.isFullscreen = isFSmock;
+
+    br.toggleFullscreen();
+    expect(br.isFullscreen.callCount).toEqual(1);
+  });
+
+  test('will always emit an event', async () => {
+    const br = new BookReader();
+    br.mode = br.constMode2up;
+    br.trigger = sinon.fake();
+    br.switchMode = sinon.fake();
+    br.updateBrClasses = sinon.fake();
+    br.refs.$brContainer = {
+      css: sinon.fake(),
+      animate: (options, speed, style, callback) => callback()
+    };
+    br.refs.$br = {
+      updateBrClasses: sinon.fake(),
+      removeClass: sinon.fake(),
+      addClass: sinon.fake(),
+      css: sinon.fake(),
+      animate: (options, speed, style, callback) => callback()
+    };
+
+    await br.toggleFullscreen();
+    expect(br.trigger.callCount).toBeGreaterThan(0);
+  });
+
+  test('will start with opening fullscreen', () => {
+    const br = new BookReader();
+    br.mode = br.constMode2up;
+    br.enterFullscreen = sinon.fake();
+
+    br.toggleFullscreen();
+    expect(br.enterFullscreen.callCount).toEqual(1);
+  });
+
+  test('will close fullscreen if BookReader is in fullscreen', () => {
+    const br = new BookReader();
+    br.mode = br.constMode1up;
+    br.exitFullScreen = sinon.fake();
+    br.isFullscreenActive = true;
+
+    br.toggleFullscreen();
+    expect(br.exitFullScreen.callCount).toEqual(1);
+  });
+});
+
+describe('BookReader.prototype.enterFullscreen', ()  => {
+  test('will bind `_fullscreenCloseHandler` by default', () => {
+    const br = new BookReader();
+    br.mode = br.constMode1up;
+    br.switchMode = sinon.fake();
+    br.updateBrClasses = sinon.fake();
+    br.refs.$brContainer = {
+      css: sinon.fake(),
+      animate: sinon.fake(),
+    };
+    expect(br._fullscreenCloseHandler).toBeUndefined();
+
+    br.enterFullscreen();
+    expect(br._fullscreenCloseHandler).toBeDefined();
+  });
+
+  test('fires certain events when called', async () => {
+    const br = new BookReader();
+    br.mode = br.constMode2up;
+    br.switchMode = sinon.fake();
+    br.updateBrClasses = sinon.fake();
+    br.trigger = sinon.fake();
+    br.resize = sinon.fake();
+    br.jumpToIndex = sinon.fake();
+    br.refs.$brContainer = {
+      css: sinon.fake(),
+      animate: (options, speed, style, callback) => callback()
+    };
+
+    await br.enterFullscreen();
+    expect(br.switchMode.callCount).toEqual(1);
+    expect(br.updateBrClasses.callCount).toEqual(1);
+    expect(br.trigger.callCount).toEqual(2); // fragmentChange, fullscreenToggled
+    expect(br.jumpToIndex.callCount).toEqual(1);
+
+    await sleep(0);
+    expect(br.resize.callCount).toEqual(1);
+  });
+});
+
+describe('BookReader.prototype.exitFullScreen', () => {
+  test('fires certain events when called', async () => {
+    const br = new BookReader();
+    br.mode = br.constMode2up;
+    br.switchMode = sinon.fake();
+    br.updateBrClasses = sinon.fake();
+    br.trigger = sinon.fake();
+    br.resize = sinon.fake();
+    br.refs.$brContainer = {
+      css: sinon.fake(),
+      animate: (options, speed, style, callback) => callback()
+    };
+    await br.exitFullScreen();
+    expect(br.switchMode.callCount).toEqual(1);
+    expect(br.updateBrClasses.callCount).toEqual(1);
+    expect(br.trigger.callCount).toEqual(2); // fragmentChange, fullscreenToggled
+    expect(br.resize.callCount).toEqual(1);
+  });
+});
+
+describe('BookReader.prototype.trigger', () => {
+  test('fires custom event', () => {
+    const br = new BookReader();
+    global.br = br;
+    global.dispatchEvent = sinon.fake();
+
+    const props = {bar: 1};
+    br.trigger('foo', props);
+    expect(global.dispatchEvent.callCount).toBe(1);
+  });
+});
+
+describe('`BookReader.prototype.prev`', () => {
+  const br = new BookReader();
+  global.br = br;
+  br.trigger = sinon.fake();
+  br.flipBackToIndex = sinon.fake();
+  br.jumpToIndex = sinon.fake();
+
+  test('does not take action if user is on front page', () => {
+    br.firstIndex = 0;
+    br.prev();
+    expect(br.trigger.callCount).toBe(0);
+    expect(br.flipBackToIndex.callCount).toBe(0);
+    expect(br.jumpToIndex.callCount).toBe(0);
+  });
+
+  describe('2up mode', () => {
+    test('fires event and turns the page', () => {
+      br.firstIndex = 10;
+      br.mode = br.constMode2up;
+      br.prev();
+      expect(br.jumpToIndex.callCount).toBe(0); // <--  does not get called
+      expect(br.trigger.callCount).toBe(1);
+      expect(br.flipBackToIndex.callCount).toBe(1);
+    });
+  });
+
+  describe('non 2up mode', () => {
+    test('jumps to provided index', () => {
+      br.firstIndex = 100;
+      br.mode = br.constMode1up;
+      br.prev();
+      expect(br.jumpToIndex.callCount).toBe(1);  // <--  gets called
+      expect(br.trigger.callCount).toBe(1); // <-- gets called by `jumpToIndex` internally
+      expect(br.flipBackToIndex.callCount).toBe(1); // <-- gets called by `jumpToIndex` internally
+    });
+  });
+});
+

package/tests/{BookReader → jest/BookReader}/DebugConsole.test.js

@@ -1,5 +1,5 @@
 import sinon from 'sinon';
-import { DebugConsole } from '../../src/BookReader/DebugConsole.js';
+import { DebugConsole } from '@/src/BookReader/DebugConsole.js';
 
 beforeEach(() => {
   sinon.stub(console, 'log');

package/tests/{BookReader → jest/BookReader}/ImageCache.test.js

@@ -1,8 +1,8 @@
 import sinon from 'sinon';
-import { BookModel } from '../../src/BookReader/BookModel.js';
-import { ImageCache } from '../../src/BookReader/ImageCache.js';
-import { Pow2ReduceSet } from '../../src/BookReader/ReduceSet.js';
-/** @typedef {import('../../src/BookReader/options.js').BookReaderOptions} BookReaderOptions */
+import { BookModel } from '@/src/BookReader/BookModel.js';
+import { ImageCache } from '@/src/BookReader/ImageCache.js';
+import { Pow2ReduceSet } from '@/src/BookReader/ReduceSet.js';
+/** @typedef {import('@/src/BookReader/options.js').BookReaderOptions} BookReaderOptions */
 
 afterEach(() => {
   jest.restoreAllMocks();

package/tests/jest/BookReader/Mode1UpLit.test.js

@@ -0,0 +1,87 @@
+import { BookModel } from '@/src/BookReader/BookModel.js';
+import { Mode1UpLit } from '@/src/BookReader/Mode1UpLit.js';
+
+/** @type {import('@/src/BookReader/options.js').BookReaderOptions['data']} */
+const SAMPLE_DATA = [
+  [
+    { width: 123, height: 123, uri: 'https://archive.org/image0.jpg', pageNum: '1' },
+  ],
+  [
+    { width: 123, height: 123, uri: 'https://archive.org/image1.jpg', pageNum: '2' },
+    { width: 123, height: 123, uri: 'https://archive.org/image2.jpg', pageNum: '3' },
+  ],
+  [
+    { width: 123, height: 123, uri: 'https://archive.org/image3.jpg', pageNum: '4' },
+    { width: 123, height: 123, uri: 'https://archive.org/image4.jpg', pageNum: '5' },
+  ],
+  [
+    { width: 123, height: 123, uri: 'https://archive.org/image5.jpg', pageNum: '6' },
+  ],
+];
+
+function make_dummy_br(overrides = {}) {
+  return Object.assign({
+    updateFirstIndex() {},
+    updateNavIndexThrottled() {},
+    data: []
+  }, overrides);
+}
+
+describe('pageTops', () => {
+  afterEach(() => document.body.innerHTML = '');
+
+  test('Works with empty book', async () => {
+    const br = make_dummy_br({ data: [] });
+    const book = new BookModel(br);
+    const mode = new Mode1UpLit(book, br);
+    document.body.appendChild(mode);
+    await mode.requestUpdate();
+    expect(mode.pageTops).toEqual({});
+  });
+
+  test('Iterates all pages', async () => {
+    const br = make_dummy_br({ data: SAMPLE_DATA });
+    const book = new BookModel(br);
+    const mode = new Mode1UpLit(book, br);
+    document.body.appendChild(mode);
+    await mode.requestUpdate();
+    expect(Object.values(mode.pageTops)).toHaveLength(6);
+  });
+
+  test('Computes tops', async () => {
+    const br = make_dummy_br({ data: SAMPLE_DATA });
+    const book = new BookModel(br);
+    const mode = new Mode1UpLit(book, br);
+    document.body.appendChild(mode);
+    await mode.requestUpdate();
+    const tops = Object.entries(mode.pageTops);
+    expect(tops.map(([index, top]) => [index, top.toFixed(1)])).toEqual([
+      // Recall these are in inches
+      ['0', '0.2'],
+      ['1', '0.6'],
+      ['2', '1.1'],
+      ['3', '1.5'],
+      ['4', '2.0'],
+      ['5', '2.4'],
+    ]);
+  });
+});
+
+describe('worldUnitsToRenderedPixels', () => {
+  test('0 case', () => {
+    const mode = new Mode1UpLit(null, null);
+    expect(mode.worldUnitsToRenderedPixels(0)).toBe(0);
+  });
+  test('Misc cases', () => {
+    const mode = new Mode1UpLit(null, null);
+    mode.screenDPI = 100;
+    mode.realWorldReduce = 1;
+    expect(mode.worldUnitsToRenderedPixels(1)).toBe(100);
+    mode.screenDPI = 100;
+    mode.realWorldReduce = 2;
+    expect(mode.worldUnitsToRenderedPixels(1)).toBe(50);
+    mode.screenDPI = 78;
+    mode.realWorldReduce = 1;
+    expect(mode.worldUnitsToRenderedPixels(1)).toBe(78);
+  });
+});

package/tests/{BookReader → jest/BookReader}/Mode2Up.test.js

@@ -1,12 +1,12 @@
 
 import sinon from 'sinon';
 import { deepCopy } from '../utils.js';
-import BookReader from '../../src/BookReader.js';
-/** @typedef {import('../../src/BookReader/options.js').BookReaderOptions} BookReaderOptions */
+import BookReader from '@/src/BookReader.js';
+/** @typedef {import('@/src/BookReader/options.js').BookReaderOptions} BookReaderOptions */
 
 beforeAll(() => {
   global.alert = jest.fn();
-})
+});
 afterEach(() => {
   jest.restoreAllMocks();
   sinon.restore();
@@ -83,7 +83,7 @@ describe('draw 2up leaves', () => {
 
     br.init();
     expect(drawLeafs.callCount).toBe(1);
-  })
+  });
 
   test('sets `this.displayedIndices`', () => {
     const extremelyWrongValueForDisplayedIndices = null;
@@ -98,7 +98,7 @@ describe('draw 2up leaves', () => {
     expect(br.displayedIndices).not.toBe(extremelyWrongValueForDisplayedIndices);
     expect(br.displayedIndices.length).toBe(2); // is array
     expect(br.displayedIndices).toEqual([-1, 0]); // default to starting index on right, placeholder for left
-  })
+  });
 });
 
 describe('resizeSpread', () => {
@@ -220,7 +220,6 @@ describe('prepareTwoPageView', () => {
       const calculateSpreadSize = sinon.spy(mode2Up, 'calculateSpreadSize');
       const prunePageContainers = sinon.spy(mode2Up, 'prunePageContainers');
       const prefetch = sinon.spy(mode2Up, 'prefetch');
-      const bindGestures = sinon.spy(br, 'bindGestures');
       const centerView = sinon.spy(mode2Up, 'centerView');
       const preparePopUp = sinon.spy(mode2Up, 'preparePopUp');
       const updateBrClasses = sinon.spy(br, 'updateBrClasses');
@@ -232,7 +231,6 @@ describe('prepareTwoPageView', () => {
       expect(drawLeafs.callCount).toBe(1);
       expect(calculateSpreadSize.callCount).toBe(1);
       expect(prunePageContainers.callCount).toBe(1);
-      expect(bindGestures.callCount).toBe(1);
       expect(centerView.callCount).toBe(1);
       expect(preparePopUp.callCount).toBe(1);
       expect(updateBrClasses.callCount).toBe(1);