@internetarchive/ia-book-actions 0.0.29-alpha50 → 0.0.29-alpha51

package/demo/index.html

@@ -131,13 +131,11 @@
     iaBookActions.returnUrl = 'https://openlibrary.org';
     iaBookActions.localCache = localCache;
 
-    let isDevBox = true;
-    iaBookActions.loanRenewTimeConfig = {
-      loanTotalTime: isDevBox ? 15 : 3600, // 60 second = 1 min
-      loanRenewAtLast: isDevBox ? 10 : 3540, // at last 10th minute
-      pageChangedInLast: isDevBox ? 5 : 900, // within last 15 second/minute
-      isDevBox: isDevBox,
-    };
+    let loanTotalTime2Min = { loanTotalTime: 20, loanRenewAtLast: 15, pageChangedInLast: 15 };
+    let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 180, pageChangedInLast: 15 };
+    let loanTotalTime1Hour = { loanTotalTime: 3600, loanRenewAtLast: 600, pageChangedInLast: 900 };
+
+    iaBookActions.loanRenewTimeConfig = loanTotalTime2Min;
 
     let lendingStatus1 = iaBookActions.lendingStatus;
     let secondsLeftOnLoan = iaBookActions.loanRenewTimeConfig.loanTotalTime;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "0.0.29-alpha50",
+  "version": "0.0.29-alpha51",
   "description": "Bookreader actions for borrowable book",
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",

package/src/components/timer-countdown.js

@@ -5,8 +5,8 @@ export default class TimerCountdown extends LitElement {
   static get properties() {
     return {
       secondsLeftOnLoan: { type: Number }, // in seconds
+      loanTotalTime: { type: Number }, // in seconds
       loanRenewAtLast: { type: Number }, // in seconds
-      isDevBox: { type: Boolean },
     };
   }
 
@@ -14,11 +14,17 @@ export default class TimerCountdown extends LitElement {
     super();
 
     /**
-     * seconds left in current time
+     * seconds left in current loan
      * @type {number}
      */
     this.secondsLeftOnLoan = 0;
 
+    /**
+     * total seconds a loan does have
+     * @type {number}
+     */
+    this.loanTotalTime = 0;
+
     /**
      * at the remaining time, we attempt to renew current loan
      * @type {number}
@@ -26,12 +32,16 @@ export default class TimerCountdown extends LitElement {
     this.loanRenewAtLast = 0;
 
     /**
-     * @type {boolean}
+     * setInterval executed interval
+     * @type {number}
      */
-    this.isDevBox = false;
-
-    // private props
     this.timerInterval = undefined;
+
+    /**
+     * delay seconds in setInterval function
+     * @type {number}
+     */
+    this.timerExecutionSeconds = 0;
   }
 
   disconnectedCallback() {
@@ -46,17 +56,22 @@ export default class TimerCountdown extends LitElement {
   }
 
   timerCountdown() {
-    // in-case of isDevBox, execute timer in each second instead of 60
-    const timerIntervalSeconds = this.isDevBox ? 1 : 60;
+    // Just a QA thing-
+    // if `this.loanTotalTime` less then 600 Seconds (10min)
+    // - let just execute setInterval in each second
+    // - otherwise execute in 60 seconds
+    const timerExecutionSeconds = this.loanTotalTime <= 600 ? 1 : 60;
 
     this.timerInterval = setInterval(() => {
-      // if this.isDevBox, just reduce seconds by 1 instead of 60 (1 min)
-      this.secondsLeftOnLoan -= timerIntervalSeconds;
+      this.secondsLeftOnLoan -= timerExecutionSeconds;
       const secondsLeft = Math.round(this.secondsLeftOnLoan);
 
-      // 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 expired
+      /**
+       * 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 expired
+       * @see IABookActions::bindLoanRenewEvents
+       */
       if (secondsLeft <= this.loanRenewAtLast) {
         this.dispatchEvent(
           new CustomEvent('IABookActions:loanRenew', {
@@ -75,7 +90,7 @@ export default class TimerCountdown extends LitElement {
         clearInterval(this.timerInterval);
         window?.Sentry?.captureMessage(sentryLogs.clearOneHourTimer);
       }
-    }, timerIntervalSeconds * 1000);
+    }, timerExecutionSeconds * 1000);
   }
 
   /**
@@ -88,7 +103,7 @@ export default class TimerCountdown extends LitElement {
     let unitOfTime = 'second';
     let timeLeft = Math.round(this.secondsLeftOnLoan);
 
-    if (this.isDevBox) {
+    if (this.loanTotalTime <= 600) {
       return `${timeLeft} seconds`;
     }
 

package/src/ia-book-actions.js

@@ -78,10 +78,9 @@ export default class IABookActions extends LitElement {
      * contains one hour auto-loan-renew time configuration
      *
      * @type {object} loanRenewTimeConfig
-     * @property {number} loanTotalTime - number of seconds a loan should last
+     * @property {number} loanTotalTime - total seconds a loan does have
      * @property {number} loanRenewAtLast - check for loan renew at last
      * @property {number} pageChangedInLast - consider loan renew eligible if viewed new page
-     * @property {boolean} isDevBox - testing flag
      */
     this.loanRenewTimeConfig = {};
 
@@ -452,8 +451,8 @@ export default class IABookActions extends LitElement {
     return this.borrowType === 'browsed'
       ? html`<timer-countdown
           .secondsLeftOnLoan=${Number(this.lendingStatus.secondsLeftOnLoan)}
+          .loanTotalTime=${this.loanRenewTimeConfig.loanTotalTime}
           .loanRenewAtLast=${this.loanRenewTimeConfig.loanRenewAtLast}
-          .isDevBox=${this.loanRenewTimeConfig.isDevBox}
         ></timer-countdown>`
       : nothing;
   }

package/test/components/timer-countdown.test.js

@@ -16,7 +16,6 @@ describe('<timer-countdown>', () => {
           loanTotalTime: 14, // in seconds
           loanRenewAtLast: 5, // in seconds
           pageChangedInLast: 5, // in seconds
-          isDevBox: true,
         },
       })
     );
@@ -33,7 +32,6 @@ describe('<timer-countdown>', () => {
           loanTotalTime: 14, // in seconds
           loanRenewAtLast: 5, // in seconds
           pageChangedInLast: 5, // in seconds
-          isDevBox: true,
         },
       })
     );

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

@@ -8,7 +8,6 @@ const loanRenewTimeConfig = {
   loanTotalTime: 13,
   loanRenewAtLast: 10,
   pageChangedInLast: 12,
-  isDevBox: true,
 };
 
 // localCache used for auto-loan-renew