@internetarchive/ia-book-actions 0.1.6 → 0.1.7

package/demo/index.html

@@ -131,9 +131,9 @@
     iaBookActions.returnUrl = '';
     iaBookActions.localCache = localCache;
 
-    let loanTotalTime2Min = { loanTotalTime: 10, loanRenewAtLast: 5, pageChangedInLast: 5 };
+    let loanTotalTime2Min = { loanTotalTime: 65, loanRenewAtLast: 60, pageChangedInLast: 15 };
     let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 180, pageChangedInLast: 15 };
-    let loanTotalTime1Hour = { loanTotalTime: 3600, loanRenewAtLast: 600, pageChangedInLast: 900 };
+    let loanTotalTime1Hour = { loanTotalTime: 3600, loanRenewAtLast: 660, pageChangedInLast: 900 };
 
     iaBookActions.loanRenewTimeConfig = loanTotalTime2Min;
 

package/package.json

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

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

@@ -9,10 +9,6 @@ import CollapsibleActionGroupStyle from '../assets/styles/collapsible-action-gro
 
 import { tabletContainerWidth } from '../core/config/constants.js';
 import { purchaseIcon } from '../assets/data/purchase.js';
-import {
-  analyticsCategories,
-  analyticsActions,
-} from '../core/config/analytics-event-and-category.js';
 import {
   dropdownOpened,
   dropdownClosed,
@@ -76,27 +72,14 @@ export class CollapsibleActionGroup extends ActionsHandler {
 
   /**
    * dispatch event when book is auto renewed / returned
-   * listen these events in action-handler.js
+   * listen these events in action-handler.js to execute ajax call on petabox.
    * @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(event, {
-        detail: {
-          event: { category, action },
-        },
-      })
-    );
+    this.dispatchEvent(new Event(event));
   }
 
   /**

package/src/components/timer-countdown.js

@@ -74,7 +74,7 @@ export default class TimerCountdown extends LitElement {
       secondsLeft -= this.timerExecutionSeconds;
       secondsLeft = Math.round(secondsLeft); // round number
 
-      // re-sync timer is gone off
+      // re-sync timer if gone off because of background window
       await this.reSyncTimerIfGoneOff(secondsLeft);
 
       /**

package/src/core/config/sentry-events.js

@@ -5,6 +5,7 @@ export const sentryLogs = {
   disconnectedCallback: 'IABookActions:disconnectedCallback',
   bookHasRenewed:
     'IABookActions:handleLoanAutoRenewed - book has renewed for next one hour',
+  bookRenewFailed: 'IABookActions:handleLoanRenewNow - failed to renew',
   browseHasExpired:
     'IABookActions:browseHasExpired - one-hour loan has been expired',
   bookWasExpired:

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

@@ -47,6 +47,12 @@ export default async function ActionsHandlerService(options) {
 
         // return success response for /demo/ server...
         if (baseHost == '/demo/1' || baseHost == '/demo/') {
+          if (option?.action == 'renew_loan') {
+            return {
+              success: true,
+              loan: { renewal: true },
+            };
+          }
           return {
             success: true,
             message: 'operation executed successfully!',

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

@@ -1,6 +1,7 @@
 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';
@@ -53,7 +54,7 @@ export default class ActionsHandler extends LitElement {
     });
 
     this.addEventListener('autoReturn', () => {
-      this.deleteLoanCookies();
+      this.handleReturnIt();
       this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'autoreturn');
     });
 
@@ -63,7 +64,7 @@ export default class ActionsHandler extends LitElement {
         this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'return');
       }
 
-      this.handleReturnIt();
+      this.handleReturnIt('returnNow');
 
       // send these events if 14-day borrow return
       if (detail?.borrowType === 'borrow') {
@@ -141,12 +142,18 @@ export default class ActionsHandler extends LitElement {
       action,
       identifier: this.identifier,
       success: data => {
-        this.setBrowseTimeSession();
-        this.dispatchEvent(
-          new CustomEvent('loanAutoRenewed', {
-            detail: { action, data },
-          })
-        );
+        if (data?.success === true && data?.loan?.renewal === true) {
+          this.setBrowseTimeSession();
+          this.dispatchEvent(
+            new CustomEvent('loanAutoRenewed', {
+              detail: { action, data },
+            })
+          );
+        } else {
+          window?.Sentry?.captureMessage(
+            `${sentryLogs.bookRenewFailed} - Error: ${JSON.stringify(data)}`
+          );
+        }
       },
       error: data => {
         this.dispatchActionError(action, data);
@@ -154,16 +161,23 @@ export default class ActionsHandler extends LitElement {
     });
   }
 
-  handleReturnIt() {
+  /**
+   * excute function when loan is returning
+   *
+   * @param {string} type - loan return type returnNow|''
+   */
+  handleReturnIt(type = '') {
     const action = 'return_loan';
-    this.dispatchToggleActionGroup();
+
+    if (type === 'returnNow') this.dispatchToggleActionGroup();
 
     ActionsHandlerService({
       action,
       identifier: this.identifier,
       success: () => {
         this.deleteLoanCookies();
-        URLHelper.goToUrl(this.returnUrl, true);
+
+        if (type === 'returnNow') URLHelper.goToUrl(this.returnUrl, true);
       },
       error: data => {
         this.dispatchActionError(action, data);

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

@@ -40,7 +40,7 @@ import ActionsConfig from './actions-config.js';
  * @enum {string}
  */
 export const bookTitles = {
-  available_1hr: '',
+  available_1hr: 'Renews each hour as long as pages are turned.',
   available_14d: 'This book can be borrowed for 14 days.',
   available_pd: 'Book available to patrons with print disabilities.',
   available_waitlist: 'A waitlist is available.',
@@ -98,7 +98,8 @@ export class GetLendingActions {
     let isBrowsing =
       lendingStatus.user_has_browsed && !lendingStatus.browsingExpired;
     if (isBrowsing) {
-      primaryTitleText = '';
+      primaryTitleText =
+        'Returns automatically after 25 minutes of inactivity.';
     } else {
       primaryTitleText = `Your loan of this book has ${lendingStatus.daysLeftOnLoan} days left.`;
     }

package/src/ia-book-actions.js

@@ -301,16 +301,28 @@ export default class IABookActions extends LitElement {
       console.log('** IABookActions:loanRenew', event.detail);
       await this.autoLoanRenewChecker(false);
 
-      // 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) {
+      /**
+       * auto-renew is not possible in last seconds (let say 50 second) because,
+       * 1. less time to execute ajax call
+       * 2. less time to write loan on datanodes
+       * 3. less time to load images by create_token api
+       * so if seconds left is < 50, just expire the loan
+       */
+      let secondsLeft = event?.detail?.secondsLeft;
+      if (secondsLeft < 50) {
         this.suppressAutoRenew = true;
+        this.browseHasExpired();
       }
 
       // show warning message with remaining time to auto returned it.
       if (this.loanRenewResult.renewNow === false) {
-        this.loanRenewResult.secondsLeft = event.detail.secondsLeft;
+        /**
+         * so compensate for the 50 second buffer to handle above race conditions
+         * let's reduce 1 min from warning texts and early return the book when 1 min left.
+         */
+        secondsLeft -= 60;
+
+        this.loanRenewResult.secondsLeft = secondsLeft;
         this.showToastMessage();
       }
     });
@@ -530,7 +542,6 @@ export default class IABookActions extends LitElement {
    * @param {object} event
    */
   async handleLoanAutoRenewed(event) {
-    // TODO: just read DATA variable here to apply security { action, data }
     if (this.loanRenewResult.renewNow) {
       window?.IALendingIntervals?.clearAll();
 
@@ -539,7 +550,7 @@ export default class IABookActions extends LitElement {
       await this.showToastMessage();
       await this.resetTimerCountState();
 
-      window?.Sentry?.captureMessage(`${sentryLogs.bookHasRenewed}`);
+      window?.Sentry?.captureMessage(sentryLogs.bookHasRenewed);
 
       // testing console....
       console.log('IABookActions: AutoRenewed:- ', {