@internetarchive/bookreader 5.0.0-94 → 5.0.0-96

package/tests/e2e/helpers/mockSearch.js

@@ -1,90 +0,0 @@
-export const TEST_TEXT_FOUND = 'theory';
-export const TEST_TEXT_NOT_FOUND = 'HopefullyNotFoundLongWord';
-export const PAGE_FIRST_RESULT = 30;
-
-export const SEARCH_INSIDE_URL_RE  = /\/fulltext\/inside\.php/;
-
-/** Mock response for a matching search term. */
-export function mockResponseFound(req, res) {
-  res.headers['Access-Control-Allow-Origin'] = '*';
-  res.headers['Content-Type'] = 'application/json';
-  res.setBody(JSON.stringify(MOCKED_RESPONSE_FOUND));
-}
-
-/** Mock response for a matching search term. */
-export function mockResponseNotFound(req, res) {
-  res.headers['Access-Control-Allow-Origin'] = '*';
-  res.headers['Content-Type'] = 'application/json';
-  res.setBody(JSON.stringify(MOCKED_RESPONSE_NOT_FOUND));
-}
-
-const PAGE_FIRST_RESULT_ADJUSTED = PAGE_FIRST_RESULT + 12;
-//mocked objects inside an unsuccessful search and of a random successful search returned by search requests
-const MOCKED_RESPONSE_NOT_FOUND = {
-  "ia": "theworksofplato01platiala",
-  "q": TEST_TEXT_NOT_FOUND,
-  "indexed": true,
-  "page_count": 1,
-  "body_length": 666,
-  "leaf0_missing": true,
-  "matches": [],
-};
-
-const MOCKED_RESPONSE_FOUND = {
-  "ia": "This request has been mocked",
-  "q": TEST_TEXT_FOUND,
-  "indexed": true,
-  "page_count": 644,
-  "body_length": 666,
-  "leaf0_missing": false,
-  "matches": [
-    {
-      "text": "Everybody knows the story of another experimental philosopher who had a great {{{" + TEST_TEXT_FOUND + "}}} about a horse being able to live without eating, and who demonstrated it so well, that he got his own horse down to a straw a day, and would unquestionably have rendered him a very spirited and rampacious animal on nothing at all, if he had not died, four-and-twenty hours before he was to have had his first comfortable bait of air. Unfortunately for the experimental philosophy of the female to whose protecting care Oliver Twist was delivered over, a similar result usually attended the operation of her system; for at the very moment when a child had contrived to exist upon the smallest possible portion of the weakest possible food, it did perversely happen in eight and a half cases out of ten, either that it sickened from want and cold, or fell into the fire from neglect, or got half-smothered by accident; in any one of which cases, the miserable little being was usually summoned into another world, and there gathered to the fathers it had never known in this.",
-      "par": [
-        {
-          "boxes": [
-            {
-              "r": 1045,
-              "b": 811,
-              "t": 753,
-              "page": PAGE_FIRST_RESULT_ADJUSTED,
-              "l": 894,
-            },
-          ],
-          "b": 1935,
-          "t": 686,
-          "page_width": 1790,
-          "r": 1704,
-          "l": 148,
-          "page_height": 2940,
-          "page": PAGE_FIRST_RESULT_ADJUSTED,
-        },
-      ],
-    },
-    {
-      "text": "That when the Dodger, and his accomplished friend Master Bates, joined in the hue-and-cry which was raised at Oliver's heels, in consequence of their executing an illegal conveyance of Mr. Brownlow's personal property, as has been already described, they were actuated by a very laudable and becoming regard for themselves ; and forasmuch as the freedom of the subject and the liberty of the individual are among the first and proudest boasts of a true-hearted Englishman, so, I need hardly beg the reader to observe, that this action should tend to exalt them in the opinion of all jniblic and patriotic men, in almost as great a degree as this strong proof of their anxiety for their own preservation and safety goes to corroborate and confirm the little code of laws which certain profound and sound-judging philosophers have laid down as the mainsprings of all Nature's deeds and actions : the said philosophers very wisely reducing the good lady's proceedings to matters of maxim and {{{" + TEST_TEXT_FOUND + "}}} : and, by a very neat and pretty compliment   to   her   exalted   wisdom   and   understanding,   putting entirely out of sight any considerations of heart, or generous impulse and feeling. For, these are matters totally beneath a female who is acknowledged by universal admission to be far above the numerous little foibles and weaknesses of her sex.",
-      "par": [
-        {
-          "boxes": [
-            {
-              "r": 593,
-              "b": 2567,
-              "t": 2507,
-              "page": 162,
-              "l": 441,
-            },
-          ],
-          "b": 2631,
-          "t": 1439,
-          "page_width": 1790,
-          "r": 1620,
-          "l": 56,
-          "page_height": 2940,
-          "page": 162,
-        },
-      ],
-    },
-  ],
-};
-
-export const SEARCH_MATCHES_LENGTH = MOCKED_RESPONSE_FOUND.matches.length;

package/tests/e2e/helpers/params.js

@@ -1,17 +0,0 @@
-// @ts-check
-class TestParams {
-  baseUrl = process.env.BASE_URL?.replace(/\/+$/, '') ?? 'http://127.0.0.1:8000'
-  ocaids = process.env.OCAIDS?.split(',') ?? null;
-  /** Whether the url we're testing is a prod (or near prod) IA url, or a demos url */
-  isIA = new URL(this.baseUrl).hostname.endsWith('archive.org');
-
-  /** @param {string} ocaid */
-  getArchiveUrl(ocaid) {
-    return this.isIA ? `${this.baseUrl}/details/${ocaid}`
-      // Otherwise it's a demo page
-      : `${this.baseUrl}/BookReaderDemo/demo-internetarchive.html?ocaid=${ocaid}`;
-  }
-}
-
-const params = new TestParams();
-export default params;

package/tests/e2e/helpers/rightToLeft.js

@@ -1,23 +0,0 @@
-import { ClientFunction } from 'testcafe';
-const getPageUrl = ClientFunction(() => window.location.href);
-
-export function runRightToLeftTests (br) {
-  test('Right to Left - correct initialization in two-page view', async t => {
-    const { nav, BRcontainer} = br;
-    await t.click(nav.mode2Up);
-
-    //checking right leaf edge is not in tree
-    await t.expect(BRcontainer.find('.br-mode-2up__leafs--left').count).eql(1);
-    await t.expect(BRcontainer.find('.br-mode-2up__leafs--right').count).eql(0);
-
-    //checks slider is in correct position
-    await t.expect(nav.sliderRange.getStyleProperty('width')).eql('0px');
-  });
-
-  test('Right to Left - assuring flipping left goes to next page', async t => {
-    const { nav } = br;
-    await t.click(nav.mode2Up);
-    await t.click(nav.goLeft);
-    await t.expect(getPageUrl()).match(/page\/n1/);
-  });
-}

package/tests/e2e/helpers/search.js

@@ -1,73 +0,0 @@
-import { ClientFunction, RequestMock } from 'testcafe';
-import { SEARCH_INSIDE_URL_RE , mockResponseFound, mockResponseNotFound,
-  TEST_TEXT_FOUND, TEST_TEXT_NOT_FOUND, PAGE_FIRST_RESULT, SEARCH_MATCHES_LENGTH } from './mockSearch';
-
-
-export function runSearchTests(br) {
-  //building mock response  for successful and unsuccessful search
-  const mockFound = RequestMock()
-    .onRequestTo(SEARCH_INSIDE_URL_RE )
-    .respond(mockResponseFound, 202);
-
-  const mockNotFound = RequestMock()
-    .onRequestTo(SEARCH_INSIDE_URL_RE )
-    .respond(mockResponseNotFound, 202);
-
-
-  test
-    .requestHooks(mockFound)('Search - successful search', async t => {
-      const nav = br.nav;
-
-      //assuring that the search bar is enabled
-      await t.expect(nav.searchIcon.visible).ok();
-      await t.click(nav.searchIcon);
-
-      //testing search for a word found in the book
-      await t.selectText(nav.searchBox).pressKey('delete');
-      // FIXME: Why is it only typing every other letter?!?!
-      await t.typeText(nav.searchBox, TEST_TEXT_FOUND.split('').join('_'));
-      await t.pressKey('enter');
-
-      await t.expect(nav.searchPin.exists).ok();
-      await t.expect(nav.searchPin.child('.BRquery').child('main').exists).ok();
-      await t.expect(nav.searchPin.child('.BRquery').child('main').innerText).contains(TEST_TEXT_FOUND);
-      await t.expect(nav.searchNavigation.exists).ok();
-      await t.expect(nav.searchNavigation.find('[data-id="resultsCount"]').exists).ok();
-      await t.expect(nav.searchNavigation.find('[data-id="resultsCount"]').innerText).contains(SEARCH_MATCHES_LENGTH);
-
-      //checking url
-      const getPageUrl = ClientFunction(() => window.location.href.toString());
-      await t.expect(getPageUrl()).contains(TEST_TEXT_FOUND);
-
-      //checks clicking on first search pin opens correct page
-      await t.click(nav.searchPin);
-      await t.expect(getPageUrl()).contains(PAGE_FIRST_RESULT);
-
-      //checks highlight on result page is visible
-      const highlight = br.shell.find(".searchHiliteLayer rect");
-      await t.expect(highlight.visible).ok();
-
-    });
-
-
-  test
-    .requestHooks(mockNotFound)('Search - unsuccessful search', async t => {
-      const nav = br.nav;
-
-      //assuring that the search bar is enabled
-      await t.expect(nav.searchIcon.visible).ok();
-      await t.click(nav.searchIcon);
-
-      //testing search for a word not found in the book
-      await t.selectText(nav.searchBox).pressKey('delete');
-      // FIXME: Why is it only typing every other letter?!?!
-      await t.typeText(nav.searchBox, TEST_TEXT_NOT_FOUND.split('').join('_'));
-      await t.pressKey('enter');
-      await t.expect(nav.searchPin.child('.BRquery').child('main').withText(TEST_TEXT_NOT_FOUND).exists).notOk();
-
-      const getPageUrl = ClientFunction(() => window.location.href.toString());
-      await t.expect(getPageUrl()).contains(TEST_TEXT_NOT_FOUND);
-    });
-
-
-}

package/tests/e2e/models/BookReader.js

@@ -1,11 +0,0 @@
-import { Selector } from 'testcafe';
-import Nav from './Navigation.js';
-
-/** Model defining BookReader base elements */
-export default class BookReader {
-  constructor () {
-    this.shell = new Selector('.BookReader');
-    this.BRcontainer = new Selector('.BRcontainer');
-    this.nav = new Nav();
-  }
-}

package/tests/e2e/models/Navigation.js

@@ -1,39 +0,0 @@
-import { Selector } from 'testcafe';
-
-/** Model defining BookReader's Navigation base elements */
-export default class Navigation {
-  constructor() {
-    this.topNavShell = new Selector('.BRtoolbar');
-    this.bottomNavShell = new Selector('.BRfooter');
-    this.itemNav = Selector('ia-bookreader').shadowRoot().find('iaux-item-navigator').shadowRoot();
-
-    // flipping
-    this.goLeft = this.bottomNavShell.find('.BRicon.book_left');
-    this.goRight = this.bottomNavShell.find('.BRicon.book_right');
-    this.goNext = this.bottomNavShell.find('.BRicon.book_flip_next');
-    this.goPrev = this.bottomNavShell.find('.BRicon.book_flip_prev');
-
-    // mode switching
-    this.mode1Up = this.bottomNavShell.find('.BRicon.onepg');
-    this.mode2Up = this.bottomNavShell.find('.BRicon.twopg');
-    this.modeThumb = this.bottomNavShell.find('.BRicon.thumb');
-    this.viewmode = this.bottomNavShell.find('.BRicon.viewmode');
-
-    // zoom
-    this.zoomIn = this.bottomNavShell.find('.BRicon.zoom_in');
-    this.zoomOut = this.bottomNavShell.find('.BRicon.zoom_out');
-
-    // search
-    this.searchIcon = this.itemNav.find('button.shortcut.search');
-    this.searchBox = this.itemNav
-      .find('ia-menu-slider').shadowRoot()
-      .find('ia-book-search-results').shadowRoot()
-      .find('input[name=query]');
-    this.searchPin = this.bottomNavShell.find('.BRsearch');
-    this.searchNavigation = this.bottomNavShell.find('.BRsearch-navigation');
-
-    // other
-    this.fullScreen = this.bottomNavShell.find('.BRicon.full');
-    this.sliderRange = this.bottomNavShell.find('.ui-slider-range');
-  }
-}

package/tests/e2e/rightToLeft.test.js

@@ -1,19 +0,0 @@
-import { runBaseTests } from './helpers/base.js';
-import { runRightToLeftTests } from './helpers/rightToLeft.js';
-import params from './helpers/params.js';
-
-import BookReader from './models/BookReader.js';
-
-const ocaids = params.ocaids || [
-  'gendaitankashu00meijuoft', // Right to Left book
-];
-
-ocaids.forEach(ocaid => {
-  const url = `${params.getArchiveUrl(ocaid)}`;
-
-  fixture `Base Tests for right to left book: ${ocaid}`.page `${url}`;
-  runBaseTests(new BookReader({ pageProgression: 'rl' }));
-
-  fixture `Specific Tests for right to left book: ${ocaid}`.page `${url}`;
-  runRightToLeftTests(new BookReader());
-});

package/tests/e2e/viewmode.test.js

@@ -1,44 +0,0 @@
-import { Selector } from 'testcafe';
-import BookReader from './models/BookReader.js';
-import params from './helpers/params.js';
-
-const ocaids = params.ocaids || ['goody'];
-
-ocaids.forEach(ocaid => {
-  const url = params.getArchiveUrl(ocaid);
-
-  fixture `Viewmode carousel`.page `${url}`;
-
-  test('Clicking `view mode` cycles through view modes', async t => {
-    const { nav } = (new BookReader());
-
-    // viewmode button only appear on mobile devices
-    await t.resizeWindow(400, 800);
-    // Flip forward one
-    await t.pressKey('right');
-    await t.pressKey('right');
-    await t.pressKey('right');
-
-    // 1up to 2up
-    await t.click(nav.viewmode);
-    const twoPageContainer = Selector('.BRmode2up');
-    await t.expect(twoPageContainer.visible).ok();
-    const twoPageImages = twoPageContainer.find('img.BRpageimage');
-    await t.expect(twoPageImages.count).gte(2);
-
-    // 2up to thumb
-    await t.click(nav.viewmode);
-    const thumbnailContainer = Selector('.BRmodeThumb');
-    await t.expect(thumbnailContainer.visible).ok();
-    const thumbImages = thumbnailContainer.find('.BRpageview img');
-    await t.expect(thumbImages.count).gt(0);
-
-    // thumb to 1up
-    await t.click(nav.viewmode);
-    const onePageViewContainer = Selector('br-mode-1up');
-    await t.expect(onePageViewContainer.visible).ok();
-    const onePageImages = onePageViewContainer.find('.BRmode1up .BRpagecontainer');
-    // we usually pre-fetch the page in question & 1 before/after it
-    await t.expect(onePageImages.count).gte(2);
-  });
-});