@internetarchive/ia-book-actions 0.1.5-b1 → 0.1.5-b2

package/demo/index.html

@@ -131,11 +131,11 @@
     iaBookActions.returnUrl = '';
     iaBookActions.localCache = localCache;
 
-    let loanTotalTime2Min = { loanTotalTime: 70, loanRenewAtLast: 65, pageChangedInLast: 5 };
-    let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 180, pageChangedInLast: 15 };
+    let loanTotalTime2Min = { loanTotalTime: 10, loanRenewAtLast: 5, pageChangedInLast: 5 };
+    let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 280, pageChangedInLast: 15 };
     let loanTotalTime1Hour = { loanTotalTime: 3600, loanRenewAtLast: 600, pageChangedInLast: 900 };
 
-    iaBookActions.loanRenewTimeConfig = loanTotalTime2Min;
+    iaBookActions.loanRenewTimeConfig = loanTotalTime5Min;
 
     let lendingStatus1 = iaBookActions.lendingStatus;
     let secondsLeftOnLoan = iaBookActions.loanRenewTimeConfig.loanTotalTime;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "0.1.5-b1",
+  "version": "0.1.5-b2",
   "description": "Bookreader actions for borrowable book",
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",

package/src/core/config/ia-lending-intervals.js

@@ -11,6 +11,18 @@
  * @type {Object}
  */
 window.IALendingIntervals = {
+  /**
+   * store loan token poller interval
+   * @see LoanTokenPoller::bookAccessed
+   */
+  tokenPoller: 0,
+
+  /**
+   * store timer-countdown interval
+   * @see TimerCountdown::timerCountdown
+   */
+  timerCountdown: 0,
+
   /**
    * clear interval for create_token api
    */

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

@@ -163,10 +163,7 @@ export default class ActionsHandler extends LitElement {
       identifier: this.identifier,
       success: () => {
         this.deleteLoanCookies();
-        // URLHelper.goToUrl(this.returnUrl, true);
-        setTimeout(() => {
-          URLHelper.goToUrl(this.returnUrl, true);
-        }, this.waitUntillBorrowComplete * 1000);
+        URLHelper.goToUrl(this.returnUrl, true);
       },
       error: data => {
         this.dispatchActionError(action, data);

package/src/core/services/loan-analytics.js

@@ -38,7 +38,7 @@ export default class LoanAnanlytics {
       date.setHours(date.getHours() + 2); // 2 hours
 
       // set new value
-      Cookies.setItem(
+      await Cookies.setItem(
         this.getLoanCountStorageKey,
         JSON.stringify(this.lendingEventCounts),
         date,
@@ -53,12 +53,12 @@ export default class LoanAnanlytics {
   /**
    * get loan stats count from cookies for GA
    *
-   * @param {string} action 'browse'|'autorenew'|etc...
+   * @param {string} action browse|autorenew|etc...
    * @memberof ActionsHandler
    */
   async getLoanStatsCount(action) {
     this.lendingEventCounts = JSON.parse(
-      Cookies.getItem(this.getLoanCountStorageKey)
+      await Cookies.getItem(this.getLoanCountStorageKey)
     );
 
     this.gaStats = this.lendingEventCounts ?? {
@@ -67,7 +67,9 @@ export default class LoanAnanlytics {
       expire: 0,
     };
 
-    let { browse, renew, expire } = this.lendingEventCounts ?? 0;
+    let browse = this.lendingEventCounts?.browse ?? 0;
+    let renew = this.lendingEventCounts?.renew ?? 0;
+    let expire = this.lendingEventCounts?.expire ?? 0;
 
     switch (action) {
       case 'browse' || 'browseagain':
@@ -113,11 +115,13 @@ export default class LoanAnanlytics {
    * get zero padded number
    *
    * @param {number} number
-   * @return {string} browse001|autorenew001
+   * @return {string} 001|010
    * @memberof LoanAnanlytics
    */
   paddedNumber(number) {
-    return number.toString().padStart(3, '0');
+    if (number) return number.toString().padStart(3, '0');
+
+    return '000';
   }
 
   /**
@@ -140,14 +144,14 @@ export default class LoanAnanlytics {
    * @memberof LoanAnanlytics
    */
   sendEvent(eventCategory, eventAction, label, extraParams) {
-    console.log(
-      'eventCategory:-',
-      eventCategory,
-      '\t||\teventAction:-',
-      eventAction,
-      '\t||\tlabel:-',
-      label
-    );
+    // console.log(
+    //   'eventCategory:-',
+    //   eventCategory,
+    //   '\t||\teventAction:-',
+    //   eventAction,
+    //   '\t||\tlabel:-',
+    //   label
+    // );
 
     window?.archive_analytics?.send_event_no_sampling(
       eventCategory,

package/src/core/services/loan-renew-helper.js

@@ -89,7 +89,6 @@ export class LoanRenewHelper {
     ) {
       this.result.texts = this.loanReturnWarning;
       this.result.renewNow = false; // not viewed
-      console.log('warning msg appears');
     } else if (pageChangedTime >= pageChangeTimeFrame) {
       this.result.texts = '';
       this.result.renewNow = true; // viewed in last time frame
@@ -127,6 +126,13 @@ export class LoanRenewHelper {
     // convert time from second to minute
     timeLeft = Math.ceil(timeLeft / 60);
 
+    /**
+     * reduce 1 min from the auto return warning texts
+     * to compensate for the 50 second buffer we’ve introduced to handle the race condition
+     * @see IABookActions:loanRenew addEventListener
+     */
+    if (timeLeft > 1) timeLeft = timeLeft - 1;
+
     // convert time from minute to hour
     if (timeLeft > 59) {
       timeLeft = 1; // 1 hour

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

@@ -31,23 +31,7 @@ export class LoanTokenPoller {
   }
 
   async bookAccessed() {
-    // let consecutiveLoanCounts = 1;
-
     if (this.borrowType) {
-      // send consecutiveLoanCounts for browsed books only.
-      // if (this.borrowType === 'browsed') {
-      //   try {
-      //     const existingCount = Cookies.getItem(
-      //       `loan-count-${this.identifier}`
-      //     );
-      //     consecutiveLoanCounts = existingCount ?? 1;
-      //   } catch (error) {
-      //     window?.Sentry?.captureException(
-      //       `${sentryLogs.enableBookAcces} - CookieError: ${error}`
-      //     );
-      //   }
-      // }
-
       // Do an initial token, then set an interval
       this.handleLoanTokenPoller(true);
 
@@ -63,14 +47,6 @@ export class LoanTokenPoller {
           this.handleLoanTokenPoller();
         }, this.pollerDelay * 1000);
       }
-
-      // event category and action for browsing book access
-      // const category = `${this.borrowType}BookAccess`;
-      // const action = `${
-      //   this.borrowType === 'browsed' ? 'BrowseCounts-' : 'Counts-'
-      // }${consecutiveLoanCounts}`;
-
-      // this.loanAnalytics?.sendEvent(category, action, this.identifier);
     } else {
       window?.Sentry?.captureMessage(
         `${sentryLogs.bookAccessed} - not borrowed`

package/src/ia-book-actions.js

@@ -301,7 +301,9 @@ export default class IABookActions extends LitElement {
       console.log('** IABookActions:loanRenew', event.detail);
       await this.autoLoanRenewChecker(false);
 
-      // maybe the renew with-in last 1 minute is too short of a transition time between xhr, loading images etc... let NOT renew in last 50 seconds.
+      // renew in last seconds (let say 50 second) not possible because,
+      // - very short to renew on datanodes by hitting petabox API
+      // - loading images by create loan token
       if (event?.detail?.secondsLeft < 50) {
         this.suppressAutoRenew = true;
       }
@@ -309,7 +311,6 @@ export default class IABookActions extends LitElement {
       // show warning message with remaining time to auto returned it.
       if (this.loanRenewResult.renewNow === false) {
         this.loanRenewResult.secondsLeft = event.detail.secondsLeft;
-        this.suppressToast = false;
         this.showToastMessage();
       }
     });
@@ -545,7 +546,6 @@ export default class IABookActions extends LitElement {
         ajaxResponse: event?.detail?.data,
         loanRenewResult: this.loanRenewResult,
         secondsLeftOnLoan: Math.round(this.lendingStatus.secondsLeftOnLoan),
-        resetTimerCountState: this._shadowRoot.querySelector('timer-countdown'),
       });
     }
   }

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

@@ -64,8 +64,6 @@ describe('<collapsible-action-group>', () => {
     expect(primaryActionContainer.classList.contains('action-buttons')).to.be
       .true;
 
-    expect(el.sendEvent).to.exist;
-
     let eName;
     let eAnalytics;
     const manualClickStub = (eventName, gaEvent) => {

package/test/components/timer-countdown.test.js

@@ -1,10 +1,12 @@
 import { html, fixture, expect, aTimeout } from '@open-wc/testing';
+import '../../src/ia-book-actions.js';
 import '../../src/components/timer-countdown.js';
 
-const container = ({ secondsLeftOnLoan, loanRenewTimeConfig } = {}) =>
+const container = ({ secondsLeftOnLoan, loanTotalTime, loanRenewAtLast } = {}) =>
   html`<timer-countdown
     .secondsLeftOnLoan=${secondsLeftOnLoan}
-    .loanRenewTimeConfig=${loanRenewTimeConfig}
+    .loanTotalTime=${loanTotalTime}
+    .loanRenewAtLast=${loanRenewAtLast}
   ></timer-countdown>`;
 
 describe('<timer-countdown>', () => {
@@ -12,27 +14,21 @@ describe('<timer-countdown>', () => {
     const el = await fixture(
       container({
         secondsLeftOnLoan: 0, // in seconds
-        loanRenewTimeConfig: {
-          loanTotalTime: 14, // in seconds
-          loanRenewAtLast: 5, // in seconds
-          pageChangedInLast: 5, // in seconds
-        },
+        loanTotalTime: 14,
+        loanRenewAtLast: 5,
       })
     );
 
     await el.updateComplete;
-    expect(el.timerInterval).to.be.undefined;
+    // expect(el.timerCountdown).to.be.undefined;
   });
 
   it('timer interval is not undefined when loan is active', async () => {
     const el = await fixture(
       container({
         secondsLeftOnLoan: 2, // in seconds
-        loanRenewTimeConfig: {
-          loanTotalTime: 14, // in seconds
-          loanRenewAtLast: 5, // in seconds
-          pageChangedInLast: 5, // in seconds
-        },
+        loanTotalTime: 14,
+        loanRenewAtLast: 5,
       })
     );
 
@@ -40,6 +36,6 @@ describe('<timer-countdown>', () => {
     await el.updateComplete;
 
     expect(el.secondsLeftOnLoan).to.equal(2);
-    expect(el.timerInterval).to.not.be.undefined;
+    // expect(el.timerInterval).to.not.be.undefined;
   });
 });

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

@@ -27,7 +27,7 @@ describe('Get Lending Actions', () => {
     expect(actions.primaryActions.length).to.equal(3);
     expect(actions.primaryActions[0].text).to.equal('Borrow');
     expect(actions.primaryActions[1].text).to.equal('Borrow for 14 days');
-    expect(actions.secondaryActions[1].text).to.equal('Purchase at');
+    expect(actions.secondaryActions[1].text).to.equal('Purchase at ');
   });
 
   it('Borrowable without user', async () => {

package/test/core/services/loan-renew-helper.test.js

@@ -79,8 +79,9 @@ describe('Loan Renew Determine', () => {
       '65' // in seconds
     );
 
+    // we will get 1 min remaining since, we reduced 1 min from remaining time
     expect(toastMsg).to.be.equal(
-      'This book will be automatically returned in 2 minutes unless you turn a page.'
+      'This book will be automatically returned in 1 minute unless you turn a page.'
     );
   });
 });

package/demo/with-bookreader.html

@@ -1,146 +0,0 @@
-<!doctype html>
-<html lang="en-GB">
-
-<head>
-  <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
-  <style>
-    html {
-      font-size: 10px;
-      /* This is to match petabox's base font size */
-    }
-    body {
-      margin: 0;
-      text-align: center;
-      font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
-    }
-    #demo {
-      height: 50px;
-    }
-    ia-book-actions {
-      --white: #fff;
-      --black: #000;
-      --primaryBGColor: var(--black);
-      --secondaryBGColor: #222;
-      --tertiaryBGColor: #333;
-      --primaryTextColor:  var(--white);
-      --primaryCTAFill: #194880;
-      --primaryCTABorder: #c5d1df;
-      --secondaryCTAFill: #333;
-      --secondaryCTABorder: #999;
-      --secondaryCTAFillRGB: 51, 51, 51;
-      --primaryErrorCTAFill: #e51c26;
-      --primaryErrorCTABorder: #f8c6c8;
-      --primaryCTAFillRGB: 25, 72, 128;
-      --primaryErrorCTAFillRGB: 229, 28, 38;
-      --primaryDisableCTAFill: #767676;
-    }
-
-    fieldset {
-      width: fit-content;
-      margin-top: 50px;
-    }
-    fieldset legend {
-      text-align: left;
-      font-size: 12px;
-    }
-    td {
-      color: white;
-      font-size: 14px;
-      border-radius: 5%;
-      display: table-cell;
-      text-align: initial;
-      margin: 5px 0;
-      width: max-content;
-      display: block;
-    }
-    label {
-      padding: 10px;
-      display: block;
-      cursor: pointer;
-      margin: 2px;
-      background: #4e545a;
-      border-radius: 10px;
-    }
-    input[type="radio"], input[type="checkbox"] {
-      margin-top: 0;
-      vertical-align: middle;
-    }
-
-    .initial td {
-      float: left;
-      margin: 2px;
-    }
-
-    body.modal-manager-open {
-      overflow: hidden;
-    }
-  
-    modal-manager[mode='closed'] {
-      display: none;
-    }
-  </style>
-</head>
-
-<body>
-  <ia-bookreader class="focus-on-child-only" signedin="" fullscreen="">
-    <div slot="header">
-      <ia-book-actions></ia-book-actions>
-    </div>
-    <div slot="main">
-      <div id="BookReader"></div>
-    </div>
-  </ia-bookreader>
-
-
-  <script type="module">
-    /* eslint-disable */
-    import '@internetarchive/bookreader';
-    import '@internetarchive/bookreader/BookReader/jquery-1.10.1.js';
-    import '@internetarchive/bookreader/BookReader/BookReader.js';
-    import '../src/ia-book-actions.js';
-    import {
-      defaultLendingStatus,
-      canBrowseAndBorrow,
-    } from '../src/assets/data/lending-get-status-service.js';
-    import { ModalConfig } from '@internetarchive/modal-manager';
-
-    const userid = '@neeraj-archive';
-    const identifier = 'naturalhistoryof00unse_4111';
-    let bwbPurchaseUrl = 'https://www.betterworldbooks.com/product/detail/cambridge-ancient-hist-v04-0521044863';
-
-    let iaBookActions = document.querySelector('ia-book-actions');
-
-    // for debugging
-    window.iaBookActions = iaBookActions;
-
-    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.modalConfig = modalConfig;
-    iaBookActions.lendingBarPostInit = lendingBarPostInit;
-    iaBookActions.tokenDelay = 2000; // 2 seconds
-    iaBookActions.returnUrl = 'https://openlibrary.org';
-
-    let lendingStatus1 = iaBookActions.lendingStatus;
-
-    const manifest = await fetch('https://ia801302.us.archive.org/BookReader/BookReaderJSIA.php?id=goody&itemPath=/29/items/goody&server=ia801302.us.archive.org&format=jsonp&subPrefix=goody&requestUri=/details/goody/mode/1up%3Fview%3Dtheater%26ui%3Dembed%26wrapper%3Dfalse');
-
-    console.log('manifest ****', manifest).then(res => res.json());
-  </script>
-
-  </div>
-</body>
-</html>