@internetarchive/ia-book-actions 0.1.4 → 0.1.5-alpha2

package/demo/index.html

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

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

@@ -32,7 +32,8 @@ export class CollapsibleActionGroup extends ActionsHandler {
       dropdownArrow: { type: String },
       disabled: { type: Boolean },
       returnUrl: { type: String },
-      renewNow: { type: Boolean },
+      autoRenew: { type: Boolean },
+      autoReturn: { type: Boolean },
     };
   }
 
@@ -52,7 +53,8 @@ export class CollapsibleActionGroup extends ActionsHandler {
     this.loaderIcon = 'https://archive.org/upload/images/tree/loading.gif';
     this.disabled = false;
     this.returnUrl = '';
-    this.renewNow = false;
+    this.autoRenew = false;
+    this.autoReturn = false;
   }
 
   updated(changed) {
@@ -63,21 +65,33 @@ export class CollapsibleActionGroup extends ActionsHandler {
       this.resetActions();
     }
 
-    if (changed.has('renewNow') && this.renewNow === true) {
-      this.dispatchLoanRenewEvent();
+    if (changed.has('autoRenew') && this.autoRenew === true) {
+      this.dispatchLoanEvent('autoRenew');
+    }
+
+    if (changed.has('autoReturn') && this.autoReturn === true) {
+      this.dispatchLoanEvent('autoReturn');
     }
   }
 
-  // dispatch this event to loan renew handler
-  dispatchLoanRenewEvent() {
-    const { category, action } = {
-      category: analyticsCategories.browse,
-      action: analyticsActions.browseLoanRenew,
-    };
+  /**
+   * dispatch event when book is auto renewed / returned
+   * listen these events in action-handler.js
+   * @see ActionsHandler
+   *
+   * @param {string} event - autoRenew|autoReturn
+   * @memberof CollapsibleActionGroup
+   */
+  dispatchLoanEvent(event) {
+    const category = analyticsCategories.browse;
+    const action =
+      event === 'autoRenew'
+        ? analyticsActions.browseAutoRenew
+        : analyticsActions.browseAutoReturn;
 
     // listen in action-handler.js to execute ajax call on petabox.
     this.dispatchEvent(
-      new CustomEvent('loanRenew', {
+      new CustomEvent(event, {
         detail: {
           event: { category, action },
         },

package/src/components/timer-countdown.js

@@ -31,43 +31,51 @@ 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}
      */
-    this.timerExecutionSeconds = 0;
+    this.timerExecutionSeconds = 60;
   }
 
   disconnectedCallback() {
     window?.IALendingIntervals?.clearTimerCountdown();
   }
 
+  firstUpdated() {
+    this.timerCountdown();
+  }
+
   updated(changed) {
     if (changed.has('secondsLeftOnLoan') && this.secondsLeftOnLoan > 0) {
-      this.disconnectedCallback();
-
       this.timerCountdown();
     }
   }
 
   timerCountdown() {
-    // - let just execute setInterval in every 1 minute
-    this.timerExecutionSeconds = 60;
+    this.disconnectedCallback();
+
+    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 +84,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/core/config/analytics-event-and-category.js

@@ -13,7 +13,8 @@ export const analyticsCategories = {
 export const analyticsActions = {
   browse: 'Borrow-1Hour',
   browseAgain: 'Borrow-Again',
-  browseLoanRenew: 'Borrow-Loan-Renew',
+  browseAutoRenew: 'AutoRenewBook',
+  browseAutoReturn: 'AutoReturnBook',
   borrow: 'Borrow-14Days',
   waitlistJoin: 'JoinWaitlist',
   waitlistLeave: 'LeaveWaitlist',

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

@@ -1,17 +1,16 @@
 import { LitElement } from 'lit';
 
 import { URLHelper } from '../../config/url-helper.js';
-import { sentryLogs } from '../../config/sentry-events.js';
 
 import ActionsHandlerService from './actions-handler-service.js';
+import LoanAnanlytics from '../loan-analytics.js';
 import * as Cookies from '../doc-cookies.js';
 
 /**
  * These are callback functions calling from actions-config.js file.
  *
- * ActionsHandlerService is a function being used to execute
- * APIs based of the request made by user. It consist some parameters are as follows:-
- * 1. identifier: book name.
+ * ActionsHandlerService is a function being used to execute APIs based of the request made by user.
+ *
  */
 
 export default class ActionsHandler extends LitElement {
@@ -24,86 +23,148 @@ export default class ActionsHandler extends LitElement {
      */
     this.waitUntillBorrowComplete = 6; // in seconds
 
-    this.bindEvents();
-  }
+    /**
+     * bind events for lending bar
+     * @type {object}
+     */
+    this.loanAnanlytics = new LoanAnanlytics();
 
-  sendEvent(eventCategory, eventAction) {
-    window?.archive_analytics?.send_event(
-      eventCategory,
-      eventAction,
-      `identifier=${this.identifier}`
-    );
+    /**
+     * bind events for lending bar
+     * @type {Function}
+     */
+    this.bindEvents();
   }
 
   bindEvents() {
     this.addEventListener('browseBook', ({ detail }) => {
       this.handleBrowseIt();
-      this.setConsecutiveLoanCounts();
+      this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'browse');
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('browseBookAgain', ({ detail }) => {
       this.handleBrowseIt();
-      this.setConsecutiveLoanCounts('browseAgain');
+      this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'browseagain');
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
-    this.addEventListener('loanRenew', ({ detail }) => {
-      this.handleLoanRenew();
+    this.addEventListener('autoRenew', ({ detail }) => {
+      this.handleLoanRenewNow();
+      this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'autorenew');
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
+    });
+
+    this.addEventListener('autoReturn', ({ detail }) => {
+      this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'autoreturn');
+      const { category, action } = detail.event;
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('returnNow', ({ detail }) => {
+      this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'return');
       this.handleReturnIt();
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('borrowBook', ({ detail }) => {
       this.handleBorrowIt();
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('loginAndBorrow', ({ detail }) => {
       this.handleLoginOk();
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('leaveWaitlist', ({ detail }) => {
       this.handleRemoveFromWaitingList();
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('joinWaitlist', ({ detail }) => {
       this.handleReserveIt();
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('purchaseBook', ({ detail }) => {
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('adminAccess', ({ detail }) => {
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('exitAdminAccess', ({ detail }) => {
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('bookTitleBar', ({ detail }) => {
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
   }
 
@@ -124,7 +185,7 @@ export default class ActionsHandler extends LitElement {
     });
   }
 
-  handleLoanRenew() {
+  handleLoanRenewNow() {
     const action = 'renew_loan';
 
     ActionsHandlerService({
@@ -220,7 +281,7 @@ export default class ActionsHandler extends LitElement {
    */
   dispatchActionError(action, data = {}) {
     // send LendingServiceError to GA
-    this.sendEvent('LendingServiceError', action);
+    this.loanAnanlytics?.sendEvent('LendingServiceError', action);
 
     this.dispatchEvent(
       new CustomEvent('lendingActionError', {
@@ -271,31 +332,6 @@ export default class ActionsHandler extends LitElement {
     }, this.waitUntillBorrowComplete * 1000);
   }
 
-  // save consecutive loan count for borrow
-  async setConsecutiveLoanCounts(action = '') {
-    try {
-      let newCount = 1;
-      const storageKey = `loan-count-${this.identifier}`;
-      const existingCount = Cookies.getItem(storageKey);
-
-      // increase browse-count by 1 when you consecutive reading a book.
-      if (action === 'browseAgain' && existingCount !== undefined) {
-        newCount = existingCount ? Number(existingCount) + 1 : 1;
-      }
-
-      const date = new Date();
-      date.setHours(date.getHours() + 2); // 2 hours
-
-      // set new value
-      Cookies.setItem(storageKey, newCount, date, '/');
-    } catch (error) {
-      window?.Sentry?.captureException(
-        `${sentryLogs.setConsecutiveLoanCounts} - Error: ${error}`
-      );
-      this.sendEvent('Cookies-Error-Actions', error);
-    }
-  }
-
   /**
    * set browse time in indexedDB
    */

package/src/core/services/doc-cookies.js

@@ -62,7 +62,7 @@ export function setItem(sKey, sValue, vEnd, sPath, sDomain, bSecure) {
 
 /**
  * BROKEN Remove specific key's value from cookie
- * @fixme hasItem isn't even implemented! This will always error.
+ *
  * @param {string} sKey cookie name
  * @param {string} [sPath] path of current item
  * @param {string} [sDomain]
@@ -81,3 +81,25 @@ export function removeItem(sKey, sPath, sDomain) {
 
   return true;
 }
+
+/**
+ * determine if a specific cookie is exist
+ *
+ * @param {string} sKey cookie name
+ *
+ * @returns {boolean}
+ */
+export function hasItem(sKey) {
+  const reCNameAllowed = /^(?:expires|max\-age|path|domain|secure|samesite|httponly)$/i;
+
+  // eslint-disable-next-line
+  if (!sKey || reCNameAllowed.test(sKey)) {
+    return false;
+  }
+
+  return new RegExp(
+    '(?:^|;\\s*)' +
+      encodeURIComponent(sKey).replace(/[\-\.\+\*]/g, '\\$&') +
+      '\\s*\\='
+  ).test(document.cookie);
+}

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

@@ -0,0 +1,189 @@
+/* eslint-disable class-methods-use-this */
+
+import { analyticsCategories } from '../config/analytics-event-and-category.js';
+import * as Cookies from './doc-cookies.js';
+
+/**
+ * This class is used to send different GA events for loan system.
+ */
+export default class LoanAnanlytics {
+  constructor() {
+    this.identifier = undefined;
+
+    /**
+     * contains the counts we send to GA
+     * @type {object}
+     * - @param {number} - browse count
+     * - @param {number} - renew count
+     * - @param {number} - expire count
+     */
+    this.gaStats = {};
+  }
+
+  /**
+   * store loan stats count in cookies to remember the count we need to sent GA
+   *
+   * @param {string} identifier - book id
+   * @param {string} action - user action on book
+   * @return {void}
+   * @memberof ActionsHandler
+   */
+  async storeLoanStatsCount(idetifier, action = '') {
+    this.identifier = idetifier;
+
+    try {
+      await this.getLoanStatsCount(action);
+
+      const date = new Date();
+      date.setHours(date.getHours() + 2); // 2 hours
+
+      // set new value
+      Cookies.setItem(
+        this.getLoanCountStorageKey,
+        JSON.stringify(this.lendingEventCounts),
+        date,
+        '/'
+      );
+    } catch (error) {
+      console.log(error);
+      this.sendEvent(
+        'Cookies-Error-Actions',
+        error,
+        `identifier=${this.identifier}`
+      );
+    }
+  }
+
+  /**
+   * get loan stats count from cookies for GA
+   *
+   * @param {string} action 'browse'|'autorenew'|etc...
+   * @memberof ActionsHandler
+   */
+  async getLoanStatsCount(action) {
+    this.lendingEventCounts = JSON.parse(
+      Cookies.getItem(this.getLoanCountStorageKey)
+    );
+
+    this.gaStats = this.lendingEventCounts ?? {
+      browse: 0,
+      renew: 0,
+      expire: 0,
+    };
+
+    let { browse, renew, expire } = this.lendingEventCounts ?? 0;
+
+    switch (action) {
+      case 'browse' || 'browseagain':
+        browse = browse ? Number(browse) + 1 : 1;
+        this.gaStats.browse = browse;
+
+        // reset renew and expire count when browse
+        renew = 0;
+        expire = 0;
+        break;
+
+      case 'autorenew':
+        renew = renew ? Number(renew) + 1 : 1;
+        this.gaStats.renew = renew;
+        break;
+
+      case 'return' || 'autoreturn':
+        expire = expire ? Number(expire) + 1 : 1;
+        this.gaStats.expire = expire;
+
+        // reset renew and expire count when browse
+        renew = 0;
+        expire = 0;
+        break;
+      default:
+        break;
+    }
+
+    // store these counts in cookies
+    this.lendingEventCounts = { browse, renew, expire };
+
+    // obtain GA category, event
+    // const { category, event } = await this.getGACategoryAction(action);
+    const category = analyticsCategories.browse;
+    const event = `browse${this.paddedNumber(
+      this.gaStats?.browse
+    )}-autorenew${this.paddedNumber(this.gaStats?.renew)}:${action}`;
+
+    // send google analytics events
+    this.sendEvent(category, event, `identifier=${this.identifier}`, {
+      browse: this.gaStats?.browse,
+      renew: this.gaStats?.renew,
+      expire: this.gaStats?.expire,
+    });
+  }
+
+  /**
+   *
+   *
+   * @param {string} action - like 'browse|autorenew|etc...'
+   * @return {object} - contains GA category and event
+   * - @param {string}
+   * - @param {string}
+   *
+   * @memberof LoanAnanlytics
+   */
+  getGACategoryAction(action) {
+    const GACategory = analyticsCategories.browse;
+    const GAAction = `browse${this.paddedNumber(
+      this.gaStats?.browse
+    )}-autorenew${this.paddedNumber(this.gaStats?.renew)}:${action}`;
+
+    return { GACategory, GAAction };
+  }
+
+  /**
+   * get zero padded number
+   *
+   * @param {number} number
+   * @return {string} browse001|autorenew001
+   * @memberof LoanAnanlytics
+   */
+  paddedNumber(number) {
+    return number.toString().padStart(3, '0');
+  }
+
+  /**
+   * get storage key for loan stats count
+   *
+   * @readonly
+   * @memberof LoanAnanlytics
+   */
+  get getLoanCountStorageKey() {
+    return `br-browse-${this.identifier}`;
+  }
+
+  /**
+   * reponsible to sent events to GA
+   *
+   * @param {*} eventCategory
+   * @param {*} eventAction
+   * @param {*} label
+   * @param {*} extraParams
+   * @memberof LoanAnanlytics
+   */
+  sendEvent(eventCategory, eventAction, label, extraParams) {
+    console.debug(
+      'eventCategory:- ',
+      eventCategory,
+      '\neventAction:- ',
+      eventAction,
+      '\nlabel:- ',
+      label,
+      '\nextraParams:- ',
+      extraParams
+    );
+
+    window?.archive_analytics?.send_event_no_sampling(
+      eventCategory,
+      eventAction,
+      label || `identifier=${this.identifier}`,
+      extraParams
+    );
+  }
+}

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

@@ -1,4 +1,5 @@
 import ActionsHandlerService from './actions-handler/actions-handler-service.js';
+import LoanAnanlytics from './loan-analytics.js';
 import { sentryLogs } from '../config/sentry-events.js';
 
 import * as Cookies from './doc-cookies.js';
@@ -17,6 +18,13 @@ export class LoanTokenPoller {
     this.pollerDelay = pollerDelay; // value in seconds
 
     this.loanTokenInterval = undefined;
+
+    /**
+     * loan analytics instance
+     * @see loan-analytics.js
+     */
+    this.loanAnalytics = new LoanAnanlytics();
+
     this.bookAccessed();
   }
 
@@ -39,7 +47,6 @@ export class LoanTokenPoller {
           window?.Sentry?.captureException(
             `${sentryLogs.enableBookAcces} - CookieError: ${error}`
           );
-          this.sendEvent('Cookies-Error-Token', error);
         }
       }
 
@@ -65,7 +72,11 @@ export class LoanTokenPoller {
         this.borrowType === 'browsed' ? 'BrowseCounts-' : 'Counts-'
       }${consecutiveLoanCounts}`;
 
-      this.sendEvent(category, action);
+      this.loanAnalytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     } else {
       window?.Sentry?.captureMessage(
         `${sentryLogs.bookAccessed} - not borrowed`
@@ -76,14 +87,6 @@ export class LoanTokenPoller {
     }
   }
 
-  sendEvent(eventCategory, eventAction) {
-    window?.archive_analytics?.send_event(
-      eventCategory,
-      eventAction,
-      `identifier=${this.identifier}`
-    );
-  }
-
   async handleLoanTokenPoller(isInitial = false) {
     const action = 'create_token';
     ActionsHandlerService({
@@ -98,7 +101,11 @@ export class LoanTokenPoller {
         );
 
         // send LendingServiceError to GA
-        this.sendEvent('LendingServiceLoanError', action);
+        this.loanAnalytics?.sendEvent(
+          'LendingServiceLoanError',
+          action,
+          `identifier=${this.identifier}`
+        );
       },
       success: () => {
         if (isInitial) this.successCallback();

package/src/ia-book-actions.js

@@ -11,7 +11,6 @@ import './components/book-title-bar.js';
 import './components/text-group.js';
 import './components/info-icon.js';
 import './components/timer-countdown.js';
-import './core/config/ia-lending-intervals.js';
 
 import { GetLendingActions } from './core/services/get-lending-actions.js';
 import { mobileContainerWidth } from './core/config/constants.js';
@@ -19,6 +18,9 @@ import { sentryLogs } from './core/config/sentry-events.js';
 import { LoanTokenPoller } from './core/services/loan-token-poller.js';
 import { LoanRenewHelper } from './core/services/loan-renew-helper.js';
 
+import './core/config/ia-lending-intervals.js';
+import * as Cookies from './core/services/doc-cookies.js';
+
 export const events = {
   browseExpired: 'IABookReader:BrowsingHasExpired',
 };
@@ -236,16 +238,10 @@ export default class IABookActions extends LitElement {
     /**
      * tokenPoller determines if user has loan token for this book
      * - if book is going to renew, need to wait until renew is completed
-     * - otherwise execute immediately
      */
-    setTimeout(
-      () => {
-        this.startLoanTokenPoller();
-      },
-
-      // if book is renew while reading, let's wait to execute create-token api
-      this.loanRenewResult.renewNow ? this.tokenDelay * 1000 : 100
-    );
+    setTimeout(() => {
+      if (!hasExpired) this.startLoanTokenPoller();
+    }, 100);
   }
 
   /**
@@ -260,12 +256,12 @@ export default class IABookActions extends LitElement {
      * dispatched this event from bookreader page changed
      */
     window.addEventListener('BookReader:userAction', () => {
+      this.suppressToast = true;
+      this.closeToastManager();
+
       if (this.borrowType === 'browsed') {
-        this.suppressToast = false;
         this.autoLoanRenewChecker(true);
       }
-
-      return nothing;
     });
 
     /**
@@ -320,6 +316,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 +335,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;
@@ -402,6 +405,9 @@ export default class IABookActions extends LitElement {
     await this.localCache.delete(`${this.identifier}-loanTime`);
     await this.localCache.delete(`${this.identifier}-pageChangedTime`);
 
+    // remove loan-renew-count-<identifier> cookie
+    Cookies.removeItem(`loan-renew-count-${this.identifier}`);
+
     // show message after browsed book is expired.
     this.loanRenewResult.renewNow = false;
     this.loanRenewResult.texts =
@@ -484,7 +490,8 @@ export default class IABookActions extends LitElement {
         .loanTotalTime=${this.loanRenewTimeConfig.loanTotalTime}
         ?hasAdminAccess=${this.hasAdminAccess}
         ?disabled=${this.disableActionGroup}
-        ?renewNow=${this.loanRenewResult.renewNow}
+        ?autoRenew=${this.loanRenewResult.renewNow}
+        ?autoReturn=${this.lendingStatus.browsingExpired}
         @loanAutoRenewed=${this.handleLoanAutoRenewed}
         @lendingActionError=${this.handleLendingActionError}
         @toggleActionGroup=${this.handleToggleActionGroup}
@@ -573,8 +580,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 +588,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 +624,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>