@internetarchive/bookreader 5.0.0-46-no-right-click → 5.0.0-46-no-right-click-2

package/BookReaderDemo/demo-internetarchive.html

@@ -130,6 +130,8 @@
     // analytics stub
     window.archive_analytics = {
       send_event_no_sampling: (category, action, label) => console.log('~~~ NO SAMPLE EVENT CALLED: ', { category, action, label }),
+      send_event: (category, action, label) => console.log('~~~ send_event SAMPLE EVENT CALLED: ', { category, action, label }),
+      send_ping: (category, action, label) => console.log('~~~ send_ping SAMPLE EVENT CALLED: ', { category, action, label }),
     }
   </script>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/bookreader",
-  "version": "5.0.0-46-no-right-click",
+  "version": "5.0.0-46-no-right-click-2",
   "description": "The Internet Archive BookReader.",
   "repository": {
     "type": "git",

package/tests/jest/BookNavigator/book-navigator.test.js

@@ -13,9 +13,8 @@ import VolumesProvider from '@/src/BookNavigator/volumes/volumes-provider.js';
 import { ModalManager } from '@internetarchive/modal-manager';
 import { SharedResizeObserver } from '@internetarchive/shared-resize-observer';
 import '@/src/BookNavigator/book-navigator.js';
-import { sleep } from '@/src/BookReader/utils';
 
-const promise0 = () => new Promise((res) => setTimeout(res, 0));
+const promise0 = () => new Promise(res => setTimeout(res, 0));
 
 const container = (sharedObserver = null) => {
   const itemStub = {
@@ -23,7 +22,7 @@ const container = (sharedObserver = null) => {
       identifier: 'foo',
       creator: 'bar',
       title: 'baz',
-    },
+    }
   };
   const modalMgr = new ModalManager();
   return html`
@@ -33,18 +32,18 @@ const container = (sharedObserver = null) => {
       .sharedObserver=${sharedObserver || new SharedResizeObserver()}
       .modal=${modalMgr}
     >
-      <div slot='main'>
-        <div id='BookReader'></div>
-        <p class='visible-in-reader'>now showing</p>
+      <div slot="main">
+        <div id="BookReader"></div>
+        <p class="visible-in-reader">now showing</p>
       <\div>
     </book-navigator>
   `;
 };
 
 window.ResizeObserver = class ResizeObserver {
-  observe = sinon.fake();
-  unobserve = sinon.fake();
-  disconnect = sinon.fake();
+  observe = sinon.fake()
+  unobserve = sinon.fake()
+  disconnect = sinon.fake()
 };
 
 afterEach(() => {
@@ -53,11 +52,11 @@ afterEach(() => {
   const body = document.querySelector('body');
   body.innerHTML = '';
   sinon.restore();
-  window.archive_analytics = null;
 });
 
+
 describe('<book-navigator>', () => {
-  describe('How it loads', () => {
+  describe("How it loads", () => {
     describe('Attaches BookReader listeners before `br.init` is called', () => {
       test('binds global event listeners', async () => {
         const el = fixtureSync(container());
@@ -72,7 +71,7 @@ describe('<book-navigator>', () => {
           jumpToIndex: sinon.fake(),
           options: { enableMultipleBooks: false }, // for multipleBooks
           el: '#BookReader',
-          refs: {},
+          refs: {}
         };
 
         const sharedObserver = new SharedResizeObserver();
@@ -86,11 +85,9 @@ describe('<book-navigator>', () => {
 
         expect(brStub.resize.callCount).toEqual(0);
 
-        window.dispatchEvent(
-          new CustomEvent('BookReader:PostInit', {
-            detail: { props: brStub },
-          })
-        );
+        window.dispatchEvent(new CustomEvent('BookReader:PostInit', {
+          detail: { props: brStub }
+        }));
         await elementUpdated(el);
 
         expect(el.emitLoadingStatusUpdate.callCount).toEqual(1);
@@ -123,15 +120,13 @@ describe('<book-navigator>', () => {
       const itemImage = fixtureSync(el.itemImage);
       expect(itemImage).toBeInstanceOf(HTMLImageElement);
       expect(itemImage.getAttribute('class')).toEqual('cover-img');
-      expect(itemImage.getAttribute('src')).toEqual(
-        'https://https://foo.archive.org/services/img/foo'
-      );
+      expect(itemImage.getAttribute('src')).toEqual('https://https://foo.archive.org/services/img/foo');
     });
   });
   describe('Menu/Layer Provider', () => {
     describe('Connecting with a provider:', () => {
       // loads Providers with base shared resources
-      test('We load 3 Sub Menus by default', async () => {
+      test('We load 3 Sub Menus by default', async() => {
         const el = fixtureSync(container());
         const $brContainer = document.createElement('div');
         const brStub = {
@@ -140,8 +135,8 @@ describe('<book-navigator>', () => {
           jumpToIndex: sinon.fake(),
           options: {},
           refs: {
-            $brContainer,
-          },
+            $brContainer
+          }
         };
         el.bookreader = brStub;
         await el.elementUpdated;
@@ -156,12 +151,10 @@ describe('<book-navigator>', () => {
         expect(el.menuProviders.share).toBeInstanceOf(SharingProvider);
 
         expect(defaultMenus).toContain('visualAdjustments');
-        expect(el.menuProviders.visualAdjustments).toBeInstanceOf(
-          VisualAdjustmentsProvider
-        );
+        expect(el.menuProviders.visualAdjustments).toBeInstanceOf(VisualAdjustmentsProvider);
       });
       describe('Loading Sub Menus By Plugin Flags', () => {
-        test('Search: uses `enableSearch` flag', async () => {
+        test('Search: uses `enableSearch` flag', async() => {
           const el = fixtureSync(container());
           const $brContainer = document.createElement('div');
           const brStub = {
@@ -170,8 +163,8 @@ describe('<book-navigator>', () => {
             jumpToIndex: sinon.fake(),
             options: { enableSearch: true },
             refs: {
-              $brContainer,
-            },
+              $brContainer
+            }
           };
           el.bookreader = brStub;
           await el.elementUpdated;
@@ -183,9 +176,9 @@ describe('<book-navigator>', () => {
           expect(el.menuProviders.search).toBeInstanceOf(SearchProvider);
 
           // also adds a menu shortcut
-          expect(el.menuShortcuts.find((m) => m.id === 'search')).toBeDefined();
+          expect(el.menuShortcuts.find(m => m.id === 'search')).toBeDefined();
         });
-        test('Volumes/Multiple Books: uses `enableMultipleBooks` flag', async () => {
+        test('Volumes/Multiple Books: uses `enableMultipleBooks` flag', async() => {
           const el = fixtureSync(container());
           const $brContainer = document.createElement('div');
           const brStub = {
@@ -196,13 +189,13 @@ describe('<book-navigator>', () => {
               enableMultipleBooks: true,
               multipleBooksList: {
                 by_subprefix: {
-                  fooSubprefix: 'beep',
-                },
-              },
+                  fooSubprefix: 'beep'
+                }
+              }
             },
             refs: {
-              $brContainer,
-            },
+              $brContainer
+            }
           };
           el.bookreader = brStub;
           await el.elementUpdated;
@@ -214,9 +207,7 @@ describe('<book-navigator>', () => {
           expect(el.menuProviders.volumes).toBeInstanceOf(VolumesProvider);
 
           // also adds a menu shortcut
-          expect(
-            el.menuShortcuts.find((m) => m.id === 'volumes')
-          ).toBeDefined();
+          expect(el.menuShortcuts.find(m => m.id === 'volumes')).toBeDefined();
         });
       });
       test('keeps track of base shared resources for providers in: `baseProviderConfig`', () => {
@@ -324,9 +315,7 @@ describe('<book-navigator>', () => {
               console.log();
               sidePanelConfig = e.detail;
             });
-            const toggleSearchMenuEvent = new Event(
-              'BookReader:ToggleSearchMenu'
-            );
+            const toggleSearchMenuEvent = new Event('BookReader:ToggleSearchMenu');
             window.dispatchEvent(toggleSearchMenuEvent);
 
             await elementUpdated(el);
@@ -338,15 +327,15 @@ describe('<book-navigator>', () => {
     });
   });
 
-  describe('Resizing', () => {
+  describe('Resizing',() => {
     test('keeps track of `brWidth` and `brHeight`', async () => {
       const el = fixtureSync(container());
       const brStub = {
         resize: sinon.fake(),
         options: {},
         refs: {
-          $brContainer: document.createElement('div'),
-        },
+          $brContainer: document.createElement('div')
+        }
       };
       el.bookreader = brStub;
       await elementUpdated(el);
@@ -356,9 +345,9 @@ describe('<book-navigator>', () => {
       const mockResizeEvent = {
         contentRect: {
           height: 500,
-          width: 900,
+          width: 900
         },
-        target: el.mainBRContainer,
+        target: el.mainBRContainer
       };
       el.handleResize(mockResizeEvent);
 
@@ -375,8 +364,8 @@ describe('<book-navigator>', () => {
         resize: sinon.fake(),
         options: {},
         refs: {
-          $brContainer: document.createElement('div'),
-        },
+          $brContainer: document.createElement('div')
+        }
       };
 
       el.bookreader = brStub;
@@ -481,7 +470,7 @@ describe('<book-navigator>', () => {
 
       expect(el.closeFullscreen.callCount).toEqual(1);
     });
-    test('removes Fullscreen shortcut when leaving fullscreen', async () => {
+    test('removes Fullscreen shortcut when leaving fullscreen', async() => {
       const el = fixtureSync(container());
       const brStub = {
         isFullscreen: () => false,
@@ -500,7 +489,7 @@ describe('<book-navigator>', () => {
       expect(el.menuShortcuts.length).toEqual(0);
       expect(el.emitMenuShortcutsUpdated.callCount).toEqual(1);
     });
-    test('Event: Listens for `BookReader:FullscreenToggled', async () => {
+    test('Event: Listens for `BookReader:FullscreenToggled', async() => {
       const el = fixtureSync(container());
       const brStub = {
         isFullscreen: () => true,
@@ -602,5 +591,40 @@ describe('<book-navigator>', () => {
         expect(preventDefaultSpy.called).toEqual(true);
       });
     });
+    it('Allows unrestricted books access to context menu', async () => {
+      window.archive_analytics = { send_event_no_sampling: sinon.fake() };
+
+      const el = fixtureSync(container());
+      const brStub = {
+        options: { restricted: false },
+      };
+
+      el.bookreader = brStub;
+      el.bookIsRestricted = false;
+
+      await el.elementUpdated;
+
+      expect(window.archive_analytics.send_event_no_sampling.called).toEqual(
+        false
+      );
+
+      const body = document.querySelector('body');
+      // const element stub for img.BRpageimage
+      const imgBRpageimage = document.createElement('img');
+      imgBRpageimage.classList.add('not-targeted-element');
+      body.appendChild(imgBRpageimage);
+      const contextMenuEvent = new Event('contextmenu', { bubbles: true });
+
+      // Set spy on contextMenuEvent to check if `preventDefault` is called
+      const preventDefaultSpy = sinon.spy(contextMenuEvent, 'preventDefault');
+      expect(preventDefaultSpy.called).toEqual(false);
+
+      imgBRpageimage.dispatchEvent(contextMenuEvent);
+
+      // analytics fires
+      expect(window.archive_analytics.send_event_no_sampling.called).toEqual(true);
+      // we do not prevent default
+      expect(preventDefaultSpy.called).toEqual(false);
+    });
   });
 });