@internetarchive/ia-book-actions 1.4.4-alpha17 → 1.4.4-alpha19

package/package.json

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

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

@@ -106,9 +106,9 @@ export default async function ActionsHandlerService(options) {
 
     /**
      * Report it, don't just swallow it. A rejected fetch (offline, dropped
-     * connection) or a non-JSON body (a 405 returning HTML, which QA has
-     * been seeing) lands here, and calling neither `success` nor `error`
-     * leaves every caller waiting on a callback that never comes.
+     * connection) or a non-JSON body (a 405 returning HTML) lands here, and
+     * calling neither `success` nor `error` leaves every caller waiting on a
+     * callback that never comes.
      *
      * For renew_loan that's not merely a missing modal: IABookActions
      * clears its loanRenewInProgress guard from these callbacks, so a
@@ -117,5 +117,6 @@ export default async function ActionsHandlerService(options) {
      * connection is exactly when this fires.
      */
     log(`[IABookActions] ✗ ${option.action} threw`, error);
+    option?.error?.({ error: String(error) });
   }
 }

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

@@ -185,7 +185,7 @@ export default class ActionsHandler extends LitElement {
           log('RENEW_LOAN --- ', data, this.identifier);
           const activeLoan = data.loan ? data.loan : undefined;
           // Optional chaining: `data.loan` is genuinely absent on some
-          // failures, and reading `.renewal` off undefined threw here.
+          // failures, and `activeLoan` can be undefined here.
           const isRenewal = activeLoan?.renewal;
 
           if (activeLoan && isRenewal) {
@@ -210,11 +210,9 @@ export default class ActionsHandler extends LitElement {
               this.identifier
             );
 
-            // Dispatch the success outcome ONLY for a confirmed renewal.
-            // This used to fire on the failure path too, so a
-            // `{loan: {renewal: false}}` response reported an error AND a
-            // success: the error modal went up while handleLoanAutoRenewed
-            // simultaneously put a fresh countdown back on the bar.
+            // Dispatch the success outcome ONLY for a confirmed renewal —
+            // a `{loan: {renewal: false}}` response goes through
+            // dispatchActionError below instead, never both.
             this.dispatchEvent(
               new CustomEvent('loanAutoRenewed', {
                 detail: { action, data: { ...data, loan: activeLoan } },

package/src/core/services/loan-token-poller.js

@@ -26,11 +26,6 @@ export class LoanTokenPoller {
    *   attempt_to_renew_loan() already minted a valid access token as part
    *   of the renew_loan response itself — an immediate confirming
    *   create_token call is redundant.
-   * @param {Function} [options.onTokenRefreshed] - called after EVERY
-   *   successful create_token, initial or routine — unlike successCallback,
-   *   which only fires for the initial one. Lets the consumer retry any
-   *   page image that failed during a prior access gap, now that access is
-   *   confirmed good again.
    */
   constructor(options = {}) {
     const {
@@ -40,7 +35,6 @@ export class LoanTokenPoller {
       errorCallback,
       pollerDelay,
       skipInitialCall = false,
-      onTokenRefreshed,
     } = options;
 
     this.identifier = identifier;
@@ -49,7 +43,6 @@ export class LoanTokenPoller {
     this.errorCallback = errorCallback; // callback function to be called after loan token is created
     this.pollerDelay = pollerDelay; // value in seconds
     this.skipInitialCall = skipInitialCall === true;
-    this.onTokenRefreshed = onTokenRefreshed;
 
     this.loanTokenInterval = undefined;
 
@@ -118,7 +111,6 @@ export class LoanTokenPoller {
           identifier: this.identifier,
           isInitial,
         });
-        this.onTokenRefreshed?.();
         if (isInitial) this.successCallback();
       },
     });

package/src/ia-book-actions.js

@@ -767,10 +767,10 @@ export default class IABookActions extends LitElement {
       // triggered this renewal.
       this.skipNextInitialTokenCall = true;
 
-      // Retry any page image that failed during the gap this renewal just
-      // closed, right away rather than waiting for the next routine
-      // create_token tick (up to tokenDelay seconds away, now that the
-      // initial one above is skipped).
+      // A page image requested in the gap between expiry and this renewal
+      // landing can come back broken — browsers don't retry a failed <img>
+      // on their own. Retry once, right when access is confirmed good
+      // again, rather than leaving it broken until the patron reloads.
       this.reloadPageImages();
 
       if (this.recoveringFromLoanExpiry) {
@@ -946,13 +946,6 @@ export default class IABookActions extends LitElement {
     const errorCallback = eventObj => {
       this.handleLendingActionError(eventObj);
     };
-    // BookReader has no self-healing for a page <img> that failed while
-    // access was briefly invalid — retry any of those now that this
-    // create_token confirms access is good again, on every success, not
-    // just the initial one.
-    const onTokenRefreshed = () => {
-      this.reloadPageImages();
-    };
 
     // Tear down any previous poller first, so only one is ever controlling
     // window.IALendingIntervals.tokenPoller at a time.
@@ -964,7 +957,6 @@ export default class IABookActions extends LitElement {
       errorCallback,
       pollerDelay: this.tokenDelay, // in seconds
       skipInitialCall,
-      onTokenRefreshed,
     });
   }
 
@@ -989,7 +981,12 @@ export default class IABookActions extends LitElement {
     this.disableActionGroup = false;
 
     const action = event?.detail?.action;
-    const errorMsg = event?.detail?.data?.error;
+    // handleLoanRenewNow's failure path sets `.error` to a boolean flag and
+    // puts the real text in `.message` — only take `.error` when it's
+    // actually a string, or the modal renders the literal word "true".
+    const rawErrorMsg = event?.detail?.data?.error;
+    const errorMsg =
+      typeof rawErrorMsg === 'string' ? rawErrorMsg : undefined;
     const isInitial = event?.detail?.isInitial === true;
 
     log('[IABookActions] handleLendingActionError', {
@@ -1002,20 +999,14 @@ export default class IABookActions extends LitElement {
     });
 
     if (action === 'create_token') {
-      // Only the INITIAL token matters enough to interrupt the patron — a
-      // routine interval refresh stays silent; the pages already loaded
-      // are still served, and the next scheduled poll tries again on its
-      // own without any special retry.
-      if (!isInitial) {
-        log(
-          '[IABookActions] create_token failed on interval refresh — staying silent'
-        );
-        return;
-      }
-
-      // The book never opened, and we don't retry — reset the bar to
-      // Borrow and the timer to 0 rather than leaving a red "Return now"
-      // with a stale countdown for a session that isn't accessible.
+      // Any create_token failure — initial or a routine interval refresh —
+      // means access can no longer be confirmed (e.g. a stale loan-record
+      // cache on some other node can make this request fail even though
+      // the loan is fine, or the loan may genuinely have just been
+      // returned via BookReaderImages.php's revokeAccess()). Don't retry
+      // and don't stay silent either way: reset the bar to Borrow and the
+      // timer to 0 rather than leaving a stale countdown for a session
+      // that isn't accessible.
       window?.IALendingIntervals?.clearAll();
       this.tokenPoller?.disconnectedCallback();
       this.lendingStatus = {
@@ -1026,8 +1017,9 @@ export default class IABookActions extends LitElement {
       };
 
       // showErrorModal has dedicated create_token messaging (refresh
-      // button + support email).
-      if (errorMsg) this.showErrorModal(errorMsg, action);
+      // button + support email) and shows regardless of whether a
+      // specific error string came back.
+      this.showErrorModal(errorMsg, action);
     } else if (action === 'renew_loan') {
       window?.IALendingIntervals?.clearAll();
       this.loanRenewInProgress = false;
@@ -1095,7 +1087,7 @@ export default class IABookActions extends LitElement {
             .identifier}"
           >info@archive.org</a
         ><br /><br />
-        <code>errorLog: ${errorMsg}</code>`;
+        ${errorMsg ? html`<code>errorLog: ${errorMsg}</code>` : nothing}`;
     }
 
     await this.modal?.showModal({

package/test/core/services/loan-token-poller.test.js

@@ -1,4 +1,4 @@
-import { expect, aTimeout } from '@open-wc/testing';
+import { expect } from '@open-wc/testing';
 import Sinon from 'sinon';
 
 import { LoanTokenPoller } from '../../../src/core/services/loan-token-poller.js';
@@ -152,45 +152,3 @@ describe('skipInitialCall option', () => {
     poller.disconnectedCallback();
   });
 });
-
-describe('onTokenRefreshed option', () => {
-  // BookReader has no self-healing for a page <img> that failed while
-  // access was briefly invalid, so the consumer needs a signal on EVERY
-  // create_token success (not just the initial one) to know it's safe to
-  // retry those images.
-  it('fires on the initial create_token success', async () => {
-    const onTokenRefreshed = Sinon.spy();
-    const poller = new LoanTokenPoller({
-      identifier: 'foo',
-      borrowType: 'browsed',
-      successCallback: () => {},
-      errorCallback: () => {},
-      pollerDelay: 120,
-      onTokenRefreshed,
-    });
-
-    await aTimeout(50);
-
-    expect(onTokenRefreshed.called).to.be.true;
-    poller.disconnectedCallback();
-  });
-
-  it('fires on a routine (non-initial) create_token success too', async () => {
-    const onTokenRefreshed = Sinon.spy();
-    const poller = new LoanTokenPoller({
-      identifier: 'foo',
-      borrowType: 'browsed',
-      successCallback: () => {},
-      errorCallback: () => {},
-      pollerDelay: 120,
-      onTokenRefreshed,
-    });
-    onTokenRefreshed.resetHistory();
-
-    await poller.handleLoanTokenPoller(false);
-    await aTimeout(50);
-
-    expect(onTokenRefreshed.called).to.be.true;
-    poller.disconnectedCallback();
-  });
-});

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

@@ -986,8 +986,7 @@ describe('autoRenewExpiredLoan', () => {
     await el.updateComplete;
 
     expect(startTokenPollerSpy.calledOnceWith(true)).to.be.true;
-    // Retried right away rather than waiting for the (now-skipped) initial
-    // create_token or the next routine tick.
+    // Retries any page image broken during the gap this renewal just closed.
     expect(el.reloadPageImages.called).to.be.true;
   });
 
@@ -1176,75 +1175,75 @@ describe('handleLendingActionError - loanRenewInProgress reset', () => {
   });
 });
 
-describe('handleLendingActionError - create_token failures must not stop the countdown (WEBDEV-8322 follow-up)', () => {
-  it('does not clear the reading countdown on a create_token failure', async () => {
-    const el = await fixture(
-      container({
-        userid: '@user1',
-        identifier: 'foobar',
-        lendingStatus: {
-          user_has_browsed: true,
-          browsingExpired: false,
-          secondsLeftOnLoan: 100,
+describe('handleLendingActionError - every create_token failure resets the bar (WEBDEV-8322 follow-up)', () => {
+  // A create_token failure can't be told apart from "the loan was actually
+  // returned" (e.g. a stale loan-record cache on another node, or a genuine
+  // revokeAccess() in BookReaderImages.php) from here, so initial and
+  // routine interval failures are treated identically: no retry, reset to
+  // Borrow/0, show the modal every time.
+  for (const isInitial of [true, false]) {
+    it(`shows the error modal and resets to Borrow/0 on a failed create_token (isInitial=${isInitial})`, async () => {
+      const el = await fixture(
+        container({
+          userid: '@user1',
+          identifier: 'foobar',
+          lendingStatus: {
+            user_has_browsed: true,
+            browsingExpired: false,
+            secondsLeftOnLoan: 100,
+          },
+        })
+      );
+      await el.updateComplete;
+
+      const showErrorModalSpy = Sinon.spy(el, 'showErrorModal');
+      const errorMsg = 'loan token not found. please try again later.';
+
+      el.handleLendingActionError({
+        detail: {
+          action: 'create_token',
+          isInitial,
+          data: { error: errorMsg },
         },
-      })
-    );
-    await el.updateComplete;
-    expect(window.IALendingIntervals.timerCountdown).to.not.equal(0);
+      });
 
-    el.handleLendingActionError({
-      detail: {
-        action: 'create_token',
-        data: { error: 'loan token not found. please try again later.' },
-      },
+      expect(showErrorModalSpy.calledOnceWith(errorMsg, 'create_token')).to.be
+        .true;
+      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);
     });
 
-    // The countdown must keep running — a token refresh hiccup says
-    // nothing about how much time is left on the loan itself.
-    expect(window.IALendingIntervals.timerCountdown).to.not.equal(0);
-  });
+    it(`stops the countdown/expiry timers on a failed create_token (isInitial=${isInitial})`, async () => {
+      const el = await fixture(
+        container({
+          userid: '@user1',
+          identifier: 'foobar',
+          lendingStatus: {
+            user_has_browsed: true,
+            browsingExpired: false,
+            secondsLeftOnLoan: 100,
+          },
+        })
+      );
+      await el.updateComplete;
+      expect(window.IALendingIntervals.timerCountdown).to.not.equal(0);
+      expect(window.IALendingIntervals.browseExpireTimeout).to.not.equal(0);
 
-  it('shows the error modal and resets to Borrow/0 on a failed INITIAL create_token (no retry)', async () => {
-    // For the INITIAL token, BookReader never got page images — the book
-    // never opened. We don't retry, so the bar must reflect that honestly
-    // (Borrow, 0 left) instead of staying red with a stale countdown for a
-    // session that isn't actually accessible.
-    const el = await fixture(
-      container({
-        userid: '@user1',
-        identifier: 'foobar',
-        lendingStatus: {
-          user_has_browsed: true,
-          browsingExpired: false,
-          secondsLeftOnLoan: 100,
+      el.handleLendingActionError({
+        detail: {
+          action: 'create_token',
+          isInitial,
+          data: { error: 'loan token not found. please try again later.' },
         },
-      })
-    );
-    await el.updateComplete;
-
-    const showErrorModalSpy = Sinon.spy(el, 'showErrorModal');
-    const errorMsg = 'loan token not found. please try again later.';
+      });
 
-    el.handleLendingActionError({
-      detail: {
-        action: 'create_token',
-        isInitial: true,
-        data: { error: errorMsg },
-      },
+      expect(window.IALendingIntervals.timerCountdown).to.equal(0);
+      expect(window.IALendingIntervals.browseExpireTimeout).to.equal(0);
     });
+  }
 
-    expect(showErrorModalSpy.calledOnceWith(errorMsg, 'create_token')).to.be
-      .true;
-    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);
-  });
-
-  it('stops the countdown/expiry timers on a failed INITIAL create_token — nothing to read yet', async () => {
-    // Unlike the interval-refresh case above (pages already loaded, keep
-    // ticking), an initial create_token failure means BookReader never got
-    // page images and we're resetting the bar to Borrow — both timers
-    // should stop rather than keep counting down a dead session.
+  it('shows the modal even without a specific error message', async () => {
     const el = await fixture(
       container({
         userid: '@user1',
@@ -1257,19 +1256,14 @@ describe('handleLendingActionError - create_token failures must not stop the cou
       })
     );
     await el.updateComplete;
-    expect(window.IALendingIntervals.timerCountdown).to.not.equal(0);
-    expect(window.IALendingIntervals.browseExpireTimeout).to.not.equal(0);
+
+    const showErrorModalSpy = Sinon.spy(el, 'showErrorModal');
 
     el.handleLendingActionError({
-      detail: {
-        action: 'create_token',
-        isInitial: true,
-        data: { error: 'loan token not found. please try again later.' },
-      },
+      detail: { action: 'create_token', isInitial: false, data: {} },
     });
 
-    expect(window.IALendingIntervals.timerCountdown).to.equal(0);
-    expect(window.IALendingIntervals.browseExpireTimeout).to.equal(0);
+    expect(showErrorModalSpy.calledOnce).to.be.true;
   });
 
   it('still clears everything on a renew_loan failure', async () => {
@@ -1614,7 +1608,10 @@ describe('WEBDEV-8322 review fixes', () => {
     expect(el.loanRenewInProgress).to.be.true;
   });
 
-  it('stays silent when an interval create_token refresh fails', async () => {
+  it('resets the bar and shows the modal on an interval create_token refresh failure too', async () => {
+    // A routine refresh failing is treated the same as the initial one --
+    // there's no reliable way to tell "harmless blip" from "the loan is
+    // actually gone" from here (see handleLendingActionError).
     const el = await fixture(
       container({
         userid: '@user1',
@@ -1640,9 +1637,8 @@ describe('WEBDEV-8322 review fixes', () => {
     });
     await el.updateComplete;
 
-    expect(spy.called).to.be.false;
-    // the patron is still reading — don't knock them out of the loan
-    expect(el.lendingStatus.user_has_browsed).to.be.true;
+    expect(spy.calledOnce).to.be.true;
+    expect(el.lendingStatus.user_has_browsed).to.be.false;
   });
 
   it('tears down the previous poller before starting a new one', async () => {