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

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

@@ -1,7 +1,8 @@
 import { LitElement } from 'lit';
 
-import { LocalCache } from '@internetarchive/local-cache';
 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';
 
@@ -16,14 +17,12 @@ import * as Cookies from '../doc-cookies.js';
 export default class ActionsHandler extends LitElement {
   constructor() {
     super();
-    this.identifier = '';
-    this.ajaxTimeout = 6000;
-    this.returnUrl = '';
-    this.autoRenewConfig = {};
 
-    this.localCache = new LocalCache({
-      namespace: '1HourLoanStorage',
-    });
+    /**
+     * wait untill borrow is complete, then refresh the page
+     * @type {number}
+     */
+    this.waitUntillBorrowComplete = 6; // in seconds
 
     this.bindEvents();
   }
@@ -36,7 +35,7 @@ export default class ActionsHandler extends LitElement {
     );
   }
 
-  async bindEvents() {
+  bindEvents() {
     this.addEventListener('browseBook', ({ detail }) => {
       this.handleBrowseIt();
       this.setConsecutiveLoanCounts();
@@ -51,9 +50,8 @@ export default class ActionsHandler extends LitElement {
       this.sendEvent(category, action);
     });
 
-    this.addEventListener('autoBrowseBook', ({ detail }) => {
-      console.log('auto renew handlerExecuted!!');
-      this.handleAutoBrowseIt();
+    this.addEventListener('loanRenew', ({ detail }) => {
+      this.handleLoanRenew();
       const { category, action } = detail.event;
       this.sendEvent(category, action);
     });
@@ -112,12 +110,12 @@ export default class ActionsHandler extends LitElement {
   handleBrowseIt() {
     const action = 'browse_book';
     this.dispatchToggleActionGroup();
-    this.setBrowseTimeSession()
 
     ActionsHandlerService({
       action,
       identifier: this.identifier,
       success: () => {
+        this.setBrowseTimeSession();
         this.handleReadItNow();
       },
       error: data => {
@@ -126,25 +124,26 @@ export default class ActionsHandler extends LitElement {
     });
   }
 
-  handleAutoBrowseIt() {
+  handleLoanRenew() {
     const action = 'renew_loan';
-    this.setBrowseTimeSession()
 
     ActionsHandlerService({
       action,
       identifier: this.identifier,
-      success: () => {
-        console.log('success!');
+      success: data => {
+        this.setBrowseTimeSession();
+        this.dispatchEvent(
+          new CustomEvent('loanAutoRenewed', {
+            detail: { action, data },
+          })
+        );
       },
       error: data => {
-        console.log(data);
-        console.log('error!');
         this.dispatchActionError(action, data);
       },
     });
   }
 
-  
   handleReturnIt() {
     const action = 'return_loan';
     this.dispatchToggleActionGroup();
@@ -269,7 +268,7 @@ export default class ActionsHandler extends LitElement {
     // redirection on details page after 5 seconds because borrowing book takes time to create item creation.
     setTimeout(() => {
       URLHelper.goToUrl(redirectTo, true);
-    }, this.ajaxTimeout);
+    }, this.waitUntillBorrowComplete * 1000);
   }
 
   // save consecutive loan count for borrow
@@ -290,11 +289,36 @@ 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);
     }
   }
 
+  /**
+   * set browse time in indexedDB
+   */
+  async setBrowseTimeSession() {
+    try {
+      const expireDate = new Date(
+        new Date().getTime() + this.loanTotalTime * 1000
+      );
+
+      // set a value
+      await this.localCache.set({
+        key: `${this.identifier}-loanTime`,
+        value: expireDate,
+        ttl: Number(this.loanTotalTime),
+      });
+
+      // delete pageChangedTime when book is auto renew at nth minute
+      await this.localCache.delete(`${this.identifier}-pageChangedTime`);
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
   deleteLoanCookies() {
     const date = new Date();
     date.setTime(date.getTime() - 24 * 60 * 60 * 1000); // one day ago
@@ -314,17 +338,4 @@ export default class ActionsHandler extends LitElement {
       '.archive.org'
     );
   }
-
-  async setBrowseTimeSession() {
-    try {
-      // set a value
-      await this.localCache.set({
-        key: `${this.identifier}-loanTime`,
-        value: new Date(), // current time
-        ttl: parseInt(this.autoRenewConfig.totalTime),
-      })
-
-      await this.localCache.delete(`${this.identifier}-pageFlipTime`);
-    } catch (error) {}
-  }
 }

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

@@ -19,7 +19,7 @@ import ActionsConfig from './actions-config.js';
  *
  * Response of this class contain an object as follows:-
  * {
- *   primaryTitle: 'Renewable every hour, pending availability.',
+ *   primaryTitle: '',
  *   primaryActions: [this.actionsConfig.returnBookConfig()],
  *   primaryColor: 'primary',
  *   secondaryActions: [this.actionsConfig.purchaseConfig()],
@@ -40,7 +40,7 @@ import ActionsConfig from './actions-config.js';
  * @enum {string}
  */
 export const bookTitles = {
-  available_1hr: 'Renewable every hour, pending availability.',
+  available_1hr: '',
   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.',
@@ -49,7 +49,7 @@ export const bookTitles = {
   being_borrowed: 'Another patron is using this book. Please check back later.',
   eligible_pd: 'You are eligible for print-disabled access.',
   on_waitlist: 'You are on the waitlist for this book.',
-  session_expired: 'Your loan has expired.',
+  session_expired: '',
   unavailable: 'This book is not available at this time.',
 };
 
@@ -98,7 +98,7 @@ export class GetLendingActions {
     let isBrowsing =
       lendingStatus.user_has_browsed && !lendingStatus.browsingExpired;
     if (isBrowsing) {
-      primaryTitleText = this.getBrowseCountdownTitle();
+      primaryTitleText = '';
     } else {
       primaryTitleText = `Your loan of this book has ${lendingStatus.daysLeftOnLoan} days left.`;
     }
@@ -251,13 +251,6 @@ export class GetLendingActions {
   borrow1HrAction() {
     const lendingStatus = this.lendingStatus || {};
 
-    const possibleTitles = {
-      one_hour: 'Renewable every hour, pending availability.',
-      session_tryagain:
-        'Another patron is using this book. Please check back later.',
-      session_expired: 'Your loan has expired.',
-    };
-
     // assess borrowable state
     const browsingHasExpired =
       !lendingStatus.available_to_browse && lendingStatus.browsingExpired;
@@ -364,6 +357,8 @@ export class GetLendingActions {
   }
 
   /**
+   * @deprecated
+   *
    * Builds the countdown toolbar title.
    *
    * @return string innerHTML for the dialogOpts title attribute

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

@@ -0,0 +1,163 @@
+import { nothing } from 'lit';
+
+/**
+ * This class is used to determine if use is eligible for auto renew loan.
+ */
+export class LoanRenewHelper {
+  constructor(hasPageChanged, identifier, localCache, loanRenewTimeConfig) {
+    this.hasPageChanged = hasPageChanged;
+    this.identifier = identifier;
+    this.localCache = localCache;
+    this.loanRenewTimeConfig = loanRenewTimeConfig;
+
+    // messages for auto return machenism
+    this.loanRenewMessage = 'This book has been renewed for 1 hour.';
+    this.loanReturnWarning =
+      'This book will be automatically returned in #time #unitsOfTime unless you turn a page.';
+
+    // private props
+    this.result = {
+      texts: null,
+      renewNow: false,
+    };
+  }
+
+  handleLoanRenew() {
+    try {
+      if (this.hasPageChanged) {
+        return this.pageChanged(); // user clicked on page
+      }
+      return this.autoChecker(); // auto checker at last 10th minute
+    } catch (error) {
+      console.log(error);
+    }
+
+    return nothing;
+  }
+
+  /**
+   * Trigger this function when user has browsed a book and change the post
+   * - every time user change the page, we set current time in indexedDB
+   * - also check if need to auto renew current loan
+   *
+   * @returns {this.result}
+   */
+  async pageChanged() {
+    const {
+      loanTotalTime, // 60
+      loanRenewAtLast, // 50
+    } = this.loanRenewTimeConfig;
+    const currentTime = new Date();
+    const loanTime = await this.localCache.get(`${this.identifier}-loanTime`);
+
+    const lastTimeFrame = this.changeTime(
+      loanTime,
+      loanTotalTime - loanRenewAtLast,
+      'add'
+    );
+
+    // if user viewed new page in last 10 minutes, renew immediately
+    if (lastTimeFrame !== null && currentTime >= lastTimeFrame) {
+      this.result.texts = this.loanRenewMessage;
+      this.result.renewNow = true;
+      console.log('manually renewed by page click!');
+    }
+
+    this.setPageChangedTime();
+    return this.result;
+  }
+
+  /**
+   * Trigger this function when countdown hits at last 10th minute
+   * - if user is active, just renew the loan at last 10th minute
+   *
+   * @returns {this.result}
+   */
+  async autoChecker() {
+    const { pageChangedInLast } = this.loanRenewTimeConfig;
+    const pageChangedTime = await this.localCache.get(
+      `${this.identifier}-pageChangedTime`
+    );
+
+    // in last 15 min if user make any activity.
+    const pageChangeTimeFrame = this.changeTime(
+      new Date(),
+      pageChangedInLast,
+      'sub'
+    ); // 15 seconds
+
+    if (
+      pageChangedTime === undefined ||
+      pageChangedTime <= pageChangeTimeFrame
+    ) {
+      this.result.texts = this.loanReturnWarning;
+      this.result.renewNow = false; // not viewed
+    } else if (pageChangedTime >= pageChangeTimeFrame) {
+      this.result.texts = '';
+      this.result.renewNow = true; // viewed in last time frame
+      console.log('silently renewed!');
+    }
+
+    return this.result;
+  }
+
+  /**
+   * set current time in indexedDB when user viewed a new page
+   */
+  async setPageChangedTime() {
+    await this.localCache.set({
+      key: `${this.identifier}-pageChangedTime`,
+      value: new Date(), // current time
+      ttl: Number(this.loanRenewTimeConfig.loanTotalTime),
+    });
+  }
+
+  /**
+   * Texts we want to show in toast template including remaining time
+   * - eg. 1 minute, 50 seconds
+   *
+   * @param {String} texts
+   * @param {Number} time
+   *
+   * @returns {String} // texts will be appear in toast template
+   */
+  getMessageTexts(texts, time) {
+    let unitOfTime = 'second';
+
+    let toastTexts = texts;
+    let timeLeft = time;
+
+    if (timeLeft > 60) {
+      unitOfTime = 'minute';
+      timeLeft = Math.floor(timeLeft / 60);
+    }
+
+    // replace remaining time
+    toastTexts = toastTexts?.replace(/#time/, timeLeft);
+
+    // replace unitsOfTime eg second vs seconds / minute vs /minutes
+    return toastTexts?.replace(
+      /#unitsOfTime/,
+      timeLeft !== 1 ? `${unitOfTime}s` : unitOfTime
+    );
+  }
+
+  /**
+   * Helper function to get time difference
+   *
+   * @param {Date} date
+   * @param {Number} seconds
+   * @param {String} op - like sub, add, mul, sub
+   *
+   * @returns {Object} Date
+   */
+  changeTime(date, seconds, op) {
+    if (date === undefined) return null;
+
+    if (op === 'sub') {
+      return new Date(date.getTime() - seconds * 1000);
+    }
+
+    return new Date(date.getTime() + seconds * 1000);
+  }
+}

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';
 
 /**
@@ -12,10 +14,10 @@ export class LoanTokenPoller {
     this.borrowType = borrowType;
     this.successCallback = successCallback; // callback function to be called after loan token is created
     this.errorCallback = errorCallback; // callback function to be called after loan token is created
-    this.pollerDelay = pollerDelay; // value in ms (1000 ms = 1 sec)
+    this.pollerDelay = pollerDelay; // value in seconds
 
     this.loanTokenInterval = undefined;
-    this.enableBookAccess();
+    this.bookAccessed();
   }
 
   disconnectedInterval() {
@@ -31,7 +33,7 @@ export class LoanTokenPoller {
     // }
   }
 
-  async enableBookAccess() {
+  async bookAccessed() {
     let consecutiveLoanCounts = 1;
 
     if (this.borrowType) {
@@ -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);
         }
       }
@@ -57,7 +61,7 @@ export class LoanTokenPoller {
       if (this.borrowType !== 'adminBorrowed') {
         this.loanTokenInterval = setInterval(() => {
           this.handleLoanTokenPoller();
-        }, this.pollerDelay);
+        }, this.pollerDelay * 1000);
       }
 
       // event category and action for browsing book access
@@ -68,7 +72,10 @@ export class LoanTokenPoller {
 
       this.sendEvent(category, action);
     } else {
-      window?.Sentry?.captureMessage('enableBookAccess error');
+      window?.Sentry?.captureMessage(
+        `${sentryLogs.bookAccessed} - 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);
       },