@internetarchive/ia-book-actions 0.1.5-alpha2 → 0.1.5-alpha3

package/demo/index.html

@@ -131,8 +131,8 @@
     iaBookActions.returnUrl = '';
     iaBookActions.localCache = localCache;
 
-    let loanTotalTime2Min = { loanTotalTime: 10, loanRenewAtLast: 5, pageChangedInLast: 5 };
-    let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 290, pageChangedInLast: 15 };
+    let loanTotalTime2Min = { loanTotalTime: 70, loanRenewAtLast: 65, pageChangedInLast: 5 };
+    let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 180, pageChangedInLast: 15 };
     let loanTotalTime1Hour = { loanTotalTime: 3600, loanRenewAtLast: 600, pageChangedInLast: 900 };
 
     iaBookActions.loanRenewTimeConfig = loanTotalTime2Min;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "0.1.5-alpha2",
+  "version": "0.1.5-alpha3",
   "description": "Bookreader actions for borrowable book",
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",

package/src/components/collapsible-action-group.js

@@ -204,7 +204,11 @@ export class CollapsibleActionGroup extends ActionsHandler {
         href="${action.url}"
         target=${action.target}
         @click=${() => {
-          this.clickHandler(action.id, action.analyticsEvent);
+          this.clickHandler(
+            action.id,
+            action.analyticsEvent,
+            action?.borrowType
+          );
         }}
       >
         ${action.id === 'purchaseBook' ? purchaseIcon : ''} ${action.text}
@@ -225,7 +229,7 @@ export class CollapsibleActionGroup extends ActionsHandler {
     return html`<button
       class="ia-button ${action.className} ${initialButton ? 'initial' : ''}"
       @click=${() => {
-        this.clickHandler(action.id, analyticsEvent);
+        this.clickHandler(action.id, analyticsEvent, action?.borrowType);
       }}
     >
       ${action.text}
@@ -238,10 +242,10 @@ export class CollapsibleActionGroup extends ActionsHandler {
    * @param { object } gaEvent - contains analytics event action and category
    *   @param { string } gaEvent.category
    *   @param { string } gaEvent.action
-   *
+   * @param { string } borrowType browse|borrow
    * @fires CollapsibleActionGroup#{eventName} - (will be browseBook, borrowBook etc...)
    */
-  clickHandler(eventName, gaEvent) {
+  clickHandler(eventName, gaEvent, borrowType = '') {
     this.dropdownState = 'close';
     this.dropdownArrow = dropdownClosed;
 
@@ -251,6 +255,7 @@ export class CollapsibleActionGroup extends ActionsHandler {
       new CustomEvent(eventName, {
         detail: {
           event: { category, action },
+          borrowType,
         },
       })
     );

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

@@ -70,6 +70,7 @@ export default class ActionsConfig {
         category: eventCategory,
         action: this.analyticsActions.doneBorrowing,
       },
+      borrowType: this.lendingStatus.user_has_browsed ? 'browse' : 'borrow',
     };
   }
 

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

@@ -37,134 +37,83 @@ export default class ActionsHandler extends LitElement {
   }
 
   bindEvents() {
-    this.addEventListener('browseBook', ({ detail }) => {
+    this.addEventListener('browseBook', () => {
       this.handleBrowseIt();
       this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'browse');
-      const { category, action } = detail.event;
-      this.loanAnanlytics?.sendEvent(
-        category,
-        action,
-        `identifier=${this.identifier}`
-      );
     });
 
-    this.addEventListener('browseBookAgain', ({ detail }) => {
+    this.addEventListener('browseBookAgain', () => {
       this.handleBrowseIt();
       this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'browseagain');
-      const { category, action } = detail.event;
-      this.loanAnanlytics?.sendEvent(
-        category,
-        action,
-        `identifier=${this.identifier}`
-      );
     });
 
-    this.addEventListener('autoRenew', ({ detail }) => {
+    this.addEventListener('autoRenew', () => {
       this.handleLoanRenewNow();
       this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'autorenew');
-      const { category, action } = detail.event;
-      this.loanAnanlytics?.sendEvent(
-        category,
-        action,
-        `identifier=${this.identifier}`
-      );
     });
 
-    this.addEventListener('autoReturn', ({ detail }) => {
+    this.addEventListener('autoReturn', () => {
+      this.deleteLoanCookies();
       this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'autoreturn');
-      const { category, action } = detail.event;
-      this.loanAnanlytics?.sendEvent(
-        category,
-        action,
-        `identifier=${this.identifier}`
-      );
     });
 
     this.addEventListener('returnNow', ({ detail }) => {
-      this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'return');
+      // use loan stats count when 1-hour borrow is active
+      if (detail?.borrowType === 'browse') {
+        this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'return');
+      }
+
       this.handleReturnIt();
-      const { category, action } = detail.event;
-      this.loanAnanlytics?.sendEvent(
-        category,
-        action,
-        `identifier=${this.identifier}`
-      );
+
+      // send these events if 14-day borrow return
+      if (detail?.borrowType === 'borrow') {
+        const { category, action } = detail.event;
+        this.loanAnanlytics?.sendEvent(category, action, this.identifier);
+      }
     });
 
     this.addEventListener('borrowBook', ({ detail }) => {
       this.handleBorrowIt();
       const { category, action } = detail.event;
-      this.loanAnanlytics?.sendEvent(
-        category,
-        action,
-        `identifier=${this.identifier}`
-      );
+      this.loanAnanlytics?.sendEvent(category, action, this.identifier);
     });
 
     this.addEventListener('loginAndBorrow', ({ detail }) => {
       this.handleLoginOk();
       const { category, action } = detail.event;
-      this.loanAnanlytics?.sendEvent(
-        category,
-        action,
-        `identifier=${this.identifier}`
-      );
+      this.loanAnanlytics?.sendEvent(category, action, this.identifier);
     });
 
     this.addEventListener('leaveWaitlist', ({ detail }) => {
       this.handleRemoveFromWaitingList();
       const { category, action } = detail.event;
-      this.loanAnanlytics?.sendEvent(
-        category,
-        action,
-        `identifier=${this.identifier}`
-      );
+      this.loanAnanlytics?.sendEvent(category, action, this.identifier);
     });
 
     this.addEventListener('joinWaitlist', ({ detail }) => {
       this.handleReserveIt();
       const { category, action } = detail.event;
-      this.loanAnanlytics?.sendEvent(
-        category,
-        action,
-        `identifier=${this.identifier}`
-      );
+      this.loanAnanlytics?.sendEvent(category, action, this.identifier);
     });
 
     this.addEventListener('purchaseBook', ({ detail }) => {
       const { category, action } = detail.event;
-      this.loanAnanlytics?.sendEvent(
-        category,
-        action,
-        `identifier=${this.identifier}`
-      );
+      this.loanAnanlytics?.sendEvent(category, action, this.identifier);
     });
 
     this.addEventListener('adminAccess', ({ detail }) => {
       const { category, action } = detail.event;
-      this.loanAnanlytics?.sendEvent(
-        category,
-        action,
-        `identifier=${this.identifier}`
-      );
+      this.loanAnanlytics?.sendEvent(category, action, this.identifier);
     });
 
     this.addEventListener('exitAdminAccess', ({ detail }) => {
       const { category, action } = detail.event;
-      this.loanAnanlytics?.sendEvent(
-        category,
-        action,
-        `identifier=${this.identifier}`
-      );
+      this.loanAnanlytics?.sendEvent(category, action, this.identifier);
     });
 
     this.addEventListener('bookTitleBar', ({ detail }) => {
       const { category, action } = detail.event;
-      this.loanAnanlytics?.sendEvent(
-        category,
-        action,
-        `identifier=${this.identifier}`
-      );
+      this.loanAnanlytics?.sendEvent(category, action, this.identifier);
     });
   }
 
@@ -214,7 +163,10 @@ export default class ActionsHandler extends LitElement {
       identifier: this.identifier,
       success: () => {
         this.deleteLoanCookies();
-        URLHelper.goToUrl(this.returnUrl, true);
+        // URLHelper.goToUrl(this.returnUrl, true);
+        setTimeout(() => {
+          URLHelper.goToUrl(this.returnUrl, true);
+        }, this.waitUntillBorrowComplete * 1000);
       },
       error: data => {
         this.dispatchActionError(action, data);

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

@@ -46,11 +46,7 @@ export default class LoanAnanlytics {
       );
     } catch (error) {
       console.log(error);
-      this.sendEvent(
-        'Cookies-Error-Actions',
-        error,
-        `identifier=${this.identifier}`
-      );
+      this.sendEvent('Cookies-Error-Actions', error, this.identifier);
     }
   }
 
@@ -78,7 +74,7 @@ export default class LoanAnanlytics {
         browse = browse ? Number(browse) + 1 : 1;
         this.gaStats.browse = browse;
 
-        // reset renew and expire count when browse
+        // reset renew and expire count
         renew = 0;
         expire = 0;
         break;
@@ -92,7 +88,7 @@ export default class LoanAnanlytics {
         expire = expire ? Number(expire) + 1 : 1;
         this.gaStats.expire = expire;
 
-        // reset renew and expire count when browse
+        // reset renew and expire count
         renew = 0;
         expire = 0;
         break;
@@ -104,37 +100,13 @@ export default class LoanAnanlytics {
     this.lendingEventCounts = { browse, renew, expire };
 
     // obtain GA category, event
-    // const { category, event } = await this.getGACategoryAction(action);
     const category = analyticsCategories.browse;
     const event = `browse${this.paddedNumber(
       this.gaStats?.browse
     )}-autorenew${this.paddedNumber(this.gaStats?.renew)}:${action}`;
 
     // send google analytics events
-    this.sendEvent(category, event, `identifier=${this.identifier}`, {
-      browse: this.gaStats?.browse,
-      renew: this.gaStats?.renew,
-      expire: this.gaStats?.expire,
-    });
-  }
-
-  /**
-   *
-   *
-   * @param {string} action - like 'browse|autorenew|etc...'
-   * @return {object} - contains GA category and event
-   * - @param {string}
-   * - @param {string}
-   *
-   * @memberof LoanAnanlytics
-   */
-  getGACategoryAction(action) {
-    const GACategory = analyticsCategories.browse;
-    const GAAction = `browse${this.paddedNumber(
-      this.gaStats?.browse
-    )}-autorenew${this.paddedNumber(this.gaStats?.renew)}:${action}`;
-
-    return { GACategory, GAAction };
+    this.sendEvent(category, event, this.identifier);
   }
 
   /**
@@ -168,21 +140,19 @@ export default class LoanAnanlytics {
    * @memberof LoanAnanlytics
    */
   sendEvent(eventCategory, eventAction, label, extraParams) {
-    console.debug(
-      'eventCategory:- ',
+    console.log(
+      'eventCategory:-',
       eventCategory,
-      '\neventAction:- ',
+      '\t||\teventAction:-',
       eventAction,
-      '\nlabel:- ',
-      label,
-      '\nextraParams:- ',
-      extraParams
+      '\t||\tlabel:-',
+      label
     );
 
     window?.archive_analytics?.send_event_no_sampling(
       eventCategory,
       eventAction,
-      label || `identifier=${this.identifier}`,
+      label || this.identifier,
       extraParams
     );
   }

package/src/core/services/loan-renew-helper.js

@@ -89,6 +89,7 @@ export class LoanRenewHelper {
     ) {
       this.result.texts = this.loanReturnWarning;
       this.result.renewNow = false; // not viewed
+      console.log('warning msg appears');
     } else if (pageChangedTime >= pageChangeTimeFrame) {
       this.result.texts = '';
       this.result.renewNow = true; // viewed in last time frame

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

@@ -37,18 +37,18 @@ export class LoanTokenPoller {
 
     if (this.borrowType) {
       // send consecutiveLoanCounts for browsed books only.
-      if (this.borrowType === 'browsed') {
-        try {
-          const existingCount = Cookies.getItem(
-            `loan-count-${this.identifier}`
-          );
-          consecutiveLoanCounts = existingCount ?? 1;
-        } catch (error) {
-          window?.Sentry?.captureException(
-            `${sentryLogs.enableBookAcces} - CookieError: ${error}`
-          );
-        }
-      }
+      // if (this.borrowType === 'browsed') {
+      //   try {
+      //     const existingCount = Cookies.getItem(
+      //       `loan-count-${this.identifier}`
+      //     );
+      //     consecutiveLoanCounts = existingCount ?? 1;
+      //   } catch (error) {
+      //     window?.Sentry?.captureException(
+      //       `${sentryLogs.enableBookAcces} - CookieError: ${error}`
+      //     );
+      //   }
+      // }
 
       // Do an initial token, then set an interval
       this.handleLoanTokenPoller(true);
@@ -67,16 +67,12 @@ export class LoanTokenPoller {
       }
 
       // event category and action for browsing book access
-      const category = `${this.borrowType}BookAccess`;
-      const action = `${
-        this.borrowType === 'browsed' ? 'BrowseCounts-' : 'Counts-'
-      }${consecutiveLoanCounts}`;
-
-      this.loanAnalytics?.sendEvent(
-        category,
-        action,
-        `identifier=${this.identifier}`
-      );
+      // const category = `${this.borrowType}BookAccess`;
+      // const action = `${
+      //   this.borrowType === 'browsed' ? 'BrowseCounts-' : 'Counts-'
+      // }${consecutiveLoanCounts}`;
+
+      // this.loanAnalytics?.sendEvent(category, action, this.identifier);
     } else {
       window?.Sentry?.captureMessage(
         `${sentryLogs.bookAccessed} - not borrowed`
@@ -104,7 +100,7 @@ export class LoanTokenPoller {
         this.loanAnalytics?.sendEvent(
           'LendingServiceLoanError',
           action,
-          `identifier=${this.identifier}`
+          this.identifier
         );
       },
       success: () => {

package/src/ia-book-actions.js

@@ -11,6 +11,7 @@ import './components/book-title-bar.js';
 import './components/text-group.js';
 import './components/info-icon.js';
 import './components/timer-countdown.js';
+import './core/config/ia-lending-intervals.js';
 
 import { GetLendingActions } from './core/services/get-lending-actions.js';
 import { mobileContainerWidth } from './core/config/constants.js';
@@ -18,9 +19,6 @@ import { sentryLogs } from './core/config/sentry-events.js';
 import { LoanTokenPoller } from './core/services/loan-token-poller.js';
 import { LoanRenewHelper } from './core/services/loan-renew-helper.js';
 
-import './core/config/ia-lending-intervals.js';
-import * as Cookies from './core/services/doc-cookies.js';
-
 export const events = {
   browseExpired: 'IABookReader:BrowsingHasExpired',
 };
@@ -75,6 +73,7 @@ export default class IABookActions extends LitElement {
     this.borrowType = ''; // (browsed|borrowed)
     this.consecutiveLoanCounts = 1; // consecutive loan count
     this.suppressToast = false;
+    this.suppressAutoRenew = false;
     this.browseTimer = undefined;
 
     /**
@@ -173,6 +172,7 @@ export default class IABookActions extends LitElement {
 
   async setupLendingToolbarActions() {
     this.suppressToast = false;
+    this.suppressAutoRenew = false;
 
     this.lendingOptions = new GetLendingActions(
       this.userid,
@@ -259,6 +259,10 @@ export default class IABookActions extends LitElement {
       this.suppressToast = true;
       this.closeToastManager();
 
+      if (this.suppressAutoRenew) {
+        return;
+      }
+
       if (this.borrowType === 'browsed') {
         this.autoLoanRenewChecker(true);
       }
@@ -290,6 +294,11 @@ export default class IABookActions extends LitElement {
     this.addEventListener('IABookActions:loanRenew', async event => {
       await this.autoLoanRenewChecker(false);
 
+      // maybe the renew with-in last 1 minute is too short of a transition time between xhr, loading images etc... let NOT renew in last 50 seconds.
+      if (event?.detail?.secondsLeft < 50) {
+        this.suppressAutoRenew = true;
+      }
+
       // show warning message with remaining time to auto returned it.
       if (this.loanRenewResult.renewNow === false) {
         this.loanRenewResult.secondsLeft = event.detail.secondsLeft;
@@ -405,9 +414,6 @@ export default class IABookActions extends LitElement {
     await this.localCache.delete(`${this.identifier}-loanTime`);
     await this.localCache.delete(`${this.identifier}-pageChangedTime`);
 
-    // remove loan-renew-count-<identifier> cookie
-    Cookies.removeItem(`loan-renew-count-${this.identifier}`);
-
     // show message after browsed book is expired.
     this.loanRenewResult.renewNow = false;
     this.loanRenewResult.texts =
@@ -507,8 +513,10 @@ export default class IABookActions extends LitElement {
    * - show success message
    * - then change the remaining time
    * - reset timer state
+   * @param {object} event
    */
-  async handleLoanAutoRenewed() {
+  async handleLoanAutoRenewed(event) {
+    // TODO: just read DATA variable here to apply security { action, data }
     if (this.loanRenewResult.renewNow) {
       window?.IALendingIntervals?.clearAll();
 
@@ -518,12 +526,12 @@ export default class IABookActions extends LitElement {
       await this.resetTimerCountState();
 
       window?.Sentry?.captureMessage(`${sentryLogs.bookHasRenewed}`);
-      // TODO: analytics?? for consecutive renew.....
 
       // testing console....
-      console.log(sentryLogs.bookHasRenewed, {
+      console.log('IABookActions: AutoRenewed:- ', {
+        ajaxResponse: event?.detail?.data,
         loanRenewResult: this.loanRenewResult,
-        browseHasRenew: this.lendingStatus.secondsLeftOnLoan,
+        secondsLeftOnLoan: Math.round(this.lendingStatus.secondsLeftOnLoan),
         resetTimerCountState: this._shadowRoot.querySelector('timer-countdown'),
       });
     }