@internetarchive/bookreader 5.0.0-71 → 5.0.0-72

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 5.0.0-72
+- Fix: Play/pause button out of sync with ReadAloud @sbwhitt
+- Fix: BookReader not loading in sandboxed iframe @cdrini
+- Dev: Fix noisy sentry error firing on any selection @cdrini
+- Dev: Update to Node 20 @cdrini
+
 # 5.0.0-71
 - Dev: update jest monorepo @renovate
 - Fix: Share & Mutliple View menu panel refactor @iisa

package/netlify.toml

@@ -1,6 +1,6 @@
 [build.environment]
   # Keep in sync with CI in .github/workflows/node.js.yml
-  NODE_VERSION = "16"
+  NODE_VERSION = "20"
 
 [[headers]]
   # Define which paths this specific [[headers]] block will cover.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/bookreader",
-  "version": "5.0.0-71",
+  "version": "5.0.0-72",
   "description": "The Internet Archive BookReader.",
   "repository": {
     "type": "git",
@@ -46,7 +46,7 @@
     "@babel/plugin-proposal-decorators": "7.22.7",
     "@babel/preset-env": "7.22.9",
     "@open-wc/testing-helpers": "^2.3.0",
-    "@types/jest": "29.5.5",
+    "@types/jest": "29.5.6",
     "@webcomponents/webcomponentsjs": "^2.6.0",
     "babel-loader": "9.1.3",
     "codecov": "^3.8.3",
@@ -67,10 +67,9 @@
     "jquery-ui-touch-punch": "0.2.3",
     "jquery.browser": "0.1.0",
     "live-server": "1.2.2",
-    "node-fetch": "3.3.2",
     "regenerator-runtime": "0.13.11",
     "sass": "1.64.2",
-    "sinon": "^15.1.0",
+    "sinon": "^17.0.0",
     "soundmanager2": "2.97.20170602",
     "svgo": "3.0.2",
     "testcafe": "2.6.2",
@@ -81,7 +80,7 @@
   "jest": {
     "testEnvironment": "jsdom",
     "transformIgnorePatterns": [
-      "node_modules/(?!(lit-html|lit-element|lit|@lit|@internetarchive|@open-wc)/)"
+      "node_modules/(?!(sinon|lit-html|lit-element|lit|@lit|@internetarchive|@open-wc)/)"
     ],
     "moduleNameMapper": {
       "^@/(.*)$": "<rootDir>/$1"

package/scripts/preversion.js

@@ -2,10 +2,6 @@ const { version: OLD_VERSION } = require('../package.json');
 const OLD_RELEASE_URL = `https://api.github.com/repos/internetarchive/bookreader/releases/tags/v${OLD_VERSION}`;
 
 async function main() {
-    // Need this because fetch is ESM-only, and we're on Node 16. Someday we should
-    // be able to move this up to the top without renaming this file to a .mjs or whatever
-    const {default: fetch} = await import('node-fetch');
-
     const {created_at} = await fetch(OLD_RELEASE_URL).then(r => r.json());
     const today = new Date().toISOString().slice(0, -5);
     const searchUrl = 'https://github.com/internetarchive/bookreader/pulls?' + new URLSearchParams({

package/src/BookReader/utils/SelectionObserver.js

@@ -30,8 +30,10 @@ export class SelectionObserver {
     const sel = window.getSelection();
 
     if (!this.selecting && sel.toString()) {
+      const target = $(sel.anchorNode).closest(this.selector)[0];
+      if (!target) return;
+      this.target = target;
       this.selecting = true;
-      this.target = $(sel.anchorNode).closest(this.selector)[0];
       this.handler('started', this.target);
     }
 

package/src/plugins/tts/AbstractTTSEngine.js

@@ -1,4 +1,5 @@
 import PageChunkIterator from './PageChunkIterator.js';
+import { hasLocalStorage } from './utils.js';
 /** @typedef {import('./utils.js').ISO6391} ISO6391 */
 /** @typedef {import('./PageChunk.js')} PageChunk */
 
@@ -80,6 +81,7 @@ export default class AbstractTTSEngine {
    */
   start(leafIndex, numLeafs) {
     this.playing = true;
+    this.paused = false;
     this.opts.onLoadingStart();
 
     this._chunkIterator = new PageChunkIterator(numLeafs, leafIndex, {
@@ -95,6 +97,7 @@ export default class AbstractTTSEngine {
   stop() {
     if (this.activeSound) this.activeSound.stop();
     this.playing = false;
+    this.paused = true;
     this._chunkIterator = null;
     this.activeSound = null;
     this.events.trigger('stop');
@@ -143,7 +146,7 @@ export default class AbstractTTSEngine {
     this.events.off('voiceschanged', this.updateBestVoice);
     this.voice = this.getVoices().find(voice => voice.voiceURI === voiceURI);
     // if the current book has a language set, store the selected voice with the book language as a suffix
-    if (this.opts.bookLanguage) {
+    if (this.opts.bookLanguage && hasLocalStorage()) {
       localStorage.setItem(`BRtts-voice-${this.opts.bookLanguage}`, this.voice.voiceURI);
     }
     if (this.activeSound) this.activeSound.setVoice(this.voice);
@@ -247,7 +250,7 @@ export default class AbstractTTSEngine {
    * @return {SpeechSynthesisVoice | undefined}
    */
   static getMatchingStoredVoice(voices, bookLanguage) {
-    const storedVoice = localStorage.getItem(`BRtts-voice-${bookLanguage}`);
+    const storedVoice = hasLocalStorage() && localStorage.getItem(`BRtts-voice-${bookLanguage}`);
     return (storedVoice ? voices.find(v => v.voiceURI === storedVoice) : undefined);
   }
 

package/src/plugins/tts/plugin.tts.js

@@ -251,7 +251,7 @@ BookReader.prototype.ttsPlayPause = function() {
     this.ttsToggle();
   } else {
     this.ttsEngine.togglePlayPause();
-    this.ttsUpdateState(this.ttsEngine.paused);
+    this.ttsUpdateState();
   }
 };
 

package/src/plugins/tts/utils.js

@@ -64,3 +64,18 @@ function searchForISO6391(language, columnsToSearch) {
   }
   return null;
 }
+
+/**
+ * Checks whether the current browser supports localStorage or
+ * if the current context has access to it.
+ * @return {boolean}
+ */
+export function hasLocalStorage() {
+  try {
+    return !!window.localStorage;
+  } catch (e) {
+    // Will throw in sandboxed iframe
+    // DOMException: Window.localStorage getter: Forbidden in a sandboxed document without the 'allow-same-origin' flag.
+    return false;
+  }
+}

package/tests/jest/BookReader/utils/SelectionObserver.test.js

@@ -40,4 +40,18 @@ describe("SelectionObserver", () => {
     observer._onSelectionChange();
     expect(handler.callCount).toBe(2);
   });
+
+  test('Only fires when selection started in selector', () => {
+    const handler = sinon.spy();
+    const observer = new SelectionObserver(".text-layer", handler);
+    const target = document.createElement("div");
+    target.classList.add("text-layer");
+
+    // stub window.getSelection
+    const getSelectionStub = sinon.stub(window, "getSelection");
+    getSelectionStub.returns({ toString: () => "test", anchorNode: document.body });
+    observer._onSelectionChange();
+    expect(handler.callCount).toBe(0);
+    expect(observer.selecting).toBe(false);
+  });
 });