@internetarchive/ia-book-actions 0.1.4-alpha7 → 0.1.5-alpha1

package/demo/index.html

@@ -131,11 +131,11 @@
     iaBookActions.returnUrl = 'https://openlibrary.org';
     iaBookActions.localCache = localCache;
 
-    let loanTotalTime2Min = { loanTotalTime: 20, loanRenewAtLast: 15, pageChangedInLast: 5 };
-    let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 230, pageChangedInLast: 15 };
+    let loanTotalTime2Min = { loanTotalTime: 10, loanRenewAtLast: 5, pageChangedInLast: 5 };
+    let loanTotalTime5Min = { loanTotalTime: 300, loanRenewAtLast: 290, pageChangedInLast: 15 };
     let loanTotalTime1Hour = { loanTotalTime: 3600, loanRenewAtLast: 600, pageChangedInLast: 900 };
 
-    iaBookActions.loanRenewTimeConfig = loanTotalTime5Min;
+    iaBookActions.loanRenewTimeConfig = loanTotalTime2Min;
 
     let lendingStatus1 = iaBookActions.lendingStatus;
     let secondsLeftOnLoan = iaBookActions.loanRenewTimeConfig.loanTotalTime;
@@ -298,16 +298,6 @@
         })
       );
     })
-
-    document.querySelector('.pageChangedEventSec').addEventListener('click', () => {
-      window.dispatchEvent(
-        new CustomEvent('BookReader:userAction', {
-          detail: {},
-          bubbles: true,
-          composed: true,
-        })
-      );
-    })
 </script>
 
   <div>
@@ -320,7 +310,6 @@
             </td>
             <td>
               <button class="pageChangedEvent">Page Change Event</button>
-              <button class="pageChangedEventSec">BR Controls Event</button>
             </td>
           </tr>
         </table>

package/package.json

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

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

@@ -32,7 +32,8 @@ export class CollapsibleActionGroup extends ActionsHandler {
       dropdownArrow: { type: String },
       disabled: { type: Boolean },
       returnUrl: { type: String },
-      renewNow: { type: Boolean },
+      autoRenew: { type: Boolean },
+      autoReturn: { type: Boolean },
     };
   }
 
@@ -52,7 +53,8 @@ export class CollapsibleActionGroup extends ActionsHandler {
     this.loaderIcon = 'https://archive.org/upload/images/tree/loading.gif';
     this.disabled = false;
     this.returnUrl = '';
-    this.renewNow = false;
+    this.autoRenew = false;
+    this.autoReturn = false;
   }
 
   updated(changed) {
@@ -63,21 +65,33 @@ export class CollapsibleActionGroup extends ActionsHandler {
       this.resetActions();
     }
 
-    if (changed.has('renewNow') && this.renewNow === true) {
-      this.dispatchLoanRenewEvent();
+    if (changed.has('autoRenew') && this.autoRenew === true) {
+      this.dispatchLoanEvent('autoRenew');
+    }
+
+    if (changed.has('autoReturn') && this.autoReturn === true) {
+      this.dispatchLoanEvent('autoReturn');
     }
   }
 
-  // dispatch this event to loan renew handler
-  dispatchLoanRenewEvent() {
-    const { category, action } = {
-      category: analyticsCategories.browse,
-      action: analyticsActions.browseLoanRenew,
-    };
+  /**
+   * dispatch event when book is auto renewed / returned
+   * listen these events in action-handler.js
+   * @see ActionsHandler
+   *
+   * @param {string} event - autoRenew|autoReturn
+   * @memberof CollapsibleActionGroup
+   */
+  dispatchLoanEvent(event) {
+    const category = analyticsCategories.browse;
+    const action =
+      event === 'autoRenew'
+        ? analyticsActions.browseAutoRenew
+        : analyticsActions.browseAutoReturn;
 
     // listen in action-handler.js to execute ajax call on petabox.
     this.dispatchEvent(
-      new CustomEvent('loanRenew', {
+      new CustomEvent(event, {
         detail: {
           event: { category, action },
         },

package/src/components/timer-countdown.js

@@ -41,7 +41,7 @@ export default class TimerCountdown extends LitElement {
      * delay seconds in setInterval function
      * @type {number}
      */
-    this.timerExecutionSeconds = 0;
+    this.timerExecutionSeconds = 60;
   }
 
   disconnectedCallback() {
@@ -61,8 +61,6 @@ export default class TimerCountdown extends LitElement {
   timerCountdown() {
     this.disconnectedCallback();
 
-    // - let just execute setInterval in every 1 minute
-    this.timerExecutionSeconds = 60;
     let secondsLeft = this.secondsLeftOnLoan;
 
     // store current time

package/src/core/config/analytics-event-and-category.js

@@ -13,7 +13,8 @@ export const analyticsCategories = {
 export const analyticsActions = {
   browse: 'Borrow-1Hour',
   browseAgain: 'Borrow-Again',
-  browseLoanRenew: 'Borrow-Loan-Renew',
+  browseAutoRenew: 'AutoRenewBook',
+  browseAutoReturn: 'AutoReturnBook',
   borrow: 'Borrow-14Days',
   waitlistJoin: 'JoinWaitlist',
   waitlistLeave: 'LeaveWaitlist',

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

@@ -2,6 +2,7 @@ import { LitElement } from 'lit';
 
 import { URLHelper } from '../../config/url-helper.js';
 import { sentryLogs } from '../../config/sentry-events.js';
+import { analyticsCategories } from '../../config/analytics-event-and-category.js';
 
 import ActionsHandlerService from './actions-handler-service.js';
 import * as Cookies from '../doc-cookies.js';
@@ -27,31 +28,50 @@ export default class ActionsHandler extends LitElement {
     this.bindEvents();
   }
 
-  sendEvent(eventCategory, eventAction) {
-    window?.archive_analytics?.send_event(
+  /**
+   * reponsible to sent events to GA
+   *
+   * @param {string} eventCategory
+   * @param {string} eventAction
+   * @memberof ActionsHandler
+   */
+  sendEvent(eventCategory, eventAction, label, extraParams) {
+    window?.archive_analytics?.send_event_no_sampling(
       eventCategory,
       eventAction,
-      `identifier=${this.identifier}`
+      label || `identifier=${this.identifier}`,
+      extraParams
     );
   }
 
+  get getLoanCountStorageKey() {
+    return `br-browse-${this.identifier}`;
+  }
+
   bindEvents() {
     this.addEventListener('browseBook', ({ detail }) => {
       this.handleBrowseIt();
-      this.setConsecutiveLoanCounts();
+      this.setConsecutiveLoanCounts('browseBook');
       const { category, action } = detail.event;
       this.sendEvent(category, action);
     });
 
     this.addEventListener('browseBookAgain', ({ detail }) => {
       this.handleBrowseIt();
-      this.setConsecutiveLoanCounts('browseAgain');
+      this.setConsecutiveLoanCounts('browseBookAgain');
+      const { category, action } = detail.event;
+      this.sendEvent(category, action);
+    });
+
+    this.addEventListener('autoRenew', ({ detail }) => {
+      this.handleLoanRenewNow();
+      this.setConsecutiveLoanCounts('autoRenew');
       const { category, action } = detail.event;
       this.sendEvent(category, action);
     });
 
-    this.addEventListener('loanRenew', ({ detail }) => {
-      this.handleLoanRenew();
+    this.addEventListener('autoReturn', ({ detail }) => {
+      this.setConsecutiveLoanCounts('autoReturn');
       const { category, action } = detail.event;
       this.sendEvent(category, action);
     });
@@ -107,6 +127,100 @@ export default class ActionsHandler extends LitElement {
     });
   }
 
+  /**
+   * store consecutive one hour loan counts in cookies for GA
+   *
+   * There are two possible way of consecutive loan
+   * - book is browsed again just after getting expired
+   * - book loan is auto renewed for another hour
+   *
+   * @param {string} action - user action on book
+   * @return {void}
+   * @memberof ActionsHandler
+   */
+  async setConsecutiveLoanCounts(action = '') {
+    try {
+      await this.getConsecutiveLoanRecord(action);
+
+      const date = new Date();
+      date.setHours(date.getHours() + 2); // 2 hours
+
+      // set new value
+      Cookies.setItem(
+        this.getLoanCountStorageKey,
+        JSON.stringify(this.lendingEventCounts),
+        date,
+        '/'
+      );
+    } catch (error) {
+      console.log(error);
+      window?.Sentry?.captureException(
+        `${sentryLogs.setConsecutiveLoanCounts} - Error: ${error}`
+      );
+      this.sendEvent('Cookies-Error-Actions', error);
+    }
+  }
+
+  /**
+   * Get consecutive loan count records from cookies for GA
+   *
+   * @param {string} action
+   * @memberof ActionsHandler
+   */
+  async getConsecutiveLoanRecord(action) {
+    const gaStats = { browse: 0, renew: 0, expire: 0 };
+
+    this.lendingEventCounts = JSON.parse(
+      Cookies.getItem(this.getLoanCountStorageKey)
+    );
+
+    let browse = this.lendingEventCounts?.browse ?? 0;
+    let renew = this.lendingEventCounts?.renew ?? 0;
+    let expire = this.lendingEventCounts?.expire ?? 0;
+
+    if (this.lendingEventCounts !== null) {
+      switch (action) {
+        case 'browseBook' || 'browseBookAgain':
+          browse = browse ? Number(browse) + 1 : 1;
+          gaStats.browse = browse;
+          break;
+
+        case 'autoRenew':
+          renew = renew ? Number(renew) + 1 : 1;
+          gaStats.renew = renew;
+          this.sendEvent(
+            analyticsCategories.browse,
+            `BookAutoRenewedFor${renew}`
+          );
+          break;
+
+        case 'autoReturn':
+          expire = expire ? Number(expire) + 1 : 1;
+          gaStats.expire = expire;
+
+          renew = 0; // reset renew count when book is expired
+          break;
+        default:
+          break;
+      }
+    }
+
+    // store these counts in cookies
+    this.lendingEventCounts = { browse, renew, expire };
+
+    // send google analytics events
+    this.sendEvent(
+      analyticsCategories.browse,
+      `browse${gaStats.browse}-autoRenew${gaStats.renew}-autoExpire${gaStats.expire}`,
+      '',
+      {
+        browse: gaStats.browse,
+        renew: gaStats.renew,
+        expire: gaStats.expire,
+      }
+    );
+  }
+
   handleBrowseIt() {
     const action = 'browse_book';
     this.dispatchToggleActionGroup();
@@ -124,7 +238,7 @@ export default class ActionsHandler extends LitElement {
     });
   }
 
-  handleLoanRenew() {
+  handleLoanRenewNow() {
     const action = 'renew_loan';
 
     ActionsHandlerService({
@@ -271,31 +385,6 @@ export default class ActionsHandler extends LitElement {
     }, this.waitUntillBorrowComplete * 1000);
   }
 
-  // save consecutive loan count for borrow
-  async setConsecutiveLoanCounts(action = '') {
-    try {
-      let newCount = 1;
-      const storageKey = `loan-count-${this.identifier}`;
-      const existingCount = Cookies.getItem(storageKey);
-
-      // increase browse-count by 1 when you consecutive reading a book.
-      if (action === 'browseAgain' && existingCount !== undefined) {
-        newCount = existingCount ? Number(existingCount) + 1 : 1;
-      }
-
-      const date = new Date();
-      date.setHours(date.getHours() + 2); // 2 hours
-
-      // set new value
-      Cookies.setItem(storageKey, newCount, date, '/');
-    } catch (error) {
-      window?.Sentry?.captureException(
-        `${sentryLogs.setConsecutiveLoanCounts} - Error: ${error}`
-      );
-      this.sendEvent('Cookies-Error-Actions', error);
-    }
-  }
-
   /**
    * set browse time in indexedDB
    */

package/src/core/services/doc-cookies.js

@@ -62,7 +62,7 @@ export function setItem(sKey, sValue, vEnd, sPath, sDomain, bSecure) {
 
 /**
  * BROKEN Remove specific key's value from cookie
- * @fixme hasItem isn't even implemented! This will always error.
+ *
  * @param {string} sKey cookie name
  * @param {string} [sPath] path of current item
  * @param {string} [sDomain]
@@ -81,3 +81,25 @@ export function removeItem(sKey, sPath, sDomain) {
 
   return true;
 }
+
+/**
+ * determine if a specific cookie is exist
+ *
+ * @param {string} sKey cookie name
+ *
+ * @returns {boolean}
+ */
+export function hasItem(sKey) {
+  const reCNameAllowed = /^(?:expires|max\-age|path|domain|secure|samesite|httponly)$/i;
+
+  // eslint-disable-next-line
+  if (!sKey || reCNameAllowed.test(sKey)) {
+    return false;
+  }
+
+  return new RegExp(
+    '(?:^|;\\s*)' +
+      encodeURIComponent(sKey).replace(/[\-\.\+\*]/g, '\\$&') +
+      '\\s*\\='
+  ).test(document.cookie);
+}

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

@@ -77,7 +77,7 @@ export class LoanTokenPoller {
   }
 
   sendEvent(eventCategory, eventAction) {
-    window?.archive_analytics?.send_event(
+    window?.archive_analytics?.send_event_no_sampling(
       eventCategory,
       eventAction,
       `identifier=${this.identifier}`

package/src/ia-book-actions.js

@@ -11,7 +11,6 @@ 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';
@@ -19,6 +18,9 @@ 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',
 };
@@ -236,16 +238,10 @@ export default class IABookActions extends LitElement {
     /**
      * tokenPoller determines if user has loan token for this book
      * - if book is going to renew, need to wait until renew is completed
-     * - otherwise execute immediately
      */
-    setTimeout(
-      () => {
-        if (!hasExpired) this.startLoanTokenPoller();
-      },
-
-      // if book is renew while reading, let's wait to execute create-token api
-      this.loanRenewResult.renewNow ? this.tokenDelay * 1000 : 100
-    );
+    setTimeout(() => {
+      if (!hasExpired) this.startLoanTokenPoller();
+    }, 100);
   }
 
   /**
@@ -260,7 +256,6 @@ export default class IABookActions extends LitElement {
      * dispatched this event from bookreader page changed
      */
     window.addEventListener('BookReader:userAction', () => {
-      console.log('user action');
       this.suppressToast = true;
       this.closeToastManager();
 
@@ -293,7 +288,6 @@ export default class IABookActions extends LitElement {
      * @see TimerCountdown::timerCountdown
      */
     this.addEventListener('IABookActions:loanRenew', async event => {
-      console.log('event::loanRenew');
       await this.autoLoanRenewChecker(false);
 
       // show warning message with remaining time to auto returned it.
@@ -326,7 +320,7 @@ export default class IABookActions extends LitElement {
    * close/hide toast message
    */
   async closeToastManager() {
-    let toastTemplate = this.shadowRoot.querySelector('toast-template');
+    const toastTemplate = this.shadowRoot.querySelector('toast-template');
     if (toastTemplate) {
       toastTemplate?.remove();
     }
@@ -411,6 +405,9 @@ 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 =
@@ -493,7 +490,8 @@ export default class IABookActions extends LitElement {
         .loanTotalTime=${this.loanRenewTimeConfig.loanTotalTime}
         ?hasAdminAccess=${this.hasAdminAccess}
         ?disabled=${this.disableActionGroup}
-        ?renewNow=${this.loanRenewResult.renewNow}
+        ?autoRenew=${this.loanRenewResult.renewNow}
+        ?autoReturn=${this.lendingStatus.browsingExpired}
         @loanAutoRenewed=${this.handleLoanAutoRenewed}
         @lendingActionError=${this.handleLendingActionError}
         @toggleActionGroup=${this.handleToggleActionGroup}
@@ -591,7 +589,8 @@ export default class IABookActions extends LitElement {
     const errorMsg = event?.detail?.data?.error;
 
     // template not show create_token errors
-    if (errorMsg && action !== 'create_token') this.showErrorModal(errorMsg, action);
+    if (errorMsg && action !== 'create_token')
+      this.showErrorModal(errorMsg, action);
 
     // if error related to loan token
     // - clear tokenPoller interval