@internetarchive/ia-book-actions 1.4.1 → 1.4.3-alpha-adminsticky

package/.github/workflows/ci.yml

@@ -11,16 +11,17 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-node@v3
+    - uses: actions/checkout@v4.1.1
+    - uses: actions/setup-node@v4.0.2
       with:
-        node-version: 16.x
+        node-version: 20.x
 
     - name: Install dependencies
       run: yarn install
 
-    # - name: Run tests
-    #   run: yarn run test
+    - name: Run tests
+      run: yarn run test
 
-    # - name: Upload reports
-    #   run: npx codecov
+    - uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

package/.github/workflows/pr-preview.yml

@@ -12,26 +12,53 @@ on:
       - synchronize
       - closed
 
+permissions:
+  contents: write
+  pull-requests: write
+
 concurrency: preview-${{ github.ref }}
 
+env:
+  PREVIEW_BRANCH: gh-pages
 jobs:
   deploy-preview:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 20.x
+      - uses: actions/setup-node@v4
 
       - name: Install and Build
         run: |
           yarn install
           yarn prepare:ghpages
+
       # Reference: https://github.com/rossjrw/pr-preview-action
       - name: Deploy preview
         uses: rossjrw/pr-preview-action@v1
+        id: preview-step
         with:
           source-dir: ./ghpages/
           umbrella-dir: pr
+          preview-branch: ${{ env.PREVIEW_BRANCH }}
+          comment: false
+
+      - uses: marocchino/sticky-pull-request-comment@v2
+        if: steps.preview-step.outputs.deployment-action == 'deploy'
+        with:
+          header: pr-preview
+          message: |
+            [PR Preview Action](https://github.com/rossjrw/pr-preview-action) ${{ steps.preview-step.outputs.action-version }}
+            :---:
+            | <p></p> :rocket: View preview at <br> ${{ steps.preview-step.outputs.preview-url }} <br><br>
+            | <h6>Built to branch [`${{ env.PREVIEW_BRANCH }}`](${{ github.server_url }}/${{ github.repository }}/tree/${{ env.PREVIEW_BRANCH }}) at ${{ steps.preview-step.outputs.action-start-time }}. <br> Preview will be ready when the [GitHub Pages deployment](${{ github.server_url }}/${{ github.repository }}/deployments) is complete. <br><br> </h6>
+
+      - uses: marocchino/sticky-pull-request-comment@v2
+        if: steps.preview-step.outputs.deployment-action == 'remove'
+        with:
+          header: pr-preview
+          message: |
+            [PR Preview Action](https://github.com/rossjrw/pr-preview-action) ${{ steps.preview-step.outputs.action-version }}
+            :---:
+            Preview removed because the pull request was closed.
+            ${{ steps.preview-step.outputs.action-start-time }}

package/README.md

@@ -1,12 +1,21 @@
-# Component for lendable and embed items
 
-The book action button component build on LitElement with support for custom content and light DOM elements.
+![Build Status](https://github.com/internetarchive/iaux-book-actions/actions/workflows/ci.yml/badge.svg) [![codecov](https://codecov.io/gh/internetarchive/iaux-book-actions/branch/main/graph/badge.svg?token=ZOYRJ2BV9W)](https://codecov.io/gh/internetarchive/iaux-book-actions)
+
+# Internet Archive Book Lending Actions
+
+This WebComponent, built using the [IA Typescript WebComponent Template](https://github.com/internetarchive/iaux-typescript-wc-template), provides support for Bookreader actions for borrowable books on Internet Archive. It extends the [Open WebComponents generator](https://open-wc.org/docs/development/generator/) with Internet Archive-specific features and developer tools.
 
 ## Installation
 ```bash
 yarn install --save @internetarchive/ia-book-actions
 ```
 
+## Local Demo with `web-dev-server`
+```bash
+yarn start
+```
+To run a local development server that serves the basic demo located in `index.html`
+
 ## Usage of Book Actions
 ```html
 <!-- index.html -->

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "1.4.1",
   "description": "Bookreader actions for borrowable book",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/internetarchive/iaux-account-settings.git"
+  },
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",
+  "version": "1.4.3-alpha-adminsticky",
   "main": "index.js",
   "module": "index.js",
   "publishConfig": {
@@ -15,28 +19,27 @@
     "prepare": "rimraf dist && husky install",
     "lint": "eslint --ext \"./src/*.js\",.html . --ignore-path .gitignore && prettier \"./src/*.js\" --check --ignore-path .gitignore",
     "format": "eslint --ext \"./src/*.js\",.html . --fix --ignore-path .gitignore && prettier \"./src/*.js\" --write --ignore-path .gitignore",
-    "test": "yarn run lint && yarn test:fast",
-    "test:fast": "web-test-runner --coverage --playwright --browsers chromium firefox webkit",
+    "test": "yarn run format && yarn run lint && yarn test:fast --coverage",
+    "test:fast": "web-test-runner",
     "test:watch": "web-test-runner --watch --playwright --browsers chromium firefox webkit",
     "deploy": "yarn run deploy:run -e $(git branch --show-current)",
     "deploy:run": "yarn run prepare:ghpages && touch ghpages/.nojekyll && yarn run deploy:gh",
     "deploy:gh": "gh-pages -t -d ghpages -m \"Build for $(git log --pretty=format:\"%h %an %ai %s\" -n1) [skip ci]\""
   },
   "dependencies": {
-    "@internetarchive/icon-info": "1.3.5",
+    "@internetarchive/icon-info": "^1.4.1",
     "@internetarchive/local-cache": "^0.2.1",
-    "@internetarchive/modal-manager": "2.0.0",
+    "@internetarchive/modal-manager": "^2.0.0",
     "@internetarchive/shared-resize-observer": "^0.2.0",
-    "install-deps": "^1.1.0",
-    "lit": "^2.8.0"
+    "lit": "^2.8.0 || ^3.3.2"
   },
   "devDependencies": {
     "@open-wc/eslint-config": "^4.2.0",
-    "@open-wc/testing": "^2.0.0",
-    "@web/dev-server": "^0.1.1",
-    "@web/dev-server-esbuild": "^0.2.16",
-    "@web/test-runner": "^0.11.7",
-    "@web/test-runner-playwright": "^0.8.8",
+    "@open-wc/testing": "^4.0.0",
+    "@web/dev-server": "^0.4.6",
+    "@web/dev-server-esbuild": "^1.0.5",
+    "@web/test-runner": "^0.20.2",
+    "@web/test-runner-playwright": "^0.11.1",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-import": "^2.22.1",

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

@@ -409,6 +409,7 @@ export default class ActionsHandler extends LitElement {
    */
   setStickyAdminAccess(value) {
     const domain = window.location.hostname === 'localhost' ? 'localhost' : '.archive.org';
-    Cookies.setItem('sticky-admin-access', value, '', '/', domain);
+    const expires = new Date(Date.now() + 30 * 24 * 60 * 60 * 1000); // 30 days from now
+    Cookies.setItem('sticky-admin-access', value, expires, '/', domain);
   }
 }

package/src/ia-book-actions.js

@@ -120,7 +120,12 @@ export default class IABookActions extends LitElement {
      * @property {boolean} renewNow - key to determine if need to renew now
      * @property {number} secondsLeft - seconds left in active loan
      */
-    this.loanRenewResult = { texts: '', renewNow: false, secondsLeft: 0, renewType: '' };
+    this.loanRenewResult = {
+      texts: '',
+      renewNow: false,
+      secondsLeft: 0,
+      renewType: '',
+    };
   }
 
   disconnectedCallback() {
@@ -535,11 +540,8 @@ export default class IABookActions extends LitElement {
   async startBrowseTimer() {
     window?.IALendingIntervals?.clearBrowseExpireTimeout();
 
-    const {
-      browsingExpired,
-      user_has_browsed,
-      secondsLeftOnLoan,
-    } = this.lendingStatus;
+    const { browsingExpired, user_has_browsed, secondsLeftOnLoan } =
+      this.lendingStatus;
 
     if (!user_has_browsed || browsingExpired) {
       log('startBrowseTimer --- !user_has_browsed || browsingExpired', {

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

@@ -0,0 +1,91 @@
+import { expect, fixture } from '@open-wc/testing';
+import sinon from 'sinon';
+
+import ActionsHandler from '../../../src/core/services/actions-handler/actions-handler.js';
+
+// Define a temporary tag for this element for testing
+const TEST_TAG = 'ia-actions-handler-test';
+if (!customElements.get(TEST_TAG)) {
+  customElements.define(TEST_TAG, ActionsHandler);
+}
+
+describe('ActionsHandler#setStickyAdminAccess', () => {
+  let clock;
+  let lastSetCookie;
+  let cookieOverridden = false;
+  let actionsHandlerFixture;
+
+  beforeEach(async () => {
+    // Intercept document.cookie writes to capture the full cookie string
+    Object.defineProperty(document, 'cookie', {
+      configurable: true,
+      get() {
+        return '';
+      },
+      set(value) {
+        lastSetCookie = value;
+      },
+    });
+    cookieOverridden = true;
+
+    // Create the element via fixture (portable across browsers)
+    actionsHandlerFixture = await fixture(`<${TEST_TAG}></${TEST_TAG}>`);
+  });
+
+  afterEach(() => {
+    sinon.restore();
+    if (clock) {
+      clock.restore();
+      clock = undefined;
+    }
+    // restore document.cookie
+    if (cookieOverridden) {
+      try {
+        // remove our instance-level override
+        // eslint-disable-next-line no-param-reassign
+        delete document.cookie;
+      } catch (e) {
+        // ignore
+      }
+      cookieOverridden = false;
+    }
+    lastSetCookie = undefined;
+  });
+
+  it('sets the sticky-admin-access cookie with correct domain, path, and 30-day expiration', async () => {
+    // Arrange: fix time and stub cookie writer
+    const now = new Date('2025-01-01T00:00:00.000Z');
+    clock = sinon.useFakeTimers({ now: now.getTime() });
+
+    // Calculate expected values based on current environment
+    const expectedDomain = window.location.hostname === 'localhost' ? 'localhost' : '.archive.org';
+    const expectedExpires = new Date(now.getTime() + 30 * 24 * 60 * 60 * 1000);
+
+    // Act: call the method on the element created in beforeEach
+    actionsHandlerFixture.setStickyAdminAccess(true);
+
+    // Assert: verify the composed cookie string
+    expect(lastSetCookie).to.be.a('string');
+    // Name and value
+    expect(lastSetCookie).to.contain(`${encodeURIComponent('sticky-admin-access')}=${encodeURIComponent('true')}`);
+    // Domain
+    expect(lastSetCookie).to.contain(`domain=${expectedDomain}`);
+    // Path
+    expect(lastSetCookie).to.contain('path=/');
+    // Expiration close to 30 days from now
+    const match = /expires=([^;]+)/.exec(lastSetCookie);
+    expect(match).to.not.equal(null);
+    const expiresStr = match && match[1];
+    const parsed = expiresStr ? new Date(expiresStr) : null;
+    expect(parsed).to.be.instanceOf(Date);
+    expect(parsed && parsed.getTime()).to.equal(expectedExpires.getTime());
+  });
+
+  it('sets the cookie value to false when disabling', async () => {
+    // Act
+    actionsHandlerFixture.setStickyAdminAccess(false);
+
+    expect(lastSetCookie).to.be.a('string');
+    expect(lastSetCookie).to.contain(`${encodeURIComponent('sticky-admin-access')}=${encodeURIComponent('false')}`);
+  });
+});

package/web-test-runner.config.mjs

@@ -3,7 +3,7 @@
 export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
   files: 'test/**/*.test.js',
   nodeResolve: true,
-  watch: true,
+  watch: false,
 
   /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
   esbuildTarget: 'auto',