@internetarchive/ia-book-actions 1.4.4-alpha10 → 1.4.4-alpha12

package/package.json

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

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

@@ -372,6 +372,12 @@ export default class ActionsHandler extends LitElement {
         new Date().getTime() + this.loanTotalTime * 1000
       );
 
+      log('[ActionsHandler] setBrowseTimeSession: resetting loanTime', {
+        identifier: this.identifier,
+        expireDate,
+        loanTotalTime: this.loanTotalTime,
+      });
+
       // set a value
       await this.localCache.set({
         key: `${this.identifier}-loanTime`,
@@ -381,12 +387,20 @@ export default class ActionsHandler extends LitElement {
 
       // delete pageChangedTime when book is auto renew at nth minute
       await this.localCache.delete(`${this.identifier}-pageChangedTime`);
+
+      log('[ActionsHandler] setBrowseTimeSession: loanTime reset complete', {
+        identifier: this.identifier,
+      });
     } catch (error) {
-      log(error);
+      log('[ActionsHandler] setBrowseTimeSession failed', error);
     }
   }
 
   deleteLoanCookies() {
+    log('[ActionsHandler] deleteLoanCookies: expiring loan cookies', {
+      identifier: this.identifier,
+    });
+
     const date = new Date();
     date.setTime(date.getTime() - 24 * 60 * 60 * 1000); // one day ago
 

package/src/core/services/loan-analytics.js

@@ -159,16 +159,16 @@ export default class LoanAnanlytics {
    * @memberof LoanAnanlytics
    */
   sendEvent(eventCategory, eventAction, label, extraParams) {
-    log(
-      'eventCategory:-',
-      eventCategory,
-      '||\teventAction:-',
-      eventAction,
-      '||\tlabel:-',
-      label,
-      '||\textraParams:-',
-      extraParams,
-    );
+    // log(
+    //   'eventCategory:-',
+    //   eventCategory,
+    //   '||\teventAction:-',
+    //   eventAction,
+    //   '||\tlabel:-',
+    //   label,
+    //   '||\textraParams:-',
+    //   extraParams,
+    // );
 
     window?.archive_analytics?.send_event_no_sampling(
       eventCategory,

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

@@ -2,6 +2,7 @@
 import ActionsHandlerService from './actions-handler/actions-handler-service.js';
 import LoanAnanlytics from './loan-analytics.js';
 import { sentryLogs } from '../config/sentry-events.js';
+import log from './log.js';
 
 /**
  * This class is used to create loan token for borrowed books
@@ -77,11 +78,21 @@ export class LoanTokenPoller {
    */
   async handleLoanTokenPoller(isInitial = false, retryCount = 0) {
     const action = 'create_token';
+    log('[LoanTokenPoller] create_token requested', {
+      identifier: this.identifier,
+      isInitial,
+      retryCount,
+    });
     ActionsHandlerService({
       identifier: this.identifier,
       action,
       error: data => this.handleTokenError(data, isInitial, retryCount),
       success: () => {
+        log('[LoanTokenPoller] create_token succeeded', {
+          identifier: this.identifier,
+          isInitial,
+          retryCount,
+        });
         if (isInitial) this.successCallback();
       },
     });
@@ -104,18 +115,37 @@ export class LoanTokenPoller {
       typeof data?.error === 'string' &&
       /do not currently have this book borrowed/i.test(data.error);
 
+    log('[LoanTokenPoller] create_token failed', {
+      identifier: this.identifier,
+      isInitial,
+      retryCount,
+      isStaleLoanReadError,
+      error: data?.error,
+    });
+
     if (
       isInitial &&
       isStaleLoanReadError &&
       retryCount < this.maxInitialTokenRetries
     ) {
       const delay = this.initialTokenRetryDelay * (retryCount + 1);
+      log('[LoanTokenPoller] retrying create_token after stale-loan-read error', {
+        identifier: this.identifier,
+        nextRetryCount: retryCount + 1,
+        delay,
+      });
       setTimeout(() => {
         this.handleLoanTokenPoller(true, retryCount + 1);
       }, delay);
       return;
     }
 
+    log('[LoanTokenPoller] giving up on create_token, reporting error', {
+      identifier: this.identifier,
+      isInitial,
+      retryCount,
+    });
+
     this.errorCallback({ detail: { action, data } });
 
     // send error to Sentry

package/src/ia-book-actions.js

@@ -61,6 +61,7 @@ export default class IABookActions extends LitElement {
       modal: { Object },
       tokenDelay: { type: Number },
       timerExecutionSeconds: { type: Number },
+      userActionGracePeriod: { type: Number },
       localCache: { type: Object },
       loanRenewTimeConfig: { type: Object },
       loanRenewResult: { type: Object },
@@ -83,6 +84,14 @@ export default class IABookActions extends LitElement {
     this.tokenDelay = 120; // in seconds
     this.timerExecutionSeconds = 30;
 
+    /**
+     * How long (ms) after bindLoanRenewEvents() runs to ignore
+     * BookReader:userAction events — BookReader fires that event on its
+     * own init-time jump to the last-read page, not just on genuine
+     * interaction. @see bindLoanRenewEvents
+     */
+    this.userActionGracePeriod = 2000;
+
     // private props
     this.postInitComplete = false;
     this.primaryActions = [];
@@ -283,7 +292,14 @@ export default class IABookActions extends LitElement {
 
     this.borrowType = actions.borrowType ? actions.borrowType : null;
 
-    if (this.borrowType === 'browsed') {
+    // Don't (re)start the countdown while a renewal is in flight — the
+    // optimistic browsingExpired flip in autoRenewExpiredLoan() (which
+    // triggers this same setupLendingToolbarActions() call) happens before
+    // renewal is confirmed, so secondsLeftOnLoan could still be a stale
+    // value from before the renewal. Wait for handleLoanAutoRenewed() to
+    // confirm the real value and clear loanRenewInProgress before showing
+    // a countdown again.
+    if (this.borrowType === 'browsed' && !this.loanRenewInProgress) {
       // start timer for loan-renew
       await this.startTimerCountdown();
 
@@ -327,10 +343,19 @@ export default class IABookActions extends LitElement {
    * 2. IABookActions:loanRenew - dispatched from timer-countdown component
    */
   bindLoanRenewEvents() {
+    this.userActionReadyAt = Date.now() + this.userActionGracePeriod;
+
     /**
      * dispatched this event from bookreader page changed
      */
     window.addEventListener('BookReader:userAction', () => {
+      if (Date.now() < this.userActionReadyAt) {
+        log(
+          '[IABookActions] BookReader:userAction ignored — within startup grace period'
+        );
+        return;
+      }
+
       // Capture before autoRenewExpiredLoan() runs — it synchronously flips
       // lendingStatus.browsingExpired to false as an optimistic UI update,
       // so checking the live property afterward would always see it as
@@ -440,7 +465,15 @@ export default class IABookActions extends LitElement {
    * On error: handleLendingActionError() shows showLoanUnavailableModal().
    */
   autoRenewExpiredLoan() {
-    if (this.loanRenewInProgress) return;
+    if (this.loanRenewInProgress) {
+      log('[IABookActions] autoRenewExpiredLoan: skipped, renewal already in progress', {
+        identifier: this.identifier,
+      });
+      return;
+    }
+    log('[IABookActions] autoRenewExpiredLoan: starting silent renewal', {
+      identifier: this.identifier,
+    });
     this.loanRenewInProgress = true;
     this.recoveringFromLoanExpiry = true;
 
@@ -448,11 +481,17 @@ export default class IABookActions extends LitElement {
 
     // Optimistically flip browsingExpired back to false so the action bar
     // stays red (patronIsReadingAction) while the renew_loan request is in
-    // flight, instead of showing the blue "Borrow" state.
+    // flight, instead of showing the blue "Borrow" state. Deliberately NOT
+    // resetting secondsLeftOnLoan here — the renewal hasn't been confirmed
+    // yet (it can take several seconds, or genuinely fail), so showing a
+    // full hour before we know the outcome would be misleading. The real
+    // value is set once handleLoanAutoRenewed() confirms success;
+    // loanRenewInProgress (already true above) is the signal consumers
+    // should use to show a "renewing" state instead of trusting the
+    // countdown during this window.
     this.lendingStatus = {
       ...this.lendingStatus,
       browsingExpired: false,
-      secondsLeftOnLoan: this.loanRenewTimeConfig.loanTotalTime,
     };
 
     // Defer renewNow until after lendingStatus timer setup completes.
@@ -505,19 +544,14 @@ export default class IABookActions extends LitElement {
       headerColor: '#194880',
       showCloseButton: false,
       closeOnBackdropClick: false,
-      message: html`<span
-        style="display:inline-flex;align-items:center;flex-wrap:nowrap;gap:4px;"
-      >
-        <span>${this.loanRenewHelper?.getMessageTexts(
-          warningTexts,
-          secondsLeft
-        )}</span>
+      message: html`<span>
+        ${this.loanRenewHelper?.getMessageTexts(warningTexts, secondsLeft)}
         <a
           href="https://help.archive.org/help/borrowing-from-the-lending-library"
           target="_blank"
           title="Get more info on borrowing from The Lending Library"
           data-event-click-tracking="BookReader|BrowsableMoreInfo"
-          style="display:inline-flex;flex-shrink:0;line-height:0;"
+          style="display:inline-block;vertical-align:middle;line-height:0;margin-left:4px;"
         >
           ${infoIcon}
         </a>
@@ -552,7 +586,10 @@ export default class IABookActions extends LitElement {
    * Execute when loan is expired
    */
   async browseHasExpired() {
-    log('[IABookActions] browseHasExpired');
+    log('[IABookActions] browseHasExpired', {
+      identifier: this.identifier,
+      loanRenewInProgress: this.loanRenewInProgress,
+    });
     window?.IALendingIntervals?.clearAll();
 
     const currStatus = {
@@ -565,6 +602,9 @@ export default class IABookActions extends LitElement {
     // remove respected key:value for loan-renew
     await this.localCache.delete(`${this.identifier}-loanTime`);
     await this.localCache.delete(`${this.identifier}-pageChangedTime`);
+    log('[IABookActions] browseHasExpired: cleared loanTime/pageChangedTime cache', {
+      identifier: this.identifier,
+    });
 
     // show message after browsed book is expired.
     this.loanRenewResult.renewNow = false;
@@ -791,9 +831,8 @@ export default class IABookActions extends LitElement {
     }
 
     log('[IABookActions] timer', {
-      secondsLeft,
-      loanRenewAtLast: this.loanRenewTimeConfig.loanRenewAtLast,
-      pageChangedInLast: this.loanRenewTimeConfig.pageChangedInLast,
+      whatShouldLeft: resyncd.whatShouldLeft,
+      whatIsleft: secondsLeft,
     });
 
     /**
@@ -952,6 +991,14 @@ export default class IABookActions extends LitElement {
     const action = event?.detail?.action;
     const errorMsg = event?.detail?.data?.error;
 
+    log('[IABookActions] handleLendingActionError', {
+      identifier: this.identifier,
+      action,
+      errorMsg,
+      loanRenewInProgress: this.loanRenewInProgress,
+      recoveringFromLoanExpiry: this.recoveringFromLoanExpiry,
+    });
+
     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

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

@@ -89,6 +89,8 @@ describe('<ia-book-actions>', () => {
         identifier: 'foobar',
       })
     );
+    // Not testing the BookReader-init grace period here — bypass it.
+    el.userActionReadyAt = 0;
 
     const spy = Sinon.spy(el, 'autoLoanRenewChecker');
     el.lendingStatus = { ...el.lendingStatus, browsingExpired: false };
@@ -111,6 +113,8 @@ describe('<ia-book-actions>', () => {
         lendingStatus: { user_has_browsed: true, browsingExpired: true },
       })
     );
+    // Not testing the BookReader-init grace period here — bypass it.
+    el.userActionReadyAt = 0;
 
     const spy = Sinon.spy(el, 'autoRenewExpiredLoan');
     el.borrowType = 'browsed';
@@ -121,6 +125,34 @@ describe('<ia-book-actions>', () => {
 
     expect(spy.calledOnce).to.be.true;
   });
+
+  it('ignores BookReader:userAction fired within the startup grace period (WEBDEV-8322 follow-up)', async () => {
+    // Regression: BookReader.jumpToIndex() fires its own 'userAction'
+    // event any time it runs — including BookReader's own init-time jump
+    // to the reader's last-read page (updateFromParams(), called from
+    // init()), which has nothing to do with the patron doing anything.
+    // Without this grace period, a plain page refresh on an already-
+    // expired loan would silently auto-renew before the patron did
+    // anything at all.
+    const el = await fixture(
+      container({
+        userid: '@user1',
+        identifier: 'foobar',
+        lendingStatus: { user_has_browsed: true, browsingExpired: true },
+      })
+    );
+    el.borrowType = 'browsed';
+    await el.updateComplete;
+
+    const spy = Sinon.spy(el, 'autoRenewExpiredLoan');
+
+    // Fired immediately after bindLoanRenewEvents() ran (in firstUpdated())
+    // — well within the default grace period.
+    window.dispatchEvent(new Event('BookReader:userAction'));
+    await el.updateComplete;
+
+    expect(spy.called).to.be.false;
+  });
 });
 
 describe('Primary Actions data', () => {
@@ -595,6 +627,36 @@ describe('autoRenewExpiredLoan', () => {
     expect(el.primaryColor).to.equal('danger');
   });
 
+  it('does not (re)start the countdown during the optimistic pre-confirmation window (WEBDEV-8322 follow-up)', async () => {
+    // Regression: the optimistic browsingExpired flip above triggers
+    // setupLendingToolbarActions() before renew_loan is even dispatched,
+    // let alone confirmed. Without gating on loanRenewInProgress, that
+    // would (re)start the timer-countdown interval using whatever stale
+    // secondsLeftOnLoan was left over from before the loan expired,
+    // showing a wrong/flickering value until handleLoanAutoRenewed()
+    // corrects it moments later.
+    const el = await fixture(
+      container({
+        userid: '@user1',
+        identifier: 'foobar',
+        lendingStatus: {
+          user_has_browsed: true,
+          available_to_browse: true,
+          browsingExpired: true,
+        },
+      })
+    );
+    await el.updateComplete;
+
+    const startTimerCountdownSpy = Sinon.spy(el, 'startTimerCountdown');
+
+    el.autoRenewExpiredLoan();
+    await el.updateComplete;
+
+    expect(el.loanRenewInProgress).to.be.true;
+    expect(startTimerCountdownSpy.called).to.be.false;
+  });
+
   it('sets loanRenewInProgress and triggers renewNow after timeout', async () => {
     const el = await fixture(
       container({
@@ -882,6 +944,8 @@ describe('BookReader:userAction race regression (WEBDEV-8322)', () => {
     );
     await el.updateComplete;
     expect(el.borrowType).to.equal('browsed');
+    // Not testing the BookReader-init grace period here — bypass it.
+    el.userActionReadyAt = 0;
 
     el.lendingStatus = { ...baseStatus, browsingExpired: true };
     await el.updateComplete;
@@ -923,6 +987,8 @@ describe('BookReader:userAction race regression (WEBDEV-8322)', () => {
     );
     await el.updateComplete;
     expect(el.borrowType).to.equal('browsed');
+    // Not testing the BookReader-init grace period here — bypass it.
+    el.userActionReadyAt = 0;
 
     el.loanRenewInProgress = true;