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

package/demo/index.html

@@ -128,7 +128,7 @@
     iaBookActions.modalConfig = modalConfig;
     iaBookActions.lendingBarPostInit = lendingBarPostInit;
     iaBookActions.tokenDelay = 2; // 2 seconds
-    iaBookActions.returnUrl = 'https://openlibrary.org';
+    iaBookActions.returnUrl = '';
     iaBookActions.localCache = localCache;
 
     let loanTotalTime2Min = { loanTotalTime: 10, loanRenewAtLast: 5, pageChangedInLast: 5 };

package/package.json

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

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

@@ -1,18 +1,16 @@
 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 LoanAnanlytics from '../loan-analytics.js';
 import * as Cookies from '../doc-cookies.js';
 
 /**
  * These are callback functions calling from actions-config.js file.
  *
- * ActionsHandlerService is a function being used to execute
- * APIs based of the request made by user. It consist some parameters are as follows:-
- * 1. identifier: book name.
+ * ActionsHandlerService is a function being used to execute APIs based of the request made by user.
+ *
  */
 
 export default class ActionsHandler extends LitElement {
@@ -25,200 +23,149 @@ export default class ActionsHandler extends LitElement {
      */
     this.waitUntillBorrowComplete = 6; // in seconds
 
-    this.bindEvents();
-  }
-
-  /**
-   * 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,
-      label || `identifier=${this.identifier}`,
-      extraParams
-    );
-  }
+    /**
+     * bind events for lending bar
+     * @type {object}
+     */
+    this.loanAnanlytics = new LoanAnanlytics();
 
-  get getLoanCountStorageKey() {
-    return `br-browse-${this.identifier}`;
+    /**
+     * bind events for lending bar
+     * @type {Function}
+     */
+    this.bindEvents();
   }
 
   bindEvents() {
     this.addEventListener('browseBook', ({ detail }) => {
       this.handleBrowseIt();
-      this.setConsecutiveLoanCounts('browseBook');
+      this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'browse');
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('browseBookAgain', ({ detail }) => {
       this.handleBrowseIt();
-      this.setConsecutiveLoanCounts('browseBookAgain');
+      this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'browseagain');
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('autoRenew', ({ detail }) => {
       this.handleLoanRenewNow();
-      this.setConsecutiveLoanCounts('autoRenew');
+      this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'autorenew');
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('autoReturn', ({ detail }) => {
-      this.setConsecutiveLoanCounts('autoReturn');
+      this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'autoreturn');
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('returnNow', ({ detail }) => {
+      this.loanAnanlytics?.storeLoanStatsCount(this.identifier, 'return');
       this.handleReturnIt();
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('borrowBook', ({ detail }) => {
       this.handleBorrowIt();
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('loginAndBorrow', ({ detail }) => {
       this.handleLoginOk();
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('leaveWaitlist', ({ detail }) => {
       this.handleRemoveFromWaitingList();
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('joinWaitlist', ({ detail }) => {
       this.handleReserveIt();
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('purchaseBook', ({ detail }) => {
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('adminAccess', ({ detail }) => {
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('exitAdminAccess', ({ detail }) => {
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
+      this.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     });
 
     this.addEventListener('bookTitleBar', ({ detail }) => {
       const { category, action } = detail.event;
-      this.sendEvent(category, action);
-    });
-  }
-
-  /**
-   * 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.loanAnanlytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
       );
-      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() {
@@ -334,7 +281,7 @@ export default class ActionsHandler extends LitElement {
    */
   dispatchActionError(action, data = {}) {
     // send LendingServiceError to GA
-    this.sendEvent('LendingServiceError', action);
+    this.loanAnanlytics?.sendEvent('LendingServiceError', action);
 
     this.dispatchEvent(
       new CustomEvent('lendingActionError', {

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

@@ -0,0 +1,189 @@
+/* eslint-disable class-methods-use-this */
+
+import { analyticsCategories } from '../config/analytics-event-and-category.js';
+import * as Cookies from './doc-cookies.js';
+
+/**
+ * This class is used to send different GA events for loan system.
+ */
+export default class LoanAnanlytics {
+  constructor() {
+    this.identifier = undefined;
+
+    /**
+     * contains the counts we send to GA
+     * @type {object}
+     * - @param {number} - browse count
+     * - @param {number} - renew count
+     * - @param {number} - expire count
+     */
+    this.gaStats = {};
+  }
+
+  /**
+   * store loan stats count in cookies to remember the count we need to sent GA
+   *
+   * @param {string} identifier - book id
+   * @param {string} action - user action on book
+   * @return {void}
+   * @memberof ActionsHandler
+   */
+  async storeLoanStatsCount(idetifier, action = '') {
+    this.identifier = idetifier;
+
+    try {
+      await this.getLoanStatsCount(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);
+      this.sendEvent(
+        'Cookies-Error-Actions',
+        error,
+        `identifier=${this.identifier}`
+      );
+    }
+  }
+
+  /**
+   * get loan stats count from cookies for GA
+   *
+   * @param {string} action 'browse'|'autorenew'|etc...
+   * @memberof ActionsHandler
+   */
+  async getLoanStatsCount(action) {
+    this.lendingEventCounts = JSON.parse(
+      Cookies.getItem(this.getLoanCountStorageKey)
+    );
+
+    this.gaStats = this.lendingEventCounts ?? {
+      browse: 0,
+      renew: 0,
+      expire: 0,
+    };
+
+    let { browse, renew, expire } = this.lendingEventCounts ?? 0;
+
+    switch (action) {
+      case 'browse' || 'browseagain':
+        browse = browse ? Number(browse) + 1 : 1;
+        this.gaStats.browse = browse;
+
+        // reset renew and expire count when browse
+        renew = 0;
+        expire = 0;
+        break;
+
+      case 'autorenew':
+        renew = renew ? Number(renew) + 1 : 1;
+        this.gaStats.renew = renew;
+        break;
+
+      case 'return' || 'autoreturn':
+        expire = expire ? Number(expire) + 1 : 1;
+        this.gaStats.expire = expire;
+
+        // reset renew and expire count when browse
+        renew = 0;
+        expire = 0;
+        break;
+      default:
+        break;
+    }
+
+    // store these counts in cookies
+    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 };
+  }
+
+  /**
+   * get zero padded number
+   *
+   * @param {number} number
+   * @return {string} browse001|autorenew001
+   * @memberof LoanAnanlytics
+   */
+  paddedNumber(number) {
+    return number.toString().padStart(3, '0');
+  }
+
+  /**
+   * get storage key for loan stats count
+   *
+   * @readonly
+   * @memberof LoanAnanlytics
+   */
+  get getLoanCountStorageKey() {
+    return `br-browse-${this.identifier}`;
+  }
+
+  /**
+   * reponsible to sent events to GA
+   *
+   * @param {*} eventCategory
+   * @param {*} eventAction
+   * @param {*} label
+   * @param {*} extraParams
+   * @memberof LoanAnanlytics
+   */
+  sendEvent(eventCategory, eventAction, label, extraParams) {
+    console.debug(
+      'eventCategory:- ',
+      eventCategory,
+      '\neventAction:- ',
+      eventAction,
+      '\nlabel:- ',
+      label,
+      '\nextraParams:- ',
+      extraParams
+    );
+
+    window?.archive_analytics?.send_event_no_sampling(
+      eventCategory,
+      eventAction,
+      label || `identifier=${this.identifier}`,
+      extraParams
+    );
+  }
+}

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

@@ -1,4 +1,5 @@
 import ActionsHandlerService from './actions-handler/actions-handler-service.js';
+import LoanAnanlytics from './loan-analytics.js';
 import { sentryLogs } from '../config/sentry-events.js';
 
 import * as Cookies from './doc-cookies.js';
@@ -17,6 +18,13 @@ export class LoanTokenPoller {
     this.pollerDelay = pollerDelay; // value in seconds
 
     this.loanTokenInterval = undefined;
+
+    /**
+     * loan analytics instance
+     * @see loan-analytics.js
+     */
+    this.loanAnalytics = new LoanAnanlytics();
+
     this.bookAccessed();
   }
 
@@ -39,7 +47,6 @@ export class LoanTokenPoller {
           window?.Sentry?.captureException(
             `${sentryLogs.enableBookAcces} - CookieError: ${error}`
           );
-          this.sendEvent('Cookies-Error-Token', error);
         }
       }
 
@@ -65,7 +72,11 @@ export class LoanTokenPoller {
         this.borrowType === 'browsed' ? 'BrowseCounts-' : 'Counts-'
       }${consecutiveLoanCounts}`;
 
-      this.sendEvent(category, action);
+      this.loanAnalytics?.sendEvent(
+        category,
+        action,
+        `identifier=${this.identifier}`
+      );
     } else {
       window?.Sentry?.captureMessage(
         `${sentryLogs.bookAccessed} - not borrowed`
@@ -76,14 +87,6 @@ export class LoanTokenPoller {
     }
   }
 
-  sendEvent(eventCategory, eventAction) {
-    window?.archive_analytics?.send_event_no_sampling(
-      eventCategory,
-      eventAction,
-      `identifier=${this.identifier}`
-    );
-  }
-
   async handleLoanTokenPoller(isInitial = false) {
     const action = 'create_token';
     ActionsHandlerService({
@@ -98,7 +101,11 @@ export class LoanTokenPoller {
         );
 
         // send LendingServiceError to GA
-        this.sendEvent('LendingServiceLoanError', action);
+        this.loanAnalytics?.sendEvent(
+          'LendingServiceLoanError',
+          action,
+          `identifier=${this.identifier}`
+        );
       },
       success: () => {
         if (isInitial) this.successCallback();