@internetarchive/ia-book-actions 1.4.6-alpha1 → 1.4.6-alpha2

package/package.json

@@ -7,7 +7,7 @@
   },
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",
-  "version": "1.4.6-alpha1",
+  "version": "1.4.6-alpha2",
   "main": "index.js",
   "module": "index.js",
   "publishConfig": {

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

@@ -145,9 +145,13 @@ export default async function ActionsHandlerService(options) {
      * connection is exactly when this fires.
      */
     log(`[IABookActions] ✗ ${option.action} threw`, error);
+    // networkFailure marks "the service never answered" (like
+    // nonJsonResponse in parseServiceResponse) — see
+    // IABookActions.handleLendingActionError.
     option?.error?.({
       error: reachedResponse ? unexpectedError : networkError,
       detail: String(error),
+      ...(reachedResponse ? {} : { networkFailure: true }),
     });
   }
 }

package/src/ia-book-actions.js

@@ -1017,33 +1017,35 @@ export default class IABookActions extends LitElement {
     if (
       action === 'create_token' &&
       !isInitial &&
-      eventData?.nonJsonResponse === true &&
-      eventData?.status === 400
+      (eventData?.nonJsonResponse === true ||
+        eventData?.networkFailure === true)
     ) {
-      // Something in front of the service (the WAF's /about/400.html)
-      // answered a routine refresh instead of the service itself. It's
-      // already reported to Sentry (ActionsHandlerService/LoanTokenPoller);
-      // the current access token keeps the book readable, and the poll
-      // interval is left running, so the next tick tries again. No modal,
-      // and no session teardown.
+      // The service never answered this routine refresh: something in
+      // front of it did (the WAF's /about/400.html, an outage page), or the
+      // request never got through. That says nothing about the loan, so
+      // no modal and no session teardown — it's already reported to Sentry
+      // (ActionsHandlerService/LoanTokenPoller), the current access token
+      // keeps the book readable, and the poll interval is left running, so
+      // the next tick tries again. The service's own answer (e.g. "You do
+      // not currently have this book borrowed.") still falls through below.
       //
       // Not for the initial call: its success is what runs
       // lendingBarPostInit() and opens the book (see startLoanTokenPoller),
       // so suppressing it would leave a reader that never loads, silently.
       log(
-        '[IABookActions] create_token HTML 400 on a routine refresh — no modal',
+        '[IABookActions] create_token routine refresh got no answer from the service — no modal',
         {
           identifier: this.identifier,
           status: eventData?.status,
+          errorMsg,
         }
       );
       return;
     }
 
     if (action === 'create_token') {
-      // Any other create_token failure — initial or a routine interval
-      // refresh, except the routine HTML 400 above — means access can no
-      // longer be confirmed (e.g. a stale loan-record
+      // Any other create_token failure — initial, or a routine refresh the
+      // service itself answered — 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

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

@@ -135,6 +135,7 @@ describe('ActionsHandlerService - thrown errors', () => {
 
     expect(error.calledOnce).to.be.true;
     expect(error.firstCall.args[0].error).to.equal(networkError);
+    expect(error.firstCall.args[0].networkFailure).to.be.true;
     const [, context] = window.Sentry.captureException.firstCall.args;
     expect(context.tags).to.deep.equal({
       identifier: 'foo',
@@ -158,5 +159,7 @@ describe('ActionsHandlerService - thrown errors', () => {
     expect(error.calledOnce).to.be.true;
     expect(error.firstCall.args[0].error).to.equal(unexpectedError);
     expect(error.firstCall.args[0].detail).to.contain('boom');
+    // the service did answer, so this isn't treated as "no answer"
+    expect(error.firstCall.args[0].networkFailure).to.be.undefined;
   });
 });

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

@@ -5,7 +5,10 @@ import Sinon from 'sinon';
 
 import { SharedResizeObserver } from '@internetarchive/shared-resize-observer';
 import { LocalCache } from '@internetarchive/local-cache';
-import { unexpectedResponseError } from '../src/core/services/actions-handler/actions-handler-service.js';
+import {
+  unexpectedResponseError,
+  networkError,
+} from '../src/core/services/actions-handler/actions-handler-service.js';
 
 beforeEach(() => {
   const modalManager = document.createElement('modal-manager');
@@ -1734,93 +1737,97 @@ describe('Sentry reports (WEBDEV-9595)', () => {
   });
 });
 
-describe('handleLendingActionError - HTML 400 on create_token (WEBDEV-9595)', () => {
+describe('handleLendingActionError - routine create_token refresh failures (WEBDEV-9595)', () => {
   const htmlBadRequest = {
     success: false,
     error: unexpectedResponseError(400),
     status: 400,
     nonJsonResponse: true,
   };
+  // the service never answered: no modal on a routine refresh
+  const noAnswer = {
+    'an HTML 400 (WAF block)': htmlBadRequest,
+    'an HTML 502': {
+      ...htmlBadRequest,
+      error: unexpectedResponseError(502),
+      status: 502,
+    },
+    'a blocked or failed request': {
+      error: networkError,
+      detail: 'TypeError: Failed to fetch',
+      networkFailure: true,
+    },
+  };
+  // the service answered "no": the loan may really be gone
+  const serviceAnswer = {
+    success: false,
+    error: 'You do not currently have this book borrowed.',
+    status: 400,
+  };
   const liveLoan = {
     is_lendable: true,
     user_has_borrowed: true,
     browsingExpired: false,
     secondsLeftOnLoan: 300,
   };
-
-  it('shows no modal and keeps the session going on a routine refresh', async () => {
+  const setup = async () => {
     const el = await fixture(
       container({
         userid: '@user1',
-        identifier: 'html-400-routine',
+        identifier: 'token-refresh-failure',
         lendingStatus: liveLoan,
       })
     );
     await el.updateComplete;
-    const showErrorModalSpy = Sinon.spy(el, 'showErrorModal');
-    const clearAllSpy = Sinon.spy(window.IALendingIntervals, 'clearAll');
-    el.tokenPoller = { disconnectedCallback: Sinon.spy() };
+    return el;
+  };
 
-    try {
-      el.handleLendingActionError({
-        detail: { action: 'create_token', isInitial: false, data: htmlBadRequest },
-      });
+  for (const [name, data] of Object.entries(noAnswer)) {
+    it(`shows no modal and keeps the session going for ${name}`, async () => {
+      const el = await setup();
+      const showErrorModalSpy = Sinon.spy(el, 'showErrorModal');
+      const clearAllSpy = Sinon.spy(window.IALendingIntervals, 'clearAll');
+      el.tokenPoller = { disconnectedCallback: Sinon.spy() };
+
+      try {
+        el.handleLendingActionError({
+          detail: { action: 'create_token', isInitial: false, data },
+        });
+
+        expect(showErrorModalSpy.called).to.be.false;
+        // none of the create_token teardown ran
+        expect(clearAllSpy.called).to.be.false;
+        expect(el.tokenPoller.disconnectedCallback.called).to.be.false;
+        expect(el.lendingStatus.secondsLeftOnLoan).to.equal(300);
+        expect(el.lendingStatus.available_to_browse).to.be.undefined;
+      } finally {
+        clearAllSpy.restore();
+      }
+    });
 
-      expect(showErrorModalSpy.called).to.be.false;
-      // none of the create_token teardown ran
-      expect(clearAllSpy.called).to.be.false;
-      expect(el.tokenPoller.disconnectedCallback.called).to.be.false;
-      expect(el.lendingStatus.secondsLeftOnLoan).to.equal(300);
-      expect(el.lendingStatus.available_to_browse).to.be.undefined;
-    } finally {
-      clearAllSpy.restore();
-    }
-  });
+    it(`still shows the modal for ${name} when the book is first opening`, async () => {
+      const el = await setup();
+      const showErrorModalSpy = Sinon.spy(el, 'showErrorModal');
 
-  it('still shows the modal when the book is first opening', async () => {
-    const el = await fixture(
-      container({
-        userid: '@user1',
-        identifier: 'html-400-initial',
-        lendingStatus: liveLoan,
-      })
-    );
-    await el.updateComplete;
-    const showErrorModalSpy = Sinon.spy(el, 'showErrorModal');
+      el.handleLendingActionError({
+        detail: { action: 'create_token', isInitial: true, data },
+      });
 
-    el.handleLendingActionError({
-      detail: { action: 'create_token', isInitial: true, data: htmlBadRequest },
+      expect(showErrorModalSpy.calledOnce).to.be.true;
     });
+  }
 
-    expect(showErrorModalSpy.calledOnce).to.be.true;
-  });
-
-  it("still shows the modal for the service's own JSON 400 and for an HTML 5xx", async () => {
-    const el = await fixture(
-      container({
-        userid: '@user1',
-        identifier: 'html-400-other',
-        lendingStatus: liveLoan,
-      })
-    );
-    await el.updateComplete;
+  it("still shows the modal and resets the bar when the service itself says no", async () => {
+    const el = await setup();
     const showErrorModalSpy = Sinon.spy(el, 'showErrorModal');
 
     el.handleLendingActionError({
-      detail: {
-        action: 'create_token',
-        isInitial: false,
-        data: { error: 'You do not currently have this book borrowed.' },
-      },
-    });
-    el.handleLendingActionError({
-      detail: {
-        action: 'create_token',
-        isInitial: false,
-        data: { ...htmlBadRequest, status: 502 },
-      },
+      detail: { action: 'create_token', isInitial: false, data: serviceAnswer },
     });
 
-    expect(showErrorModalSpy.calledTwice).to.be.true;
+    expect(
+      showErrorModalSpy.calledOnceWith(serviceAnswer.error, 'create_token')
+    ).to.be.true;
+    expect(el.lendingStatus.secondsLeftOnLoan).to.equal(0);
   });
 });