@internetarchive/bookreader 5.0.0-6-14 → 5.0.0-60

package/tests/jest/BookNavigator/search/search-provider.test.js

@@ -0,0 +1,167 @@
+import { fixtureCleanup, fixtureSync } from '@open-wc/testing-helpers';
+import sinon from 'sinon';
+import searchProvider from '@/src/BookNavigator/search/search-provider';
+
+afterEach(() => {
+  sinon.restore();
+  fixtureCleanup();
+});
+
+describe('Search Provider', () => {
+  describe('constructor', () => {
+    const provider = new searchProvider({
+      onProviderChange: sinon.fake(),
+      bookreader: {}
+    });
+
+    expect(provider.bookreader).toBeDefined();
+    expect(provider.onProviderChange).toBeDefined();
+    expect(provider.id).toEqual('search');
+    expect(provider.icon).toBeDefined();
+    expect(fixtureSync(provider.icon).tagName).toEqual('IA-ICON-SEARCH');
+    expect(provider.label).toEqual('Search inside');
+    expect(provider.menuDetails).toBeDefined();
+    expect(provider.component).toBeDefined();
+  });
+  describe('Search request life cycles', () => {
+    test('Event: catches `BookReader:SearchStarted`', async() => {
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {}
+      });
+      sinon.spy(provider, 'updateMenu');
+      window.dispatchEvent(new CustomEvent('BookReader:SearchStarted', { detail: { props: { term: 'foo' }}}));
+      expect(provider.updateMenu.callCount).toEqual(1);
+    });
+    test('Event: catches `BookReader:SearchCallback`', async() => {
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {}
+      });
+      sinon.spy(provider, 'updateMenu');
+      const brStub = {};
+      window.dispatchEvent(new CustomEvent('BookReader:SearchCallback', { detail: { props: { instance: brStub, results: { matches: []} }}}));
+      expect(provider.updateMenu.callCount).toEqual(1);
+      expect(provider.bookreader).toEqual(brStub);
+    });
+    test('Event: catches `BookReader:SearchCallbackEmpty`', async() => {
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {}
+      });
+      sinon.spy(provider, 'onSearchRequestError');
+      sinon.spy(provider, 'updateMenu');
+      const brStub = {};
+      window.dispatchEvent(new CustomEvent('BookReader:SearchCallbackEmpty', { detail: { props: { instance: brStub }}}));
+      expect(provider.onSearchRequestError.getCall(0).args[1]).toEqual('noResults');
+      expect(provider.updateMenu.callCount).toEqual(1);
+      expect(provider.bookreader).toEqual(brStub);
+    });
+    test('Event: catches `BookReader:SearchCallbackNotIndexed`', async() => {
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {}
+      });
+      const brStub = {};
+      sinon.spy(provider, 'onSearchRequestError');
+      sinon.spy(provider, 'updateMenu');
+      window.dispatchEvent(new CustomEvent('BookReader:SearchCallbackNotIndexed', { detail: { props: { instance: brStub }}}));
+      expect(provider.onSearchRequestError.getCall(0).args[1]).toEqual('notIndexed');
+      expect(provider.updateMenu.callCount).toEqual(1);
+      expect(provider.bookreader).toEqual(brStub);
+    });
+    test('Event: catches `BookReader:SearchCallbackError`', async() => {
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {}
+      });
+      sinon.spy(provider, 'onSearchRequestError');
+      sinon.spy(provider, 'updateMenu');
+      const brStub = {};
+      window.dispatchEvent(new CustomEvent('BookReader:SearchCallbackError', { detail: { props: { instance: brStub }}}));
+      expect(provider.onSearchRequestError.getCall(0).args[1]).toEqual(undefined);
+      expect(provider.updateMenu.callCount).toEqual(1);
+      expect(provider.bookreader).toEqual(brStub);
+    });
+    test('Event: catches `component@resultSelected` - user clicks result in side panel - & turns page', async() => {
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {
+          leafNumToIndex: sinon.fake(),
+          _searchPluginGoToResult: sinon.fake()
+        }
+      });
+
+      const searchResultStub = {
+        match: { par: [{ text: 'foo', page: 3 }] },
+      };
+      fixtureSync(provider.component).dispatchEvent(
+        new CustomEvent('resultSelected',
+          { detail: searchResultStub })
+      );
+
+      expect(provider.bookreader._searchPluginGoToResult.callCount).toEqual(1);
+    });
+    test('update url when search is cancelled or input cleared', async() => {
+      const urlPluginMock = {
+        pullFromAddressBar: sinon.fake(),
+        removeUrlParam: sinon.fake()
+      };
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {
+          leafNumToIndex: sinon.fake(),
+          _searchPluginGoToResult: sinon.fake(),
+          urlPlugin: urlPluginMock
+        }
+      });
+
+      provider.onSearchCanceled();
+      await provider.updateComplete;
+
+      expect(urlPluginMock.pullFromAddressBar.callCount).toEqual(1);
+      expect(urlPluginMock.removeUrlParam.callCount).toEqual(1);
+
+      provider.onSearchCanceled();
+      await provider.updateComplete;
+
+      expect(urlPluginMock.pullFromAddressBar.callCount).toEqual(2);
+      expect(urlPluginMock.removeUrlParam.callCount).toEqual(2);
+    });
+    it('updateSearchInUrl', async () => {
+      let fieldToSet;
+      let valueOfFieldToSet;
+      let setUrlParamCalled = false;
+      const urlPluginMock = {
+        pullFromAddressBar: sinon.fake(),
+        removeUrlParam: sinon.fake(),
+        setUrlParam: (field, val) => {
+          fieldToSet = field;
+          valueOfFieldToSet = val;
+          setUrlParamCalled = true;
+        }
+      };
+      const provider = new searchProvider({
+        onProviderChange: sinon.fake(),
+        bookreader: {
+          leafNumToIndex: sinon.fake(),
+          _searchPluginGoToResult: sinon.fake(),
+          urlPlugin: urlPluginMock,
+          search: sinon.fake()
+        }
+      });
+
+      const searchInitiatedEvent = new CustomEvent('bookSearchInitiated', { detail: { query: 'foobar' } });
+      // set initial seachState with a query
+      provider.onBookSearchInitiated(searchInitiatedEvent);
+      await provider.updateComplete;
+      // checking this fn:
+      provider.updateSearchInUrl();
+      await provider.updateComplete;
+
+      expect(fieldToSet).toEqual('q');
+      expect(valueOfFieldToSet).toEqual('foobar');
+      expect(setUrlParamCalled).toBe(true);
+    });
+  });
+});

package/tests/{karma/BookNavigator → jest/BookNavigator/search}/search-results.test.js

@@ -1,24 +1,22 @@
 import {
   html,
   fixture,
-  expect,
   oneEvent,
-} from '@open-wc/testing';
+} from '@open-wc/testing-helpers';
 import sinon from 'sinon';
-import { IABookSearchResults } from '../../../src/BookNavigator/search/search-results.js';
+import { IABookSearchResults } from '@/src/BookNavigator/search/search-results.js';
 
 const container = (results = [], query = '') => (
   html`<ia-book-search-results .results=${results} .query=${query}></ia-book-search-results>`
 );
 
-console.log("ia-book-search-results-test")
-
 const searchQuery = 'Bristol';
 
 const results = [{
   text: `In the drawing of caricatures and cartoons\u2014or any other com' mercial art, for that matter\u2014the artist should know something about the processes of reproduction for that particular form of art work. For pen and ink work the engraving is made on a sine printing plate. It is not necessary, however, to know all about these processes of reproduction. The artist should know that all work intended for line rqproducttons should be made on white paper or {{{${searchQuery}}}} Board with black drawing ink. The drawing to be reproduced is photographed on a chemically treated sine plate, which is then treated with acid. This acid eats away the surface of the sine, except the photographed' lines, which are left in relief, somewhat like printing type. Colored inks do not photograph well; neither does black ink on colored paper.`,
   cover: '//placehold.it/30x44',
   title: 'Book title',
+  displayPageNumber: 'Page 24',
   par: [{
     boxes: [{
       r: 2672, b: 792, t: 689, page: 24, l: 2424,
@@ -33,6 +31,7 @@ const results = [{
   }],
 }, {
   text: `Drawings intended for sale should be made on a good grade of {{{${searchQuery}}}} Board, and a margin left all the way around the drawings. They should be mailed flat, and'require first class postage. Enclose postage for the return of the drawings. Only send good drawings of a reason- able quantity. Enclose a neat and terse letter to the one you are sending the drawings to, written with pen and ink or typewriter if possible, on`,
+  displayPageNumber: 'Page 86',
   par: [{
     boxes: [{
       r: 698, b: 4460, t: 4324, page: 86, l: 450,
@@ -47,69 +46,101 @@ const results = [{
   }],
 }];
 
+const resultWithScript = [{
+  text: `foo bar <script>const msg = 'test' + ' failure'; document.write(msg);</script> {{{${searchQuery}}}} baz`,
+  cover: '//placehold.it/30x44',
+  title: 'Book title',
+  displayPageNumber: 'Page 24',
+  par: [{
+    boxes: [{
+      r: 2672, b: 792, t: 689, page: 24, l: 2424,
+    }],
+    b: 1371,
+    t: 689,
+    page_width: 3658,
+    r: 3192,
+    l: 428,
+    page_height: 5357,
+    page: 24,
+  }],
+}];
+
 describe('<ia-book-search-results>', () => {
   afterEach(() => {
     sinon.restore();
   });
 
-  it('sets default properties', async () => {
+  test('sets default properties', async () => {
     const query = 'bristol';
     const el = await fixture(container(results, query));
 
-    expect(el.results).to.equal(results);
-    expect(el.query).to.equal(query);
+    expect(el.results).toEqual(results);
+    expect(el.query).toEqual(query);
   });
 
-  it('sets results when passed in via event object', async () => {
+  test('sets results when passed in via event object', async () => {
     const el = await fixture(container());
 
     el.setResults({ detail: { results } });
-    expect(el.results).to.equal(results);
+    expect(el.results).toEqual(results);
   });
 
-  it('listens for a custom search callback event on the document', async () => {
+  test('listens for a custom search callback event on the document', async () => {
     IABookSearchResults.prototype.setResults = sinon.fake();
     const el = await fixture(container());
     const event = new Event('BookReader:SearchCallback');
 
     event.detail = { results };
     document.dispatchEvent(event);
-    expect(el.setResults.callCount).to.equal(1);
-    expect(el.setResults.firstArg).to.equal(event);
+    expect(el.setResults.callCount).toEqual(1);
+    expect(el.setResults.firstArg).toEqual(event);
   });
 
-  it('renders results that contain the book title', async () => {
+  test('renders results that contain the book title', async () => {
     sinon.replace(IABookSearchResults.prototype, 'createRenderRoot', function createRenderRoot() { return this; });
     const el = await fixture(container(results));
 
-    expect(el.innerHTML).to.include(`${results[0].title}`);
+    expect(el.innerHTML).toContain(`${results[0].title}`);
   });
 
-  it('renders results that contain a highlighted match', async () => {
+  test('renders results that contain a highlighted match', async () => {
     sinon.replace(IABookSearchResults.prototype, 'createRenderRoot', function createRenderRoot() { return this; });
     const el = await fixture(container(results));
 
-    expect(el.innerHTML).to.include(`<mark>${searchQuery}</mark>`);
+    // Lit inserts HTML comments that inhibit searching for exact innerHTML matches.
+    // So query the DOM for the match instead.
+    const match = el.querySelector('mark');
+    expect(match?.textContent).toEqual(searchQuery);
   });
 
-  it('renders results that contain an optional cover image', async () => {
+  test('renders results that contain sanitized HTML tags', async () => {
+    sinon.replace(IABookSearchResults.prototype, 'createRenderRoot', function createRenderRoot() { return this; });
+    // A result whose text contains a <script> tag that will insert 'test failure' into the element if not sanitized
+    const el = await fixture(container(resultWithScript));
+
+    const match = el.querySelector('mark');
+    expect(match?.textContent).toEqual(searchQuery);
+    expect(el.innerHTML).not.toContain('test failure');
+  });
+
+  test('renders results that contain an optional cover image', async () => {
     sinon.replace(IABookSearchResults.prototype, 'createRenderRoot', function createRenderRoot() { return this; });
     const el = await fixture(container(results));
 
-    expect(el.innerHTML).to.include(`<img src="${results[0].cover}">`);
+    expect(el.innerHTML).toContain(`<img src="${results[0].cover}">`);
   });
 
-  it('sets a query prop when search input receives input', async () => {
+  test('sets a query prop when search input receives input', async () => {
     const el = await fixture(container(results));
     const searchInput = el.shadowRoot.querySelector('[name="query"]');
 
     searchInput.value = searchQuery;
     searchInput.dispatchEvent(new Event('keyup'));
 
-    expect(el.query).to.equal(searchQuery);
+    expect(el.query).toEqual(searchQuery);
   });
 
-  it('emits a custom event when search form submitted when input is populated', async () => {
+  test('emits a custom event when search form submitted when input is populated', async () => {
     const el = await fixture(container(results));
 
     setTimeout(() => {
@@ -119,122 +150,135 @@ describe('<ia-book-search-results>', () => {
     });
     const response = await oneEvent(el, 'bookSearchInitiated');
 
-    expect(response).to.exist;
+    expect(response).toBeDefined();
   });
 
-  it('uses a singular noun when one result given', async () => {
+  test('uses a singular noun when one result given', async () => {
     const el = await fixture(container([results[0]]));
     const resultsCount = await fixture(el.resultsCount);
 
-    expect(resultsCount.innerHTML).to.include('1 result');
+    expect(resultsCount.innerHTML).toContain('1 result');
   });
 
-  it('can render header with active options count', async () => {
+  test('can render header with active options count', async () => {
     const el = await fixture(container(results));
     el.renderHeader = true;
 
     await el.updateComplete;
 
-    expect(el.shadowRoot.querySelector('header p').innerText).to.include('2');
+    expect(el.shadowRoot.querySelector('header p').textContent).toContain('2');
   });
 
-  it('renders search all files checkbox when enabled', async () => {
+  test('renders search all files checkbox when enabled', async () => {
     const el = await fixture(container(results));
     el.renderSearchAllFiles = true;
 
     await el.updateComplete;
 
-    expect(el.shadowRoot.querySelector('[name="all_files"]')).to.not.be.null;
+    expect(el.shadowRoot.querySelector('[name="all_files"]')).not.toBeNull();
   });
 
-  it('emits a resultSelected event when a search result is clicked', async () => {
+  test('emits a resultSelected event when a search result is clicked', async () => {
     const el = await fixture(container(results));
 
     setTimeout(() => (
-      el.shadowRoot.querySelector('book-search-result').querySelector('li').click()
+      el.shadowRoot.querySelector('li').click()
     ));
     const response = await oneEvent(el, 'resultSelected');
 
-    expect(response).to.exist;
+    expect(response).toBeDefined();
   });
 
-  it('emits a closeMenu event when a search result is clicked', async () => {
+  test('emits a closeMenu event when a search result is clicked', async () => {
     const el = await fixture(container(results));
 
     setTimeout(() => (
-      el.shadowRoot.querySelector('book-search-result').querySelector('li').click()
+      el.shadowRoot.querySelector('li').click()
     ));
     const response = await oneEvent(el, 'closeMenu');
 
-    expect(response).to.exist;
+    expect(response).toBeDefined();
   });
 
   describe('Search results placeholders', () => {
-    it('renders a loading state when queryInProgress is true', async () => {
+    test('renders a loading state when queryInProgress is true', async () => {
       const el = await fixture(container(results));
 
       el.queryInProgress = true;
       await el.updateComplete;
 
-      expect(el.shadowRoot.querySelector('.loading')).to.not.be.null;
+      expect(el.shadowRoot.querySelector('.loading')).not.toBeNull();
     });
-    it('renders an error message when provided', async () => {
+    test('renders an error message when provided', async () => {
       const el = await fixture(container([]));
       const message = 'Sample error message';
       el.errorMessage = message;
       await el.updateComplete;
 
-      expect(el.shadowRoot.querySelector('.error-message')).to.exist;
-      expect(el.shadowRoot.querySelector('.search-cta')).to.be.null;
+      expect(el.shadowRoot.querySelector('.error-message')).toBeDefined();
+      expect(el.shadowRoot.querySelector('.search-cta')).toBeNull();
     });
-    it('displays call to search when no results or search errors are showing', async () => {
+    test('displays call to search when no results or search errors are showing', async () => {
       const el = await fixture(container([]));
 
-      expect(el.shadowRoot.querySelector('.search-cta')).to.exist;
-      expect(el.shadowRoot.querySelector('.error-message')).to.be.null;
-      expect(el.shadowRoot.querySelector('.results')).to.be.null;
+      expect(el.shadowRoot.querySelector('.search-cta')).toBeDefined();
+      expect(el.shadowRoot.querySelector('.error-message')).toBeNull();
+      expect(el.shadowRoot.querySelector('.results')).toBeNull();
     });
   });
 
-  it('displays results images when told to', async () => {
+  test('displays results images when told to', async () => {
     const el = await fixture(container(results));
     el.displayResultImages = true;
     await el.updateComplete;
 
-    expect(el.shadowRoot.querySelector('.results.show-image')).to.exist;
+    expect(el.shadowRoot.querySelector('.results.show-image')).toBeDefined();
   });
 
   describe('search input focus', () => {
-    it('will always try to re-focus once the component updates', async () => {
+    test('will always try to re-focus once the component updates', async () => {
       const el = await fixture(container(results));
       el.focusOnInputIfNecessary = sinon.fake();
       // update any property to fire lifecycle
       el.results = [];
       await el.updateComplete;
 
-      expect(el.focusOnInputIfNecessary.callCount).to.equal(1);
+      expect(el.focusOnInputIfNecessary.callCount).toEqual(1);
     });
-    it('refocuses on input when results are empty', async () => {
+    test('refocuses on input when results are empty', async () => {
       const el = await fixture(container(results));
       el.results = [];
       await el.updateComplete;
 
       const searchInputField = el.shadowRoot.querySelector('input[type=\'search\']');
-      expect(searchInputField).to.equal(el.shadowRoot.activeElement);
+      expect(searchInputField).toEqual(el.shadowRoot.activeElement);
     });
   });
 
-  // it("emits a bookSearchCanceled event when loading state's cancel action clicked", async () => {
-  //   const el = await fixture(container(results));
+  test("emits a bookSearchCanceled event when loading state's cancel action clicked", async () => {
+    const el = await fixture(container(results));
 
-  //   el.queryInProgress = true;
-  //   await el.updateComplete;
+    el.queryInProgress = true;
+    await el.updateComplete;
 
-  //   setTimeout(() => (
-  //     el.shadowRoot.querySelector('button').click()
-  //   ));
-  //   const response = await oneEvent(el, 'bookSearchCanceled');
+    setTimeout(() => (
+      el.shadowRoot.querySelector('button').click()
+    ));
+    const response = await oneEvent(el, 'bookSearchCanceled');
 
-  //   expect(response).to.exist;
-  // });
+    expect(response).toBeDefined();
+  });
+  it('cancels search when input is cleared', async () => {
+    const el = await fixture(container(results));
+
+    el.cancelSearch = sinon.fake();
+    await el.updateComplete;
+
+    const searchInput = el.shadowRoot.querySelector('[name="query"]');
+
+    searchInput.value = '';
+    searchInput.dispatchEvent(new Event('search'));
+
+    expect(el.cancelSearch.callCount).toEqual(1);
+  });
 });

package/tests/jest/BookNavigator/sharing/sharing-provider.test.js

@@ -0,0 +1,49 @@
+import { fixtureSync } from '@open-wc/testing-helpers';
+import sinon from 'sinon';
+import SharingProvider from '@/src/BookNavigator/sharing.js';
+
+afterEach(() => {
+  sinon.restore();
+});
+
+const item = {
+  metadata: {
+    identifier: 'stubby-id',
+    creator: 'mr. big',
+    title: 'Stubby title',
+  }
+};
+
+const baseHost = 'foo.org';
+const subPrefix = 'beep-boop_12 4 5';
+
+describe('Sharing Provider', () => {
+  describe('constructor', () => {
+    const provider = new SharingProvider({
+      item,
+      baseHost,
+      bookreader: {
+        options: { subPrefix }
+      }
+    });
+
+    expect(provider.id).toEqual('share');
+    expect(provider.icon).toBeDefined();
+    expect(provider.label).toEqual('Share this book');
+    expect(fixtureSync(provider.component).tagName).toContain('IA-SHARING-OPTIONS');
+  });
+
+  describe('Handles being a sub file/volume', () => {
+    test('encodes the subprefix if it has one', async () => {
+      const provider = new SharingProvider({
+        item,
+        baseHost,
+        bookreader: {
+          options: { subPrefix }
+        }
+      });
+
+      expect(fixtureSync(provider.component).fileSubPrefix).toEqual(subPrefix);
+    });
+  });
+});