@internetarchive/bookreader 5.0.0-36 → 5.0.0-37

package/src/plugins/tts/WebTTSEngine.js

@@ -167,7 +167,7 @@ export class WebTTSSound {
    * left off.
    * @return {Promise<void>}
    */
-  reload() {
+  async reload() {
     // We'll restore the pause state, so copy it here
     const wasPaused = this.paused;
     // Use recent event to determine where we'll restart from
@@ -179,14 +179,12 @@ export class WebTTSSound {
     }
 
     // We can't modify the utterance object, so we have to make a new one
-    return this.stop()
-      .then(() => {
-        this.load();
-        // Instead of playing and immediately pausing, we don't start playing. Note
-        // this is a requirement because pause doesn't work consistently across
-        // browsers.
-        if (!wasPaused) this.play();
-      });
+    await this.stop();
+    this.load();
+    // Instead of playing and immediately pausing, we don't start playing. Note
+    // this is a requirement because pause doesn't work consistently across
+    // browsers.
+    if (!wasPaused) this.play();
   }
 
   play() {
@@ -222,15 +220,16 @@ export class WebTTSSound {
     return endPromise;
   }
 
-  finish() {
-    this.stop().then(() => this.utterance.dispatchEvent(new Event('finish')));
+  async finish() {
+    await this.stop();
+    this.utterance.dispatchEvent(new Event('finish'));
   }
 
   /**
    * @override
    * Will fire a pause event unless already paused
    **/
-  pause() {
+  async pause() {
     if (this.paused) return;
 
     const pausePromise = promisifyEvent(this.utterance, 'pause');
@@ -246,15 +245,14 @@ export class WebTTSSound {
     if (pauseMightNotFire) {
       // wait for it just in case
       const timeoutPromise = sleep(100).then(() => 'timeout');
-      Promise.race([pausePromise, timeoutPromise])
-        .then(result => {
-          // We got our pause event; nothing to do!
-          if (result != 'timeout') return;
-
-          this.utterance.dispatchEvent(new CustomEvent('pause', this._lastEvents.start));
-          // if pause might not work, then we'll stop entirely and restart later
-          if (pauseMightNotWork) this.stop();
-        });
+      const result = await Promise.race([pausePromise, timeoutPromise]);
+      // We got our pause event; nothing to do!
+      if (result != 'timeout') return;
+
+      this.utterance.dispatchEvent(new CustomEvent('pause', this._lastEvents.start));
+
+      // if pause might not work, then we'll stop entirely and restart later
+      if (pauseMightNotWork) this.stop();
     }
   }
 
@@ -325,13 +323,11 @@ export class WebTTSSound {
       // We could do the same as before (but resume+pause instead of pause+resume),
       // but that means we'd _constantly_ be running in the background. So in that
       // case, let's just restart the chunk
-      Promise.race([
+      await Promise.race([
         promisifyEvent(this.utterance, 'resume'),
         sleep(14000).then(() => 'timeout'),
-      ])
-        .then(result => {
-          result == 'timeout' ? this.reload() : this._chromePausingBugFix();
-        });
+      ]);
+      result == 'timeout' ? this.reload() : this._chromePausingBugFix();
       break;
     case 'timeout':
       // We hit Chrome's secret cut off time. Pause/resume

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

@@ -35,7 +35,8 @@ describe('pageTops', () => {
     const book = new BookModel(br);
     const mode = new Mode1UpLit(book, br);
     document.body.appendChild(mode);
-    await mode.requestUpdate();
+    mode.requestUpdate();
+    await mode.updateComplete;
     expect(mode.pageTops).toEqual({});
   });
 

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

@@ -19,30 +19,32 @@ const FAKE_XML_5COORDS = `<OBJECT data="file://localhost//tmp/derive/goodytwosho
 const FAKE_XML_EMPTY = '';
 
 describe("Generic tests", () => {
-  let br;
-  beforeEach(() => {
-    document.body.innerHTML = '<div id="BookReader">';
-    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' },
-        ]
+  document.body.innerHTML = '<div id="BookReader">';
+  const br = new BookreaderWithTextSelection({
+    data: [
+      [
+        { width: 800, height: 1200,
+          uri: '//archive.org/download/BookReader/img/page001.jpg' },
       ],
-    });
-    br.init();
+      [
+        { 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();
+    $('.textSelectionSVG').remove();
   });
 
   test("_createPageContainer overridden function still creates a BRpagecontainer element", () => {

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

@@ -123,28 +123,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 +148,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/jest/plugins/tts/AbstractTTSEngine.test.js

@@ -6,7 +6,7 @@ import PageChunkIterator from '@/src/plugins/tts/PageChunkIterator.js';
 
 // 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,8 +15,8 @@ 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);
   });
 });
 

package/tests/karma/BookNavigator/bookmarks/bookmarks-list.test.js

@@ -49,7 +49,7 @@ describe('<ia-bookmarks-list>', () => {
   it('renders bookmarks that contain page numbers', async () => {
     const el = await fixture(container(bookmarks));
 
-    expect(el.shadowRoot.innerHTML).to.include(`Page ${bookmarks[0].page}`);
+    expect(el.shadowRoot.textContent).to.include(`Page ${bookmarks[0].page}`);
   });
 
   it('renders bookmarks that contain an optional note', async () => {
@@ -161,7 +161,7 @@ describe('<ia-bookmarks-list>', () => {
     const el = await fixture(container([bookmarks[0]]));
     const bookmarksCount = await fixture(el.bookmarksCount);
 
-    expect(bookmarksCount.innerHTML).to.include('(1)');
+    expect(bookmarksCount.textContent).to.include('(1)');
   });
 
   it('does not render the bookmarks count when no bookmarks present', async () => {

package/tests/karma/BookNavigator/downloads/downloads.test.js

@@ -49,6 +49,6 @@ describe('<ia-book-downloads>', () => {
     expect(el.shadowRoot.querySelector("ul").childElementCount).to.equal(2);
     expect(el.isBookProtected).to.equal(false);
 
-    expect(el.shadowRoot.querySelector("ul li a").innerHTML).to.include("Get PDF");
+    expect(el.shadowRoot.querySelector("ul li a").textContent).to.include("Get PDF");
   });
 });

package/tests/karma/BookNavigator/volumes/volumes-provider.test.js

@@ -77,15 +77,15 @@ describe('Volumes Provider', () => {
 
     provider.sortVolumes("title_asc");
     expect(provider.sortOrderBy).to.equal("title_asc");
-    expect(provider.sortButton.getHTML()).includes("sort-by asc-icon");
+    expect(fixtureSync(provider.sortButton).outerHTML).includes("sort-by asc-icon");
 
     provider.sortVolumes("title_desc");
     expect(provider.sortOrderBy).to.equal("title_desc");
-    expect(provider.sortButton.getHTML()).includes("sort-by desc-icon");
+    expect(fixtureSync(provider.sortButton).outerHTML).includes("sort-by desc-icon");
 
     provider.sortVolumes("default");
     expect(provider.sortOrderBy).to.equal("default");
-    expect(provider.sortButton.getHTML()).includes("sort-by neutral-icon");
+    expect(fixtureSync(provider.sortButton).outerHTML).includes("sort-by neutral-icon");
   });
 
   it('sort volumes in initial order', async () => {

package/webpack.config.js

@@ -16,7 +16,7 @@ const shared = {
     rules: [
       {
         test: /\.js$/,
-        exclude: /node_modules[/\\](?!(lit-element|lit-html)[/\\]).*/,
+        exclude: /node_modules[/\\](?!(lit-element|lit-html|lit|@lit)[/\\]).*/,
         loader: "babel-loader",
       }
     ]