@internetarchive/bookreader 5.0.0-9 → 5.0.0-90

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();
@@ -102,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`', () => {
@@ -123,28 +103,24 @@ describe('Plugin: Search', () => {
     expect(br.options.goToFirstResult).toBeTruthy();
   });
 
-  test('SearchCallback event fires when AJAX search returns results', () => {
+  test('SearchCallback event fires when AJAX search returns results', async () => {
     br.init();
-    const dfd = br.search('foo');
-    return dfd.then(() => {
-      expect(triggeredEvents()).toContain(`${namespace}SearchCallback`);
-    });
+    await br.search('foo');
+    expect(triggeredEvents()).toContain(`${namespace}SearchCallback`);
   });
 
-  test('SearchCallbackError event fires when AJAX search returns error', () => {
+  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: [],
@@ -152,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:';
@@ -23,10 +23,35 @@ const results = {
       r: 1598,
       l: 50,
       page_height: 2940,
-      page: 37
-    }]
-  }]
+      page: 37,
+    }],
+  }],
 };
+
+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;
 
@@ -106,11 +106,31 @@ for (const dummyVoice of [dummyVoice, dummyVoiceUnderscores]) {
         { default: false, lang: "ru-RU", name: "Google русский", localService: false, voiceURI: "Google русский" },
         { default: false, lang: "zh-CN", name: "Google 普通话（中国大陆）", localService: false, voiceURI: "Google 普通话（中国大陆）" },
         { default: false, lang: "zh-HK", name: "Google 粤語（香港）", localService: false, voiceURI: "Google 粤語（香港）" },
-        { default: false, lang: "zh-TW", name: "Google 國語（臺灣）", localService: false, voiceURI: "Google 國語（臺灣）" }
+        { default: false, lang: "zh-TW", name: "Google 國語（臺灣）", localService: false, voiceURI: "Google 國語（臺灣）" },
       ];
 
       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;
 }

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

@@ -1,10 +1,10 @@
-import FestivalTTSEngine from '../../../src/plugins/tts/FestivalTTSEngine.js';
+import FestivalTTSEngine from '@/src/plugins/tts/FestivalTTSEngine.js';
 import sinon from 'sinon';
 import { afterEventLoop } from '../../utils.js';
 import { DUMMY_TTS_ENGINE_OPTS } from './AbstractTTSEngine.test.js';
-import PageChunk from '../../../src/plugins/tts/PageChunk.js';
-import PageChunkIterator from '../../../src/plugins/tts/PageChunkIterator.js';
-/** @typedef {import('../../../src/plugins/tts/AbstractTTSEngine.js').TTSEngineOptions} TTSEngineOptions */
+import PageChunk from '@/src/plugins/tts/PageChunk.js';
+import PageChunkIterator from '@/src/plugins/tts/PageChunkIterator.js';
+/** @typedef {import('@/src/plugins/tts/AbstractTTSEngine.js').TTSEngineOptions} TTSEngineOptions */
 
 describe('iOSCaptureUserIntentHack', () => {
   test('synchronously calls createSound/play to capture user intent', () => {

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

@@ -1,4 +1,4 @@
-import PageChunk from '../../../src/plugins/tts/PageChunk.js';
+import PageChunk from '@/src/plugins/tts/PageChunk.js';
 
 describe('_fixChunkRects', () => {
   const { _fixChunkRects } = PageChunk;

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

@@ -1,6 +1,6 @@
 import sinon from 'sinon';
-import PageChunkIterator from "../../../src/plugins/tts/PageChunkIterator";
-import PageChunk from '../../../src/plugins/tts/PageChunk';
+import PageChunkIterator from "@/src/plugins/tts/PageChunkIterator";
+import PageChunk from '@/src/plugins/tts/PageChunk';
 
 describe('Buffers pages', () => {
   test('Does not error if no room for reverse buffer', async () => {
@@ -109,7 +109,7 @@ describe('Iterates pages', () => {
     expect(iterator._cursor.chunk).toBe(0);
 
     for (let i = 2; i >= 0; i--) {
-      await iterator.decrement()
+      await iterator.decrement();
       expect(iterator._cursor.page).toBe(49);
       expect(iterator._cursor.chunk).toBe(i);
     }

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

@@ -1,5 +1,5 @@
 import sinon from 'sinon';
-import { WebTTSSound } from '../../../src/plugins/tts/WebTTSEngine.js';
+import WebTTSEngine, { WebTTSSound } from '@/src/plugins/tts/WebTTSEngine.js';
 import { afterEventLoop, eventTargetMixin } from '../../utils.js';
 
 beforeEach(() => {
@@ -8,6 +8,7 @@ beforeEach(() => {
     speak: sinon.stub(),
     pause: sinon.stub(),
     resume: sinon.stub(),
+
     ...eventTargetMixin(),
   };
   window.SpeechSynthesisUtterance = function (text) {
@@ -21,6 +22,51 @@ afterEach(() => {
   delete window.SpeechSynthesisUtterance;
 });
 
+describe('WebTTSEngine', () => {
+  test('getVoices should include default voice when no actual default', () => {
+    // iOS devices set all the voices to default -_-
+    speechSynthesis.getVoices = () => [
+      {
+        default: true,
+        lang: "ar-001",
+        localService: true,
+        name: "Majed",
+        voiceURI: "com.apple.voice.compact.ar-001.Maged",
+      },
+      {
+        default: true,
+        lang: "bg-BG",
+        localService: true,
+        name: "Daria",
+        voiceURI: "com.apple.voice.compact.bg-BG.Daria",
+      },
+    ];
+    const voices = WebTTSEngine.prototype.getVoices();
+    expect(voices.length).toBe(3);
+    expect(voices[0].voiceURI).toBe('bookreader.SystemDefault');
+  });
+
+  test('getVoices should not include default voice when there is a default', () => {
+    speechSynthesis.getVoices = () => [
+      {
+        default: true,
+        lang: "ar-001",
+        localService: true,
+        name: "Majed",
+        voiceURI: "com.apple.voice.compact.ar-001.Maged",
+      },
+      {
+        default: false,
+        lang: "bg-BG",
+        localService: true,
+        name: "Daria",
+        voiceURI: "com.apple.voice.compact.bg-BG.Daria",
+      },
+    ];
+    const voices = WebTTSEngine.prototype.getVoices();
+    expect(voices.length).toBe(2);
+  });
+});
 
 describe('WebTTSSound', () => {
   describe('setPlaybackRate', () => {

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

@@ -1,38 +1,4 @@
-import sinon from 'sinon';
-import { afterEventLoop, eventTargetMixin } from '../../utils.js';
-import * as utils from '../../../src/plugins/tts/utils.js';
-
-describe('promisifyEvent', () => {
-  const { promisifyEvent } = utils;
-
-  test('Resolves once event fires', async () => {
-    const fakeTarget = eventTargetMixin();
-    const resolveSpy = sinon.spy();
-    promisifyEvent(fakeTarget, 'pause').then(resolveSpy);
-
-    await afterEventLoop()
-    expect(resolveSpy.callCount).toBe(0);
-    fakeTarget.dispatchEvent('pause', {});
-    await afterEventLoop();
-    expect(resolveSpy.callCount).toBe(1);
-  });
-
-  test('Only resolves once', async () => {
-    const fakeTarget = eventTargetMixin();
-    const resolveSpy = sinon.spy();
-    promisifyEvent(fakeTarget, 'pause').then(resolveSpy);
-
-    await afterEventLoop()
-    expect(resolveSpy.callCount).toBe(0);
-    fakeTarget.dispatchEvent('pause', {});
-    fakeTarget.dispatchEvent('pause', {});
-    fakeTarget.dispatchEvent('pause', {});
-    fakeTarget.dispatchEvent('pause', {});
-
-    await afterEventLoop();
-    expect(resolveSpy.callCount).toBe(1);
-  });
-});
+import * as utils from '@/src/plugins/tts/utils.js';
 
 describe('approximateWordCount', () => {
   const { approximateWordCount } = utils;
@@ -66,31 +32,6 @@ describe('approximateWordCount', () => {
   });
 });
 
-describe('sleep', () => {
-  const { sleep } = utils;
-
-  test('Sleep 0 doest not called immediately', async () => {
-    const spy = sinon.spy();
-    sleep(0).then(spy);
-    expect(spy.callCount).toBe(0);
-    await afterEventLoop();
-    expect(spy.callCount).toBe(1);
-  });
-
-  test('Waits the appropriate ms', async () => {
-    const clock = sinon.useFakeTimers();
-    const spy = sinon.spy();
-    sleep(10).then(spy);
-    expect(spy.callCount).toBe(0);
-    clock.tick(10);
-    expect(spy.callCount).toBe(0);
-    clock.restore();
-
-    await afterEventLoop();
-    expect(spy.callCount).toBe(1);
-  });
-});
-
 describe('toISO6391', () => {
   const { toISO6391 } = utils;