@internetarchive/ia-book-actions 0.0.7-2 → 0.0.7-5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "0.0.7-02",
+  "version": "0.0.7-5",
   "description": "Bookreader actions for borrowable book",
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",
@@ -22,6 +22,7 @@
     "@internetarchive/icon-bookmark": "^1.1.3",
     "@internetarchive/icon-close": "^1.1.3",
     "@internetarchive/icon-info": "^1.2.6",
+    "@internetarchive/local-cache": "^0.1.1",
     "@internetarchive/modal-manager": "^0.1.0",
     "@internetarchive/shared-resize-observer": "^0.0.1",
     "lit-element": "^2.4.0",

package/src/components/collapsible-action-group.js

@@ -63,25 +63,38 @@ export class CollapsibleActionGroup extends ActionsHandler {
     }
   }
 
-  /* emit custom event to fetch loan token */
-  emitEnableBookAccess() {
+  /**
+   * Dispatches event when patron is borrowing book.
+   * Notes borrow type, and consecutive borrow counts
+   *
+   * @fires CollapsibleActionGroup#enableBookAccess
+   */
+  async emitEnableBookAccess() {
     // send consecutiveLoanCounts for browsed books only.
-    if (this.borrowType === 'browsing') {
-      this.consecutiveLoanCounts =
-        localStorage.getItem('consecutive-loan-count') ?? 1;
+    if (this.borrowType === 'browsed') {
+      try {
+        const existingCount = await this.localCache.get(
+          'consecutive-loan-count'
+        );
+        if (existingCount !== undefined) {
+          this.consecutiveLoanCounts = existingCount.value ?? 1;
+        }
+      } catch (error) {
+        console.log(error);
+      }
     }
 
     // event category and action for browsing book access
     const eventCategory = `${this.borrowType}BookAccess`;
     const eventAction = `${
-      this.borrowType === 'browsing' ? 'BrowseCounts-' : 'Counts-'
+      this.borrowType === 'browsed' ? 'BrowseCounts-' : 'Counts-'
     }${this.consecutiveLoanCounts}`;
 
     this.dispatchEvent(
       new CustomEvent('enableBookAccess', {
         detail: {
           event: {
-            category: eventCategory, // brosingBookAccess | borrowingBookAccess
+            category: eventCategory, // browsedBookAccess | borrowedBookAccess
             action: eventAction, // (BrowseCounts-N|Counts-N)
           },
           borrowType: this.borrowType,
@@ -222,11 +235,13 @@ export class CollapsibleActionGroup extends ActionsHandler {
   }
 
   /**
-   * Click handler to emit custom event on action click
-   * @param { string } eventName
-   * @param { object } gaEvent
+   * Dispatches click events when patron clicks on action buttons
+   * @param { string } eventName - actions like 'browseBook', 'borrowBook' etc...
+   * @param { object } gaEvent - contains analytics event action and category
    *   @param { string } gaEvent.category
    *   @param { string } gaEvent.action
+   *
+   * @fires CollapsibleActionGroup#{eventName} - (will be browseBook, borrowBook etc...)
    */
   clickHandler(eventName, gaEvent) {
     this.dropdownState = 'close';

package/src/core/services/actions-handler/actions-handler-service.js

@@ -16,6 +16,11 @@ export default function ActionsHandlerService(options) {
   let baseHost = '/services/loans/loan';
   const location = window?.location;
 
+  // return intentional error on dev environment
+  const shouldReturnError =
+    location?.href?.indexOf('?error=true') !== -1 &&
+    location?.hostname !== 'archive.org';
+
   if (location?.pathname === '/demo/') baseHost = `/demo/`;
 
   let formData = new FormData();
@@ -27,12 +32,11 @@ export default function ActionsHandlerService(options) {
     body: formData,
   })
     .then(response => {
-      let shouldReturnError = location?.href?.indexOf('?error=true') !== -1;
       const tokenError = 'loan token not found. please try again later.';
       const borrowError =
         'This book is not available to borrow at this time. Please try again later.';
 
-      // return error reponse if query param has ?error=true param...
+      // return error reponse when not production and has ?error=true param...
       const erroneousActions = ['browse_book', 'borrow_book', 'create_token'];
       if (shouldReturnError && erroneousActions.includes(option?.action)) {
         return {

package/src/core/services/actions-handler/actions-handler.js

@@ -1,4 +1,6 @@
 import { LitElement } from 'lit-element';
+import { LocalCache } from '@internetarchive/local-cache';
+
 import { URLHelper } from '../../config/url-helper.js';
 import ActionsHandlerService from './actions-handler-service.js';
 
@@ -14,10 +16,11 @@ export default class ActionsHandler extends LitElement {
   constructor(identifier) {
     super();
     this.identifier = identifier;
-    this.ajaxTimeout = 6000;
+    this.ajaxTimeout = 7000;
     this.loanTokenPollingDelay =
       window.location.pathname === '/demo/' ? 2000 : 120000; // 120000 ms = 2 min
     this.loanTokenInterval = undefined;
+    this.localCache = new LocalCache();
     this.bindEvents();
   }
 
@@ -119,106 +122,121 @@ export default class ActionsHandler extends LitElement {
   }
 
   handleBrowseIt() {
-    const context = 'browse_book';
+    const action = 'browse_book';
     this.dispatchToggleActionGroup();
 
     ActionsHandlerService({
-      action: context,
+      action,
       identifier: this.identifier,
       success: () => {
         this.handleReadItNow();
       },
       error: data => {
-        this.dispatchActionError(context, data);
+        this.dispatchActionError(action, data);
       },
     });
   }
 
   handleReturnIt() {
-    const context = 'return_loan';
+    const action = 'return_loan';
     this.dispatchToggleActionGroup();
 
     ActionsHandlerService({
-      action: context,
+      action,
       identifier: this.identifier,
       success: () => {
         this.deleteLoanCookies();
         URLHelper.goToUrl(`/details/${this.identifier}`, true);
       },
       error: data => {
-        this.dispatchActionError(context, data);
+        this.dispatchActionError(action, data);
       },
     });
   }
 
   handleBorrowIt() {
-    const context = 'borrow_book';
+    const action = 'borrow_book';
     this.dispatchToggleActionGroup();
 
     ActionsHandlerService({
-      action: context,
+      action,
       identifier: this.identifier,
       success: () => {
         this.handleReadItNow();
       },
       error: data => {
-        this.dispatchActionError(context, data);
+        this.dispatchActionError(action, data);
       },
     });
   }
 
   handleReserveIt() {
-    const context = 'join_waitlist';
+    const action = 'join_waitlist';
     this.dispatchToggleActionGroup();
 
     ActionsHandlerService({
-      action: context,
+      action,
       identifier: this.identifier,
       success: () => {
         URLHelper.goToUrl(URLHelper.getRedirectUrl(), true);
       },
       error: data => {
-        this.dispatchActionError(context, data);
+        this.dispatchActionError(action, data);
       },
     });
   }
 
   handleRemoveFromWaitingList() {
-    const context = 'leave_waitlist';
+    const action = 'leave_waitlist';
     this.dispatchToggleActionGroup();
 
     ActionsHandlerService({
-      action: context,
+      action,
       identifier: this.identifier,
       success: () => {
         URLHelper.goToUrl(URLHelper.getRedirectUrl(), true);
       },
       error: data => {
-        this.dispatchActionError(context, data);
+        this.dispatchActionError(action, data);
       },
     });
   }
 
   handleLoanTokenPoller() {
-    const context = 'create_token';
+    const action = 'create_token';
     ActionsHandlerService({
       identifier: this.identifier,
-      action: context,
+      action,
       error: data => {
-        this.dispatchActionError(context, data);
+        this.dispatchActionError(action, data);
         clearInterval(this.loanTokenInterval); // stop token fetch api
       },
     });
   }
 
-  dispatchActionError(context, data = {}) {
+  /**
+   * Dispatches event when an error occured on action
+   * Notes:- toggle <collapsible-action-group> visibility (enable/disable).
+   *
+   * @param { String } action - name of action like browse_book, borrow_book
+   * @param { Object } data - erroneous response from api call
+   *
+   * @fires ActionsHandler#lendingActionError
+   */
+  dispatchActionError(action, data = {}) {
     this.dispatchEvent(
       new CustomEvent('lendingActionError', {
-        detail: { context, data },
+        detail: { action, data },
       })
     );
   }
 
+  /**
+   * Dispatches event when patron is clicked on action buttons.
+   * Notes:- toggle <collapsible-action-group> disable/enable.
+   *
+   * @fires ActionsHandler#toggleActionGroup
+   */
   dispatchToggleActionGroup() {
     this.dispatchEvent(new CustomEvent('toggleActionGroup'));
   }
@@ -256,19 +274,25 @@ export default class ActionsHandler extends LitElement {
   }
 
   // save consecutive loan count for borrow
-  setConsecutiveLoanCounts(action = '') {
-    const { localStorage } = window;
-    if (localStorage) {
+  async setConsecutiveLoanCounts(action = '') {
+    try {
       let newCount = 1;
       const storageKey = `consecutive-loan-count`;
-      const existingCount = Number(localStorage.getItem(storageKey));
+      const existingCount = await this.localCache.get(storageKey);
 
-      // want to increase browse-count by 1 if,
-      // you consecutive reading a book.
-      if (action === 'browseAgain') {
+      // increase browse-count by 1 when you consecutive reading a book.
+      if (action === 'browseAgain' && existingCount !== undefined) {
         newCount = existingCount ? existingCount + 1 : 1;
       }
-      localStorage.setItem(storageKey, newCount);
+
+      // set new value
+      await this.localCache.set({
+        key: storageKey,
+        value: newCount,
+        ttl: 7200, // 2 hours
+      });
+    } catch (error) {
+      console.log(error);
     }
   }
 

package/src/core/services/get-lending-actions.js

@@ -96,7 +96,7 @@ export default class GetLendingActions {
         this.actionsConfig.adminAccessConfig(),
         this.actionsConfig.purchaseConfig(),
       ],
-      borrowType: isBrowsing ? 'browsing' : 'borrowing',
+      borrowType: isBrowsing ? 'browsed' : 'borrowed',
     };
   }
 

package/src/ia-book-actions.js

@@ -24,6 +24,7 @@ export default class IABookActions extends LitElement {
       barType: { type: String },
       sharedObserver: { attribute: false },
       disableActionGroup: { type: Boolean },
+      modal: { Object },
     };
   }
 
@@ -37,12 +38,15 @@ export default class IABookActions extends LitElement {
     this.bwbPurchaseUrl = '';
     this.barType = 'action'; // 'title'|'action'
     this.sharedObserver = undefined;
+    this.disableActionGroup = false;
+    this.modal = undefined;
+
+    // private props
     this.primaryActions = [];
     this.primaryTitle = '';
     this.primaryColor = 'primary';
     this.secondaryActions = [];
     this.lendingOptions = {};
-    this.disableActionGroup = false;
   }
 
   disconnectedCallback() {
@@ -144,8 +148,8 @@ export default class IABookActions extends LitElement {
     });
 
     this.borrowType = actions.borrowType;
-    if (this.borrowType === 'browsing') {
-      // start timer for browsing.
+    if (this.borrowType === 'browsed') {
+      // start timer for browsed.
       // when browse is completed, we shows browse-again button
       this.startBrowseTimer();
     }
@@ -201,28 +205,27 @@ export default class IABookActions extends LitElement {
    *
    * @event IABookActions#lendingActionError
    * @param {Object} event - The employee who is responsible for the project
-   * @param {string} event.detail.context - action when error occurred like 'browseBook', 'borrowBook'
-   * @param {string} event.detail.data.error - error message
+   *  @param {string} event.detail.action - action when error occurred like 'browseBook', 'borrowBook'
+   *  @param {string} event.detail.data.error - error message
    */
   handleLendingActionError(event) {
-    console.log(event?.detail?.data);
     // toggle activity loader
     this.handleToggleActionGroup();
 
-    const context = event?.detail?.context;
+    const action = event?.detail?.action;
     const errorMsg = event?.detail?.data?.error;
 
-    if (errorMsg) this.showErrorModal(errorMsg);
+    if (errorMsg) this.showErrorModal(errorMsg, action);
 
     // update action bar state if book is not available to browse or borrow.
     if (errorMsg && errorMsg.match(/not available to borrow/gm)) {
       let currStatus = this.lendingStatus;
-      if (context === 'browse_book') {
+      if (action === 'browse_book') {
         currStatus = {
           ...this.lendingStatus,
           available_to_browse: false,
         };
-      } else if (context === 'borrow_book') {
+      } else if (action === 'borrow_book') {
         currStatus = {
           ...this.lendingStatus,
           available_to_borrow: false,
@@ -233,22 +236,42 @@ export default class IABookActions extends LitElement {
   }
 
   /* show error message if something went wrong */
-  async showErrorModal(errorMsg) {
+  async showErrorModal(errorMsg, action) {
     this.disableActionGroup = false;
 
-    this.modal = document.querySelector('#action-bar-modal');
+    // check if this.modal passed as prop
     if (!this.modal) {
-      this.modal = document.createElement('modal-manager');
-      this.modal.id = 'action-bar-modal';
+      this.modal = document.querySelector('modal-manager');
+
+      // check the DOM if <modal-manager> already there
+      if (!this.modal) this.modal = document.createElement('modal-manager');
     }
+
+    this.modal.id = 'action-bar-modal';
     await document.body.appendChild(this.modal);
 
+    const modalConfig = new ModalConfig({
+      title: 'Lending error',
+      message: errorMsg,
+      headerColor: '#d9534f',
+    });
+
+    if (action === 'create_token') {
+      modalConfig.closeOnBackdropClick = false;
+      modalConfig.showCloseButton = false;
+      modalConfig.message = html` Uh oh, something went wrong trying to access
+        this book.<br />
+        Please <a href="${() => window.location.reload(true)}">refresh</a> to
+        try again or send us an email to
+        <a
+          href="mailto:info@archive.org?subject=Help: cannot access my borrowed book: ${this
+            .identifier}"
+          >info@archive.org</a
+        >`;
+    }
+
     this.modal.showModal({
-      config: new ModalConfig({
-        title: 'Lending error',
-        message: errorMsg,
-        headerColor: '#d9534f',
-      }),
+      config: modalConfig,
     });
   }
 

package/test/components/collapsible-action-group.test.js

@@ -1,6 +1,5 @@
 import { html, fixture, expect } from '@open-wc/testing';
 import '../../src/components/collapsible-action-group.js';
-import Sinon from 'sinon';
 
 const container = ({
   primaryActions = [
@@ -85,27 +84,3 @@ describe('<collapsible-action-group>', () => {
     expect(eAnalytics.action).to.equal('Browse');
   });
 });
-
-describe('fetch loan token and localStorage for browsed/borrowsed book', () => {
-  afterEach(() => {
-    const localStorageMock = {
-      getItem: Sinon.spy(),
-      setItem: Sinon.spy(),
-    };
-    Object.defineProperty(window, 'localStorage', {
-      value: localStorageMock,
-    });
-  });
-
-  it('test localStorage function when borrowType is browsed', async () => {
-    await fixture(container({ borrowType: 'browsed' }));
-    expect(localStorage.getItem).to.be.calledOnce;
-    expect(localStorage.getItem).to.be.calledWith('consecutive-loan-count');
-  });
-
-  it('test localStorage function when borrowType is borrowed', async () => {
-    await fixture(container({ borrowType: 'borrowed' }));
-    expect(localStorage.getItem).to.not.be.calledOnce;
-    expect(localStorage.getItem).to.not.be.calledWith('consecutive-loan-count');
-  });
-});

package/test/ia-book-actions.test.js

@@ -122,7 +122,7 @@ describe('Borrow status actions', () => {
     el.addEventListener('lendingActionError', () => {
       el.handleLendingActionError({
         detail: {
-          context: 'browse_book',
+          action: 'browse_book',
           data: { error: 'not available to borrow' },
         },
       });
@@ -151,7 +151,7 @@ describe('Borrow status actions', () => {
     el.addEventListener('lendingActionError', () => {
       el.handleLendingActionError({
         detail: {
-          context: 'borrow_book',
+          action: 'borrow_book',
           data: { error: 'not available to borrow' },
         },
       });