@internetarchive/ia-book-actions 1.4.4-alpha5 → 1.4.4-alpha7

package/package.json

@@ -7,7 +7,7 @@
   },
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",
-  "version": "1.4.4-alpha5",
+  "version": "1.4.4-alpha7",
   "main": "index.js",
   "module": "index.js",
   "publishConfig": {

package/src/ia-book-actions.js

@@ -407,6 +407,16 @@ export default class IABookActions extends LitElement {
    * @param {Boolean} hasPageChanged
    */
   async autoLoanRenewChecker(hasPageChanged = false) {
+    // Guards against re-entrancy the same way autoRenewExpiredLoan() does.
+    // BookReader:userAction can fire several times in quick succession
+    // (e.g. a single scroll gesture), and this method has no debouncing of
+    // its own — without this guard, each event would spin up its own
+    // LoanRenewHelper concurrently, and whichever's async localCache reads
+    // resolve last would clobber this.loanRenewResult, potentially
+    // re-triggering the whole renew_loan/create_token flow while a
+    // renewal from an earlier event is already in flight or just landed.
+    if (this.loanRenewInProgress) return;
+
     this.loanRenewHelper = new LoanRenewHelper(
       hasPageChanged,
       this.identifier,
@@ -568,13 +578,14 @@ export default class IABookActions extends LitElement {
    * Show modal when the book can no longer be automatically renewed
    * because another patron has checked it out.
    */
-  async showLoanUnavailableModal() {
+  async showLoanUnavailableModal(errorMsg) {
     const config = new ModalConfig({
       headline: '',
       showCloseButton: false,
       closeOnBackdropClick: false,
       headerColor: '#d9534f',
       message:
+        errorMsg ||
         'Due to inactivity, this book was returned, and someone else has now borrowed it. Please try again later.',
     });
 
@@ -934,60 +945,60 @@ export default class IABookActions extends LitElement {
     const action = event?.detail?.action;
     const errorMsg = event?.detail?.data?.error;
 
-    // A create_token hiccup only affects BookReader's page-image access
-    // token — it says nothing about how much time is left on the loan
-    // itself, so it must not stop the reading countdown. Only clear the
-    // token poller so it can be retried. Every other action failure
-    // (renew_loan, browse_book, etc.) genuinely affects loan state, so it
-    // still clears everything as before.
     if (action === 'create_token') {
+      // A create_token hiccup only affects BookReader's page-image access
+      // token — it says nothing about how much time is left on the loan
+      // itself, so it must not stop the reading countdown. Only clear the
+      // token poller so it can be retried.
       window?.IALendingIntervals?.clearTokenPoller();
-    } else {
-      window?.IALendingIntervals?.clearAll();
-    }
 
-    if (action === 'renew_loan') {
+      // The loan itself is fine — just this token refresh failed — but
+      // the action bar must reflect that it isn't safely browsable right
+      // now rather than silently doing nothing.
+      this.lendingStatus = {
+        ...this.lendingStatus,
+        user_has_browsed: false,
+        available_to_browse: true,
+      };
+    } else if (action === 'renew_loan') {
+      window?.IALendingIntervals?.clearAll();
       this.loanRenewInProgress = false;
       this.recoveringFromLoanExpiry = false;
-    }
-
-    // For renew_loan failures after auto-renew, show the patron-facing message
-    if (
-      errorMsg &&
-      action === 'renew_loan' &&
-      errorMsg.match(/not available/)
-    ) {
-      this.showLoanUnavailableModal();
-    } else if (errorMsg && action !== 'create_token') {
-      this.showErrorModal(errorMsg, action);
-    }
 
-    // if error related to loan token
-    // - set user_has_browsed to `false`
-    if (action === 'create_token') {
-      const currStatus = {
+      // The loan was NOT actually renewed — reflect that immediately
+      // (show Borrow, and clear the stale timer value) instead of leaving
+      // the action bar showing "Return now" with a frozen countdown from
+      // before the failed attempt, which falsely implies the book is
+      // still actively being read.
+      this.lendingStatus = {
         ...this.lendingStatus,
         user_has_browsed: false,
         available_to_browse: true,
+        secondsLeftOnLoan: 0,
       };
-      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;
-      if (action === 'browse_book') {
-        currStatus = {
-          ...this.lendingStatus,
-          available_to_browse: false,
-        };
-      } else if (action === 'borrow_book') {
-        currStatus = {
-          ...this.lendingStatus,
-          available_to_borrow: false,
-        };
+      // Show the real error and refresh the page on dismissal (the
+      // modal's Okay button) so the client picks up whatever the server
+      // now authoritatively considers true — matching on "not available"
+      // to guess the reason was fragile since the server can return any
+      // message (e.g. a lending limit).
+      this.showLoanUnavailableModal(errorMsg);
+    } else {
+      // Every other action failure genuinely affects loan state.
+      window?.IALendingIntervals?.clearAll();
+
+      if (!errorMsg) return;
+
+      this.showErrorModal(errorMsg, action);
+
+      // update action bar state if book is not available to browse or borrow.
+      if (errorMsg.match(/not available to borrow/gm)) {
+        if (action === 'browse_book') {
+          this.lendingStatus = { ...this.lendingStatus, available_to_browse: false };
+        } else if (action === 'borrow_book') {
+          this.lendingStatus = { ...this.lendingStatus, available_to_borrow: false };
+        }
       }
-      this.lendingStatus = currStatus;
     }
   }
 

package/test/ia-book-actions.test.js

@@ -900,6 +900,45 @@ describe('BookReader:userAction race regression (WEBDEV-8322)', () => {
     expect(autoLoanRenewCheckerSpy.called).to.be.false;
     expect(el.loanRenewResult.renewNow).to.be.true;
   });
+
+  it('ignores repeated BookReader:userAction events firing in quick succession (e.g. from a scroll)', async () => {
+    // Regression: a single scroll gesture can fire BookReader:userAction
+    // several times in rapid succession. autoLoanRenewChecker() had no
+    // guard against concurrent/repeated invocation, unlike
+    // autoRenewExpiredLoan() — each event spun up its own LoanRenewHelper,
+    // racing to overwrite this.loanRenewResult and potentially
+    // re-triggering renew_loan/create_token while a prior call from an
+    // earlier event was still in flight or had just landed.
+    const baseStatus = {
+      is_lendable: true,
+      user_has_browsed: true,
+      browsingExpired: false,
+    };
+    const el = await fixture(
+      container({
+        userid: '@user1',
+        identifier: 'foobar',
+        lendingStatus: baseStatus,
+      })
+    );
+    await el.updateComplete;
+    expect(el.borrowType).to.equal('browsed');
+
+    el.loanRenewInProgress = true;
+
+    const loanRenewHelperSpy = Sinon.spy(el, 'autoLoanRenewChecker');
+
+    // Simulate a scroll firing the event several times back to back.
+    window.dispatchEvent(new CustomEvent('BookReader:userAction'));
+    window.dispatchEvent(new CustomEvent('BookReader:userAction'));
+    window.dispatchEvent(new CustomEvent('BookReader:userAction'));
+    await aTimeout(50);
+
+    // The method is still called each time (the guard is inside it), but
+    // must no-op instead of spinning up a new LoanRenewHelper each time.
+    expect(loanRenewHelperSpy.callCount).to.equal(3);
+    expect(el.loanRenewHelper).to.be.undefined;
+  });
 });
 
 describe('handleLendingActionError - loanRenewInProgress reset', () => {
@@ -978,6 +1017,110 @@ describe('handleLendingActionError - create_token failures must not stop the cou
 
     expect(window.IALendingIntervals.timerCountdown).to.equal(0);
   });
+
+  it('shows the same unavailable-modal-and-refresh path for any renew_loan failure, regardless of message text', async () => {
+    // Regression: branching on errorMsg.match(/not available/) to decide
+    // how to recover was fragile — the server can return any message
+    // (e.g. a lending limit hit), and guessing which lendingStatus fields
+    // are now accurate client-side is error-prone. Every renew_loan
+    // failure now shows the real error and refreshes the page on
+    // dismissal (showLoanUnavailableModal's Okay button), rather than
+    // trying to patch up state without reloading from the server.
+    const el = await fixture(
+      container({
+        userid: '@user1',
+        identifier: 'foobar',
+        lendingStatus: {
+          is_lendable: true,
+          user_has_browsed: true,
+          browsingExpired: false,
+          available_to_browse: false,
+          secondsLeftOnLoan: 100,
+        },
+      })
+    );
+    await el.updateComplete;
+
+    const showUnavailableSpy = Sinon.spy(el, 'showLoanUnavailableModal');
+    const lendingLimitMsg =
+      'Your account has hit a lending limit. Please try again later or contact info@archive.org.';
+
+    el.handleLendingActionError({
+      detail: {
+        action: 'renew_loan',
+        data: { error: lendingLimitMsg },
+      },
+    });
+    await el.updateComplete;
+
+    expect(showUnavailableSpy.calledOnceWith(lendingLimitMsg)).to.be.true;
+  });
+
+  it('updates lendingStatus immediately on a renew_loan failure — Borrow state, timer cleared', async () => {
+    // The modal's Okay button refreshes the page, but that shouldn't be
+    // the only thing correcting the UI — while the modal is still open,
+    // the action bar must already show Borrow instead of "Return now"
+    // with a stale countdown value from before the failed renewal.
+    const el = await fixture(
+      container({
+        userid: '@user1',
+        identifier: 'foobar',
+        lendingStatus: {
+          is_lendable: true,
+          user_has_browsed: true,
+          browsingExpired: false,
+          available_to_browse: false,
+          secondsLeftOnLoan: 100,
+        },
+      })
+    );
+    await el.updateComplete;
+
+    el.handleLendingActionError({
+      detail: {
+        action: 'renew_loan',
+        data: {
+          error:
+            'Your account has hit a lending limit. Please try again later or contact info@archive.org.',
+        },
+      },
+    });
+    await el.updateComplete;
+
+    expect(el.lendingStatus.user_has_browsed).to.be.false;
+    expect(el.lendingStatus.available_to_browse).to.be.true;
+    expect(el.lendingStatus.secondsLeftOnLoan).to.equal(0);
+    expect(el.primaryActions[0].text).to.not.equal('Return now');
+  });
+
+  it('also shows the unavailable modal for the "not available" message, with its own text', async () => {
+    const el = await fixture(
+      container({
+        userid: '@user1',
+        identifier: 'foobar',
+        lendingStatus: {
+          is_lendable: true,
+          user_has_browsed: true,
+          browsingExpired: false,
+          secondsLeftOnLoan: 100,
+        },
+      })
+    );
+    await el.updateComplete;
+
+    const showUnavailableSpy = Sinon.spy(el, 'showLoanUnavailableModal');
+    const notAvailableMsg = 'This book is not available to borrow at this time.';
+
+    el.handleLendingActionError({
+      detail: {
+        action: 'renew_loan',
+        data: { error: notAvailableMsg },
+      },
+    });
+    await el.updateComplete;
+
+    expect(showUnavailableSpy.calledOnceWith(notAvailableMsg)).to.be.true;
+  });
 });
 
 describe('showWarningModal', () => {