@internetarchive/ia-book-actions 0.1.4 → 0.1.5

package/demo/index.html

@@ -131,11 +131,11 @@
     iaBookActions.returnUrl = 'https://openlibrary.org';
     iaBookActions.localCache = localCache;
 
-    let loanTotalTime2Min = { loanTotalTime: 20, loanRenewAtLast: 15, pageChangedInLast: 15 };
-    let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 180, pageChangedInLast: 15 };
+    let loanTotalTime2Min = { loanTotalTime: 20, loanRenewAtLast: 15, pageChangedInLast: 5 };
+    let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 290, pageChangedInLast: 15 };
     let loanTotalTime1Hour = { loanTotalTime: 3600, loanRenewAtLast: 600, pageChangedInLast: 900 };
 
-    iaBookActions.loanRenewTimeConfig = loanTotalTime1Hour;
+    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.4",
+  "version": "0.1.5",
   "description": "Bookreader actions for borrowable book",
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",

package/src/components/timer-countdown.js

@@ -31,6 +31,12 @@ export default class TimerCountdown extends LitElement {
      */
     this.loanRenewAtLast = 0;
 
+    /**
+     * store time when timer is started
+     * @type {string}
+     */
+    this.timeWhenTimerStart = '';
+
     /**
      * delay seconds in setInterval function
      * @type {number}
@@ -42,32 +48,36 @@ export default class TimerCountdown extends LitElement {
     window?.IALendingIntervals?.clearTimerCountdown();
   }
 
+  firstUpdated() {
+    this.timerCountdown();
+  }
+
   updated(changed) {
     if (changed.has('secondsLeftOnLoan') && this.secondsLeftOnLoan > 0) {
-      this.disconnectedCallback();
-
       this.timerCountdown();
     }
   }
 
   timerCountdown() {
+    this.disconnectedCallback();
+
     // - let just execute setInterval in every 1 minute
     this.timerExecutionSeconds = 60;
+    let secondsLeft = this.secondsLeftOnLoan;
+
+    // store current time
+    this.timeWhenTimerStart = new Date();
 
     /**
      * set interval in window object
      * @see ia-lending-intervals.js
      */
-    window.IALendingIntervals.timerCountdown = setInterval(() => {
-      this.secondsLeftOnLoan -= this.timerExecutionSeconds;
-      const secondsLeft = Math.round(this.secondsLeftOnLoan);
+    window.IALendingIntervals.timerCountdown = setInterval(async () => {
+      secondsLeft -= this.timerExecutionSeconds;
+      secondsLeft = Math.round(secondsLeft); // round number
 
-      console.log(
-        'timeLeftInSec',
-        secondsLeft,
-        ' ||| timeLeftInMin',
-        Math.ceil(secondsLeft / 60)
-      );
+      // re-sync timer is gone off
+      await this.reSyncTimerIfGoneOff(secondsLeft);
 
       /**
        * execute from last 10th minute to 0th minute
@@ -76,26 +86,74 @@ export default class TimerCountdown extends LitElement {
        * @see IABookActions::bindLoanRenewEvents
        */
       if (secondsLeft <= this.loanRenewAtLast) {
-        this.dispatchEvent(
-          new CustomEvent('IABookActions:loanRenew', {
-            detail: {
-              hasPageChanged: false,
-              secondsLeft,
-            },
-            bubbles: true,
-            composed: true,
-          })
-        );
+        this.dispatchLoanRenewEvent(secondsLeft);
       }
 
-      // clear interval
-      if (secondsLeft <= 60) {
+      // clear interval in secondsLeft if less
+      if (secondsLeft <= this.timerExecutionSeconds) {
         this.disconnectedCallback();
         window?.Sentry?.captureMessage(sentryLogs.clearOneHourTimer);
       }
     }, this.timerExecutionSeconds * 1000);
   }
 
+  /**
+   * dispatch loan renew attempt event
+   *
+   * @param {number} secondsLeft
+   * @memberof TimerCountdown
+   */
+  dispatchLoanRenewEvent(secondsLeft) {
+    this.dispatchEvent(
+      new CustomEvent('IABookActions:loanRenew', {
+        detail: {
+          hasPageChanged: false,
+          secondsLeft,
+        },
+        bubbles: true,
+        composed: true,
+      })
+    );
+  }
+
+  /**
+   * helper function to determine if timer is not in sync properly
+   *
+   * @param {number} timerSecondsLeft - actual seconds left get from setInterval
+   *
+   * @memberof TimerCountdown
+   */
+  async reSyncTimerIfGoneOff(timerSecondsLeft) {
+    // debug info
+    console.log(
+      new Date().toLocaleTimeString(),
+      'timeLeftInSec',
+      timerSecondsLeft,
+      ' ||| timeLeftInMin',
+      Math.ceil(timerSecondsLeft / 60)
+    );
+
+    const currentTime = new Date();
+
+    // current time - loan time
+    const diffInSeconds =
+      currentTime.getTime() / 1000 - this.timeWhenTimerStart.getTime() / 1000;
+
+    const secondsShouldLeft = this.secondsLeftOnLoan - diffInSeconds;
+
+    // convert in minutes
+    const whatIsleft = Math.round(timerSecondsLeft);
+    const whatShouldLeft = Math.round(secondsShouldLeft);
+
+    if (whatIsleft !== whatShouldLeft) {
+      // debug info
+      console.log(
+        `timer is gone off, let's re-sync, whatIsleft -> ${whatIsleft}, whatShouldLeft -> ${whatShouldLeft}`
+      );
+      this.secondsLeftOnLoan = secondsShouldLeft; // the seconds should left in timer again
+    }
+  }
+
   /**
    * get remaining time with timeunit
    *

package/src/ia-book-actions.js

@@ -240,7 +240,7 @@ export default class IABookActions extends LitElement {
      */
     setTimeout(
       () => {
-        this.startLoanTokenPoller();
+        if (!hasExpired) this.startLoanTokenPoller();
       },
 
       // if book is renew while reading, let's wait to execute create-token api
@@ -260,12 +260,13 @@ export default class IABookActions extends LitElement {
      * dispatched this event from bookreader page changed
      */
     window.addEventListener('BookReader:userAction', () => {
+      console.log('user action');
+      this.suppressToast = true;
+      this.closeToastManager();
+
       if (this.borrowType === 'browsed') {
-        this.suppressToast = false;
         this.autoLoanRenewChecker(true);
       }
-
-      return nothing;
     });
 
     /**
@@ -320,6 +321,16 @@ export default class IABookActions extends LitElement {
     this.loanRenewResult = this.loanRenewHelper.result;
   }
 
+  /**
+   * close/hide toast message
+   */
+  async closeToastManager() {
+    const toastTemplate = this.shadowRoot.querySelector('toast-template');
+    if (toastTemplate) {
+      toastTemplate?.remove();
+    }
+  }
+
   /**
    * Show toast messages on some specific loan renew features. e.g.
    * - show message when book is auto renewed
@@ -329,14 +340,11 @@ export default class IABookActions extends LitElement {
   async showToastMessage() {
     if (this.suppressToast) return;
 
-    const iaBookActions = document.querySelector('ia-book-actions')?.shadowRoot;
-    if (!iaBookActions) return;
-
-    let toastTemplate = iaBookActions.querySelector('toast-template');
+    let toastTemplate = this.shadowRoot.querySelector('toast-template');
     if (!toastTemplate) {
       toastTemplate = document.createElement('toast-template');
     }
-    await iaBookActions.appendChild(toastTemplate);
+    await this.shadowRoot.appendChild(toastTemplate);
 
     // if secondsLeft < 60, consider it 1 minute
     let { secondsLeft } = this.loanRenewResult;
@@ -573,8 +581,7 @@ export default class IABookActions extends LitElement {
    *  @param {string} event.detail.data.error - error message
    */
   handleLendingActionError(event) {
-    // toggle activity loader
-    this.handleToggleActionGroup();
+    this.disableActionGroup = false;
 
     // clear all intervals for lending system when error occured
     window?.IALendingIntervals?.clearAll();
@@ -582,7 +589,9 @@ export default class IABookActions extends LitElement {
     const action = event?.detail?.action;
     const errorMsg = event?.detail?.data?.error;
 
-    if (errorMsg) this.showErrorModal(errorMsg, action);
+    // template not show create_token errors
+    if (errorMsg && action !== 'create_token')
+      this.showErrorModal(errorMsg, action);
 
     // if error related to loan token
     // - clear tokenPoller interval
@@ -616,8 +625,6 @@ export default class IABookActions extends LitElement {
 
   /* show error message if something went wrong */
   async showErrorModal(errorMsg, action) {
-    this.disableActionGroup = false;
-
     // check if this.modal passed as prop
     if (!this.modal) {
       this.modal = document.querySelector('modal-manager');

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>