@internetarchive/bookreader 5.0.0-90 → 5.0.0-92

package/tests/jest/plugins/plugin.chapters.test.js

@@ -1,7 +1,7 @@
 import sinon from "sinon";
 
-import BookReader from "@/src/BookReader.js";
-import "@/src/plugins/plugin.chapters.js";
+import "@/src/BookReader.js";
+import {ChaptersPlugin} from "@/src/plugins/plugin.chapters.js";
 import { BookModel } from "@/src/BookReader/BookModel";
 import { deepCopy } from "../utils";
 /** @typedef {import('@/src/plugins/plugin.chapters').TocEntry} TocEntry  */
@@ -68,50 +68,44 @@ afterEach(() => {
   sinon.restore();
 });
 
-describe("BRChaptersPlugin", () => {
+describe("ChaptersPlugin", () => {
   beforeEach(() => {
     sinon.stub(BookModel.prototype, "getPageIndex").callsFake((str) =>
       parseFloat(str),
     );
   });
 
-  describe("_chaptersInit", () => {
-    test("does not render when no open library record", async () => {
-      const fakeBR = {
-        options: {},
-        getOpenLibraryRecord: async () => null,
-        _chaptersRender: sinon.stub(),
-      };
-      await BookReader.prototype._chapterInit.call(fakeBR);
-      expect(fakeBR._chaptersRender.callCount).toBe(0);
+  describe("init", () => {
+    test("does not render when open library has no record", async () => {
+      const p = new ChaptersPlugin({ options: { vars: {} } });
+      sinon.stub(p, "getOpenLibraryRecord").resolves(null);
+      sinon.spy(p, "_render");
+      await p.init();
+      expect(p._render.callCount).toBe(0);
     });
 
-    test("does not render when open library record with no TOC", async () => {
-      const fakeBR = {
-        options: {},
-        getOpenLibraryRecord: async () => ({ key: "/books/OL1M" }),
-        _chaptersRender: sinon.stub(),
-      };
-      await BookReader.prototype._chapterInit.call(fakeBR);
-      expect(fakeBR._chaptersRender.callCount).toBe(0);
+    test("does not render when open library record has no TOC", async () => {
+      const p = new ChaptersPlugin({ options: { vars: {} } });
+      sinon.stub(p, "getOpenLibraryRecord").resolves({ key: "/books/OL1M" });
+      sinon.spy(p, "_render");
+      await p.init();
+      expect(p._render.callCount).toBe(0);
     });
 
     test("renders if valid TOC on open library", async () => {
       const fakeBR = {
-        options: {},
+        options: { vars: {} },
         bind: sinon.stub(),
-        book: {
-          getPageIndex: (str) => parseFloat(str),
-        },
-        getOpenLibraryRecord: async () => ({
-          "title": "The Adventures of Sherlock Holmes",
-          "table_of_contents": deepCopy(SAMPLE_TOC_OPTION),
-          "ocaid": "adventureofsherl0000unse",
-        }),
-        _chaptersRender: sinon.stub(),
       };
-      await BookReader.prototype._chapterInit.call(fakeBR);
-      expect(fakeBR._chaptersRender.callCount).toBe(1);
+      const p = new ChaptersPlugin(fakeBR);
+      sinon.stub(p, "getOpenLibraryRecord").resolves({
+        "title": "The Adventures of Sherlock Holmes",
+        "table_of_contents": deepCopy(SAMPLE_TOC_OPTION),
+        "ocaid": "adventureofsherl0000unse",
+      });
+      sinon.stub(p, "_render");
+      await p.init();
+      expect(p._render.callCount).toBe(1);
     });
 
     test("does not fetch open library record if table of contents in options", async () => {
@@ -120,12 +114,13 @@ describe("BRChaptersPlugin", () => {
           table_of_contents: deepCopy(SAMPLE_TOC_UNDEF),
         },
         bind: sinon.stub(),
-        getOpenLibraryRecord: sinon.stub(),
-        _chaptersRender: sinon.stub(),
       };
-      await BookReader.prototype._chapterInit.call(fakeBR);
-      expect(fakeBR.getOpenLibraryRecord.callCount).toBe(0);
-      expect(fakeBR._chaptersRender.callCount).toBe(1);
+      const p = new ChaptersPlugin(fakeBR);
+      sinon.stub(p, "getOpenLibraryRecord");
+      sinon.stub(p, "_render");
+      await p.init();
+      expect(p.getOpenLibraryRecord.callCount).toBe(0);
+      expect(p._render.callCount).toBe(1);
     });
 
     test("converts leafs and pagenums to page index", async () => {
@@ -141,55 +136,58 @@ describe("BRChaptersPlugin", () => {
           leafNumToIndex: (leaf) => leaf + 1,
           getPageIndex: (str) => parseFloat(str),
         },
-        _chaptersRender: sinon.stub(),
       };
-      await BookReader.prototype._chapterInit.call(fakeBR);
-      expect(fakeBR._chaptersRender.callCount).toBe(1);
-      expect(fakeBR._tocEntries[0].pageIndex).toBe(1);
-      expect(fakeBR._tocEntries[1].pageIndex).toBe(17);
+      const p = new ChaptersPlugin(fakeBR);
+      sinon.stub(p, "_render");
+      await p.init();
+      expect(p._render.callCount).toBe(1);
+      expect(p._tocEntries[0].pageIndex).toBe(1);
+      expect(p._tocEntries[1].pageIndex).toBe(17);
     });
   });
 
-  describe('_chaptersRender', () => {
+  describe('_render', () => {
     test('renders markers and panel', () => {
       const fakeBR = {
-        _tocEntries: SAMPLE_TOC,
-        _chaptersRenderMarker: sinon.stub(),
         shell: {
           menuProviders: {},
           addMenuShortcut: sinon.stub(),
           updateMenuContents: sinon.stub(),
         },
       };
-      BookReader.prototype._chaptersRender.call(fakeBR);
+      const p = new ChaptersPlugin(fakeBR);
+      sinon.stub(p, '_renderMarker');
+      p._tocEntries = deepCopy(SAMPLE_TOC);
+      p._render();
       expect(fakeBR.shell.menuProviders['chapters']).toBeTruthy();
       expect(fakeBR.shell.addMenuShortcut.callCount).toBe(1);
       expect(fakeBR.shell.updateMenuContents.callCount).toBe(1);
-      expect(fakeBR._chaptersRenderMarker.callCount).toBeGreaterThan(1);
+      expect(p._renderMarker.callCount).toBeGreaterThan(1);
     });
   });
 
-  describe('_chaptersUpdateCurrent', () => {
+  describe('_updateCurrent', () => {
     test('highlights the current chapter', () => {
       const fakeBR = {
         mode: 2,
         firstIndex: 16,
         displayedIndices: [16, 17],
-        _tocEntries: SAMPLE_TOC,
-        _chaptersPanel: {
-          currentChapter: null,
-        },
       };
-      BookReader.prototype._chaptersUpdateCurrent.call(fakeBR);
-      expect(fakeBR._chaptersPanel.currentChapter).toEqual(SAMPLE_TOC[1]);
+      const p = new ChaptersPlugin(fakeBR);
+      p._tocEntries = deepCopy(SAMPLE_TOC);
+      p._chaptersPanel = {
+        currentChapter: null,
+      };
+      p._updateCurrent();
+      expect(p._chaptersPanel.currentChapter).toEqual(SAMPLE_TOC[1]);
 
       fakeBR.mode = 1;
-      BookReader.prototype._chaptersUpdateCurrent.call(fakeBR);
-      expect(fakeBR._chaptersPanel.currentChapter).toEqual(SAMPLE_TOC[0]);
+      p._updateCurrent();
+      expect(p._chaptersPanel.currentChapter).toEqual(SAMPLE_TOC[0]);
 
       fakeBR.firstIndex = 0;
-      BookReader.prototype._chaptersUpdateCurrent.call(fakeBR);
-      expect(fakeBR._chaptersPanel.currentChapter).toBeUndefined();
+      p._updateCurrent();
+      expect(p._chaptersPanel.currentChapter).toBeUndefined();
     });
   });
 });

package/tests/jest/plugins/search/plugin.search.test.js

@@ -5,6 +5,7 @@ import { DUMMY_RESULTS } from './utils.js';
 
 jest.mock('@/src/plugins/search/view.js');
 
+/** @type {BookReader} */
 let br;
 const namespace = 'BookReader:';
 const triggeredEvents = () => {
@@ -23,10 +24,14 @@ beforeEach(() => {
 
   $.fn.trigger = jest.fn();
   document.body.innerHTML = '<div id="BookReader">';
-  br = new BookReader();
+  br = new BookReader({
+    server: 'foo.bar.com',
+    bookPath: '/13/items/foo/foobar',
+    subPrefix: '/foobar',
+  });
   br.initToolbar = jest.fn();
   br.showProgressPopup = jest.fn();
-  br.searchXHR = jest.fn();
+  br._plugins.search.searchXHR = jest.fn();
 });
 
 afterEach(() => {
@@ -34,54 +39,24 @@ afterEach(() => {
 });
 
 describe('Plugin: Search', () => {
-  test('has option flag', () => {
-    expect(BookReader.defaultOptions.enableSearch).toEqual(true);
-  });
-
-  test('has added BR property: server', () => {
-    expect(br).toHaveProperty('server');
-    expect(br.server).toBeTruthy();
-  });
-
-  test('has added BR property: bookId', () => {
-    expect(br).toHaveProperty('bookId');
-    expect(br.bookId).toBeFalsy();
-  });
-
-  test('has added BR property: subPrefix', () => {
-    expect(br).toHaveProperty('subPrefix');
-    expect(br.subPrefix).toBeFalsy();
-  });
-
-  test('has added BR property: bookPath', () => {
-    expect(br).toHaveProperty('bookPath');
-    expect(br.bookPath).toBeFalsy();
-  });
-
-  test('has added BR property: searchInsideUrl', () => {
-    expect(br).toHaveProperty('searchInsideUrl');
-    expect(br.searchInsideUrl).toBeTruthy();
-  });
-
-  test('has added BR property: initialSearchTerm', () => {
-    expect(br.options).toHaveProperty('initialSearchTerm');
-    expect(br.options.initialSearchTerm).toBeFalsy();
-  });
-
   test('On init, it loads the toolbar', () => {
     br.init();
     expect(br.initToolbar).toHaveBeenCalled();
   });
 
+  test('Constructs SearchView', () => {
+    expect(br._plugins.search.searchView).toBeDefined();
+  });
+
   test('On init, it will run a search if given `options.initialSearchTerm`', () => {
-    br.search = jest.fn();
-    br.options.initialSearchTerm = 'foo';
+    br._plugins.search.search = jest.fn();
+    br.options.plugins.search.initialSearchTerm = 'foo';
     br.init();
 
-    expect(br.search).toHaveBeenCalled();
-    expect(br.search.mock.calls[0][1])
+    expect(br._plugins.search.search).toHaveBeenCalled();
+    expect(br._plugins.search.search.mock.calls[0][1])
       .toHaveProperty('goToFirstResult', true);
-    expect(br.search.mock.calls[0][1])
+    expect(br._plugins.search.search.mock.calls[0][1])
       .toHaveProperty('suppressFragmentChange', false);
   });
 
@@ -100,7 +75,7 @@ describe('Plugin: Search', () => {
   test('SearchStarted event fires and should go to first result', () => {
     br.init();
     br.search('foo', { goToFirstResult: true});
-    expect(br.options.goToFirstResult).toBeTruthy();
+    expect(br._plugins.search.options.goToFirstResult).toBeTruthy();
   });
 
   test('SearchCallback event fires when AJAX search returns results', async () => {

package/tests/jest/plugins/search/plugin.search.view.test.js

@@ -1,9 +1,10 @@
-
+// @ts-check
 import BookReader from '@/src/BookReader.js';
 import '@/src/plugins/search/plugin.search.js';
 import { marshallSearchResults } from '@/src/plugins/search/utils.js';
 import '@/src/plugins/search/view.js';
 
+/** @type {BookReader} */
 let br;
 const namespace = 'BookReader:';
 const results = {
@@ -71,31 +72,22 @@ afterEach(() => {
 });
 
 describe('View: Plugin: Search', () => {
-  test('When search runs, the view gets created.', () => {
-    br.search = jest.fn();
-    br.options.initialSearchTerm = 'foo';
-    br.init();
-
-    expect(br.searchView).toBeDefined();
-    expect(br.searchView.handleSearchCallback).toBeDefined();
-  });
-
   describe("Search results navigation bar", () => {
     test('Search Results callback creates the results nav', () => {
       br.init();
       const event = new CustomEvent(`${namespace}SearchCallback`);
       const options = { goToFirstResult: false };
 
-      expect(br.searchView.dom.searchNavigation).toBeUndefined();
+      expect(br._plugins.search.searchView.dom.searchNavigation).toBeUndefined();
 
-      br.searchView.handleSearchCallback(event, { results, options});
-      expect(br.searchView.dom.searchNavigation).toBeDefined();
+      br._plugins.search.searchView.handleSearchCallback(event, { results, options});
+      expect(br._plugins.search.searchView.dom.searchNavigation).toBeDefined();
     });
     test('has controls', () => {
       br.init();
       const event = new CustomEvent(`${namespace}SearchCallback`);
       const options = { goToFirstResult: false };
-      br.searchView.handleSearchCallback(event, { results, options});
+      br._plugins.search.searchView.handleSearchCallback(event, { results, options});
 
       const searchResultsNav = document.querySelector('.BRsearch-navigation');
       expect(searchResultsNav).toBeDefined();
@@ -110,9 +102,9 @@ describe('View: Plugin: Search', () => {
       br.init();
       const event = new CustomEvent(`${namespace}SearchCallback`);
       const options = { goToFirstResult: false };
-      br.searchView.handleSearchCallback(event, { results: resultWithScript, options });
+      br._plugins.search.searchView.handleSearchCallback(event, { results: resultWithScript, options });
 
-      expect(br.searchView.dom.searchNavigation.parent().html()).not.toContain('<script>alert(1);</script>');
+      expect(br._plugins.search.searchView.dom.searchNavigation.parent().html()).not.toContain('<script>alert(1);</script>');
     });
 
     describe('Click events handlers', () => {
@@ -122,7 +114,7 @@ describe('View: Plugin: Search', () => {
         br.trigger = (eventName) => eventNameTriggered = eventName;
 
         expect(eventNameTriggered).toBeFalsy();
-        br.searchView.toggleSidebar();
+        br._plugins.search.searchView.toggleSidebar();
         expect(eventNameTriggered).toEqual('ToggleSearchMenu');
       });
       it('triggers custom event when closing navbar', () => {
@@ -131,7 +123,7 @@ describe('View: Plugin: Search', () => {
         br.trigger = (eventName) => eventNameTriggered = eventName;
 
         expect(eventNameTriggered).toBeFalsy();
-        br.searchView.clearSearchFieldAndResults();
+        br._plugins.search.searchView.clearSearchFieldAndResults();
         expect(eventNameTriggered).toEqual('SearchResultsCleared');
       });
     });

package/tests/jest/plugins/tts/WebTTSEngine.test.js

@@ -93,51 +93,57 @@ describe('WebTTSSound', () => {
   });
 
   describe('_chromePausingBugFix', () => {
+    /** @type {sinon.SinonFakeTimers} */
+    let clock = null;
+
+    beforeEach(() => {
+      clock = sinon.useFakeTimers();
+    });
+
+    afterEach(() => {
+      clock.restore();
+    });
+
     test('if speech less than 15s, nothing special', async () => {
-      const clock = sinon.useFakeTimers();
       const sound = new WebTTSSound('hello world foo bar');
       sound.load();
       sound.play();
       sound._chromePausingBugFix();
       clock.tick(10000);
       sound.utterance.dispatchEvent('end', {});
-      clock.restore();
       await afterEventLoop();
       expect(speechSynthesis.pause.callCount).toBe(0);
     });
 
     test('if speech greater than 15s, pause called', async () => {
-      const clock = sinon.useFakeTimers();
       const sound = new WebTTSSound('foo bah');
       sound.load();
       sound.play();
       sound._chromePausingBugFix();
       clock.tick(20000);
-      clock.restore();
 
       await afterEventLoop();
       expect(speechSynthesis.pause.callCount).toBe(1);
     });
 
-    test('on pause reloads if timed out', async () => {
-      const clock = sinon.useFakeTimers();
+    test('on pause, stops sound if timed out', async () => {
       const sound = new WebTTSSound('foo bah');
       sound.load();
       sound.play();
+      sound.stop = sinon.stub();
       sound._chromePausingBugFix();
-      sound.pause();
-      clock.tick(2000);
-      clock.restore();
+      clock.tick(5000);
+      sound.utterance.dispatchEvent('pause', {});
+      await afterEventLoop();
+      clock.tick(15000);
 
       await afterEventLoop();
-      expect(speechSynthesis.cancel.callCount).toBe(1);
+      expect(sound.stop.callCount).toBe(1);
     });
   });
 
   test('fire pause if browser does not do it', async () => {
     const clock = sinon.useFakeTimers();
-    const languageGetter = jest.spyOn(window.navigator, 'userAgent', 'get');
-    languageGetter.mockReturnValue('firefox android');
     const sound = new WebTTSSound('foo bah');
     sound.load();
     sound.play();

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

@@ -145,7 +145,7 @@ describe('Plugin: URL controller', () => {
       search: 'foo',
     }));
     BookReader.prototype.search = jest.fn();
-    br.options.initialSearchTerm = 'foo';
+    br.options.plugins.search = { initialSearchTerm: 'foo' };
     br.options.urlMode = 'history';
     br.init();
     br.urlUpdateFragment();

package/tests/jest/util/browserSniffing.test.js

@@ -1,5 +1,5 @@
 import {
-  isChrome, isFirefox, isSafari,
+  isChrome, isEdge, isFirefox, isSafari,
 } from '@/src/util/browserSniffing.js';
 
 const TESTS = [
@@ -19,7 +19,13 @@ const TESTS = [
     name: 'Edge on Windows 10',
     userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; ServiceUI 14) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.102 Safari/537.36 Edge/18.18362',
     vendor: '',
-    machingFn: null,
+    machingFn: isEdge,
+  },
+  {
+    name: 'Edge on Windows 11',
+    userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.0.0 Safari/537.36 Edg/134.0.0.0',
+    vendor: 'Google Inc.',
+    machingFn: isEdge,
   },
   {
     name: 'IE11 on Windows 10',
@@ -47,7 +53,7 @@ const TESTS = [
   },
 ];
 
-for (const fn of [isChrome, isFirefox, isSafari]) {
+for (const fn of [isChrome, isEdge, isFirefox, isSafari]) {
   describe(fn.name, () => {
     for (const { name, userAgent, vendor, machingFn } of TESTS) {
       test(name, () => expect(fn(userAgent, vendor)).toBe(machingFn == fn));

package/tests/jest/utils.js

@@ -1,3 +1,6 @@
+// Keep a copy of this, since it can be overridden by sinon timers.
+const _realTimeout = setTimeout;
+
 /**
  * Resolves after all enqueued callbacks in the event loop have resolved.
  * @return {Promise}
@@ -5,7 +8,7 @@
 export function afterEventLoop() {
   // Waiting 0 seconds essentially lets us run at the end of the event
   // loop (i.e. after any promises which aren't _actually_ async have finished)
-  return new Promise(res => setTimeout(res, 0));
+  return new Promise(res => _realTimeout(res, 0));
 }
 
 /**