@internetarchive/bookreader 5.0.0-8-multiple-files → 5.0.0-80

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

@@ -0,0 +1,317 @@
+import sinon from 'sinon';
+
+import '@/src/BookReader.js';
+import {
+  BookreaderWithTextSelection,
+  Cache,
+  genMap,
+  lookAroundWindow,
+  zip,
+} from '@/src/plugins/plugin.text_selection.js';
+
+
+/** @type {BookReader} */
+
+// djvu.xml book infos copied from https://ia803103.us.archive.org/14/items/goodytwoshoes00newyiala/goodytwoshoes00newyiala_djvu.xml
+const FAKE_XML_1WORD = `
+  <OBJECT data="file://localhost//tmp/derive/goodytwoshoes00newyiala//goodytwoshoes00newyiala.djvu" height="3192" type="image/x.djvu" usemap="goodytwoshoes00newyiala_0001.djvu" width="2454">
+    <PARAGRAPH>
+      <LINE>
+        <WORD coords="1216,2768,1256,2640">test</WORD>
+      </LINE>
+    </PARAGRAPH>
+  </OBJECT>`;
+const FAKE_XML_MULT_WORDS = `
+  <OBJECT data="file://localhost//tmp/derive/goodytwoshoes00newyiala//goodytwoshoes00newyiala.djvu" height="3192" type="image/x.djvu" usemap="goodytwoshoes00newyiala_0001.djvu" width="2454">
+    <PARAGRAPH>
+      <LINE>
+        <WORD coords="1216,2768,1256,2640">test1</WORD>
+        <WORD coords="1400,2768,1500,2640">test2</WORD>
+        <WORD coords="1600,2768,1700,2640">test3</WORD>
+      </LINE>
+    </PARAGRAPH>
+  </OBJECT>`;
+const FAKE_XML_MULT_LINES = `
+  <OBJECT data="file://localhost//tmp/derive/goodytwoshoes00newyiala//goodytwoshoes00newyiala.djvu" height="3192" type="image/x.djvu" usemap="goodytwoshoes00newyiala_0001.djvu" width="2454">
+    <PARAGRAPH>
+      <LINE>
+        <WORD coords="119,2050,230,2014" x-confidence="29">way </WORD>
+        <WORD coords="230,2038,320,2002" x-confidence="30">can </WORD>
+        <WORD coords="320,2039,433,2002" x-confidence="28">false </WORD>
+        <WORD coords="433,2051,658,2003" x-confidence="29">judgment </WORD>
+        <WORD coords="658,2039,728,2002" x-confidence="30">be </WORD>
+        <WORD coords="658,2039,728,2002" x-confidence="30">-</WORD>
+        <WORD coords="728,2039,939,2001" x-confidence="29">formed. </WORD>
+        <WORD coords="939,2039,1087,2001" x-confidence="29">There </WORD>
+        <WORD coords="1087,2039,1187,2002" x-confidence="29">still </WORD>
+        <WORD coords="1187,2038,1370,2003" x-confidence="29">remains </WORD>
+        <WORD coords="1370,2037,1433,2014" x-confidence="28">an-</WORD>
+      </LINE>
+      <LINE>
+        <WORD coords="244,2099,370,2063" x-confidence="29">other mode </WORD>
+        <WORD coords="370,2100,427,2064" x-confidence="29">in </WORD>
+        <WORD coords="427,2100,566,2063" x-confidence="29">which </WORD>
+        <WORD coords="566,2100,670,2063" x-confidence="29">false </WORD>
+        <WORD coords="670,2112,907,2063" x-confidence="29">judgments </WORD>
+        <WORD coords="907,2112,1006,2064" x-confidence="29">may </WORD>
+        <WORD coords="1006,2100,1071,2063" x-confidence="29">be </WORD>
+        <WORD coords="1071,2100,1266,2062" x-confidence="29">formed. </WORD>
+        <WORD coords="1266,2110,1435,2062" x-confidence="29">Suppose</WORD>
+      </LINE>
+      <LINE>
+        <WORD coords="118,2160,217,2123" x-confidence="29">that </WORD>
+        <WORD coords="217,2160,289,2124" x-confidence="29">we </WORD>
+        <WORD coords="289,2160,400,2124" x-confidence="29">have </WORD>
+        <WORD coords="400,2160,456,2124" x-confidence="30">in </WORD>
+        <WORD coords="456,2161,542,2136" x-confidence="29">our </WORD>
+        <WORD coords="542,2161,660,2124" x-confidence="29">souls </WORD>
+        <WORD coords="660,2160,700,2136" x-confidence="29">a </WORD>
+        <WORD coords="700,2160,847,2129" x-confidence="28">waxen </WORD>
+        <WORD coords="847,2160,983,2123" x-confidence="29">tablet </WORD>
+        <WORD coords="983,2160,1045,2124" x-confidence="29">of </WORD>
+        <WORD coords="1045,2160,1211,2124" x-confidence="29">various </WORD>
+        <WORD coords="1211,2171,1398,2122" x-confidence="29">qualities </WORD>
+        <WORD coords="1398,2157,1434,2122" x-confidence="29">lastWord</WORD>
+      </LINE>
+    </PARAGRAPH>
+  </OBJECT>`;
+const FAKE_XML_5COORDS = `
+  <OBJECT data="file://localhost//tmp/derive/goodytwoshoes00newyiala//goodytwoshoes00newyiala.djvu" height="3192" type="image/x.djvu" usemap="goodytwoshoes00newyiala_0001.djvu" width="2454">
+    <PARAGRAPH>
+      <LINE>
+        <WORD coords="1216,2768,1256,2640,2690">test</WORD>
+      </LINE>
+    </PARAGRAPH>
+  </OBJECT>`;
+const FAKE_XML_EMPTY = '';
+
+describe("Generic tests", () => {
+  document.body.innerHTML = '<div id="BookReader">';
+  const br = new BookreaderWithTextSelection({
+    data: [
+      [
+        { width: 800, height: 1200,
+          uri: '//archive.org/download/BookReader/img/page001.jpg' },
+      ],
+      [
+        { width: 800, height: 1200,
+          uri: '//archive.org/download/BookReader/img/page002.jpg' },
+        { width: 800, height: 1200,
+          uri: '//archive.org/download/BookReader/img/page003.jpg' },
+      ],
+      [
+        { width: 800, height: 1200,
+          uri: '//archive.org/download/BookReader/img/page004.jpg' },
+        { width: 800, height: 1200,
+          uri: '//archive.org/download/BookReader/img/page005.jpg' },
+      ]
+    ],
+  });
+  br.init();
+
+  afterEach(() => {
+    sinon.restore();
+    $('.BRtextLayer').remove();
+  });
+
+  test("_createPageContainer overridden function still creates a BRpagecontainer element", () => {
+    const spy = sinon.spy(br.textSelectionPlugin, 'createTextLayer');
+    sinon.stub(br.textSelectionPlugin, "getPageText")
+      .returns($(new DOMParser().parseFromString(FAKE_XML_1WORD, "text/xml")));
+    const container = br._createPageContainer(1, {});
+    expect(container).toBeTruthy();
+    expect(spy.callCount).toBe(1);
+  });
+
+  // test loading first object from sample data
+  test("_createPageContainer handles index 0", () => {
+    const spy = sinon.spy(br.textSelectionPlugin, 'createTextLayer');
+    br._createPageContainer(0, {});
+    expect(spy.callCount).toBe(1);
+  });
+
+  // test loading last object from sample data
+  test("_createPageContainer handles index -1", () => {
+    const spy = sinon.spy(br.textSelectionPlugin, 'createTextLayer');
+    br._createPageContainer(-1, {});
+    expect(spy.callCount).toBe(0);
+  });
+
+  test("createTextLayer will render the last page and create text layer properly", async () => {
+    const $container = br.refs.$brContainer;
+    sinon.stub(br.textSelectionPlugin, "getPageText")
+      .returns($(new DOMParser().parseFromString(FAKE_XML_1WORD, "text/xml")));
+    const pageIndex = br.data.length - 1;
+    await br.textSelectionPlugin.createTextLayer({ $container, page: { index: pageIndex, width: 100, height: 100 }});
+    expect($container.find(".BRtextLayer").length).toBe(1);
+    expect($container.find("p").length).toBe(1);
+  });
+
+  test("createTextLayer will not create text layer if there are too many words", async () => {
+    const $container = br.refs.$brContainer;
+    const xml = FAKE_XML_1WORD.replace(/<WORD.*<\/WORD>/, FAKE_XML_1WORD.match(/<WORD.*<\/WORD>/)[0].repeat(3000));
+    sinon.stub(br.textSelectionPlugin, "getPageText")
+      .returns($(new DOMParser().parseFromString(xml, "text/xml")));
+    await br.textSelectionPlugin.createTextLayer({ $container, page: { index: 0, width: 100, height: 100 }});
+    expect($container.find(".BRtextLayer").length).toBe(0);
+    expect($container.find("p").length).toBe(0);
+    expect($container.find(".BRwordElement").length).toBe(0);
+  });
+
+  test("createTextLayer creates text layer with paragraph with 1 word element", async () => {
+    const $container = br.refs.$brContainer;
+    sinon.stub(br.textSelectionPlugin, "getPageText")
+      .returns($(new DOMParser().parseFromString(FAKE_XML_1WORD, "text/xml")));
+    await br.textSelectionPlugin.createTextLayer({ $container, page: { index: 1, width: 100, height: 100 }});
+    expect($container.find(".BRtextLayer").length).toBe(1);
+    expect($container.find("p").length).toBe(1);
+    expect($container.find(".BRwordElement").length).toBe(1);
+    expect($container.find(".BRwordElement").text()).toBe("test");
+  });
+
+  test("createTextLayer creates text layer with paragraph with multiple word elements", async () => {
+    const $container = br.refs.$brContainer;
+    sinon.stub(br.textSelectionPlugin, "getPageText")
+      .returns($(new DOMParser().parseFromString(FAKE_XML_MULT_WORDS, "text/xml")));
+    await br.textSelectionPlugin.createTextLayer({ $container, page: { index: 2, width: 100, height: 100 }});
+    expect($container.find(".BRtextLayer").length).toBe(1);
+    expect($container.find("p").length).toBe(1);
+    expect($container.find(".BRwordElement").length).toBe(3);
+    expect($container.find(".BRspace").length).toBe(2);
+  });
+
+  test("createTextLayer creates text layer with paragraph with word with 5 params coordinates", async () => {
+    const $container = br.refs.$brContainer;
+    sinon.stub(br.textSelectionPlugin, "getPageText")
+      .returns($(new DOMParser().parseFromString(FAKE_XML_5COORDS, "text/xml")));
+    await br.textSelectionPlugin.createTextLayer({ $container, page: { index: 3, width: 100, height: 100 }});
+    expect($container.find(".BRtextLayer").length).toBe(1);
+    expect($container.find("p").length).toBe(1);
+    expect($container.find(".BRwordElement").length).toBe(1);
+  });
+
+  test("createTextLayer handles multiple lines", async () => {
+    const $container = br.refs.$brContainer;
+    sinon.stub(br.textSelectionPlugin, "getPageText")
+      .returns($(new DOMParser().parseFromString(FAKE_XML_MULT_LINES, "text/xml")));
+    await br.textSelectionPlugin.createTextLayer({ $container, page: { index: 3, width: 100, height: 100 }});
+    expect($container.find(".BRtextLayer").length).toBe(1);
+    expect($container.find("p").length).toBe(1);
+    expect($container.find(".BRlineElement").length).toBe(3);
+    // Adds space at end of line; except last line/hyphens
+    expect($container.find("p").text()).toMatch(/another/);
+    expect($container.find("p").text()).toMatch(/Suppose /);
+    expect($container.find("p").text()).toMatch(/lastWord$/);
+    expect($container.find("p > br").length).toBe(1);
+  });
+
+  test("createTextLayer repairs trailing hyphens", async () => {
+    const $container = br.refs.$brContainer;
+    sinon.stub(br.textSelectionPlugin, "getPageText")
+      .returns($(new DOMParser().parseFromString(FAKE_XML_MULT_LINES, "text/xml")));
+    await br.textSelectionPlugin.createTextLayer({ $container, page: { index: 3, width: 100, height: 100 }});
+
+    expect($container.find(".BRwordElement--hyphen").length).toBe(1);
+    expect($container.find(".BRwordElement--hyphen").closest(".BRlineElement").text().endsWith(' ')).toBe(false);
+    expect($container.find(".BRwordElement--hyphen").closest(".BRlineElement").text().endsWith('-')).toBe(false);
+  });
+
+  test("createTextLayer can handle empty xml", async () => {
+    const $container = br.refs.$brContainer;
+    sinon.stub(br.textSelectionPlugin, "getPageText")
+      .returns($(new DOMParser().parseFromString(FAKE_XML_EMPTY, "text/xml")));
+    await br.textSelectionPlugin.createTextLayer({ $container, page: { index: 4, width: 100, height: 100 }});
+    expect($container.find(".BRtextLayer").length).toBe(1);
+    expect($container.find("p").length).toBe(0);
+    expect($container.find(".BRwordElement").length).toBe(0);
+  });
+
+  const LONG_PRESS_DURATION = 500;
+  test("calling stopPageFlip does not allow long click to flip the page", () => {
+    const $container = br.refs.$brContainer;
+    br.textSelectionPlugin.stopPageFlip($container);
+    const currIndex = br.currentIndex();
+    $container.find("BRwordElement").trigger("mousedown");
+    // Waits for long press
+    setTimeout(() => {
+      $container.find("BRwordElement").trigger("mousedown");
+      // Waits for flipping animation
+      setTimeout(() => {
+        expect(br.currentIndex()).toBe(currIndex);
+      }, 2000);
+    }, LONG_PRESS_DURATION);
+  });
+});
+
+describe("Cache", () => {
+  test('Adding works', () => {
+    const c = new Cache(10);
+    c.add(35);
+    expect(c.entries).toEqual([35]);
+  });
+
+  test('Size does not grow beyond limit', () => {
+    const c = new Cache(2);
+    c.add(35);
+    c.add(32);
+    c.add(12);
+    c.add(11);
+    c.add(112);
+    expect(c.entries).toHaveLength(2);
+  });
+
+  test('Oldest evicted first', () => {
+    const c = new Cache(2);
+    c.add(35);
+    c.add(32);
+    c.add(12);
+    c.add(12);
+    c.add(10);
+    expect(c.entries).toEqual([12, 10]);
+  });
+});
+
+describe('genMap', () => {
+  test('handles empty', () => {
+    expect(Array.from(genMap([], x => x ** 2))).toEqual([]);
+  });
+
+  test('handles non-empty', () => {
+    expect(Array.from(genMap([1,2,3], x => x ** 2))).toEqual([1,4,9]);
+  });
+});
+
+describe('lookAroundWindow', () => {
+  test('handles empty', () => {
+    expect(Array.from(lookAroundWindow([]))).toEqual([]);
+  });
+
+  test('handles smaller than window', () => {
+    expect(Array.from(lookAroundWindow([1]))).toEqual([[undefined, 1, undefined]]);
+    expect(Array.from(lookAroundWindow([1, 2]))).toEqual([[undefined, 1, 2], [1, 2, undefined]]);
+    expect(Array.from(lookAroundWindow([1, 2, 3]))).toEqual([[undefined, 1, 2], [1, 2, 3], [2, 3, undefined]]);
+  });
+
+  test('handles larger than window', () => {
+    expect(Array.from(lookAroundWindow([1, 2, 3, 4]))).toEqual([
+      [undefined, 1, 2],
+      [1, 2, 3],
+      [2, 3, 4],
+      [3, 4, undefined],
+    ]);
+  });
+});
+
+describe('zip', () => {
+  test('handles empty', () => {
+    expect(Array.from(zip([], []))).toEqual([]);
+  });
+
+  test('uneven throws error', () => {
+    expect(() => Array.from(zip([1], [2, 3]))).toThrow();
+  });
+
+  test('handles even', () => {
+    expect(Array.from(zip([1, 2], [3, 4]))).toEqual([[1, 3], [2, 4]]);
+  });
+});

package/tests/{plugins → jest/plugins}/plugin.vendor-fullscreen.test.js

@@ -1,6 +1,6 @@
 
-import BookReader from '../../src/BookReader.js';
-import * as util from '../../src/plugins/plugin.vendor-fullscreen.js';
+import BookReader from '@/src/BookReader.js';
+import * as util from '@/src/plugins/plugin.vendor-fullscreen.js';
 
 let br;
 beforeEach(() => {

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

@@ -1,9 +1,9 @@
+import BookReader from '@/src/BookReader.js';
+import '@/src/plugins/search/plugin.search.js';
+import { deepCopy } from '../../utils.js';
+import { DUMMY_RESULTS } from './utils.js';
 
-import BookReader from '../../../src/BookReader.js';
-import '../../../src/plugins/plugin.mobile_nav.js';
-import '../../../src/plugins/search/plugin.search.js';
-
-jest.mock('../../../src/plugins/search/view.js');
+jest.mock('@/src/plugins/search/view.js');
 
 let br;
 const namespace = 'BookReader:';
@@ -18,27 +18,7 @@ beforeEach(() => {
   $.ajax = jest.fn().mockImplementation(() => {
     // return from:
     // `https://ia800304.us.archive.org/fulltext/inside.php?item_id=adventuresofoli00dick&doc=adventuresofoli00dick&path=/30/items/adventuresofoli00dick&q=child&callback=<serialized jQ CB>`
-    return Promise.resolve({
-      ia: "adventuresofoli00dick",
-      q: "child",
-      indexed: true,
-      page_count: 644,
-      body_length: 666,
-      leaf0_missing: false,
-      matches: [{
-        text: 'For a long; time after it was ushered into this world of sorrow and trouble, by the parish surgeon, it remained a matter of considerable doubt wliether the {{{child}}} Avould survi^ e to bear any name at all; in which case it is somewhat more than probable that these memoirs would never have appeared; or, if they had, that being comprised within a couple of pages, they would have possessed the inestimable meiit of being the most concise and faithful specimen of biography, extant in the literature of any age or country.',
-        par: [{
-          boxes: [{r: 1221, b: 2121, t: 2075, page: 37, l: 1107}],
-          b: 2535,
-          t: 1942,
-          page_width: 1790,
-          r: 1598,
-          l: 50,
-          page_height: 2940,
-          page: 37
-        }]
-      }]
-    });
+    return Promise.resolve(deepCopy(DUMMY_RESULTS));
   });
 
   $.fn.trigger = jest.fn();
@@ -46,6 +26,7 @@ beforeEach(() => {
   br = new BookReader();
   br.initToolbar = jest.fn();
   br.showProgressPopup = jest.fn();
+  br.searchXHR = jest.fn();
 });
 
 afterEach(() => {
@@ -101,7 +82,7 @@ describe('Plugin: Search', () => {
     expect(br.search.mock.calls[0][1])
       .toHaveProperty('goToFirstResult', true);
     expect(br.search.mock.calls[0][1])
-      .toHaveProperty('suppressFragmentChange', true);
+      .toHaveProperty('suppressFragmentChange', false);
   });
 
   test('calling `search` fires ajax call`', () => {
@@ -116,28 +97,30 @@ describe('Plugin: Search', () => {
     expect(triggeredEvents()).toContain(`${namespace}SearchStarted`);
   });
 
-  test('SearchCallback event fires when AJAX search returns results', () => {
+  test('SearchStarted event fires and should go to first result', () => {
     br.init();
-    const dfd = br.search('foo');
-    return dfd.then(() => {
-      expect(triggeredEvents()).toContain(`${namespace}SearchCallback`);
-    });
+    br.search('foo', { goToFirstResult: true});
+    expect(br.options.goToFirstResult).toBeTruthy();
   });
 
-  test('SearchCallbackError event fires when AJAX search returns error', () => {
+  test('SearchCallback event fires when AJAX search returns results', async () => {
+    br.init();
+    await br.search('foo');
+    expect(triggeredEvents()).toContain(`${namespace}SearchCallback`);
+  });
+
+  test('SearchCallbackError event fires when AJAX search returns error', async () => {
     $.ajax = jest.fn().mockImplementation(() => {
       return Promise.resolve({
         error: true,
       });
     });
     br.init();
-    const dfd = br.search('foo');
-    return dfd.then(() => {
-      expect(triggeredEvents()).toContain(`${namespace}SearchCallbackError`);
-    });
+    await br.search('foo');
+    expect(triggeredEvents()).toContain(`${namespace}SearchCallbackError`);
   });
 
-  test('SearchCallbackNotIndexed event fires when AJAX search returns false indexed value', () => {
+  test('SearchCallbackNotIndexed event fires when AJAX search returns false indexed value', async () => {
     $.ajax = jest.fn().mockImplementation(() => {
       return Promise.resolve({
         matches: [],
@@ -145,22 +128,18 @@ describe('Plugin: Search', () => {
       });
     });
     br.init();
-    const dfd = br.search('foo');
-    return dfd.then(() => {
-      expect(triggeredEvents()).toContain(`${namespace}SearchCallbackBookNotIndexed`);
-    });
+    await br.search('foo');
+    expect(triggeredEvents()).toContain(`${namespace}SearchCallbackBookNotIndexed`);
   });
 
-  test('SearchCallbackEmpty event fires when AJAX search returns no matches', () => {
+  test('SearchCallbackEmpty event fires when AJAX search returns no matches', async () => {
     $.ajax = jest.fn().mockImplementation(() => {
       return Promise.resolve({
         matches: [],
       });
     });
     br.init();
-    const dfd = br.search('foo');
-    return dfd.then(() => {
-      expect(triggeredEvents()).toContain(`${namespace}SearchCallbackEmpty`);
-    });
+    await br.search('foo');
+    expect(triggeredEvents()).toContain(`${namespace}SearchCallbackEmpty`);
   });
 });

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

@@ -1,8 +1,8 @@
 
-import BookReader from '../../../src/BookReader.js';
-import '../../../src/plugins/plugin.mobile_nav.js';
-import '../../../src/plugins/search/plugin.search.js';
-import '../../../src/plugins/search/view.js';
+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';
 
 let br;
 const namespace = 'BookReader:';
@@ -27,6 +27,31 @@ const results = {
     }]
   }]
 };
+
+marshallSearchResults(results, () => '', '{{{', '}}}');
+const resultWithScript = {
+  ia: "adventuresofoli00dick",
+  q: "child",
+  indexed: true,
+  page_count: 644,
+  body_length: 666,
+  leaf0_missing: false,
+  matches: [{
+    text: 'foo bar <script>alert(1);</script> {{{keyword}}} baz',
+    par: [{
+      boxes: [{r: 1221, b: 2121, t: 2075, page: 37, l: 1107}],
+      b: 2535,
+      t: 1942,
+      page_width: 1790,
+      r: 1598,
+      l: 50,
+      page_height: 2940,
+      page: 37
+    }]
+  }]
+};
+
+marshallSearchResults(resultWithScript, () => '', '{{{', '}}}');
 beforeEach(() => {
   $.ajax = jest.fn().mockImplementation(() => {
     // return from:
@@ -63,14 +88,14 @@ describe('View: Plugin: Search', () => {
 
       expect(br.searchView.dom.searchNavigation).toBeUndefined();
 
-      br.searchView.handleSearchCallback(event, { results, options})
+      br.searchView.handleSearchCallback(event, { results, options});
       expect(br.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.searchView.handleSearchCallback(event, { results, options});
 
       const searchResultsNav = document.querySelector('.BRsearch-navigation');
       expect(searchResultsNav).toBeDefined();
@@ -81,6 +106,14 @@ describe('View: Plugin: Search', () => {
       expect(searchResultsNav.querySelector('.prev')).toBeDefined();
       expect(searchResultsNav.querySelector('.next')).toBeDefined();
     });
+    test('disallows xss from search results', () => {
+      br.init();
+      const event = new CustomEvent(`${namespace}SearchCallback`);
+      const options = { goToFirstResult: false };
+      br.searchView.handleSearchCallback(event, { results: resultWithScript, options });
+
+      expect(br.searchView.dom.searchNavigation.parent().html()).not.toContain('<script>alert(1);</script>');
+    });
 
     describe('Click events handlers', () => {
       it('triggers custom event when toggling side menu', () => {

package/tests/jest/plugins/search/utils.js

@@ -0,0 +1,25 @@
+import { marshallSearchResults } from "@/src/plugins/search/utils";
+
+export const DUMMY_RESULTS = {
+  ia: "adventuresofoli00dick",
+  q: "child",
+  indexed: true,
+  page_count: 644,
+  body_length: 666,
+  leaf0_missing: false,
+  matches: [{
+    text: 'For a long; time after it was ushered into this world of sorrow and trouble, by the parish surgeon, it remained a matter of considerable doubt wliether the {{{child}}} Avould survi^ e to bear any name at all; in which case it is somewhat more than probable that these memoirs would never have appeared; or, if they had, that being comprised within a couple of pages, they would have possessed the inestimable meiit of being the most concise and faithful specimen of biography, extant in the literature of any age or country.',
+    par: [{
+      boxes: [{r: 1221, b: 2121, t: 2075, page: 37, l: 1107}],
+      b: 2535,
+      t: 1942,
+      page_width: 1790,
+      r: 1598,
+      l: 50,
+      page_height: 2940,
+      page: 37
+    }]
+  }]
+};
+
+marshallSearchResults(DUMMY_RESULTS, () => '', '{{{', '}}}');

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

@@ -0,0 +1,29 @@
+import { marshallSearchResults, renderMatch } from '@/src/plugins/search/utils.js';
+import { deepCopy } from '@/tests/jest/utils.js';
+import { DUMMY_RESULTS } from './utils.js';
+
+describe('renderMatch', () => {
+  test('Supports custom pre/post tags', () => {
+    const matchText = DUMMY_RESULTS.matches[0].text
+      .replace(/\{\{\{/g, '<IA_FTS_MATCH>')
+      .replace(/\}\}\}/g, '</IA_FTS_MATCH>');
+    const html = renderMatch(matchText, '<IA_FTS_MATCH>', '</IA_FTS_MATCH>');
+    expect(html).toContain('<mark>');
+    expect(html).toContain('</mark>');
+  });
+});
+
+describe('marshallSearchResults', () => {
+  test('Adds match index', () => {
+    const results = deepCopy(DUMMY_RESULTS);
+    marshallSearchResults(results, x => x.toString(), '{{{', '}}}');
+    expect(results.matches[0]).toHaveProperty('matchIndex', 0);
+    expect(results.matches[0].par[0].boxes[0]).toHaveProperty('matchIndex', 0);
+  });
+
+  test('Adds display page number', () => {
+    const results = deepCopy(DUMMY_RESULTS);
+    marshallSearchResults(results, x => `n${x}`, '{{{', '}}}');
+    expect(results.matches[0]).toHaveProperty('displayPageNumber', 'n37');
+  });
+});

package/tests/{plugins → jest/plugins}/tts/AbstractTTSEngine.test.js

@@ -1,12 +1,12 @@
 import sinon from 'sinon';
 import { afterEventLoop } from '../../utils.js';
-import AbstractTTSEngine from '../../../src/plugins/tts/AbstractTTSEngine.js';
-import PageChunkIterator from '../../../src/plugins/tts/PageChunkIterator.js';
-/** @typedef {import('../../../src/plugins/tts/AbstractTTSEngine.js').TTSEngineOptions} TTSEngineOptions */
+import AbstractTTSEngine from '@/src/plugins/tts/AbstractTTSEngine.js';
+import PageChunkIterator from '@/src/plugins/tts/PageChunkIterator.js';
+/** @typedef {import('@/src/plugins/tts/AbstractTTSEngine.js').TTSEngineOptions} TTSEngineOptions */
 
 // Skipping because it's flaky. Fix in #672
 describe.skip('AbstractTTSEngine', () => {
-  test('stops playing once done', () => {
+  test('stops playing once done', async () => {
     class DummyEngine extends AbstractTTSEngine {
       getVoices() { return []; }
     }
@@ -15,12 +15,12 @@ describe.skip('AbstractTTSEngine', () => {
     const stopStub = sinon.stub(d, 'stop');
     expect(stopStub.callCount).toBe(0);
     d.step();
-    return afterEventLoop()
-      .then(() => expect(stopStub.callCount).toBe(1));
+    await afterEventLoop();
+    expect(stopStub.callCount).toBe(1);
   });
 });
 
-for (const dummyVoice of [dummyVoice, dummyVoiceUnderscores]) {
+for (const dummyVoice of [dummyVoiceHyphens, dummyVoiceUnderscores]) {
   describe(`getBestBookVoice with BCP47 ${dummyVoice == dummyVoiceUnderscores ? '+' : '-'} underscores`, () => {
     const { getBestBookVoice } = AbstractTTSEngine;
 
@@ -111,6 +111,26 @@ for (const dummyVoice of [dummyVoice, dummyVoiceUnderscores]) {
 
       expect(getBestBookVoice(voices, 'en', ['en-CA', 'en'])).toBe(voices[0]);
     });
+
+    test('choose stored language from localStorage', () => {
+      const voices = [
+        dummyVoice({lang: "en-US", voiceURI: "English US", default: true}),
+        dummyVoice({lang: "en-GB", voiceURI: "English GB"}),
+        dummyVoice({lang: "en-CA", voiceURI: "English CA"}),
+      ];
+      class DummyEngine extends AbstractTTSEngine {
+        getVoices() { return voices; }
+      }
+      const ttsEngine = new DummyEngine({...DUMMY_TTS_ENGINE_OPTS, bookLanguage: 'en'});
+      // simulates setting default voice on tts startup
+      ttsEngine.updateBestVoice();
+      // simulates user choosing a voice that matches the bookLanguage
+      // voice will be stored in localStorage
+      ttsEngine.setVoice(voices[2].voiceURI);
+
+      // expecting the voice to be selected by getMatchingStoredVoice and returned as best voice
+      expect(getBestBookVoice(voices, 'en', [])).toBe(voices[2]);
+    });
   });
 }
 
@@ -130,7 +150,7 @@ export const DUMMY_TTS_ENGINE_OPTS = {
  * @param {SpeechSynthesisVoice}
  * @return {SpeechSynthesisVoice}
  **/
-function dummyVoice(overrides) {
+function dummyVoiceHyphens(overrides) {
   return Object.assign({
     default: false,
     lang: "en-US",
@@ -147,7 +167,7 @@ function dummyVoice(overrides) {
  * @return {SpeechSynthesisVoice}
  **/
 function dummyVoiceUnderscores(overrides) {
-  const voice = dummyVoice(overrides);
+  const voice = dummyVoiceHyphens(overrides);
   voice.lang = voice.lang.replace('-', '_');
   return voice;
 }