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

package/demo/index.html

@@ -106,20 +106,19 @@
 
     let lendingBarPostInit = function lendingBarPostInit() {
       setTimeout(function() {
-        console.log('executed');
-        // emitLendingActionBarInitEvent();
-        // brInit();
+        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-9",
+  "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/core/services/actions-handler/actions-handler.js

@@ -16,7 +16,7 @@ export default class ActionsHandler extends LitElement {
   constructor(identifier) {
     super();
     this.identifier = identifier;
-    this.ajaxTimeout = 7000;
+    this.ajaxTimeout = 6000;
     this.localCache = new LocalCache();
     this.bindEvents();
   }
@@ -178,7 +178,6 @@ export default class ActionsHandler extends LitElement {
     });
   }
 
-
   /**
    * Dispatches event when an error occured on action
    * Notes:- toggle <collapsible-action-group> visibility (enable/disable).
@@ -242,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

@@ -1,6 +1,4 @@
-import { LitElement } from 'lit-element';
 import { LocalCache } from '@internetarchive/local-cache';
-
 import ActionsHandlerService from './actions-handler/actions-handler-service.js';
 
 /**
@@ -8,29 +6,33 @@ import ActionsHandlerService from './actions-handler/actions-handler-service.js'
  *
  * ActionsHandlerService is a function being used to execute
  */
-export class LoanTokenPoller extends LitElement {
-  constructor() {
-    super();
-    this.identifier = '';
-    this.loanTokenPollingDelay = window.location.pathname === '/demo/' ? 2000 : 120000; // 120000 ms = 2 min
+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();
   }
 
-  disconnectedCallback() {
+  disconnectedInterval() {
+    clearInterval(this.loanTokenInterval);
     this.loanTokenInterval = undefined;
   }
 
-  async enableBookAccess(identifier, borrowType) {
-    this.identifier = identifier
+  async enableBookAccess() {
     let consecutiveLoanCounts = 1;
 
-    if (borrowType) {
+    if (this.borrowType) {
       // send consecutiveLoanCounts for browsed books only.
-      if (borrowType === 'browsed') {
+      if (this.borrowType === 'browsed') {
         try {
           const existingCount = await this.localCache.get(
-            'consecutive-loan-count'
+            `loan-count-${this.identifier}`
           );
           consecutiveLoanCounts = existingCount ?? 1;
         } catch (error) {
@@ -39,22 +41,22 @@ export class LoanTokenPoller extends LitElement {
       }
 
       // Do an initial token, then set an interval
-      this.handleLoanTokenPoller();
+      this.handleLoanTokenPoller(true);
 
       this.loanTokenInterval = setInterval(() => {
         this.handleLoanTokenPoller();
-      }, this.loanTokenPollingDelay);
+      }, this.pollerDelay);
 
       // event category and action for browsing book access
-      const category = `${borrowType}BookAccess`;
+      const category = `${this.borrowType}BookAccess`;
       const action = `${
-        borrowType === 'browsed' ? 'BrowseCounts-' : 'Counts-'
+        this.borrowType === 'browsed' ? 'BrowseCounts-' : 'Counts-'
       }${consecutiveLoanCounts}`;
-      console.log(consecutiveLoanCounts)
+
       this.sendEvent(category, action);
     } else {
       // if book is not browsed, just clear token polling interval
-      clearInterval(this.loanTokenInterval);
+      this.disconnectedInterval(); // stop token fetch api
     }
   }
 
@@ -68,36 +70,18 @@ export class LoanTokenPoller extends LitElement {
     );
   }
 
-  async handleLoanTokenPoller() {
+  async handleLoanTokenPoller(isInitial = false) {
     const action = 'create_token';
-    // await new Promise(r => setTimeout(r, 3000));
     ActionsHandlerService({
       identifier: this.identifier,
       action,
       error: data => {
-        console.log('error', data);
-        this.handleLendingActionError({detail: { action, data }})
-        // this.dispatchActionError(action, data);
-        clearInterval(this.loanTokenInterval); // stop token fetch api
+        this.disconnectedInterval(); // stop token fetch api
+        this.errorCallback({ detail: { action, data } });
+      },
+      success: () => {
+        if (isInitial) this.successCallback();
       },
     });
   }
-
-  /**
-   * 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 = {}) {
-    console.log('disptaced');
-    this.dispatchEvent(
-      new CustomEvent('lendingActionError', {
-        detail: { action, data },
-      })
-    );
-  }
 }

package/src/ia-book-actions.js

@@ -1,5 +1,5 @@
 /* eslint-disable camelcase */
-import { html, css } from 'lit-element';
+import { html, css, LitElement } from 'lit-element';
 
 import { SharedResizeObserver } from '@internetarchive/shared-resize-observer';
 import { ModalConfig } from '@internetarchive/modal-manager';
@@ -13,7 +13,7 @@ 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 LoanTokenPoller {
+export default class IABookActions extends LitElement {
   static get properties() {
     return {
       userid: { type: String },
@@ -22,11 +22,15 @@ export default class IABookActions extends LoanTokenPoller {
       lendingStatus: { type: Object },
       width: { type: Number },
       bwbPurchaseUrl: { type: String },
-      lendingBarPostInit: { type: Function },
+      lendingBarPostInit: {
+        type: Function,
+        attribute: false,
+      },
       barType: { type: String },
       sharedObserver: { attribute: false },
       disableActionGroup: { type: Boolean },
       modal: { Object },
+      tokenDelay: { type: Number },
     };
   }
 
@@ -43,6 +47,7 @@ export default class IABookActions extends LoanTokenPoller {
     this.sharedObserver = undefined;
     this.disableActionGroup = false;
     this.modal = undefined;
+    this.tokenDelay = 120000; // 2 minutes
 
     // private props
     this.primaryActions = [];
@@ -157,26 +162,25 @@ export default class IABookActions extends LoanTokenPoller {
       this.startBrowseTimer();
     }
 
-    // enable access of borrowed/browsed books
-    if (this.borrowType) {
-      await this.enableBookAccess(this.identifier, this.borrowType);
+    // early return if not borrowed or no action-bar
+    if (!this.borrowType || this.barType === 'title') {
+      this.lendingBarPostInit();
+      return;
     }
 
-    /**
-     * this callback function use to:-
-     * - disptach lenfingFlow::PostInit event
-     * - initialize bookreader using br.init()
-     */
-    console.log(this.lendingBarPostInit);
-    this.lendingBarPostInit;
+    this.startLoanTokenPoller();
   }
 
   render() {
     if (this.barType === 'title') {
-      return html`<section class="lending-wrapper">${this.bookTitleBar}</section>`;
+      return html`<section class="lending-wrapper">
+        ${this.bookTitleBar}
+      </section>`;
     }
 
-    return html`<section class="lending-wrapper">${this.bookActionBar}</section>`;
+    return html`<section class="lending-wrapper">
+      ${this.bookActionBar}
+    </section>`;
   }
 
   get bookTitleBar() {
@@ -206,6 +210,40 @@ export default class IABookActions extends LoanTokenPoller {
     `;
   }
 
+  /**
+   * 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
    *
@@ -273,12 +311,18 @@ export default class IABookActions extends LoanTokenPoller {
     });
 
     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;
+  });
+});