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

package/demo/index.html

@@ -133,8 +133,8 @@
 
     let isDevBox = true;
     iaBookActions.loanRenewConfig = {
-      totalTime: isDevBox ? 10 : 3600, // 60 second = 1 min
-      autoCheckAt: isDevBox ? 5 : 3540, // at last 10th minute
+      totalTime: isDevBox ? 13 : 3600, // 60 second = 1 min
+      autoCheckAt: isDevBox ? 10 : 3540, // at last 10th minute
       pageChangedInLast: isDevBox ? 5 : 900, // within last 15 second/minute
       isDevBox: isDevBox,
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "0.0.29-alpha38",
+  "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

@@ -220,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
@@ -228,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
@@ -371,11 +374,11 @@ export default class IABookActions extends LitElement {
    * Execute when loan is expired
    */
   async browseHasExpired() {
+    this.tokenPoller?.disconnectedInterval();
+
     const currStatus = { ...this.lendingStatus, browsingExpired: true };
     this.lendingStatus = currStatus;
 
-    this.tokenPoller?.disconnectedInterval();
-
     // remove respected key:value for loan-renew
     await this.localCache.delete(`${this.identifier}-loanTime`);
     await this.localCache.delete(`${this.identifier}-pageChangedTime`);

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}
@@ -264,54 +270,14 @@ describe('Browsing expired status', () => {
     // timer-countdown is gone now
     expect(el.shadowRoot.querySelector('timer-countdown')).to.be.null;
 
-    // book has been expired
+    //   // 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('Book is browsing and eligible to renew it', async () => {
-    const el = await fixture(
-      container({
-        userid: '@userid',
-        lendingStatus: {
-          is_lendable: true,
-          user_has_browsed: true,
-          browseHasExpired: false,
-          secondsLeftOnLoan: 1,
-        },
-      })
-    );
-
-    // timer-countdown is still active
-    // expect(el.shadowRoot.querySelector('timer-countdown')).to.not.be.null
-
-    // let eventReceived = false;
-    // const listener = () => {
-    //   eventReceived = true;
-    // };
-    // el.addEventListener('IABookReader:userAction', listener);
-
-    el.loanRenewResult = {
-      texts: 'book has been renewed',
-      renewNow: true,
-      timeLeft: 10,
-    };
-
-    await aTimeout(1500); // wait for 1.5 second
-    await el.updateComplete;
-
-    // // timer-countdown is gone now
-    // expect(el.shadowRoot.querySelector('timer-countdown')).to.not.be.null
-    // expect(el.shadowRoot.querySelector('toast-template')).to.not.be.null
-
-    expect(el.loanRenewResult.timeLeft).to.equal(10);
-    // // book has been expired
-    // 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 () => {
     const baseStatus = {
       is_lendable: true,
@@ -348,40 +314,47 @@ describe('Browsing expired status', () => {
   });
 });
 
-describe('Shared Resize Observer', () => {
-  it('can receive a Shared Resize Observer', async () => {
-    const sharedObserverStub = new SharedResizeObserver();
-    const addObserverSpy = Sinon.spy(sharedObserverStub, 'addObserver');
-    const component = await fixture(html` <ia-book-actions
-      .userid=${'@userid'}
-      .identifier=${'foo'}
-      .lendingStatus=${{
-        is_lendable: true,
-        user_has_browsed: true,
-        available_to_browse: true,
-        available_to_borrow: true,
-      }}
-      .sharedObserver=${sharedObserverStub}
-    ></ia-book-actions>`);
-    await component.updateComplete;
+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,
+        },
+      })
+    );
 
-    expect(addObserverSpy.callCount).to.equal(1);
-  });
+    el.loanRenewResult = {
+      texts: 'This book has been renewed for 1 hour.',
+      renewNow: true,
+      timeLeft: 10,
+    };
 
-  it('loads its own resize observer if it is not received', async () => {
-    const component = await fixture(html` <ia-book-actions
-      .userid=${'@userid'}
-      .identifier=${'foo'}
-      .lendingStatus=${{
-        is_lendable: true,
-        user_has_browsed: true,
-        available_to_browse: true,
-        available_to_borrow: true,
-      }}
-    ></ia-book-actions>`);
+    await localCache.set({
+      key: `${el.identifier}-loanTime`,
+      value: new Date(new Date().getTime() + 10 * 1000),
+      ttl: Number(10),
+    });
 
-    await component.updateComplete;
-    expect(component.sharedObserver).to.not.be.undefined;
+    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.'
+    );
   });
 });