@internetarchive/ia-book-actions 0.0.10 → 0.0.12-2

package/package.json

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

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

@@ -1,8 +1,8 @@
 import { LitElement } from 'lit-element';
-import { LocalCache } from '@internetarchive/local-cache';
 
 import { URLHelper } from '../../config/url-helper.js';
 import ActionsHandlerService from './actions-handler-service.js';
+import * as Cookies from '../doc-cookies.js';
 
 /**
  * These are callback functions calling from actions-config.js file.
@@ -17,7 +17,6 @@ export default class ActionsHandler extends LitElement {
     super();
     this.identifier = identifier;
     this.ajaxTimeout = 6000;
-    this.localCache = new LocalCache();
     this.bindEvents();
   }
 
@@ -242,36 +241,40 @@ export default class ActionsHandler extends LitElement {
     try {
       let newCount = 1;
       const storageKey = `loan-count-${this.identifier}`;
-      const existingCount = await this.localCache.get(storageKey);
+      const existingCount = Cookies.getItem(storageKey);
 
       // increase browse-count by 1 when you consecutive reading a book.
       if (action === 'browseAgain' && existingCount !== undefined) {
-        newCount = existingCount ? existingCount + 1 : 1;
+        newCount = existingCount ? Number(existingCount) + 1 : 1;
       }
 
+      const date = new Date();
+      date.setHours(date.getHours() + 2); // 2 hours
+
       // set new value
-      await this.localCache.set({
-        key: storageKey,
-        value: newCount,
-        ttl: 7200, // 2 hours
-      });
+      Cookies.setItem(storageKey, newCount, date, '/');
     } catch (error) {
-      console.log(error);
+      this.sendEvent('Cookies-Error-Actions', error);
     }
   }
 
   deleteLoanCookies() {
     const date = new Date();
     date.setTime(date.getTime() - 24 * 60 * 60 * 1000); // one day ago
-    const expiry = date.toGMTString();
-    let cookie = `loan-${this.identifier}=""`;
-    cookie += `; expires=${expiry}`;
-    cookie += '; path=/; domain=.archive.org;';
-    document.cookie = cookie;
-
-    cookie = `br-loan-${this.identifier}=""`;
-    cookie += `; expires=${expiry}`;
-    cookie += '; path=/; domain=.archive.org;';
-    document.cookie = cookie;
+
+    Cookies.setItem(
+      `loan-${this.identifier}=""`,
+      '',
+      date,
+      '/',
+      '.archive.org'
+    );
+    Cookies.setItem(
+      `br-loan-${this.identifier}=""`,
+      '',
+      date,
+      '/',
+      '.archive.org'
+    );
   }
 }

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

@@ -0,0 +1,83 @@
+/* eslint-disable */
+/**
+ * Helper module use to get, set and remove item from cookie
+ *
+ * See more:
+ *  https://developer.mozilla.org/en-US/docs/Web/API/document.cookie
+ *  https://developer.mozilla.org/User:fusionchess
+ *  https://github.com/madmurphy/cookies.js
+ *  This framework is released under the GNU Public License, version 3 or later.
+ *  http://www.gnu.org/licenses/gpl-3.0-standalone.html
+ */
+
+/**
+ * Get specific key's value stored in cookie
+ *
+ * @param {string} sKey
+ *
+ * @returns {string|null}
+ */
+export function getItem(sKey) {
+  if (!sKey) return null;
+
+  return (
+    decodeURIComponent(
+      // eslint-disable-next-line no-useless-escape
+      document.cookie.replace(
+        new RegExp(
+          '(?:(?:^|.*;)\\s*' +
+            encodeURIComponent(sKey).replace(/[\-\.\+\*]/g, '\\$&') +
+            '\\s*\\=\\s*([^;]*).*$)|^.*$'
+        ),
+        '$1'
+      )
+    ) || null
+  );
+}
+
+/**
+ * Set specific key's value in cookie
+ *
+ * @param {string} sKey cookie name
+ * @param {string} sValue cookie value
+ * @param {string} [vEnd] expire|max-age
+ * @param {string} [sPath] path of current item
+ * @param {string} [sDomain] domain name
+ * @param {boolean} [bSecure]
+ *
+ * @returns {true}
+ */
+export function setItem(sKey, sValue, vEnd, sPath, sDomain, bSecure) {
+  document.cookie =
+    encodeURIComponent(sKey) +
+    '=' +
+    encodeURIComponent(sValue) +
+    (vEnd ? `; expires=${vEnd.toUTCString()}` : '') +
+    (sDomain ? `; domain=${sDomain}` : '') +
+    (sPath ? `; path=${sPath}` : '') +
+    (bSecure ? `; secure` : '');
+
+  return true;
+}
+
+/**
+ * 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]
+ *
+ * @returns {boolean}
+ */
+export function removeItem(sKey, sPath, sDomain) {
+  // eslint-disable-next-line
+  if (!hasItem(sKey)) return false;
+
+  document.cookie =
+    encodeURIComponent(sKey) +
+    `=; expires=Thu, 01 Jan 1970 00:00:00 GMT` +
+    (sDomain ? `; domain=${sDomain}` : '') +
+    (sPath ? `; path=${sPath}` : '');
+
+  return true;
+}

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

@@ -1,5 +1,5 @@
-import { LocalCache } from '@internetarchive/local-cache';
 import ActionsHandlerService from './actions-handler/actions-handler-service.js';
+import * as Cookies from './doc-cookies.js';
 
 /**
  * This class is used to create loan token for borrowed books
@@ -15,7 +15,6 @@ export class LoanTokenPoller {
     this.pollerDelay = pollerDelay; // value in ms (1000 ms = 1 sec)
 
     this.loanTokenInterval = undefined;
-    this.localCache = new LocalCache();
     this.enableBookAccess();
   }
 
@@ -31,12 +30,12 @@ export class LoanTokenPoller {
       // send consecutiveLoanCounts for browsed books only.
       if (this.borrowType === 'browsed') {
         try {
-          const existingCount = await this.localCache.get(
+          const existingCount = Cookies.getItem(
             `loan-count-${this.identifier}`
           );
           consecutiveLoanCounts = existingCount ?? 1;
         } catch (error) {
-          console.log(error);
+          this.sendEvent('Cookies-Error-Token', error);
         }
       }
 
@@ -77,7 +76,12 @@ export class LoanTokenPoller {
       action,
       error: data => {
         this.disconnectedInterval(); // stop token fetch api
-        this.errorCallback({ detail: { action, data } });
+
+        if (isInitial) {
+          this.errorCallback({ detail: { action, data } });
+        } else {
+          this.errorCallback({ detail: { action, data, isExpired: true } });
+        }
       },
       success: () => {
         if (isInitial) this.successCallback();

package/src/ia-book-actions.js

@@ -162,6 +162,10 @@ export default class IABookActions extends LitElement {
       this.startBrowseTimer();
     }
 
+    if (this.lendingStatus.browsingExpired) {
+      this.tokenPoller.disconnectedInterval();
+    }
+
     // early return if not borrowed or no action-bar
     if (!this.borrowType || this.barType === 'title') {
       this.lendingBarPostInit();
@@ -261,6 +265,7 @@ export default class IABookActions extends LitElement {
    * @param {Object} event - The employee who is responsible for the project
    *  @param {string} event.detail.action - action when error occurred like 'browseBook', 'borrowBook'
    *  @param {string} event.detail.data.error - error message
+   *  @param {string} event.detail.data.isExpired - triggered when loan is expired
    */
   handleLendingActionError(event) {
     // toggle activity loader
@@ -268,8 +273,9 @@ export default class IABookActions extends LitElement {
 
     const action = event?.detail?.action;
     const errorMsg = event?.detail?.data?.error;
+    const loanExpired = event?.detail?.data?.isExpired;
 
-    if (errorMsg) this.showErrorModal(errorMsg, action);
+    if (errorMsg) this.showErrorModal(errorMsg, action, loanExpired);
 
     // update action bar state if book is not available to browse or borrow.
     if (errorMsg && errorMsg.match(/not available to borrow/gm)) {
@@ -290,7 +296,7 @@ export default class IABookActions extends LitElement {
   }
 
   /* show error message if something went wrong */
-  async showErrorModal(errorMsg, action) {
+  async showErrorModal(errorMsg, action, loanExpired) {
     this.disableActionGroup = false;
 
     // check if this.modal passed as prop
@@ -311,23 +317,14 @@ export default class IABookActions extends LitElement {
     });
 
     if (action === 'create_token') {
-      const refreshButton = html`<button
-        style="background:none;font-size:inherit;border:0;padding:0;color:#0000ee;cursor:pointer;text-decoration:underline"
-        @click=${() => window.location.reload(true)}
-      >
-        refresh
-      </button>`;
-
       modalConfig.closeOnBackdropClick = false;
-      modalConfig.showCloseButton = false;
-      modalConfig.message = html` Uh oh, something went wrong trying to access
-        this book.<br />
-        Please ${refreshButton} to try again or send us an email to
-        <a
-          href="mailto:info@archive.org?subject=Help: cannot access my borrowed book: ${this
-            .identifier}"
-          >info@archive.org</a
-        >`;
+      if (loanExpired) {
+        modalConfig.showCloseButton = true;
+        modalConfig.message = this.loanExpiredMessage;
+      } else {
+        modalConfig.showCloseButton = false;
+        modalConfig.message = this.loanErrorMessage;
+      }
     }
 
     this.modal.showModal({
@@ -335,6 +332,29 @@ export default class IABookActions extends LitElement {
     });
   }
 
+  /* eslint-disable class-methods-use-this */
+  get loanExpiredMessage() {
+    return html`Your current loan is expired, please close this model and click
+      on <strong>Borrow Again</strong> button to continue reading this book`;
+  }
+
+  get loanErrorMessage() {
+    const refreshButton = html`<button
+      style="background:none;font-size:inherit;border:0;padding:0;color:#0000ee;cursor:pointer;text-decoration:underline"
+      @click=${() => window.location.reload(true)}
+    >
+      refresh
+    </button>`;
+
+    return html`Uh oh, something went wrong trying to access this book.<br />
+      Please ${refreshButton} to try again or send us an email to
+      <a
+        href="mailto:info@archive.org?subject=Help: cannot access my borrowed book: ${this
+          .identifier}"
+        >info@archive.org</a
+      >`;
+  }
+
   get iconClass() {
     return this.width <= mobileContainerWidth ? 'mobile' : 'desktop';
   }

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

@@ -1,13 +1,13 @@
 import { expect } from '@open-wc/testing';
 import Sinon from 'sinon';
 
-import { LocalCache } from '@internetarchive/local-cache';
+// import { LocalCache } from '@internetarchive/local-cache';
 import { LoanTokenPoller } from '../../../src/core/services/loan-token-poller.js';
 
 describe('Get Loan Token', () => {
   it('get loan token for browsed books', async () => {
-    const localCacheStub = new LocalCache();
-    const localCacheGetSpy = Sinon.spy(localCacheStub, 'get');
+    // const localCacheStub = new LocalCache();
+    // const localCacheGetSpy = Sinon.spy(localCacheStub, 'get');
 
     const tokenPoller = new LoanTokenPoller(
       'identifier1',
@@ -24,14 +24,14 @@ describe('Get Loan Token', () => {
     successCallbackSpy();
     expect(successCallbackSpy.callCount).to.equal(1);
 
-    localCacheGetSpy();
-    expect(localCacheGetSpy.callCount).to.equal(1);
+    // localCacheGetSpy();
+    // expect(localCacheGetSpy.callCount).to.equal(1);
 
-    expect(tokenPoller.localCache.namespace).to.equal('LocalCache');
-    expect(tokenPoller.localCache.get).to.be.a('function');
+    // expect(tokenPoller.localCache.namespace).to.equal('LocalCache');
+    // expect(tokenPoller.localCache.get).to.be.a('function');
 
-    tokenPoller.disconnectedInterval(); // clear token poller interval
-    expect(tokenPoller.loanTokenInterval).to.equal(undefined);
+    // tokenPoller.disconnectedInterval(); // clear token poller interval
+    // expect(tokenPoller.loanTokenInterval).to.equal(undefined);
 
     tokenPoller.handleLoanTokenPoller(true);
     expect(tokenPoller.errorCallback).to.be.a('function');