@internetarchive/ia-book-actions 0.0.7-7 → 0.0.8-1

package/demo/index.html

@@ -104,14 +104,21 @@
     const modalConfig = new ModalConfig();
     modalConfig.headerColor = '#d9534f';
 
+    let lendingBarPostInit = function lendingBarPostInit() {
+      setTimeout(function() {
+        console.log('executed', 'br.init()');
+      }, 100);
+    }
+
     // set defaultLendingStatus for unavailable (without borrowables) book
     iaBookActions.userid = userid;
     iaBookActions.identifier = identifier;
     iaBookActions.bookTitle = 'Contemporary Black biography. Volume 39 : profiles from the interContemporary Black biography. Volume 39';
     iaBookActions.lendingStatus = canBrowseAndBorrow;
     iaBookActions.bwbPurchaseUrl = '';
-    iaBookActions.barType = '';
     iaBookActions.modalConfig = modalConfig;
+    iaBookActions.lendingBarPostInit = lendingBarPostInit;
+    iaBookActions.tokenDelay = 2000; // 2 seconds
 
     let lendingStatus1 = iaBookActions.lendingStatus;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "0.0.7-7",
+  "version": "0.0.8-1",
   "description": "Bookreader actions for borrowable book",
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",
@@ -22,7 +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/local-cache": "^0.2.0",
     "@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

@@ -27,7 +27,6 @@ export class CollapsibleActionGroup extends ActionsHandler {
       hasAdminAccess: { type: Boolean },
       dropdownArrow: { type: String },
       disabled: { type: Boolean },
-      borrowType: { type: String },
     };
   }
 
@@ -46,15 +45,6 @@ export class CollapsibleActionGroup extends ActionsHandler {
     this.title = '';
     this.loaderIcon = 'https://archive.org/upload/images/tree/loading.gif';
     this.disabled = false;
-    this.borrowType = ''; // (browsed|borrowed)
-    this.consecutiveLoanCounts = 1; // consecutive loan count
-  }
-
-  firstUpdated() {
-    // this is execute to fetch loan token
-    if (this.borrowType) {
-      this.emitEnableBookAccess();
-    }
   }
 
   updated(changed) {
@@ -63,46 +53,6 @@ export class CollapsibleActionGroup extends ActionsHandler {
     }
   }
 
-  /**
-   * 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 === '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 === 'browsed' ? 'BrowseCounts-' : 'Counts-'
-    }${this.consecutiveLoanCounts}`;
-
-    this.dispatchEvent(
-      new CustomEvent('enableBookAccess', {
-        detail: {
-          event: {
-            category: eventCategory, // browsedBookAccess | borrowedBookAccess
-            action: eventAction, // (BrowseCounts-N|Counts-N)
-          },
-          borrowType: this.borrowType,
-        },
-      })
-    );
-  }
-
   /**
    * merge primaryActions and secondaryActions into dropdown
    */

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

@@ -16,18 +16,11 @@ export default class ActionsHandler extends LitElement {
   constructor(identifier) {
     super();
     this.identifier = identifier;
-    this.ajaxTimeout = 7000;
-    this.loanTokenPollingDelay =
-      window.location.pathname === '/demo/' ? 2000 : 120000; // 120000 ms = 2 min
-    this.loanTokenInterval = undefined;
+    this.ajaxTimeout = 6000;
     this.localCache = new LocalCache();
     this.bindEvents();
   }
 
-  disconnectedCallback() {
-    this.loanTokenInterval = undefined;
-  }
-
   sendEvent(eventCategory, eventAction) {
     // eslint-disable-next-line no-console
     console?.log('Book action: ', { eventCategory, eventAction });
@@ -102,26 +95,6 @@ export default class ActionsHandler extends LitElement {
       const { category, action } = detail.event;
       this.sendEvent(category, action);
     });
-
-    this.addEventListener('enableBookAccess', ({ detail }) => {
-      const borrowType = detail?.borrowType;
-
-      // fetch loan token for browsed/borrowed book and set an interval
-      if (borrowType) {
-        // Do an initial token, then set an interval
-        this.handleLoanTokenPoller();
-
-        this.loanTokenInterval = setInterval(() => {
-          this.handleLoanTokenPoller();
-        }, this.loanTokenPollingDelay);
-
-        const { category, action } = detail?.event;
-        this.sendEvent(category, action);
-      } else {
-        // if book is not browsed, just clear token polling interval
-        clearInterval(this.loanTokenInterval);
-      }
-    });
   }
 
   handleBrowseIt() {
@@ -205,18 +178,6 @@ export default class ActionsHandler extends LitElement {
     });
   }
 
-  handleLoanTokenPoller() {
-    const action = 'create_token';
-    ActionsHandlerService({
-      identifier: this.identifier,
-      action,
-      error: data => {
-        this.dispatchActionError(action, data);
-        clearInterval(this.loanTokenInterval); // stop token fetch api
-      },
-    });
-  }
-
   /**
    * Dispatches event when an error occured on action
    * Notes:- toggle <collapsible-action-group> visibility (enable/disable).
@@ -280,7 +241,7 @@ export default class ActionsHandler extends LitElement {
   async setConsecutiveLoanCounts(action = '') {
     try {
       let newCount = 1;
-      const storageKey = `consecutive-loan-count`;
+      const storageKey = `loan-count-${this.identifier}`;
       const existingCount = await this.localCache.get(storageKey);
 
       // increase browse-count by 1 when you consecutive reading a book.

package/src/core/services/loan-token-poller.js

@@ -0,0 +1,87 @@
+import { LocalCache } from '@internetarchive/local-cache';
+import ActionsHandlerService from './actions-handler/actions-handler-service.js';
+
+/**
+ * This class is used to create loan token for borrowed books
+ *
+ * ActionsHandlerService is a function being used to execute
+ */
+export class LoanTokenPoller {
+  constructor(id, borrowType, successCallback, errorCallback, pollerDelay) {
+    this.identifier = id;
+    this.borrowType = borrowType;
+    this.successCallback = successCallback; // callback function to be called after loan token is created
+    this.errorCallback = errorCallback; // callback function to be called after loan token is created
+    this.pollerDelay = pollerDelay; // value in ms (1000 ms = 1 sec)
+
+    this.loanTokenInterval = undefined;
+    this.localCache = new LocalCache();
+    this.enableBookAccess();
+  }
+
+  disconnectedInterval() {
+    clearInterval(this.loanTokenInterval);
+    this.loanTokenInterval = undefined;
+  }
+
+  async enableBookAccess() {
+    let consecutiveLoanCounts = 1;
+
+    if (this.borrowType) {
+      // send consecutiveLoanCounts for browsed books only.
+      if (this.borrowType === 'browsed') {
+        try {
+          const existingCount = await this.localCache.get(
+            `loan-count-${this.identifier}`
+          );
+          consecutiveLoanCounts = existingCount ?? 1;
+        } catch (error) {
+          console.log(error);
+        }
+      }
+
+      // Do an initial token, then set an interval
+      this.handleLoanTokenPoller(true);
+
+      this.loanTokenInterval = setInterval(() => {
+        this.handleLoanTokenPoller();
+      }, this.pollerDelay);
+
+      // event category and action for browsing book access
+      const category = `${this.borrowType}BookAccess`;
+      const action = `${
+        this.borrowType === 'browsed' ? 'BrowseCounts-' : 'Counts-'
+      }${consecutiveLoanCounts}`;
+
+      this.sendEvent(category, action);
+    } else {
+      // if book is not browsed, just clear token polling interval
+      this.disconnectedInterval(); // stop token fetch api
+    }
+  }
+
+  sendEvent(eventCategory, eventAction) {
+    // eslint-disable-next-line no-console
+    console?.log('Book action: ', { eventCategory, eventAction });
+    window?.archive_analytics?.send_event_no_sampling(
+      eventCategory,
+      eventAction,
+      `identifier=${this.identifier}`
+    );
+  }
+
+  async handleLoanTokenPoller(isInitial = false) {
+    const action = 'create_token';
+    ActionsHandlerService({
+      identifier: this.identifier,
+      action,
+      error: data => {
+        this.disconnectedInterval(); // stop token fetch api
+        this.errorCallback({ detail: { action, data } });
+      },
+      success: () => {
+        if (isInitial) this.successCallback();
+      },
+    });
+  }
+}

package/src/ia-book-actions.js

@@ -11,6 +11,7 @@ import './components/info-icon.js';
 
 import GetLendingActions from './core/services/get-lending-actions.js';
 import { mobileContainerWidth } from './core/config/constants.js';
+import { LoanTokenPoller } from './core/services/loan-token-poller.js';
 
 export default class IABookActions extends LitElement {
   static get properties() {
@@ -21,10 +22,15 @@ export default class IABookActions extends LitElement {
       lendingStatus: { type: Object },
       width: { type: Number },
       bwbPurchaseUrl: { type: String },
+      lendingBarPostInit: {
+        type: Function,
+        attribute: false,
+      },
       barType: { type: String },
       sharedObserver: { attribute: false },
       disableActionGroup: { type: Boolean },
       modal: { Object },
+      tokenDelay: { type: Number },
     };
   }
 
@@ -36,10 +42,12 @@ export default class IABookActions extends LitElement {
     this.lendingStatus = {};
     this.width = 0;
     this.bwbPurchaseUrl = '';
+    this.lendingBarPostInit = () => {};
     this.barType = 'action'; // 'title'|'action'
     this.sharedObserver = undefined;
     this.disableActionGroup = false;
     this.modal = undefined;
+    this.tokenDelay = 120000; // 2 minutes
 
     // private props
     this.primaryActions = [];
@@ -47,6 +55,8 @@ export default class IABookActions extends LitElement {
     this.primaryColor = 'primary';
     this.secondaryActions = [];
     this.lendingOptions = {};
+    this.borrowType = ''; // (browsed|borrowed)
+    this.consecutiveLoanCounts = 1; // consecutive loan count
   }
 
   disconnectedCallback() {
@@ -58,8 +68,6 @@ export default class IABookActions extends LitElement {
       this.sharedObserver = new SharedResizeObserver();
       this.setupResizeObserver();
     }
-
-    this.setupLendingToolbarActions();
   }
 
   updated(changed) {
@@ -153,14 +161,26 @@ export default class IABookActions extends LitElement {
       // when browse is completed, we shows browse-again button
       this.startBrowseTimer();
     }
+
+    // early return if not borrowed or no action-bar
+    if (!this.borrowType || this.barType === 'title') {
+      this.lendingBarPostInit();
+      return;
+    }
+
+    this.startLoanTokenPoller();
   }
 
   render() {
-    return html`
-      <section class="lending-wrapper">
-        ${this.barType === 'title' ? this.bookTitleBar : this.bookActionBar}
-      </section>
-    `;
+    if (this.barType === 'title') {
+      return html`<section class="lending-wrapper">
+        ${this.bookTitleBar}
+      </section>`;
+    }
+
+    return html`<section class="lending-wrapper">
+      ${this.bookActionBar}
+    </section>`;
   }
 
   get bookTitleBar() {
@@ -190,6 +210,40 @@ export default class IABookActions extends LitElement {
     `;
   }
 
+  /**
+   * enable access of borrowed/browsed books
+   */
+  startLoanTokenPoller() {
+    if (this.tokenPoller) {
+      this.tokenPoller.disconnectedInterval();
+    }
+    const successCallback = () => {
+      this.lendingBarPostInit();
+    };
+    const errorCallback = eventObj => {
+      this.handleLendingActionError(eventObj);
+    };
+
+    /**
+     * LoanTokenPoller is a class that polls the loan token
+     * it takes 5 params
+     * 1. this.identifier
+     * 2. this.borrowType
+     * 3. successCallback - it used to
+     *    - disptach lendingFlow::PostInit event
+     *    - initialize bookreader using br.init()
+     * 4. errorCallback
+     * 5. tokenPollerDelay
+     */
+    this.tokenPoller = new LoanTokenPoller(
+      this.identifier,
+      this.borrowType,
+      successCallback,
+      errorCallback,
+      this.tokenDelay // 1000 ms = 1 sec
+    );
+  }
+
   /*
    * custom event handler to toggle action group visibility
    *
@@ -257,12 +311,18 @@ export default class IABookActions extends LitElement {
     });
 
     if (action === 'create_token') {
+      const refreshButton = html`<button
+        style="background:none;font-size:inherit;border:0;padding:0;color:#0000ee;cursor:pointer;text-decoration:underline"
+        @click=${() => window.location.reload(true)}
+      >
+        refresh
+      </button>`;
+
       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
+        Please ${refreshButton} to try again or send us an email to
         <a
           href="mailto:info@archive.org?subject=Help: cannot access my borrowed book: ${this
             .identifier}"

package/test/core/services/loan-token-poller.test.js

@@ -0,0 +1,40 @@
+import { expect } from '@open-wc/testing';
+import Sinon from 'sinon';
+
+import { LocalCache } from '@internetarchive/local-cache';
+import { LoanTokenPoller } from '../../../src/core/services/loan-token-poller.js';
+
+describe('Get Loan Token', () => {
+  it('get loan token for browsed books', async () => {
+    const localCacheStub = new LocalCache();
+    const localCacheGetSpy = Sinon.spy(localCacheStub, 'get');
+
+    const tokenPoller = new LoanTokenPoller(
+      'identifier1',
+      'browsed',
+      () => {
+        console.log('success callback is executed!');
+      },
+      () => {
+        console.log('error callback is executed!');
+      },
+      2000 // 2 minutes'
+    );
+    const successCallbackSpy = Sinon.stub(tokenPoller, 'successCallback');
+    successCallbackSpy();
+    expect(successCallbackSpy.callCount).to.equal(1);
+
+    localCacheGetSpy();
+    expect(localCacheGetSpy.callCount).to.equal(1);
+
+    expect(tokenPoller.localCache.namespace).to.equal('LocalCache');
+    expect(tokenPoller.localCache.get).to.be.a('function');
+
+    tokenPoller.disconnectedInterval(); // clear token poller interval
+    expect(tokenPoller.loanTokenInterval).to.equal(undefined);
+
+    tokenPoller.handleLoanTokenPoller(true);
+    expect(tokenPoller.errorCallback).to.be.a('function');
+    expect(tokenPoller.successCallback).have;
+  });
+});