@internetarchive/bookreader 5.0.0-9 → 5.0.0-90

package/.eslintrc.js

@@ -1,49 +1,51 @@
 module.exports = {
+  "parser": "@babel/eslint-parser",
   "env": {
     "browser": true,
     "jquery": true,
     "es6": true,
     "node": true,
-    "jest": true
+    "jest": true,
   },
   "plugins": [
-    "testcafe"
+    "testcafe",
+    "no-jquery",
   ],
   "extends": [
     "eslint:recommended",
-    "plugin:testcafe/recommended"
+    "plugin:testcafe/recommended",
+    "plugin:no-jquery/deprecated",
   ],
   "globals": {
     // Browser API
-    "MediaMetadata": "readonly"
+    "MediaMetadata": "readonly",
   },
   "parserOptions": {
     "ecmaVersion": 2020,
-    "sourceType": "module"
+    "ecmaFeatures": { "legacyDecorators": true },
+    "sourceType": "module",
   },
   "rules": {
-    "comma-dangle": ["error", "only-multiline"],
+    "comma-dangle": ["error", "always-multiline", {"functions": "only-multiline"}],
+    "semi": ["error", "always"],
     "space-before-blocks": ["error"],
     "keyword-spacing": [2, {"before": true, "after": true}],
-    "indent": ["error", 2],
+    "indent": ["error", 2, {
+      // This for some reason causing errors after switch to parser: babel-eslint.
+      // See https://github.com/babel/babel-eslint/issues/681
+      "ignoredNodes": ["TemplateLiteral"],
+    }],
     "no-console": "off", // Used too often behind `debug` options; not dealing with this now
     "no-empty": ["error", { "allowEmptyCatch": true }],
+    "no-jquery/no-bind": ["error"],
+    "no-jquery/no-event-shorthand": ["error"],
+    "no-jquery/no-sizzle": ["error"],
+    "no-jquery/no-trim": ["error"],
     "no-trailing-spaces": ["error"],
     "no-unused-vars": ["error", { "vars": "all", "args": "none", "ignoreRestSiblings": false }], // set args:none; this is generally more annoying than useful
     "no-var": ["error"],
     "prefer-const": ["error"],
     "space-infix-ops": ["error", { "int32Hint": false }],
-    "eol-last": ["error", "always"]
+    "eol-last": ["error", "always"],
   },
-  "overrides": [
-    { // TODO; these should be cleaned up as well
-      "files": [
-        "src/BookReader.js",
-        "src/dragscrollable-br.js"
-      ],
-      "rules": {
-        "no-var": ["off"],
-      }
-    },
-  ],
 };

package/.github/workflows/node.js.yml

@@ -10,28 +10,93 @@ on:
     branches: [ master ]
 
 jobs:
-  build:
+  install:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-node@v1
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
       with:
-        node-version: 14.x
-    - uses: actions/cache@v2
+        # Keep in sync with netlify.toml
+        node-version: 20.x
+    - name: Cache node_modules
+      uses: actions/cache@v4
+      id: cache
       with:
         # Caching node_modules isn't recommended because it can break across
         # Node versions and won't work with npm ci (See https://github.com/actions/cache/blob/main/examples.md#node---npm )
-        # But we pin the node version, and we don't update it that often anyways. And 
+        # But we pin the node version, and we don't update it that often anyways. And
         # we don't use `npm ci` specifically to try to get faster CI flows. So caching
         # `node_modules` directly.
         path: 'node_modules'
-        key: ${{ runner.os }}-node-${{ hashFiles('package*.json') }}
-    - run: npm install
-    - run: npm run build
+        key: ${{ runner.os }}-node-20-${{ hashFiles('package*.json') }}
+    - if: steps.cache.outputs.cache-hit != 'true'
+      run: npm install
+
+  build:
+    needs: install
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: 20.x
+    - name: Load node_modules from cache
+      uses: actions/cache@v4
+      with:
+        # Use node_modules from previous jobs
+        path: 'node_modules'
+        key: ${{ runner.os }}-node-20-${{ hashFiles('package*.json') }}
+    - name: Cache BookReader/
+      uses: actions/cache@v4
+      id: build-cache
+      with:
+        # Cache the build files so we don't have to build twice for e2e tests
+        path: 'BookReader'
+        key: ${{ runner.os }}-${{ github.sha }}
+    - if: steps.build-cache.outputs.cache-hit != 'true'
+      run: npm run build
+
+  tests:
+    needs: install
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: 20.x
+    - name: Load node_modules from cache
+      uses: actions/cache@v4
+      with:
+        # Use node_modules from previous jobs
+        path: 'node_modules'
+        key: ${{ runner.os }}-node-20-${{ hashFiles('package*.json') }}
     - run: npm run lint
     - run: npm run test
-    - run: npm run codecov
+    - uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+    
+  e2e-tests:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: 20.x
+    - name: Load node_modules from cache
+      uses: actions/cache@v4
+      with:
+        # Use node_modules from previous jobs
+        path: 'node_modules'
+        key: ${{ runner.os }}-node-20-${{ hashFiles('package*.json') }}
+    - name: Load BookReader/ from cache
+      uses: actions/cache@v4
+      with:
+        # Cache the build files so we don't have to build twice for e2e tests
+        path: 'BookReader'
+        key: ${{ runner.os }}-${{ github.sha }}
     # Travis machines usually have 2 cores (see https://docs.travis-ci.com/user/reference/overview/#virtualisation-environment-vs-operating-system )
     # Quarantine mode (sigh) to catch unstable tests (see https://devexpress.github.io/testcafe/documentation/guides/basic-guides/run-tests.html#quarantine-mode )
-    - run: BASE_URL=http://127.0.0.1:8000/BookReaderDemo/ npx testcafe --concurrency 2 --quarantine-mode
+    - run: npx testcafe --concurrency 2 --quarantine-mode

package/.github/workflows/npm-publish.yml

@@ -11,10 +11,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 14
+          node-version: 20
       - run: npm ci
       - run: npm test
 
@@ -22,26 +22,12 @@ jobs:
     needs: build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 14
+          node-version: 20
           registry-url: https://registry.npmjs.org/
       - run: npm ci
       - run: npm publish --tag next
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
-
-  publish-gpr:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: 14
-          registry-url: https://npm.pkg.github.com/
-      - run: npm ci
-      - run: npm publish --tag next
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/.testcaferc.js

@@ -0,0 +1,10 @@
+// @ts-check
+/** @type {TestCafeConfigurationOptions} */
+module.exports = {
+  appCommand: "npm run serve",
+  browsers: [
+    "chrome:headless",
+    "firefox:headless",
+  ],
+  src: ["tests/e2e/**/*test.js"]
+};