@internetarchive/ia-book-actions 0.0.29 → 0.1.1

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

@@ -0,0 +1,156 @@
+/* eslint-disable class-methods-use-this */
+
+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 {
+      loanRenewAtLast, // 50
+    } = this.loanRenewTimeConfig;
+    const currentTime = new Date();
+    const loanTime = await this.localCache.get(`${this.identifier}-loanTime`);
+
+    const lastTimeFrame = this.changeTime(loanTime, loanRenewAtLast, 'sub');
+
+    // 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;
+    }
+
+    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
+    }
+
+    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, 2 minutes
+   *
+   * @param {String} texts
+   * @param {Number} secondsLeft
+   *
+   * @returns {String} // texts will be appear in toast template
+   */
+  getMessageTexts(texts, secondsLeft) {
+    const unitOfTime = 'minute';
+
+    let toastTexts = texts;
+    let timeLeft = secondsLeft;
+
+    // convert time from second to minute
+    timeLeft = Math.ceil(timeLeft / 60);
+
+    // replace #time variable with remaining time
+    toastTexts = toastTexts?.replace(/#time/, timeLeft);
+
+    // replace #unitsOfTime variable with minute/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);
       },