@internetarchive/bookreader 5.0.0-26 → 5.0.0-29

package/tests/e2e/viewmode.test.js

@@ -1,36 +1,36 @@
-import { Selector } from 'testcafe';
-import BookReader from './models/BookReader';
-import params from './helpers/params';
+// import { Selector } from 'testcafe';
+// import BookReader from './models/BookReader';
+// import params from './helpers/params';
 
-fixture `Viewmode carousel`.page `${params.baseUrl}/BookReaderDemo/viewmode-cycle.html`;
+// fixture `Viewmode carousel`.page `${params.baseUrl}/BookReaderDemo/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('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);
 
-  // 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/jest/BookReader/BookReaderPublicFunctions.test.js

@@ -1,56 +1,66 @@
 import BookReader from '@/src/BookReader';
+import { sleep } from '@/src/plugins/tts/utils';
+import sinon from 'sinon';
 
 beforeAll(() => {
-  global.alert = jest.fn();
+  global.alert = sinon.fake();
 });
 afterEach(() => {
-  jest.restoreAllMocks();
+  sinon.restore();
 });
 
 describe('BookReader.prototype.toggleFullscreen', ()  => {
   test('uses `isFullscreen` to check fullscreen state', () => {
-    const isFSmock = jest.fn();
-    isFSmock.mockReturnValueOnce(false);
+    const isFSmock = sinon.fake();
+    // isFSmock.mockReturnValueOnce(false);
     const br = new BookReader();
     br.mode = br.constMode1up;
-    br.enterFullscreen = jest.fn();
+    br.enterFullscreen = sinon.fake();
     br.isFullscreen = isFSmock;
 
     br.toggleFullscreen();
-    expect(br.isFullscreen).toHaveBeenCalled();
+    expect(br.isFullscreen.callCount).toEqual(1);
   });
 
   test('will always emit an event', async () => {
     const br = new BookReader();
     br.mode = br.constMode2up;
-    br.trigger = jest.fn();
-    br.switchMode = jest.fn();
+    br.trigger = sinon.fake();
+    br.switchMode = sinon.fake();
+    br.updateBrClasses = sinon.fake();
     br.refs.$brContainer = {
-      css: jest.fn(),
+      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).toHaveBeenCalled();
+    expect(br.trigger.callCount).toBeGreaterThan(0);
   });
 
   test('will start with opening fullscreen', () => {
     const br = new BookReader();
     br.mode = br.constMode2up;
-    br.enterFullscreen = jest.fn();
+    br.enterFullscreen = sinon.fake();
 
     br.toggleFullscreen();
-    expect(br.enterFullscreen).toHaveBeenCalled();
+    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 = jest.fn();
+    br.exitFullScreen = sinon.fake();
     br.isFullscreenActive = true;
 
     br.toggleFullscreen();
-    expect(br.exitFullScreen).toHaveBeenCalled();
+    expect(br.exitFullScreen.callCount).toEqual(1);
   });
 });
 
@@ -58,11 +68,11 @@ describe('BookReader.prototype.enterFullscreen', ()  => {
   test('will bind `_fullscreenCloseHandler` by default', () => {
     const br = new BookReader();
     br.mode = br.constMode1up;
-    br.switchMode = jest.fn();
-    br.updateBrClasses = jest.fn();
+    br.switchMode = sinon.fake();
+    br.updateBrClasses = sinon.fake();
     br.refs.$brContainer = {
-      css: jest.fn(),
-      animate: jest.fn(),
+      css: sinon.fake(),
+      animate: sinon.fake(),
     };
     expect(br._fullscreenCloseHandler).toBeUndefined();
 
@@ -73,22 +83,24 @@ describe('BookReader.prototype.enterFullscreen', ()  => {
   test('fires certain events when called', async () => {
     const br = new BookReader();
     br.mode = br.constMode2up;
-    br.switchMode = jest.fn();
-    br.updateBrClasses = jest.fn();
-    br.trigger = jest.fn();
-    br.resize = jest.fn();
-    br.jumpToIndex = jest.fn();
+    br.switchMode = sinon.fake();
+    br.updateBrClasses = sinon.fake();
+    br.trigger = sinon.fake();
+    br.resize = sinon.fake();
+    br.jumpToIndex = sinon.fake();
     br.refs.$brContainer = {
-      css: jest.fn(),
+      css: sinon.fake(),
       animate: (options, speed, style, callback) => callback()
     };
 
     await br.enterFullscreen();
-    expect(br.switchMode).toHaveBeenCalledTimes(1);
-    expect(br.updateBrClasses).toHaveBeenCalledTimes(0); // book nav's fullscreen manager will set these classes
-    expect(br.trigger).toHaveBeenCalledTimes(2); // fragmentChange, fullscreenToggled
-    expect(br.resize).toHaveBeenCalledTimes(1);
-    expect(br.jumpToIndex).toHaveBeenCalledTimes(1);
+    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);
   });
 });
 
@@ -96,19 +108,19 @@ describe('BookReader.prototype.exitFullScreen', () => {
   test('fires certain events when called', async () => {
     const br = new BookReader();
     br.mode = br.constMode2up;
-    br.switchMode = jest.fn();
-    br.updateBrClasses = jest.fn();
-    br.trigger = jest.fn();
-    br.resize = jest.fn();
+    br.switchMode = sinon.fake();
+    br.updateBrClasses = sinon.fake();
+    br.trigger = sinon.fake();
+    br.resize = sinon.fake();
     br.refs.$brContainer = {
-      css: jest.fn(),
+      css: sinon.fake(),
       animate: (options, speed, style, callback) => callback()
     };
     await br.exitFullScreen();
-    expect(br.switchMode).toHaveBeenCalledTimes(1);
-    expect(br.updateBrClasses).toHaveBeenCalledTimes(1);
-    expect(br.trigger).toHaveBeenCalledTimes(2); // fragmentChange, fullscreenToggled
-    expect(br.resize).toHaveBeenCalledTimes(1);
+    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);
   });
 });
 
@@ -116,27 +128,27 @@ describe('BookReader.prototype.trigger', () => {
   test('fires custom event', () => {
     const br = new BookReader();
     global.br = br;
-    global.dispatchEvent = jest.fn();
+    global.dispatchEvent = sinon.fake();
 
     const props = {bar: 1};
     br.trigger('foo', props);
-    expect(global.dispatchEvent.mock.calls.length).toBe(1);
+    expect(global.dispatchEvent.callCount).toBe(1);
   });
 });
 
 describe('`BookReader.prototype.prev`', () => {
   const br = new BookReader();
   global.br = br;
-  br.trigger = jest.fn();
-  br.flipBackToIndex = jest.fn();
-  br.jumpToIndex = jest.fn();
+  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.mock.calls.length).toBe(0);
-    expect(br.flipBackToIndex.mock.calls.length).toBe(0);
-    expect(br.jumpToIndex.mock.calls.length).toBe(0);
+    expect(br.trigger.callCount).toBe(0);
+    expect(br.flipBackToIndex.callCount).toBe(0);
+    expect(br.jumpToIndex.callCount).toBe(0);
   });
 
   describe('2up mode', () => {
@@ -144,9 +156,9 @@ describe('`BookReader.prototype.prev`', () => {
       br.firstIndex = 10;
       br.mode = br.constMode2up;
       br.prev();
-      expect(br.jumpToIndex.mock.calls.length).toBe(0); // <--  does not get called
-      expect(br.trigger.mock.calls.length).toBe(1);
-      expect(br.flipBackToIndex.mock.calls.length).toBe(1);
+      expect(br.jumpToIndex.callCount).toBe(0); // <--  does not get called
+      expect(br.trigger.callCount).toBe(1);
+      expect(br.flipBackToIndex.callCount).toBe(1);
     });
   });
 
@@ -155,9 +167,9 @@ describe('`BookReader.prototype.prev`', () => {
       br.firstIndex = 100;
       br.mode = br.constMode1up;
       br.prev();
-      expect(br.jumpToIndex.mock.calls.length).toBe(1);  // <--  gets called
-      expect(br.trigger.mock.calls.length).toBe(1); // <-- gets called by `jumpToIndex` internally
-      expect(br.flipBackToIndex.mock.calls.length).toBe(1); // <-- gets called by `jumpToIndex` internally
+      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/jest/BookReader.test.js

@@ -1,7 +1,7 @@
 
 import BookReader from '@/src/BookReader.js';
 import '@/src/plugins/plugin.resume.js';
-import '@/src/plugins/plugin.url.js';
+import '@/src/plugins/url/plugin.url.js';
 
 let br;
 beforeAll(() => {

package/tests/jest/plugins/url/UrlPlugin.test.js

@@ -0,0 +1,175 @@
+import { UrlPlugin } from '@/src/plugins/url/UrlPlugin';
+
+afterEach(() => {
+  jest.clearAllMocks();
+});
+
+describe('UrlPlugin tests', () => {
+  const urlPlugin = new UrlPlugin();
+
+  describe('urlStateToUrlString tests', () => {
+    test('urlStateToUrlString with known states in schema', () => {
+      const urlState = { page: 'n7', mode: '1up', search: 'foo' };
+      const urlStateWithQueries = { page: 'n7', mode: '1up', q: 'hello', view: 'theater', sort: 'title_asc' };
+
+      const expectedUrlFromState = 'page/n7/mode/1up?q=foo';
+      const expectedUrlFromStateWithQueries = 'page/n7/mode/1up?q=hello&view=theater&sort=title_asc';
+
+      expect(urlPlugin.urlStateToUrlString(urlState)).toBe(expectedUrlFromState);
+      expect(urlPlugin.urlStateToUrlString(urlStateWithQueries)).toBe(expectedUrlFromStateWithQueries);
+    });
+
+    test('urlStateToUrlString with unknown states in schema', () => {
+      const urlState = { page: 'n7', mode: '1up' };
+      const urlStateWithQueries = { page: 'n7', mode: '1up', q: 'hello', viewer: 'theater', sortBy: 'title_asc' };
+
+      const expectedUrlFromState = 'page/n7/mode/1up';
+      const expectedUrlFromStateWithQueries = 'page/n7/mode/1up?q=hello&viewer=theater&sortBy=title_asc';
+
+      expect(urlPlugin.urlStateToUrlString(urlState)).toBe(expectedUrlFromState);
+      expect(urlPlugin.urlStateToUrlString(urlStateWithQueries)).toBe(expectedUrlFromStateWithQueries);
+    });
+
+    test('urlStateToUrlString with boolean value', () => {
+      const urlState = { page: 'n7', mode: '1up', search: 'foo', view: 'theater', wrapper: 'false' };
+      const expectedUrlFromState = 'page/n7/mode/1up?q=foo&view=theater&wrapper=false';
+
+      expect(urlPlugin.urlStateToUrlString(urlState)).toBe(expectedUrlFromState);
+    });
+  });
+
+  describe('urlStringToUrlState tests', () => {
+    test('urlStringToUrlState without query string', () => {
+      const url = '/page/n7/mode/2up';
+      const url1 = '/page/n7/mode/1up';
+
+      expect(urlPlugin.urlStringToUrlState(url)).toEqual({page: 'n7', mode: '2up'});
+      expect(urlPlugin.urlStringToUrlState(url1)).toEqual({page: 'n7', mode: '1up'});
+    });
+
+    test('urlStringToUrlState with deprecated_for', () => {
+      const url = '/page/n7/mode/2up/search/hello';
+
+      expect(urlPlugin.urlStringToUrlState(url)).toEqual({page: 'n7', mode: '2up', q: 'hello'});
+    });
+
+    test('urlStringToUrlState with query string', () => {
+      const url = '/page/n7/mode/2up/search/hello?view=theather&foo=bar&sort=title_asc';
+      const url1 = '/mode/2up?ref=ol&ui=embed&wrapper=false&view=theater';
+
+      expect(urlPlugin.urlStringToUrlState(url)).toEqual(
+        {page: 'n7', mode: '2up', q: 'hello', view: 'theather', foo: 'bar', sort: 'title_asc'}
+      );
+      expect(urlPlugin.urlStringToUrlState(url1)).toEqual(
+        {mode: '2up', ref: 'ol', ui: 'embed', wrapper: 'false', view: 'theater'}
+      );
+    });
+
+    test('urlStringToUrlState compare search and ?q', () => {
+      const url = '/page/n7/mode/2up/search/hello';
+      urlPlugin.urlState = { q: 'hello' };
+
+      expect(urlPlugin.urlStringToUrlState(url)).toEqual({page: 'n7', mode: '2up', q: 'hello'});
+    });
+  });
+
+  describe('url plugin helper functions', () => {
+    test('setUrlParam', () => {
+      urlPlugin.urlState = {};
+      urlPlugin.setUrlParam('page', '20');
+      urlPlugin.setUrlParam('mode', '2up');
+
+      expect(urlPlugin.urlState).toEqual({page: '20', mode: '2up'});
+    });
+
+    test('removeUrlParam', () => {
+      urlPlugin.setUrlParam('page', '20');
+      urlPlugin.setUrlParam('mode', '2up');
+      urlPlugin.removeUrlParam('mode');
+
+      expect(urlPlugin.urlState).toEqual({page: '20'});
+    });
+
+    test('getUrlParam', () => {
+      urlPlugin.setUrlParam('page', '20');
+      urlPlugin.setUrlParam('mode', '2up');
+      expect(urlPlugin.getUrlParam('page')).toEqual('20');
+      expect(urlPlugin.getUrlParam('mode')).toEqual('2up');
+    });
+  });
+
+  describe('pullFromAddressBar and pushToAddressBar - hash mode', () => {
+    test('url first load - empty state', () => {
+      urlPlugin.urlState = {};
+      urlPlugin.urlMode = 'hash';
+
+      urlPlugin.pullFromAddressBar({ pathname: '', search: '', hash: '#' });
+      expect(urlPlugin.urlState).toEqual({});
+
+      urlPlugin.pushToAddressBar();
+      expect(window.location.hash).toEqual('');
+    });
+
+    test('url without mode state value - use default', () => {
+      urlPlugin.urlState = {};
+      urlPlugin.urlMode = 'hash';
+
+      urlPlugin.pullFromAddressBar({ pathname: '', search: '', hash: '#page/12' });
+      expect(urlPlugin.urlState).toEqual({page: '12'});
+
+      urlPlugin.pushToAddressBar();
+      expect(window.location.hash).toEqual('#page/12');
+    });
+
+    test('url with query param', () => {
+      urlPlugin.urlState = {};
+      urlPlugin.urlMode = 'hash';
+
+      urlPlugin.pullFromAddressBar({ pathname: '', search: '', hash: '#page/12?q=hello&view=theater' });
+      expect(urlPlugin.urlState).toEqual({page: '12', q: 'hello', view: 'theater'});
+
+      urlPlugin.pushToAddressBar();
+      expect(window.location.hash).toEqual('#page/12?q=hello&view=theater');
+    });
+  });
+
+  describe('pullFromAddressBar and pushToAddressBar - history mode', () => {
+    test('url first load - empty state', () => {
+      urlPlugin.urlState = {};
+      urlPlugin.urlHistoryBasePath = '/details/foo';
+      urlPlugin.urlMode = 'history';
+
+      urlPlugin.pullFromAddressBar({ pathname: '', search: '', hash: '' });
+      expect(urlPlugin.urlState).toEqual({});
+
+      urlPlugin.pushToAddressBar();
+      expect(window.location.pathname).toEqual('/details/foo');
+    });
+
+    test('url without mode state value', () => {
+      urlPlugin.urlState = {};
+      urlPlugin.urlHistoryBasePath = '/details/foo/';
+      urlPlugin.urlMode = 'history';
+
+      urlPlugin.pullFromAddressBar({ pathname: '/details/foo/page/12', search: '', hash: '' });
+      expect(urlPlugin.urlState).toEqual({page: '12'});
+
+      urlPlugin.pushToAddressBar();
+      expect(window.location.pathname).toEqual('/details/foo/page/12');
+    });
+
+    test('url with query param', () => {
+      urlPlugin.urlState = {};
+      urlPlugin.urlHistoryBasePath = '/details/foo/';
+      urlPlugin.urlMode = 'history';
+
+      urlPlugin.pullFromAddressBar({ pathname: '/details/foo/page/12', search: '?q=hello&view=theater', hash: '' });
+      expect(urlPlugin.urlState).toEqual({page: '12', q: 'hello', view: 'theater'});
+
+      urlPlugin.pushToAddressBar();
+      const locationUrl = `${window.location.pathname}${window.location.search}`;
+      expect(locationUrl).toEqual('/details/foo/page/12?q=hello&view=theater');
+    });
+  });
+
+});

package/tests/jest/plugins/{plugin.url.test.js → url/plugin.url.test.js}

@@ -1,6 +1,6 @@
-
 import BookReader from '@/src/BookReader.js';
-import '@/src/plugins/plugin.url.js';
+import '@/src/plugins/url/plugin.url.js';
+import sinon from 'sinon';
 
 let br;
 beforeAll(() => {
@@ -10,6 +10,7 @@ beforeAll(() => {
 
 afterEach(() => {
   jest.clearAllMocks();
+  sinon.restore();
 });
 
 describe('Plugin: URL controller', () => {