@internetarchive/bookreader 5.0.0-18

package/tests/plugins/tts/utils.test.js

@@ -0,0 +1,133 @@
+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);
+  });
+});
+
+describe('approximateWordCount', () => {
+  const { approximateWordCount } = utils;
+
+  test('Empties', () => {
+    expect(approximateWordCount('')).toBe(0);
+    expect(approximateWordCount('    ')).toBe(0);
+  });
+
+  test('Spaceless', () => {
+    expect(approximateWordCount('supercalifragilisticexpialidocious')).toBe(1);
+  });
+
+  test('Basic', () => {
+    expect(approximateWordCount('the quick brown fox jumped over the lazy dog')).toBe(9);
+    expect(approximateWordCount('to be or not to be that is the question')).toBe(10);
+  });
+
+  test('Spacing', () => {
+    expect(approximateWordCount('   the     quick brown   fox jumped over the lazy dog ')).toBe(9);
+  });
+
+  test('Punctuation not separate word (unless separate)', () => {
+    expect(approximateWordCount('the. quick brown. fox. jumped. over the. lazy dog.')).toBe(9);
+    expect(approximateWordCount(' . . . . . ')).toBe(5);
+  });
+
+  test('Realword examples', () => {
+    expect(approximateWordCount("Albert\u2019s cats had a .large blue dish of milk for breakfast.")).toBe(11);
+    expect(approximateWordCount("FARM FOLK O nce upon a time there was a sturdy little boy who lived in Belgium. Every morning after he milked the cows, he gave his cats a large blue dish of milk for breakfast.")).toBe(36);
+  });
+});
+
+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;
+
+  test('ISO 639-1', () => {
+    expect(toISO6391('en')).toBe('en');
+    expect(toISO6391('fr')).toBe('fr');
+    expect(toISO6391('SQ')).toBe('sq');
+    expect(toISO6391('aa')).toBe('aa');
+  });
+
+  test('ISO 639-2/T', () => {
+    expect(toISO6391('amh')).toBe('am');
+    expect(toISO6391('BIH')).toBe('bh');
+  });
+
+  test('ISO 639-2/B', () => {
+    expect(toISO6391('BAQ')).toBe('eu');
+    expect(toISO6391('chi')).toBe('zh');
+  });
+
+  test('Name', () => {
+    expect(toISO6391('english')).toBe('en');
+    expect(toISO6391('German')).toBe('de');
+  });
+
+  test('Endonym', () => {
+    expect(toISO6391('français')).toBe('fr');
+    expect(toISO6391('汉语')).toBe('zh');
+  });
+
+  test('Mismatch', () => {
+    expect(toISO6391('Parseltongue')).toBe(null);
+    expect(toISO6391('Pig Latin')).toBe(null);
+  });
+
+  test('Falsey inputs', () => {
+    expect(toISO6391(null)).toBe(null);
+    expect(toISO6391('')).toBe(null);
+  });
+});

package/tests/util/browserSniffing.test.js

@@ -0,0 +1,56 @@
+import {
+  isChrome, isFirefox, isSafari,
+} from '../../src/util/browserSniffing.js';
+
+const TESTS = [
+  {
+    name: 'Firefox on Windows 10',
+    userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:69.0) Gecko/20100101 Firefox/69.0',
+    vendor: '',
+    machingFn: isFirefox,
+  },
+  {
+    name: 'Chrome on Windows 10',
+    userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3865.90 Safari/537.36',
+    vendor: 'Google Inc.',
+    machingFn: isChrome,
+  },
+  {
+    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,
+  },
+  {
+    name: 'IE11 on Windows 10',
+    userAgent: 'Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; Touch; .NET4.0C; .NET4.0E; Tablet PC 2.0; Zoom 3.6.0; rv:11.0) like Gecko',
+    vendor: '',
+    machingFn: null,
+  },
+  {
+    name: 'Chromium on Windows 10',
+    userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3923.0 Safari/537.36',
+    vendor: 'Google Inc.',
+    machingFn: isChrome,
+  },
+  {
+    name: 'Safari 12 on Mojave',
+    userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.1.2 Safari/605.1.15',
+    vendor: 'Apple Computer, Inc.',
+    machingFn: isSafari,
+  },
+  {
+    name: 'Safari 10 on iPhone 7',
+    userAgent: 'Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_1 like Mac OS X) AppleWebKit/603.1.30 (KHTML, like Gecko) Version/10.0 Mobile/14E304 Safari/602.1',
+    vendor: 'Apple Computer, Inc.',
+    machingFn: isSafari,
+  },
+];
+
+for (const fn of [isChrome, isFirefox, isSafari]) {
+  describe(fn.name, () => {
+    for (const { name, userAgent, vendor, machingFn } of TESTS) {
+      test(name, () => expect(fn(userAgent, vendor)).toBe(machingFn == fn));
+    }
+  });
+}

package/tests/util/docCookies.test.js

@@ -0,0 +1,15 @@
+import * as docCookies from '../../src/util/docCookies.js';
+
+afterEach(() => {
+  jest.clearAllMocks();
+});
+
+describe('Helper function: set and get cookie item', () => {
+  test('set cookie item value', () => {
+    expect(docCookies.setItem('test-cookie', 'jack-sparow')).toBeTruthy();
+  });
+
+  test('get cookie item value', () => {
+    expect(docCookies.getItem('test-cookie')).toEqual('jack-sparow');
+  });
+});

package/tests/util/strings.test.js

@@ -0,0 +1,63 @@
+import { APPLY_FILTERS, applyVariables } from '../../src/util/strings.js';
+
+describe('applyVariables', () => {
+  test('null cases', () => {
+    expect(applyVariables(null, {})).toBeUndefined();
+    expect(applyVariables('', {})).toEqual('');
+    expect(applyVariables('', {x: 3})).toEqual('');
+  });
+
+  test('Ignores undefined variables', () => {
+    expect(applyVariables('Hello {{name}}!', {})).toEqual('Hello {{name}}!');
+  });
+
+  test('Replaces multiple instances', () => {
+    expect(applyVariables('Hello {{name}}! How are you doing, {{name}}?', {name: 'Bill'})).toEqual('Hello Bill! How are you doing, Bill?');
+    expect(applyVariables('Hello {{name}}! You are {{age}}, {{name}}', {name: 'Bill', age: 54})).toEqual('Hello Bill! You are 54, Bill');
+  });
+
+  test('Is case sensitive', () => {
+    expect(applyVariables('Hello {{name}}', {NAME: 'Bill'})).toEqual('Hello {{name}}');
+  });
+
+  test('Supports variable names with funny chars', () => {
+    expect(applyVariables('Hello {{first name}}', {'first name': 'Bill'})).toEqual('Hello Bill');
+  });
+
+  test('Overrides do override', () => {
+    expect(applyVariables('Hello {{name}}', {name: 'Bill'}, {name: 'Bobby'})).toEqual('Hello Bobby');
+  });
+
+  test('Nullish values', () => {
+    expect(applyVariables('Hello {{name}}', {name: undefined})).toEqual('Hello undefined');
+    expect(applyVariables('Hello {{name}}', {name: null})).toEqual('Hello null');
+    expect(applyVariables('Hello {{name}}', {name: ''})).toEqual('Hello ');
+  });
+
+  test('Non-string values', () => {
+    expect(applyVariables('Hello {{name}}', {name: 10})).toEqual('Hello 10');
+    expect(applyVariables('Hello {{name}}', {name: 0})).toEqual('Hello 0');
+  });
+
+  test('Filters', () => {
+    expect(applyVariables('Hello {{name|urlencode}}', {name: 'Jim bob'})).toEqual('Hello Jim%20bob');
+    expect(applyVariables('Hello {{name|urlencode}}', {name: 0})).toEqual('Hello 0');
+    expect(applyVariables('Hello {{name|urlencode}}', {})).toEqual('Hello {{name|urlencode}}');
+  });
+
+  test('Custom filters', () => {
+    expect(applyVariables('Hello {{name|upper}}', {name: 'Jim bob'}, {}, {upper: s => s.toUpperCase()})).toEqual('Hello JIM BOB');
+  });
+
+  test('Multiple filters', () => {
+    const filters = Object.assign({}, APPLY_FILTERS, {
+      upper: s => s.toUpperCase(),
+      lower: s => s.toLowerCase(),
+      double: s => s + s,
+    });
+    expect(applyVariables('Hello {{name|upper|urlencode}}', {name: 'Jim bob'}, {}, filters)).toEqual('Hello JIM%20BOB');
+    expect(applyVariables('Hello {{name|upper|lower}}', {name: 'Jim bob'}, {}, filters)).toEqual('Hello jim bob');
+    expect(applyVariables('Hello {{name|lower|upper}}', {name: 'Jim bob'}, {}, filters)).toEqual('Hello JIM BOB');
+    expect(applyVariables('Hello {{name|lower|double}}', {name: 'Jim bob'}, {}, filters)).toEqual('Hello jim bobjim bob');
+  });
+});

package/tests/utils.js

@@ -0,0 +1,80 @@
+/**
+ * Resolves after all enqueued callbacks in the event loop have resolved.
+ * @return {Promise}
+ */
+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));
+}
+
+/**
+ * Event target mixin
+ * @return {EventTarget}
+ */
+export function eventTargetMixin() {
+  return {
+    addEventListener(evName, listener) {
+      const listeners = this._listeners[evName] || [];
+      listeners.push(listener);
+      this._listeners[evName] = listeners;
+    },
+    dispatchEvent(evName, ev) {
+      const listeners = this._listeners[evName] || [];
+      listeners.forEach(fn => fn(ev));
+    },
+    removeEventListener(evName, listener) {
+      const listeners = this._listeners[evName] || [];
+      this._listeners[evName] = listeners.filter(fn => fn != listener);
+    },
+    _listeners: {},
+  };
+}
+
+/** @implements {EventTarget} */
+export class EventTargetSpy {
+  /** @type {Record<string, Function[]} */
+  _listeners = {}
+  get _totalListenerCount() {
+    return Object.values(this._listeners)
+      .map(a => a.length)
+      .reduce((a, b) => a + b, 0);
+  }
+
+  addEventListener(evName, listener) {
+    const listeners = this._listeners[evName] || [];
+    listeners.push(listener);
+    this._listeners[evName] = listeners;
+  }
+
+  dispatchEvent(evName, ev) {
+    const listeners = this._listeners[evName] || [];
+    listeners.forEach(fn => fn(ev));
+  }
+
+  removeEventListener(evName, listener) {
+    const listeners = this._listeners[evName] || [];
+    this._listeners[evName] = listeners.filter(fn => fn != listener);
+  }
+
+  /**
+   * @param {EventTarget} realEventTarget
+   */
+  static wrap(realEventTarget) {
+    const spy = new EventTargetSpy();
+    realEventTarget.addEventListener = spy.addEventListener.bind(spy);
+    realEventTarget.removeEventListener = spy.removeEventListener.bind(spy);
+    realEventTarget.dispatchEvent = spy.dispatchEvent.bind(spy);
+    return spy;
+  }
+}
+
+/**
+ * Lazy deep copy function; only supports objects (no classes)
+ * @template T
+ * @param {T} obj
+ * @return {T}
+ */
+export function deepCopy(obj) {
+  return JSON.parse(JSON.stringify(obj));
+}

package/webpack.config.js

@@ -0,0 +1,85 @@
+// @ts-check
+const path = require('path');
+const webpack = require('webpack');
+
+/** @type {webpack.Configuration} */
+const shared = {
+  mode: 'production',
+
+  watchOptions: {
+    ignored: ['BookReader/**', 'node_modules/**', 'tests/**']
+  },
+
+  target: ['web', 'es5'],
+
+  module: {
+    rules: [
+      { test: /\.js$/, exclude: /node_modules/, loader: "babel-loader" }
+    ]
+  },
+
+  output: {
+    filename: '[name]',
+    path: path.resolve(__dirname, 'BookReader'),
+  },
+};
+
+/** @type {webpack.Configuration[]} */
+module.exports = [
+  {
+    ...shared,
+
+    // Output file -> srcfile
+    entry: {
+      // BookReader
+      'BookReader.js': './src/BookReader.js',
+
+      // Plugins (sorted!)
+      'plugins/plugin.archive_analytics.js': { import: './src/plugins/plugin.archive_analytics.js', dependOn: 'BookReader.js' },
+      'plugins/plugin.autoplay.js': { import: './src/plugins/plugin.autoplay.js', dependOn: 'BookReader.js' },
+      'plugins/plugin.chapters.js': { import: './src/plugins/plugin.chapters.js', dependOn: 'BookReader.js' },
+      'plugins/plugin.iframe.js': { import: './src/plugins/plugin.iframe.js', dependOn: 'BookReader.js' },
+      'plugins/plugin.mobile_nav.js': { import: './src/plugins/plugin.mobile_nav.js', dependOn: 'BookReader.js' },
+      'plugins/plugin.resume.js': { import: './src/plugins/plugin.resume.js', dependOn: 'BookReader.js' },
+      'plugins/plugin.search.js': { import: './src/plugins/search/plugin.search.js', dependOn: 'BookReader.js' },
+      'plugins/plugin.text_selection.js': { import: './src/plugins/plugin.text_selection.js', dependOn: 'BookReader.js' },
+      'plugins/plugin.tts.js': { import: './src/plugins/tts/plugin.tts.js', dependOn: 'BookReader.js' },
+      'plugins/plugin.url.js': { import: './src/plugins/plugin.url.js', dependOn: 'BookReader.js' },
+      'plugins/plugin.vendor-fullscreen.js': { import: './src/plugins/plugin.vendor-fullscreen.js', dependOn: 'BookReader.js' },
+      'bookreader-component-bundle.js': { import: './src/BookReaderComponent/BookReaderComponent.js', dependOn: 'BookReader.js' }
+    },
+
+    externals: {
+      // Anytime 'jquery' is imported, use the at runtime globally defined jQuery
+      // instead of bundling a copy of jquery at compile-time.
+      jquery: 'jQuery',
+    },
+    plugins: [
+      new webpack.ProvidePlugin({
+        // Make $ and jQuery available without importing
+        $: 'jquery',
+        jQuery: 'jquery',
+      })
+    ],
+
+    output: {
+      filename: '[name]',
+      path: path.resolve(__dirname, 'BookReader'),
+    },
+
+    // Accurate source maps at the expense of build time.
+    // The source map is intentionally exposed
+    // to users via sourceMapFilename for prod debugging.
+    devtool: 'source-map'
+  },
+
+  // jQuery gets its own build, so that it can be used as an "external" in
+  // everything else.
+  {
+    ...shared,
+
+    entry: {
+      'jquery-1.10.1.js': { import: './src/jquery-wrapper.js' },
+    },
+  },
+];