@internetarchive/ia-book-actions 0.1.5-b2 → 0.1.6-a1

package/demo/index.html

@@ -131,11 +131,11 @@
     iaBookActions.returnUrl = '';
     iaBookActions.localCache = localCache;
 
-    let loanTotalTime2Min = { loanTotalTime: 10, loanRenewAtLast: 5, pageChangedInLast: 5 };
-    let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 280, pageChangedInLast: 15 };
-    let loanTotalTime1Hour = { loanTotalTime: 3600, loanRenewAtLast: 600, pageChangedInLast: 900 };
+    let loanTotalTime2Min = { loanTotalTime: 60, loanRenewAtLast: 51, pageChangedInLast: 15 };
+    let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 180, pageChangedInLast: 15 };
+    let loanTotalTime1Hour = { loanTotalTime: 3600, loanRenewAtLast: 660, pageChangedInLast: 900 };
 
-    iaBookActions.loanRenewTimeConfig = loanTotalTime5Min;
+    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.5-b2",
+  "version": "0.1.6-a1",
   "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,25 +72,16 @@ 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 },
-        },
+        detail: {},
       })
     );
   }

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/services/actions-handler/actions-handler.js

@@ -53,7 +53,7 @@ export default class ActionsHandler extends LitElement {
     });
 
     this.addEventListener('autoReturn', () => {
-      this.deleteLoanCookies();
+      this.handleReturnIt();
       this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'autoreturn');
     });
 
@@ -63,7 +63,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') {
@@ -154,16 +154,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/core/services/loan-analytics.js

@@ -144,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

@@ -126,13 +126,6 @@ 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/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) {
+      /**
+       * renew in 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();
       }
     });

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

@@ -2,7 +2,11 @@ import { html, fixture, expect, aTimeout } from '@open-wc/testing';
 import '../../src/ia-book-actions.js';
 import '../../src/components/timer-countdown.js';
 
-const container = ({ secondsLeftOnLoan, loanTotalTime, loanRenewAtLast } = {}) =>
+const container = ({
+  secondsLeftOnLoan,
+  loanTotalTime,
+  loanRenewAtLast,
+} = {}) =>
   html`<timer-countdown
     .secondsLeftOnLoan=${secondsLeftOnLoan}
     .loanTotalTime=${loanTotalTime}
@@ -20,7 +24,7 @@ describe('<timer-countdown>', () => {
     );
 
     await el.updateComplete;
-    // expect(el.timerCountdown).to.be.undefined;
+    // expect(window.IALendingIntervals.timerCountdown).to.be.undefined;
   });
 
   it('timer interval is not undefined when loan is active', async () => {
@@ -36,6 +40,6 @@ describe('<timer-countdown>', () => {
     await el.updateComplete;
 
     expect(el.secondsLeftOnLoan).to.equal(2);
-    // expect(el.timerInterval).to.not.be.undefined;
+    // expect(el.timerCountdown).to.not.be.undefined;
   });
 });

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

@@ -79,9 +79,8 @@ 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 1 minute unless you turn a page.'
+      'This book will be automatically returned in 2 minutes unless you turn a page.'
     );
   });
 });