@internetarchive/ia-book-actions 0.0.29-alpha35 → 0.0.29-alpha37

package/demo/index.html

@@ -72,6 +72,10 @@
       margin: 2px;
     }
 
+    fieldset {
+      display: inline-grid;
+    }
+
     body.modal-manager-open {
       overflow: hidden;
     }
@@ -129,10 +133,10 @@
 
     let isDevBox = true;
     iaBookActions.loanRenewConfig = {
-      totalTime: isDevBox ? 120 : 3600, // 60 second = 1 min
-      autoCheckAt: isDevBox ? 115 : 3540, // at last 10th minute
-      pageChangedInLast: isDevBox ? 80 : 900, // within last 15 second/minute
-      env: isDevBox ? 'dev' : 'prod',
+      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,
     };
 
     let lendingStatus1 = iaBookActions.lendingStatus;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "0.0.29-alpha35",
+  "version": "0.0.29-alpha37",
   "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() {
@@ -32,32 +33,33 @@ export default class TimerCountdown extends LitElement {
     // execute interval in each second in-case of dev environment
     this.timerInterval = setInterval(
       () => {
-        this.timeLeftOnLoan -= this.loanRenewConfig.env === 'dev' ? 1 : 60;
+        this.timeLeftOnLoan -= this.loanRenewConfig.isDevBox ? 1 : 60;
+        const timeLeft = Math.round(this.timeLeftOnLoan);
 
         // 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 (
-          Math.round(this.timeLeftOnLoan) <= this.loanRenewConfig.autoCheckAt
-        ) {
+        if (timeLeft <= this.loanRenewConfig.autoCheckAt) {
           this.dispatchEvent(
             new CustomEvent('IABookActions:loanRenew', {
               detail: {
                 hasPageChanged: false,
-                timeLeft: Math.round(this.timeLeftOnLoan),
+                timeLeft,
               },
               bubbles: true,
               composed: true,
             })
           );
         }
-        console.log(this.timeLeftOnLoan, this.loanRenewConfig.autoCheckAt)
-        // clear interval if timer is < this.loanRenewConfig.autoCheckAt
-        if (this.timeLeftOnLoan < this.loanRenewConfig.autoCheckAt) {
+
+        // clear interval
+        if (timeLeft <= 1) {
           clearInterval(this.timerInterval);
+          window?.Sentry?.captureMessage(sentryLogs.clearOneHourTimer);
+          console.log(sentryLogs.clearOneHourTimer);
         }
       },
-      this.loanRenewConfig.env === 'dev' ? 1000 : 60000
+      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';
 
@@ -103,12 +105,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 => {
@@ -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

@@ -27,7 +27,7 @@ export class LoanRenewHelper {
       if (this.hasPageChanged) {
         return this.pageChanged(); // user clicked on page
       }
-      return this.autoChecker(); // auto checker at 50th minute
+      return this.autoChecker(); // auto checker at last 10th minute
     } catch (error) {
       console.log(error);
     }
@@ -57,7 +57,7 @@ export class LoanRenewHelper {
     );
 
     // if user viewed new page in last 10 minutes, renew immediately
-    if (currentTime >= lastTimeFrame) {
+    if (lastTimeFrame !== null && currentTime >= lastTimeFrame) {
       this.result.texts = this.loanRenewMessage;
       this.result.renewNow = true;
       console.log('manually renewed by page click!');
@@ -68,33 +68,31 @@ export class LoanRenewHelper {
   }
 
   /**
-   * Trigger this function when countdown hits last 10 minutes
-   * - if user is open new page, just renew the loan at last 10th minute
+   * 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 currentTime = new Date();
     const { pageChangedInLast } = this.loanRenewConfig;
-    const lastPageFlipTime = await this.localCache.get(
+    const pageChangedTime = await this.localCache.get(
       `${this.identifier}-pageChangedTime`
     );
 
-    // last 15 min if used flipped a page.
-    const lastFlipTimeFrame = this.changeTime(
-      currentTime,
+    // in last 15 min if user make any activity.
+    const pageChangeTimeFrame = this.changeTime(
+      new Date(),
       pageChangedInLast,
       'sub'
     ); // 15 seconds
 
     if (
-      lastPageFlipTime === undefined ||
-      lastPageFlipTime <= lastFlipTimeFrame
+      pageChangedTime === undefined ||
+      pageChangedTime <= pageChangeTimeFrame
     ) {
       this.result.texts = this.loanReturnWarning;
       this.result.renewNow = false; // not viewed
-      // console.log('not viewed!');
-    } else if (lastPageFlipTime >= lastFlipTimeFrame) {
+    } else if (pageChangedTime >= pageChangeTimeFrame) {
       this.result.texts = '';
       this.result.renewNow = true; // viewed in last time frame
       console.log('silently renewed!');

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';
 
@@ -92,7 +93,7 @@ export default class IABookActions extends LitElement {
 
   disconnectedCallback() {
     this.tokenPoller.disconnectedInterval();
-    window?.Sentry?.captureMessage('disconnectedCallback');
+    window?.Sentry?.captureMessage(sentryLogs.disconnectedCallback);
     this.disconnectResizeObserver();
   }
 
@@ -184,9 +185,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 +196,8 @@ export default class IABookActions extends LitElement {
           composed: true,
         })
       );
+
+      // early return if book is already expired
       return;
     }
 
@@ -253,9 +254,17 @@ export default class IABookActions extends LitElement {
      */
     document.addEventListener('click', () => {
       if (this.loanRenewHelper && this.loanRenewResult.timeLeft > 0) {
-        console.log('1');
+        console.log('clicked-outside');
         this.suppressToast = true;
       }
+
+      // reload when user click on page after it EXPIRED
+      const hasExpired =
+        'browsingExpired' in this.lendingStatus &&
+        this.lendingStatus?.browsingExpired;
+      if (hasExpired) {
+        window.location?.reload();
+      }
     });
 
     /**
@@ -283,7 +292,6 @@ export default class IABookActions extends LitElement {
     );
 
     await this.loanRenewHelper.handleLoanRenew();
-    // console.log(this.loanRenewResult.timeLeft);
     this.loanRenewResult = this.loanRenewHelper.result;
   }
 
@@ -366,6 +374,9 @@ export default class IABookActions extends LitElement {
 
     this.suppressToast = false;
     this.showToastMessage();
+
+    window?.Sentry?.captureMessage(sentryLogs.browseHasExpired);
+    console.log(sentryLogs.browseHasExpired);
   }
 
   /**
@@ -463,7 +474,14 @@ export default class IABookActions extends LitElement {
       await this.showToastMessage();
       await this.browseHasRenew();
       await this.resetTimerCountState();
-      this.startLoanTokenPoller();
+
+      window?.Sentry?.captureMessage(`${sentryLogs.bookHasRenewed}`);
+
+      console.log(sentryLogs.bookHasRenewed, {
+        loanRenewResult: this.loanRenewResult,
+        browseHasRenew: this.lendingStatus.secondsLeftOnLoan,
+        resetTimerCountState: this._shadowRoot.querySelector('timer-countdown'),
+      });
     }
   }
 
@@ -472,7 +490,7 @@ export default class IABookActions extends LitElement {
    */
   startLoanTokenPoller() {
     if (this.tokenPoller) {
-      window?.Sentry?.captureMessage('startLoanTokenPoller clearing interval');
+      window?.Sentry?.captureMessage(sentryLogs.clearTokenPoller);
       this.tokenPoller.disconnectedInterval();
     }
     const successCallback = () => {
@@ -529,6 +547,20 @@ export default class IABookActions extends LitElement {
 
     if (errorMsg) this.showErrorModal(errorMsg, action);
 
+    // if error related to loan token
+    // - clear tokenPoller interval
+    // - set user_has_browsed to `false`
+    if (action === 'create_token') {
+      this.tokenPoller.disconnectedInterval();
+
+      const currStatus = {
+        ...this.lendingStatus,
+        user_has_browsed: false,
+        available_to_browse: true,
+      };
+      this.lendingStatus = currStatus;
+    }
+
     // update action bar state if book is not available to browse or borrow.
     if (errorMsg && errorMsg.match(/not available to borrow/gm)) {
       let currStatus = this.lendingStatus;
@@ -584,7 +616,8 @@ export default class IABookActions extends LitElement {
           href="mailto:info@archive.org?subject=Help: cannot access my borrowed book: ${this
             .identifier}"
           >info@archive.org</a
-        >`;
+        ><br /><br />
+        errorLog: ${errorMsg}`;
     }
 
     this.modal.showModal({