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

package/package.json

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

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

@@ -26,6 +26,11 @@ 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 {
@@ -35,6 +40,7 @@ export class LoanTokenPoller {
       errorCallback,
       pollerDelay,
       skipInitialCall = false,
+      onTokenRefreshed,
     } = options;
 
     this.identifier = identifier;
@@ -43,6 +49,7 @@ 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;
 
@@ -111,6 +118,7 @@ export class LoanTokenPoller {
           identifier: this.identifier,
           isInitial,
         });
+        this.onTokenRefreshed?.();
         if (isInitial) this.successCallback();
       },
     });

package/src/ia-book-actions.js

@@ -55,6 +55,10 @@ export default class IABookActions extends LitElement {
         type: Function,
         attribute: false,
       },
+      reloadPageImages: {
+        type: Function,
+        attribute: false,
+      },
       barType: { type: String },
       sharedObserver: { attribute: false },
       disableActionGroup: { type: Boolean },
@@ -77,6 +81,7 @@ export default class IABookActions extends LitElement {
     this.width = 0;
     this.bwbPurchaseUrl = '';
     this.lendingBarPostInit = () => {};
+    this.reloadPageImages = () => {};
     this.barType = 'action'; // 'title'|'action'
     this.sharedObserver = undefined;
     this.disableActionGroup = false;
@@ -762,6 +767,12 @@ 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).
+      this.reloadPageImages();
+
       if (this.recoveringFromLoanExpiry) {
         // Only now is it safe to re-initialize BookReader — not for a
         // routine top-up, where that would be disruptive. Call it
@@ -935,6 +946,13 @@ 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.
@@ -946,6 +964,7 @@ export default class IABookActions extends LitElement {
       errorCallback,
       pollerDelay: this.tokenDelay, // in seconds
       skipInitialCall,
+      onTokenRefreshed,
     });
   }
 
@@ -1130,6 +1149,10 @@ export default class IABookActions extends LitElement {
         justify-content: center;
         flex-wrap: wrap;
       }
+
+      #action-bar-modal {
+        --modalWidth: 36rem;
+      }
     `;
   }
 }

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

@@ -1,4 +1,4 @@
-import { expect } from '@open-wc/testing';
+import { expect, aTimeout } from '@open-wc/testing';
 import Sinon from 'sinon';
 
 import { LoanTokenPoller } from '../../../src/core/services/loan-token-poller.js';
@@ -152,3 +152,45 @@ 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

@@ -958,6 +958,7 @@ describe('autoRenewExpiredLoan', () => {
     );
     await el.updateComplete;
     el.postInitComplete = true;
+    el.reloadPageImages = Sinon.spy();
 
     await el.localCache.set({
       key: 'foobar-loanTime',
@@ -985,6 +986,9 @@ 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.
+    expect(el.reloadPageImages.called).to.be.true;
   });
 
   it('calls lendingBarPostInit directly on a recovery renewal and skips the initial create_token', async () => {
@@ -1006,6 +1010,7 @@ describe('autoRenewExpiredLoan', () => {
     );
     await el.updateComplete;
     el.lendingBarPostInit = Sinon.spy();
+    el.reloadPageImages = Sinon.spy();
 
     await el.localCache.set({
       key: 'foobar-loanTime',
@@ -1030,6 +1035,7 @@ describe('autoRenewExpiredLoan', () => {
     // create_token success callback.
     expect(el.lendingBarPostInit.calledOnce).to.be.true;
     expect(el.postInitComplete).to.be.true;
+    expect(el.reloadPageImages.called).to.be.true;
 
     await el.updateComplete;
     await aTimeout(150); // let the 100ms token-poller-restart check run