@internetarchive/ia-book-actions 0.0.29-alpha37 → 0.0.29-alpha39

package/package.json

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

package/src/ia-book-actions.js

@@ -72,15 +72,22 @@ export default class IABookActions extends LitElement {
     this.borrowType = ''; // (browsed|borrowed)
     this.consecutiveLoanCounts = 1; // consecutive loan count
 
-    // loan auto renew
-    this.browserTimer = undefined;
+    /**
+     * contains loan renew time config
+     * - totalTime:- number of seconds a loan should last
+     * - autoCheckAt:- check for loan renew at last
+     * - pageChangedInLast: consider loan renew eligible in last
+     * - isDevBox:- it just for testing purpose
+     */
     this.loanRenewConfig = {};
     this.suppressToast = false;
+    this.browseTimer = undefined;
 
     /**
      * contains loan auto-renew response
      * - texts:- texts messages need to show in toast message
      * - renewNow:- key to determine if need to renew now
+     * - timeLeft:- number of seconds left in active loan
      */
     this.loanRenewResult = {
       texts: null,
@@ -92,7 +99,7 @@ export default class IABookActions extends LitElement {
   }
 
   disconnectedCallback() {
-    this.tokenPoller.disconnectedInterval();
+    this.tokenPoller?.disconnectedInterval();
     window?.Sentry?.captureMessage(sentryLogs.disconnectedCallback);
     this.disconnectResizeObserver();
   }
@@ -213,6 +220,13 @@ export default class IABookActions extends LitElement {
       return;
     }
 
+    // initial timer state for 1-hour loan
+    if (this.borrowType === 'browsed' && !this.loanRenewResult.renewNow) {
+      setTimeout(() => {
+        this.resetTimerCountState();
+      }, 100);
+    }
+
     /**
      * tokenPoller determines if user has loan token for this book
      * - if book is going to renew, need to wait until renew is completed
@@ -221,17 +235,13 @@ export default class IABookActions extends LitElement {
     setTimeout(
       () => {
         this.startLoanTokenPoller();
-
-        if (this.borrowType === 'browsed' && !this.loanRenewResult.renewNow) {
-          this.resetTimerCountState();
-        }
       },
       this.loanRenewResult.renewNow ? this.tokenDelay * 1000 : 100
     );
   }
 
   /**
-   * Bind 1 hour loan auto renew,
+   * Bind 1 hour loan auto renew event,
    * There are two events we want to use,
    * 1. BookReader:pageChanged - dispatched from bookreader side
    * 2. IABookActions:loanRenew - dispatched from timer-countdown component
@@ -252,17 +262,17 @@ export default class IABookActions extends LitElement {
     /**
      * Detech click-event on document to close toast-template
      */
-    document.addEventListener('click', () => {
+    document.addEventListener('click', e => {
       if (this.loanRenewHelper && this.loanRenewResult.timeLeft > 0) {
         console.log('clicked-outside');
         this.suppressToast = true;
       }
 
-      // reload when user click on page after it EXPIRED
+      // reload when user click on book-page and book is EXPIRED
       const hasExpired =
         'browsingExpired' in this.lendingStatus &&
         this.lendingStatus?.browsingExpired;
-      if (hasExpired) {
+      if (hasExpired && e.target.nodeName !== 'IA-BOOK-ACTIONS') {
         window.location?.reload();
       }
     });
@@ -283,6 +293,11 @@ export default class IABookActions extends LitElement {
     });
   }
 
+  /**
+   * To determine if need to be renewed browsed book
+   *
+   * @param {Boolean} hasPageChanged
+   */
   async autoLoanRenewChecker(hasPageChanged = false) {
     this.loanRenewHelper = new LoanRenewHelper(
       hasPageChanged,
@@ -304,7 +319,9 @@ export default class IABookActions extends LitElement {
   async showToastMessage() {
     if (this.suppressToast) return;
 
-    const iaBookActions = document.querySelector('ia-book-actions').shadowRoot;
+    const iaBookActions = document.querySelector('ia-book-actions')?.shadowRoot;
+    if (!iaBookActions) return;
+
     let toastTemplate = iaBookActions.querySelector('toast-template');
     if (!toastTemplate) {
       toastTemplate = document.createElement('toast-template');
@@ -338,8 +355,7 @@ export default class IABookActions extends LitElement {
   }
 
   startBrowseTimer() {
-    clearTimeout(this.browserTimer);
-
+    clearTimeout(this.browseTimer);
     const {
       browsingExpired,
       user_has_browsed,
@@ -349,7 +365,7 @@ export default class IABookActions extends LitElement {
       return;
     }
 
-    this.browserTimer = setTimeout(() => {
+    this.browseTimer = setTimeout(() => {
       this.browseHasExpired();
     }, secondsLeftOnLoan * 1000);
   }
@@ -358,7 +374,7 @@ export default class IABookActions extends LitElement {
    * Execute when loan is expired
    */
   async browseHasExpired() {
-    clearTimeout(this.browserTimer);
+    this.tokenPoller?.disconnectedInterval();
 
     const currStatus = { ...this.lendingStatus, browsingExpired: true };
     this.lendingStatus = currStatus;
@@ -468,7 +484,7 @@ export default class IABookActions extends LitElement {
    */
   async handleLoanAutoRenewed() {
     if (this.loanRenewResult.renewNow) {
-      this.tokenPoller.disconnectedInterval();
+      this.tokenPoller?.disconnectedInterval();
 
       this.suppressToast = false;
       await this.showToastMessage();
@@ -491,7 +507,7 @@ export default class IABookActions extends LitElement {
   startLoanTokenPoller() {
     if (this.tokenPoller) {
       window?.Sentry?.captureMessage(sentryLogs.clearTokenPoller);
-      this.tokenPoller.disconnectedInterval();
+      this.tokenPoller?.disconnectedInterval();
     }
     const successCallback = () => {
       this.lendingBarPostInit();
@@ -551,7 +567,7 @@ export default class IABookActions extends LitElement {
     // - clear tokenPoller interval
     // - set user_has_browsed to `false`
     if (action === 'create_token') {
-      this.tokenPoller.disconnectedInterval();
+      this.tokenPoller?.disconnectedInterval();
 
       const currStatus = {
         ...this.lendingStatus,

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

@@ -0,0 +1,47 @@
+import { html, fixture, expect, aTimeout } from '@open-wc/testing';
+import '../../src/components/timer-countdown.js';
+
+const container = ({ timeLeftOnLoan, loanRenewConfig } = {}) =>
+  html`<timer-countdown
+    .timeLeftOnLoan=${timeLeftOnLoan}
+    .loanRenewConfig=${loanRenewConfig}
+  ></timer-countdown>`;
+
+describe('<timer-countdown>', () => {
+  it('timer interval is undefined when loan is expired', async () => {
+    const el = await fixture(
+      container({
+        timeLeftOnLoan: 0, // in seconds
+        loanRenewConfig: {
+          totalTime: 14, // in seconds
+          autoCheckAt: 5, // in seconds
+          pageChangedInLast: 5, // in seconds
+          isDevBox: true,
+        },
+      })
+    );
+
+    await el.updateComplete;
+    expect(el.timerInterval).to.be.undefined;
+  });
+
+  it('timer interval is not undefined when loan is active', async () => {
+    const el = await fixture(
+      container({
+        timeLeftOnLoan: 2, // in seconds
+        loanRenewConfig: {
+          totalTime: 14, // in seconds
+          autoCheckAt: 5, // in seconds
+          pageChangedInLast: 5, // in seconds
+          isDevBox: true,
+        },
+      })
+    );
+
+    await aTimeout(1900);
+    await el.updateComplete;
+
+    expect(el.timeLeftOnLoan).to.equal(1);
+    expect(el.timerInterval).to.not.be.undefined;
+  });
+});

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

@@ -0,0 +1,85 @@
+import { expect, aTimeout } from '@open-wc/testing';
+
+import { LocalCache } from '@internetarchive/local-cache';
+import { LoanRenewHelper } from '../../../src/core/services/loan-renew-helper.js';
+
+const identifier = 'booBar';
+const loanRenewConfig = {
+  totalTime: 13,
+  autoCheckAt: 10,
+  pageChangedInLast: 12,
+  isDevBox: true,
+};
+
+// localCache used for auto-loan-renew
+const localCache = new LocalCache({
+  namespace: 'loanRenew',
+});
+
+beforeEach(async () => {
+  await localCache.set({
+    key: `${identifier}-loanTime`,
+    value: new Date(new Date().getTime() + loanRenewConfig.totalTime * 1000),
+    ttl: Number(loanRenewConfig.totalTime),
+  });
+});
+
+describe('Loan Renew Determine', () => {
+  it('flip book page while reading a book', async () => {
+    await aTimeout(1500);
+
+    await localCache.set({
+      key: `${identifier}-pageChangedTime`,
+      value: new Date(), // current time
+      ttl: Number(loanRenewConfig.totalTime),
+    });
+
+    const loanRenewHelper = new LoanRenewHelper(
+      true, // hasPageChanged
+      identifier,
+      localCache,
+      loanRenewConfig
+    );
+    await loanRenewHelper.handleLoanRenew();
+
+    expect(loanRenewHelper.result.renewNow).to.be.false;
+  });
+
+  it('auto renewed book when user is currently reading', async () => {
+    await localCache.set({
+      key: `${identifier}-pageChangedTime`,
+      value: new Date(), // current time
+      ttl: Number(loanRenewConfig.totalTime),
+    });
+
+    await aTimeout(1500);
+
+    const loanRenewHelper = new LoanRenewHelper(
+      false, // timer-countdown event
+      identifier,
+      localCache,
+      loanRenewConfig
+    );
+    await loanRenewHelper.handleLoanRenew();
+
+    expect(loanRenewHelper.result.renewNow).to.be.true;
+  });
+
+  it('get toast message template', async () => {
+    const loanRenewHelper = new LoanRenewHelper(
+      false,
+      identifier,
+      localCache,
+      loanRenewConfig
+    );
+
+    const toastMsg = loanRenewHelper.getMessageTexts(
+      loanRenewHelper.loanReturnWarning,
+      '65'
+    );
+
+    expect(toastMsg).to.be.equal(
+      'This book will be automatically returned in 1 minute unless you turn a page.'
+    );
+  });
+});

package/test/ia-book-actions.test.js

@@ -4,11 +4,17 @@ import '../src/ia-book-actions.js';
 import Sinon from 'sinon';
 
 import { SharedResizeObserver } from '@internetarchive/shared-resize-observer';
+import { LocalCache } from '@internetarchive/local-cache';
 
 afterEach(() => {
   Sinon.restore();
 });
 
+// localCache used for auto-loan-renew
+const localCache = new LocalCache({
+  namespace: 'loanRenew',
+});
+
 const container = ({ userid, identifier, lendingStatus = {} } = {}) =>
   html`<ia-book-actions
     .userid=${userid}
@@ -230,9 +236,14 @@ describe('Browsing expired status', () => {
         },
       })
     );
-    expect(el.primaryTitle).contains('Borrow ends at ');
+    expect(el.primaryTitle).contains('');
     expect(el.primaryActions[0].text).to.equal('Return now');
     expect(el.primaryActions[1].text).to.equal('Print Disability Access');
+
+    // default params of one-hour loan renew
+    expect(el.loanRenewResult.texts).to.equal(null);
+    expect(el.loanRenewResult.renewNow).to.equal(false);
+    expect(el.loanRenewResult.timeLeft).to.equal(0);
   });
 
   it('Book is browsing and going to expire after 1 second', async () => {
@@ -248,10 +259,23 @@ describe('Browsing expired status', () => {
       })
     );
 
+    // timer-countdown is still active
+    expect(el.shadowRoot.querySelector('timer-countdown')).to.not.be.null;
+
     await aTimeout(1500); // wait for 1.5 second
     await el.updateComplete;
 
     expect(el.primaryActions[0].text).to.equal('Borrow');
+
+    // timer-countdown is gone now
+    expect(el.shadowRoot.querySelector('timer-countdown')).to.be.null;
+
+    //   // book has been expired
+    expect(el.loanRenewResult.renewNow).to.equal(false);
+    expect(el.loanRenewResult.timeLeft).to.equal(0);
+    expect(el.loanRenewResult.texts).to.equal(
+      'This book has been automatically returned due to inactivity.'
+    );
   });
 
   it('Expiring book cancels interval & emits event', async () => {
@@ -276,9 +300,8 @@ describe('Browsing expired status', () => {
     el.lendingStatus = browsingStatus;
     await el.updateComplete;
 
-    expect(el.primaryTitle).contains('Borrow ends at ');
+    expect(el.primaryTitle).contains('');
     expect(el.primaryActions[0].text).to.equal('Return now');
-    expect(el.tokenPoller.loanTokenInterval).to.not.equal(undefined);
 
     const expiredStatus = { ...browsingStatus, browsingExpired: true };
     el.lendingStatus = expiredStatus;
@@ -291,6 +314,50 @@ describe('Browsing expired status', () => {
   });
 });
 
+describe('Auto renew one hour loan', () => {
+  it('Book is browsing and renewed it now', async () => {
+    const el = await fixture(
+      container({
+        userid: '@userid',
+        identifier: 'Foo',
+        lendingStatus: {
+          is_lendable: true,
+          user_has_browsed: true,
+          browseHasExpired: false,
+          secondsLeftOnLoan: 12,
+        },
+      })
+    );
+
+    el.loanRenewResult = {
+      texts: 'This book has been renewed for 1 hour.',
+      renewNow: true,
+      timeLeft: 10,
+    };
+
+    await localCache.set({
+      key: `${el.identifier}-loanTime`,
+      value: new Date(new Date().getTime() + 10 * 1000),
+      ttl: Number(10),
+    });
+
+    const myEvent = new CustomEvent('loanAutoRenewed');
+    el.addEventListener('loanAutoRenewed', () => {
+      el.handleLoanAutoRenewed();
+    });
+    el.dispatchEvent(myEvent);
+
+    await aTimeout(1500); // wait for 1.5 second
+    await el.updateComplete;
+
+    expect(el.loanRenewResult.timeLeft).to.equal(10);
+    expect(el.loanRenewResult.renewNow).to.equal(true);
+    expect(el.loanRenewResult.texts).to.equal(
+      'This book has been renewed for 1 hour.'
+    );
+  });
+});
+
 describe('Shared Resize Observer', () => {
   it('can receive a Shared Resize Observer', async () => {
     const sharedObserverStub = new SharedResizeObserver();