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

package/demo/index.html

@@ -72,6 +72,10 @@
       margin: 2px;
     }
 
+    fieldset {
+      display: inline-grid;
+    }
+
     body.modal-manager-open {
       overflow: hidden;
     }
@@ -129,9 +133,9 @@
 
     let isDevBox = true;
     iaBookActions.loanRenewConfig = {
-      totalTime: isDevBox ? 20 : 3600, // 60 second = 1 min
-      autoCheckAt: isDevBox ? 15 : 3540, // at last 10th minute
-      pageChangedInLast: isDevBox ? 80 : 900, // within last 15 second/minute
+      totalTime: isDevBox ? 10 : 3600, // 60 second = 1 min
+      autoCheckAt: isDevBox ? 5 : 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-alpha36",
+  "version": "0.0.29-alpha38",
   "description": "Bookreader actions for borrowable book",
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",

package/src/assets/data/lending-get-status-service.js

@@ -100,7 +100,7 @@ export const canBrowseAndBorrow = {
   // userid: "",
   bookUrl: '/details/practicalorganic00plim',
   daysLeftOnLoan: 0,
-  isAdmin: false,
+  isAdmin: true,
   isArchiveOrgLending: true,
   isAvailable: false,
   isAvailableForBrowsing: false,
@@ -118,7 +118,7 @@ export const canBrowseAndBorrow = {
   loanStartDate: '2021-07-30 09:57:40',
   loansUrl: '/details/@neeraj-archive?tab=loans#loans-on-loan',
   maxLoans: 10,
-  secondsLeftOnLoan: 12,
+  secondsLeftOnLoan: 3591,
   shouldProtectImages: true,
   totalWaitlistCount: 0,
   userHasBorrowed: false,

package/src/components/timer-countdown.js

@@ -1,4 +1,5 @@
 import { html, css, LitElement } from 'lit';
+import { sentryLogs } from '../core/config/sentry-events.js';
 
 export default class TimerCountdown extends LitElement {
   static get properties() {
@@ -38,14 +39,12 @@ export default class TimerCountdown extends LitElement {
         // execute from last 10th minute to 0th minute
         // - 10th - to check if user has viewed
         // - till 0th - to show warning msg with remaining time to auto returned
-        if (
-          timeLeft <= this.loanRenewConfig.autoCheckAt
-        ) {
+        if (timeLeft <= this.loanRenewConfig.autoCheckAt) {
           this.dispatchEvent(
             new CustomEvent('IABookActions:loanRenew', {
               detail: {
                 hasPageChanged: false,
-                timeLeft: timeLeft,
+                timeLeft,
               },
               bubbles: true,
               composed: true,
@@ -55,8 +54,9 @@ export default class TimerCountdown extends LitElement {
 
         // clear interval
         if (timeLeft <= 1) {
-          // clearInterval(this.timerInterval);
-          console.log('cleared timer interval');
+          clearInterval(this.timerInterval);
+          window?.Sentry?.captureMessage(sentryLogs.clearOneHourTimer);
+          console.log(sentryLogs.clearOneHourTimer);
         }
       },
       this.loanRenewConfig.isDevBox ? 1000 : 60000

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

@@ -0,0 +1,20 @@
+/**
+ * Analytics categories and events. Used when building actions in
+ */
+export const sentryLogs = {
+  disconnectedCallback: 'IABookActions:disconnectedCallback',
+  bookHasRenewed:
+    'IABookActions:handleLoanAutoRenewed - book has renewed for next one hour',
+  browseHasExpired:
+    'IABookActions:browseHasExpired - one-hour loan has been expired',
+  bookWasExpired:
+    'IABookActions:setupLendingToolbarActions - book was expired at intial, no tokenPoller',
+  clearTokenPoller:
+    'IABookActions:startLoanTokenPoller - clearing token poller interval',
+  clearOneHourTimer:
+    'IABookActions:timerCountdown - one-hour timer interval cleared',
+  enableBookAccess: 'IABookActions:enableBookAccess',
+  handleLoanTokenPoller: 'IABookActions:handleLoanTokenPoller',
+  setConsecutiveLoanCounts: 'IABookActions:setConsecutiveLoanCounts',
+  actionsHandlerService: 'IABookActions:actionsHandlerService',
+};

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

@@ -1,4 +1,5 @@
 /* eslint-disable */
+import { sentryLogs } from '../../config/sentry-events.js';
 
 /**
  * Helper to call loan service
@@ -64,7 +65,9 @@ export default async function ActionsHandlerService(options) {
           option?.error(data);
         }
       });
-  } catch (err) {
-    window?.Sentry?.captureException(err);
+  } catch (error) {
+    window?.Sentry?.captureException(
+      `${sentryLogs.actionsHandlerService} - Error: ${error}`
+    );
   }
 }

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

@@ -1,6 +1,8 @@
 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 * as Cookies from '../doc-cookies.js';
 
@@ -283,7 +285,9 @@ export default class ActionsHandler extends LitElement {
       // set new value
       Cookies.setItem(storageKey, newCount, date, '/');
     } catch (error) {
-      window?.Sentry?.captureException(error);
+      window?.Sentry?.captureException(
+        `${sentryLogs.setConsecutiveLoanCounts} - Error: ${error}`
+      );
       this.sendEvent('Cookies-Error-Actions', error);
     }
   }

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

@@ -26,9 +26,8 @@ export class LoanRenewHelper {
     try {
       if (this.hasPageChanged) {
         return this.pageChanged(); // user clicked on page
-      } else {
-        return this.autoChecker(); // auto checker at last 10th minute
       }
+      return this.autoChecker(); // auto checker at last 10th minute
     } catch (error) {
       console.log(error);
     }

package/src/core/services/loan-token-poller.js

@@ -1,4 +1,6 @@
 import ActionsHandlerService from './actions-handler/actions-handler-service.js';
+import { sentryLogs } from '../config/sentry-events.js';
+
 import * as Cookies from './doc-cookies.js';
 
 /**
@@ -43,7 +45,9 @@ export class LoanTokenPoller {
           );
           consecutiveLoanCounts = existingCount ?? 1;
         } catch (error) {
-          window?.Sentry?.captureException(error);
+          window?.Sentry?.captureException(
+            `${sentryLogs.enableBookAcces} - CookieError: ${error}`
+          );
           this.sendEvent('Cookies-Error-Token', error);
         }
       }
@@ -68,7 +72,10 @@ export class LoanTokenPoller {
 
       this.sendEvent(category, action);
     } else {
-      window?.Sentry?.captureMessage('enableBookAccess error');
+      window?.Sentry?.captureMessage(
+        `${sentryLogs.enableBookAccess} - not borrowed`
+      );
+
       // if book is not browsed, just clear token polling interval
       this.disconnectedInterval(); // stop token fetch api
     }
@@ -88,12 +95,14 @@ export class LoanTokenPoller {
       identifier: this.identifier,
       action,
       error: data => {
-        window?.Sentry?.captureMessage(
-          'handleLoanTokenPoller error',
-          JSON.stringify(data)
-        );
         this.disconnectedInterval(); // stop token fetch api
         this.errorCallback({ detail: { action, data } });
+
+        // send error to Sentry
+        window?.Sentry?.captureMessage(
+          `${sentryLogs.handleLoanTokenPoller} - Error: ${JSON.stringify(data)}`
+        );
+
         // send LendingServiceError to GA
         this.sendEvent('LendingServiceLoanError', action);
       },

package/src/ia-book-actions.js

@@ -14,6 +14,7 @@ import './components/timer-countdown.js';
 
 import { GetLendingActions } from './core/services/get-lending-actions.js';
 import { mobileContainerWidth } from './core/config/constants.js';
+import { sentryLogs } from './core/config/sentry-events.js';
 import { LoanTokenPoller } from './core/services/loan-token-poller.js';
 import { LoanRenewHelper } from './core/services/loan-renew-helper.js';
 
@@ -71,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,
@@ -91,8 +99,8 @@ export default class IABookActions extends LitElement {
   }
 
   disconnectedCallback() {
-    this.tokenPoller.disconnectedInterval();
-    window?.Sentry?.captureMessage('disconnectedCallback');
+    this.tokenPoller?.disconnectedInterval();
+    window?.Sentry?.captureMessage(sentryLogs.disconnectedCallback);
     this.disconnectResizeObserver();
   }
 
@@ -184,9 +192,7 @@ export default class IABookActions extends LitElement {
       this.lendingStatus?.browsingExpired;
     if (hasExpired) {
       if (!this.tokenPoller) {
-        window?.Sentry?.captureMessage(
-          'setupLendingToolbarActions hasExpired - no tokenPoller'
-        );
+        window?.Sentry?.captureMessage(sentryLogs.bookWasExpired);
       }
       this.tokenPoller?.disconnectedInterval();
       /** Global event - always fire */
@@ -197,6 +203,8 @@ export default class IABookActions extends LitElement {
           composed: true,
         })
       );
+
+      // early return if book is already expired
       return;
     }
 
@@ -251,11 +259,19 @@ 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 book-page and book is EXPIRED
+      const hasExpired =
+        'browsingExpired' in this.lendingStatus &&
+        this.lendingStatus?.browsingExpired;
+      if (hasExpired && e.target.nodeName !== 'IA-BOOK-ACTIONS') {
+        window.location?.reload();
+      }
     });
 
     /**
@@ -274,6 +290,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,
@@ -295,7 +316,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');
@@ -329,8 +352,7 @@ export default class IABookActions extends LitElement {
   }
 
   startBrowseTimer() {
-    clearTimeout(this.browserTimer);
-
+    clearTimeout(this.browseTimer);
     const {
       browsingExpired,
       user_has_browsed,
@@ -340,7 +362,7 @@ export default class IABookActions extends LitElement {
       return;
     }
 
-    this.browserTimer = setTimeout(() => {
+    this.browseTimer = setTimeout(() => {
       this.browseHasExpired();
     }, secondsLeftOnLoan * 1000);
   }
@@ -349,11 +371,11 @@ export default class IABookActions extends LitElement {
    * Execute when loan is expired
    */
   async browseHasExpired() {
-    clearTimeout(this.browserTimer);
-
     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`);
@@ -365,6 +387,9 @@ export default class IABookActions extends LitElement {
 
     this.suppressToast = false;
     this.showToastMessage();
+
+    window?.Sentry?.captureMessage(sentryLogs.browseHasExpired);
+    console.log(sentryLogs.browseHasExpired);
   }
 
   /**
@@ -456,12 +481,20 @@ export default class IABookActions extends LitElement {
    */
   async handleLoanAutoRenewed() {
     if (this.loanRenewResult.renewNow) {
-      this.tokenPoller.disconnectedInterval();
+      this.tokenPoller?.disconnectedInterval();
 
       this.suppressToast = false;
       await this.showToastMessage();
       await this.browseHasRenew();
       await this.resetTimerCountState();
+
+      window?.Sentry?.captureMessage(`${sentryLogs.bookHasRenewed}`);
+
+      console.log(sentryLogs.bookHasRenewed, {
+        loanRenewResult: this.loanRenewResult,
+        browseHasRenew: this.lendingStatus.secondsLeftOnLoan,
+        resetTimerCountState: this._shadowRoot.querySelector('timer-countdown'),
+      });
     }
   }
 
@@ -470,8 +503,8 @@ export default class IABookActions extends LitElement {
    */
   startLoanTokenPoller() {
     if (this.tokenPoller) {
-      window?.Sentry?.captureMessage('startLoanTokenPoller clearing interval');
-      this.tokenPoller.disconnectedInterval();
+      window?.Sentry?.captureMessage(sentryLogs.clearTokenPoller);
+      this.tokenPoller?.disconnectedInterval();
     }
     const successCallback = () => {
       this.lendingBarPostInit();
@@ -531,7 +564,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/ia-book-actions.test.js

@@ -230,9 +230,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 +253,63 @@ 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.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 () => {
@@ -276,9 +334,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;
@@ -327,3 +384,40 @@ describe('Shared Resize Observer', () => {
     expect(component.sharedObserver).to.not.be.undefined;
   });
 });
+
+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;
+
+    expect(addObserverSpy.callCount).to.equal(1);
+  });
+
+  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 component.updateComplete;
+    expect(component.sharedObserver).to.not.be.undefined;
+  });
+});