@internetarchive/ia-book-actions 0.0.29-alpha4 → 0.0.29-alpha40

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 = ({ secondsLeftOnLoan, loanRenewTimeConfig } = {}) =>
+  html`<timer-countdown
+    .secondsLeftOnLoan=${secondsLeftOnLoan}
+    .loanRenewTimeConfig=${loanRenewTimeConfig}
+  ></timer-countdown>`;
+
+describe('<timer-countdown>', () => {
+  it('timer interval is undefined when loan is expired', async () => {
+    const el = await fixture(
+      container({
+        secondsLeftOnLoan: 0, // in seconds
+        loanRenewTimeConfig: {
+          loanTotalTime: 14, // in seconds
+          loanRenewAtLast: 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({
+        secondsLeftOnLoan: 2, // in seconds
+        loanRenewTimeConfig: {
+          loanTotalTime: 14, // in seconds
+          loanRenewAtLast: 5, // in seconds
+          pageChangedInLast: 5, // in seconds
+          isDevBox: true,
+        },
+      })
+    );
+
+    await aTimeout(1900);
+    await el.updateComplete;
+
+    expect(el.secondsLeftOnLoan).to.equal(2);
+    expect(el.timerInterval).to.not.be.undefined;
+  });
+});

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

@@ -25,7 +25,7 @@ describe('Get Lending Actions', () => {
 
     expect(actions.primaryTitle).to.equal(bookTitles.available_1hr);
     expect(actions.primaryActions.length).to.equal(3);
-    expect(actions.primaryActions[0].text).to.equal('Borrow for 1 hour');
+    expect(actions.primaryActions[0].text).to.equal('Borrow');
     expect(actions.primaryActions[1].text).to.equal('Borrow for 14 days');
     expect(actions.secondaryActions[1].text).to.equal('Purchase at');
   });
@@ -111,7 +111,7 @@ describe('Get Lending Actions', () => {
         expect(actions.primaryTitle).to.equal(bookTitles.claim_waitlist);
         expect(actions.primaryActions.length).to.equal(3);
         expect(actions.primaryActions[0].text).to.equal('Borrow for 14 days');
-        expect(actions.primaryActions[1].text).to.equal('Borrow for 1 hour');
+        expect(actions.primaryActions[1].text).to.equal('Borrow');
         expect(actions.primaryActions[2].text).to.equal('Leave Waitlist');
         expect(spy.called).to.be.true;
       });
@@ -138,7 +138,7 @@ describe('Get Lending Actions', () => {
         expect(actions.primaryTitle).to.equal(bookTitles.on_waitlist);
         expect(actions.primaryActions.length).to.equal(2);
         expect(actions.primaryActions[0].text).to.equal('Leave Waitlist');
-        expect(actions.primaryActions[1].text).to.equal('Borrow for 1 hour');
+        expect(actions.primaryActions[1].text).to.equal('Borrow');
         expect(claimSpy.called).to.be.false;
         expect(waitlistSpy.called).to.be.true;
       });
@@ -162,7 +162,7 @@ describe('Get Lending Actions', () => {
         expect(actions.primaryTitle).to.equal(bookTitles.on_waitlist);
         expect(actions.primaryActions.length).to.equal(2);
         expect(actions.primaryActions[0].text).to.equal('Leave Waitlist');
-        expect(actions.primaryActions[1].text).to.equal('Borrow for 1 hour');
+        expect(actions.primaryActions[1].text).to.equal('Borrow');
         expect(waitlistSpy.called).to.be.true;
       });
     });

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

@@ -0,0 +1,87 @@
+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 loanRenewTimeConfig = {
+  loanTotalTime: 13,
+  loanRenewAtLast: 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() + loanRenewTimeConfig.loanTotalTime * 1000
+    ),
+    ttl: Number(loanRenewTimeConfig.loanTotalTime),
+  });
+});
+
+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(loanRenewTimeConfig.loanTotalTime),
+    });
+
+    const loanRenewHelper = new LoanRenewHelper(
+      true, // hasPageChanged
+      identifier,
+      localCache,
+      loanRenewTimeConfig
+    );
+    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(loanRenewTimeConfig.loanTotalTime),
+    });
+
+    await aTimeout(1500);
+
+    const loanRenewHelper = new LoanRenewHelper(
+      false, // timer-countdown event
+      identifier,
+      localCache,
+      loanRenewTimeConfig
+    );
+    await loanRenewHelper.handleLoanRenew();
+
+    expect(loanRenewHelper.result.renewNow).to.be.true;
+  });
+
+  it('get toast message template', async () => {
+    const loanRenewHelper = new LoanRenewHelper(
+      false,
+      identifier,
+      localCache,
+      loanRenewTimeConfig
+    );
+
+    const toastMsg = loanRenewHelper.getMessageTexts(
+      loanRenewHelper.loanReturnWarning,
+      '65' // in seconds
+    );
+
+    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}
@@ -81,7 +87,7 @@ describe('Primary Actions data', () => {
     );
     const expectedPrimaryActions = [
       {
-        text: 'Borrow for 1 hour',
+        text: 'Borrow', // changed from 'Borrow for 1 hour'
         callback: () => {},
         className: 'ia-button primary',
       },
@@ -161,7 +167,7 @@ describe('Borrow status actions', () => {
 
     // removed available_to_borrow from lending bar
     expect(el.lendingStatus.available_to_borrow).to.be.false;
-    expect(el.primaryActions[0].text).to.equal('Borrow for 1 hour');
+    expect(el.primaryActions[0].text).to.equal('Borrow');
   });
 
   it('Check action for borrowable book without user', async () => {
@@ -182,9 +188,7 @@ describe('Borrow status actions', () => {
       },
     ];
 
-    expect(el.primaryTitle).to.equal(
-      'Renewable every hour, pending availability.'
-    );
+    expect(el.primaryTitle).to.equal('');
     expect(el.primaryActions.length).to.equal(2);
     expect(el.primaryActions[0].text).to.equal('Log In and Borrow');
     expect(el.primaryActions[0].text).to.equal(expectedPrimaryActions[0].text);
@@ -232,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('');
+    expect(el.loanRenewResult.renewNow).to.equal(false);
+    expect(el.loanRenewResult.secondsLeft).to.equal(0);
   });
 
   it('Book is browsing and going to expire after 1 second', async () => {
@@ -250,11 +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.primaryTitle).contains('Your loan has expired.');
-    expect(el.primaryActions[0].text).to.equal('Borrow again');
+    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.secondsLeft).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 () => {
@@ -279,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;
@@ -289,12 +309,55 @@ describe('Browsing expired status', () => {
     await aTimeout(1500); // wait for 1.5 sec
 
     expect(eventReceived).to.equal(true);
-    expect(el.primaryTitle).contains('Your loan has expired.');
-    expect(el.primaryActions[0].text).to.equal('Borrow again');
+    expect(el.primaryActions[0].text).to.equal('Borrow');
     expect(el.tokenPoller.loanTokenInterval).to.equal(undefined);
   });
 });
 
+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,
+      secondsLeft: 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.texts).to.equal(
+      'This book has been renewed for 1 hour.'
+    );
+    expect(el.loanRenewResult.renewNow).to.equal(true);
+    expect(el.loanRenewResult.secondsLeft).to.equal(10);
+  });
+});
+
 describe('Shared Resize Observer', () => {
   it('can receive a Shared Resize Observer', async () => {
     const sharedObserverStub = new SharedResizeObserver();

package/src/assets/styles/timer-countdown.js

@@ -1,58 +0,0 @@
-import { css } from 'lit';
-
-export default timerCountDownStyle = css`
-  :host {
-    right: 5px;
-    font-size: 14px;
-    position: absolute;
-  }
-  #countdown1 {
-    position: relative;
-    margin: auto;
-    margin-top: 100px;
-    height: 40px;
-    width: 40px;
-    text-align: center;
-  }
-  
-  #countdown-number {
-    color: white;
-    display: inline-block;
-    line-height: 40px;
-    margin-right: 12px;
-  }
-  
-  svg {
-    position: absolute;
-    top: 0;
-    right: 0;
-    width: 40px;
-    height: 40px;
-    transform: rotateY(-180deg) rotateZ(-90deg);
-  }
-  
-  svg circle {
-    stroke-dasharray: 113px;
-    stroke-dashoffset: 0px;
-    stroke-linecap: round;
-    stroke-width: 3px;
-    stroke: white;
-    fill: none;
-    animation: countdown 60s linear infinite forwards;
-  }
-  
-  @keyframes countdown {
-    from {
-      stroke-dashoffset: 0px;
-    }
-    to {
-      stroke-dashoffset: 113px;
-    }
-  }
-  .hidden {
-    display: none;
-  }
-  .visible {
-    display: inline-block;
-  }
-`;

package/src/components/toast-message.js

@@ -1,76 +0,0 @@
-import { html, css, LitElement, nothing } from 'lit';
-
-export class ToastMessage extends LitElement {
-  static get properties() {
-    return {
-      texts: { type: String },
-      dismisOnClick: { type: Boolean },
-      hideToast: { type: Boolean },
-    };
-  }
-
-  constructor() {
-    super();
-    this.texts = '';
-    this.textClass = '';
-    this.hideToast = false;
-  }
-
-  render() {
-    return !this.hideToast
-      ? html`
-          <span
-            class="toast-message fade-in ${this.textClass}"
-            title="Click/tap to close"
-            @click=${() => { this.dismisOnClick ? this.hideToast = true : nothing}}
-            >${this.texts}</span>
-        `
-      : nothing;
-  }
-
-  static get styles() {
-    const heightFromTop = css`var(--messageHeightFromTop, 15%)`;
-
-    return css`
-      :host {
-        display: inline-block;
-        
-      }
-      .toast-message {
-        z-index: 2;
-        position: absolute;
-        top: ${heightFromTop};
-        font-size: 1.4rem;
-        font-family: "Helvetica Neue";
-        color: #fff;
-        left: 50%;
-        background: #333;
-        border: 1px solid #fff;
-        border-radius: 5px;
-        box-shadow: 1px 1px 2px;
-        padding: 10px;
-        width: fit-content;
-        transform: translate(-50%, -50%);
-        cursor: pointer;
-        animation: fadeIn 5s;
-        @keyframes fadeIn {
-          0% {
-            opacity: 0;
-          }
-          100% {
-            opacity: 1;
-          }
-        }
-      }
-
-      .hidden {
-        display: none;
-      }
-      .visible {
-        display: inline-block;
-      }
-    `;
-  }
-}
-
-window.customElements.define('toast-message', ToastMessage);

package/src/core/services/one-hour-auto-renew.js

@@ -1,152 +0,0 @@
-import ActionsHandlerService from './actions-handler/actions-handler-service.js';
-
-/**
- * This class is used to determine if use is eligible for auto renew loan.
- *
- * ActionsHandlerService is a function being used to execute
- */
-export class OneHourAutoRenew {
-  constructor(pageClick, identifier, localCache, autoRenewConfig, userHasBrowsed) {
-    this.pageClick = pageClick;
-    this.identifier = identifier;
-    this.localCache = localCache;
-    this.autoRenewConfig = autoRenewConfig;
-    this.userHasBrowsed = userHasBrowsed;
-
-    // messages for auto return machenism
-    this.autoRenewMessage = 'This book has been renewed for another hour.';
-    this.autoReturnMessage = 'This book has been auto-returned due to inactivity.';
-    this.autoReturnWarning = 'This book will be auto-returned in 10 minutes unless you turn a page.';
-    
-    // private props
-    this.resultRes = {
-      toastTexts: this.autoReturnMessage,
-      hideToast: true,
-      renewNow: false,
-    };
-
-    return this.handleBookAutoRenew();
-  }
-
-  async handleBookAutoRenew() {
-    try {
-      // if page is not flipped in last 15 minutes,
-      // instantaly renew it if user viewed new page in last 10 minutes
-      if (this.pageClick) {
-        console.log('page flipped!')
-        this.setPageFlippedTime();
-        return this.userFlippedBookPage(); // user clicked on page
-      } else {
-        console.log('auto checker!')
-        return this.autoCheckerTimer(); // auto checker at 50th minute
-      }
-
-    } catch (error) {
-      console.log(error)
-    }
-  }
-
-  async setPageFlippedTime() {
-    // set pageFlipTime time in localStorage
-    await this.localCache.set({
-      key: `${this.identifier}-pageFlipTime`,
-      value: new Date(), // current time
-      ttl: parseInt(this.autoRenewConfig.totalTime),
-    })
-  }
-
-  async userFlippedBookPage() {
-    const {
-      totalTime, // 60
-      autoCheckAt, // 50
-    } = this.autoRenewConfig;
-    const currentDate = new Date();
-    const loanTime = await this.localCache.get(`${this.identifier}-loanTime`);
-
-    const lastTimeFrame = await this.changeTime(
-      loanTime,
-      totalTime - autoCheckAt,
-      'add'
-    ); // 50 seconds
-
-    if (currentDate >= lastTimeFrame) {
-      console.log('1 YES NOW BORROW IT AGAIN NOW!');
-      this.resultRes.toastTexts = this.autoRenewMessage;
-      this.resultRes.browseAgainNow = true;
-      this.resultRes.hideToast = false;
-      this.resultRes.renewNow = true;
-    }
-
-    return this.resultRes;
-  }
-
-  async autoCheckerTimer() {
-    const currentDate = new Date();
-    const { FlippedInLast } = this.autoRenewConfig;
-    const lastPageFlipTime = await this.localCache.get(`${this.identifier}-pageFlipTime`);
-
-    // last 15 min if used flipped a page.
-    const lastFlipTimeFrame = await this.changeTime(
-      currentDate,
-      FlippedInLast,
-      'sub'
-    ); // 15 seconds
-
-    if (lastPageFlipTime === undefined || lastPageFlipTime <= lastFlipTimeFrame) { // not viewed
-      console.log('2 not viewed, warning message!');
-      this.resultRes.toastTexts = this.autoReturnWarning;
-      this.resultRes.hideToast = false;
-    } else if (lastPageFlipTime >= lastFlipTimeFrame) { // viewed in last time frame
-      console.log('3 viewed, auto renew and message!');
-      this.resultRes.toastTexts = this.autoRenewMessage;
-      this.resultRes.browseAgainNow = true;
-      this.resultRes.hideToast = false;
-      this.resultRes.renewNow = true;
-
-      // delete pageFlipTime when book is auto renew at nth minute
-      await this.localCache.delete(`${this.identifier}-pageFlipTime`);
-    }
-
-    return this.resultRes;
-  }
-
-  async changeTime(date, minutes, op) {
-    if (date === undefined) return undefined;
-    
-    if (op === 'sub') {
-      return new Date(date.getTime() - minutes * 1000);
-    }
-
-    return new Date(date.getTime() + minutes * 1000);
-  }
-
-
-  sendEvent(eventCategory, eventAction) {
-    window?.archive_analytics?.send_event(
-      eventCategory,
-      eventAction,
-      `identifier=${this.identifier}`
-    );
-  }
-
-  async handleAutoRenew() {
-    const action = 'renew_loan';
-    ActionsHandlerService({
-      identifier: this.identifier,
-      action,
-      error: data => {
-        window?.Sentry?.captureMessage(
-          'handleAutoRenew error',
-          JSON.stringify(data)
-        );
-        // this.errorCallback({ detail: { action, data } });
-        // send LendingServiceError to GA
-        this.sendEvent('handleAutoRenew', action);
-      },
-      success: () => {
-        console.log('success!');
-        return 'success';
-      },
-    });
-  }
-}