ep_performance_test_hooks 0.0.11 → 0.0.14

package/.eslintrc.cjs

@@ -0,0 +1,9 @@
+'use strict';
+
+// This is a workaround for https://github.com/eslint/eslint/issues/3458
+require('eslint-config-etherpad/patch/modern-module-resolution');
+
+module.exports = {
+  root: true,
+  extends: 'etherpad/plugin',
+};

package/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    versioning-strategy: "increase"

package/.github/workflows/backend-tests.yml

@@ -1,6 +1,3 @@
-# You need to change lines 38 and 46 in case the plugin's name on npmjs.com is different
-# from the repository name
-
 name: "Backend tests"
 
 # any branch is useful for testing before a PR is submitted
@@ -11,40 +8,68 @@ jobs:
     # run on pushes to any branch
     # run on PRs from external forks
     if: |
-         (github.event_name != 'pull_request')
-         || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
+      (github.event_name != 'pull_request')
+      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
     name: with Plugins
     runs-on: ubuntu-latest
 
     steps:
-    - name: Install libreoffice
-      run: |
-        sudo add-apt-repository -y ppa:libreoffice/ppa
-        sudo apt update
-        sudo apt install -y --no-install-recommends libreoffice libreoffice-pdfimport
-
-    # clone etherpad-lite
-    - name: Install etherpad core
-      uses: actions/checkout@v2
-      with:
-        repository: ether/etherpad-lite
-
-    - name: Install all dependencies and symlink for ep_etherpad-lite
-      run: src/bin/installDeps.sh
-
-    # clone this repository into node_modules/ep_plugin-name
-    - name: Checkout plugin repository
-      uses: actions/checkout@v2
-      with:
-        path: ./node_modules/${{github.event.repository.name}}
-
-    - name: Install plugin dependencies
-      run: |
-        cd node_modules/${{github.event.repository.name}}
-        npm ci
-
-    - name: Run the backend tests
-      run: cd src && npm test
-
-##ETHERPAD_NPM_V=2
-## NPM configuration automatically created using src/bin/plugins/updateAllPluginsScript.sh
+      -
+        name: Install libreoffice
+        run: |
+          sudo add-apt-repository -y ppa:libreoffice/ppa
+          sudo apt update
+          sudo apt install -y --no-install-recommends libreoffice libreoffice-pdfimport
+      -
+        name: Install etherpad core
+        uses: actions/checkout@v2
+        with:
+          repository: ether/etherpad-lite
+      -
+        name: Checkout plugin repository
+        uses: actions/checkout@v2
+        with:
+          path: ./node_modules/__tmp
+      -
+        name: Determine plugin name
+        id: plugin_name
+        run: |
+          cd ./node_modules/__tmp
+          npx -c 'printf %s\\n "::set-output name=plugin_name::${npm_package_name}"'
+      -
+        name: Rename plugin directory
+        run: |
+          mv ./node_modules/__tmp ./node_modules/"${PLUGIN_NAME}"
+        env:
+          PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
+      -
+        uses: actions/setup-node@v3
+        with:
+          node-version: 12
+          cache: 'npm'
+          cache-dependency-path: |
+            src/package-lock.json
+            src/bin/doc/package-lock.json
+            node_modules/${{ steps.plugin_name.outputs.plugin_name }}/package-lock.json
+      -
+        name: Install plugin dependencies
+        run: |
+          cd ./node_modules/"${PLUGIN_NAME}"
+          npm ci
+        env:
+          PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
+      # Etherpad core dependencies must be installed after installing the
+      # plugin's dependencies, otherwise npm will try to hoist common
+      # dependencies by removing them from src/node_modules and installing them
+      # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
+      # to be buggy, because it sometimes removes dependencies from
+      # src/node_modules but fails to add them to the top-level node_modules.
+      # Even if npm correctly hoists the dependencies, the hoisting seems to
+      # confuse tools such as `npm outdated`, `npm update`, and some ESLint
+      # rules.
+      -
+        name: Install Etherpad core dependencies
+        run: src/bin/installDeps.sh
+      -
+        name: Run the backend tests
+        run: cd src && npm test

package/.github/workflows/frontend-tests.yml

@@ -0,0 +1,110 @@
+# Publicly credit Sauce Labs because they generously support open source
+# projects.
+name: "frontend tests powered by Sauce Labs"
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      -
+        name: Fail if Dependabot
+        if: github.actor == 'dependabot[bot]'
+        run: |
+          cat <<EOF >&2
+          Frontend tests skipped because Dependabot can't access secrets.
+          Manually re-run the jobs to run the frontend tests.
+          For more information, see:
+          https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions/
+          EOF
+          exit 1
+      -
+        name: Generate Sauce Labs strings
+        id: sauce_strings
+        run: |
+          printf %s\\n '::set-output name=name::${{github.event.repository.name}} ${{ github.workflow }} - ${{ github.job }}'
+          printf %s\\n '::set-output name=tunnel_id::${{ github.run_id }}-${{ github.run_number }}-${{ github.job }}'
+      -
+        name: Check out Etherpad core
+        uses: actions/checkout@v2
+        with:
+          repository: ether/etherpad-lite
+      -
+        uses: actions/setup-node@v3
+        with:
+          node-version: 12
+          cache: 'npm'
+          cache-dependency-path: |
+            src/package-lock.json
+            src/bin/doc/package-lock.json
+      -
+        name: Check out the plugin
+        uses: actions/checkout@v2
+        with:
+          path: ./node_modules/__tmp
+      -
+        name: export GIT_HASH to env
+        id: environment
+        run: |
+          cd ./node_modules/__tmp
+          echo "::set-output name=sha_short::$(git rev-parse --short ${{ github.sha }})"
+      -
+        name: Determine plugin name
+        id: plugin_name
+        run: |
+          cd ./node_modules/__tmp
+          npx -c 'printf %s\\n "::set-output name=plugin_name::${npm_package_name}"'
+      -
+        name: Rename plugin directory
+        env:
+          PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
+        run: |
+          mv ./node_modules/__tmp ./node_modules/"${PLUGIN_NAME}"
+      -
+        name: Install plugin dependencies
+        env:
+          PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
+        run: |
+          cd ./node_modules/"${PLUGIN_NAME}"
+          npm ci
+      # Etherpad core dependencies must be installed after installing the
+      # plugin's dependencies, otherwise npm will try to hoist common
+      # dependencies by removing them from src/node_modules and installing them
+      # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
+      # to be buggy, because it sometimes removes dependencies from
+      # src/node_modules but fails to add them to the top-level node_modules.
+      # Even if npm correctly hoists the dependencies, the hoisting seems to
+      # confuse tools such as `npm outdated`, `npm update`, and some ESLint
+      # rules.
+      -
+        name: Install Etherpad core dependencies
+        run: src/bin/installDeps.sh
+      -
+        name: Create settings.json
+        run: cp settings.json.template settings.json
+      -
+        name: Disable import/export rate limiting
+        run: |
+          sed -e '/^ *"importExportRateLimiting":/,/^ *\}/ s/"max":.*/"max": 0/' -i settings.json
+      -
+        name: Remove standard frontend test files
+        run: rm -rf src/tests/frontend/specs
+      -
+        uses: saucelabs/sauce-connect-action@v2.1.1
+        with:
+          username: ${{ secrets.SAUCE_USERNAME }}
+          accessKey: ${{ secrets.SAUCE_ACCESS_KEY }}
+          tunnelIdentifier: ${{ steps.sauce_strings.outputs.tunnel_id }}
+      -
+        name: Run the frontend tests
+        shell: bash
+        env:
+          SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
+          SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
+          SAUCE_NAME: ${{ steps.sauce_strings.outputs.name }}
+          TRAVIS_JOB_NUMBER: ${{ steps.sauce_strings.outputs.tunnel_id }}
+          GIT_HASH: ${{ steps.environment.outputs.sha_short }}
+        run: |
+          src/tests/frontend/travis/runner.sh

package/.github/workflows/npmpublish.yml

@@ -21,50 +21,86 @@ jobs:
       # cloned to etherpad-lite then moved to ../etherpad-lite. To avoid
       # conflicts with this plugin's clone, etherpad-lite must be cloned and
       # moved out before this plugin's repo is cloned to $GITHUB_WORKSPACE.
-      - uses: actions/checkout@v2
+      -
+        uses: actions/checkout@v2
         with:
           repository: ether/etherpad-lite
           path: etherpad-lite
-      - run: mv etherpad-lite ..
+      -
+        run: mv etherpad-lite ..
       # etherpad-lite has been moved outside of $GITHUB_WORKSPACE, so it is now
       # safe to clone this plugin's repo to $GITHUB_WORKSPACE.
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      -
+        uses: actions/checkout@v2
+      # This is necessary for actions/setup-node because '..' can't be used in
+      # cache-dependency-path.
+      -
+        name: Create ep_etherpad-lite symlink
+        run: |
+          mkdir -p node_modules
+          ln -s ../../etherpad-lite/src node_modules/ep_etherpad-lite
+      -
+        uses: actions/setup-node@v3
         with:
           node-version: 12
+          cache: 'npm'
+          cache-dependency-path: |
+            node_modules/ep_etherpad-lite/package-lock.json
+            node_modules/ep_etherpad-lite/bin/doc/package-lock.json
+            package-lock.json
       # All of ep_etherpad-lite's devDependencies are installed because the
       # plugin might do `require('ep_etherpad-lite/node_modules/${devDep}')`.
       # Eventually it would be nice to create an ESLint plugin that prohibits
       # Etherpad plugins from piggybacking off of ep_etherpad-lite's
       # devDependencies. If we had that, we could change this line to only
       # install production dependencies.
-      - run: cd ../etherpad-lite/src && npm ci
-      - run: npm ci
+      -
+        run: cd ../etherpad-lite/src && npm ci
+      -
+        run: npm ci
       # This runs some sanity checks and creates a symlink at
       # node_modules/ep_etherpad-lite that points to ../../etherpad-lite/src.
       # This step must be done after `npm ci` installs the plugin's dependencies
       # because npm "helpfully" cleans up such symlinks. :( Installing
       # ep_etherpad-lite in the plugin's node_modules prevents lint errors and
       # unit test failures if the plugin does `require('ep_etherpad-lite/foo')`.
-      - run: npm install --no-save ep_etherpad-lite@file:../etherpad-lite/src
-      - run: npm test
-      - run: npm run lint
+      -
+        run: npm install --no-save ep_etherpad-lite@file:../etherpad-lite/src
+      -
+        run: npm test
+      -
+        run: npm run lint
 
   publish-npm:
     if: github.event_name == 'push'
     needs: test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      -
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      -
+        uses: actions/setup-node@v3
         with:
           node-version: 12
           registry-url: https://registry.npmjs.org/
-      - run: git config user.name 'github-actions[bot]'
-      - run: git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
-      - run: npm ci
-      - run: npm version patch
-      - run: git push --follow-tags
+          cache: 'npm'
+      -
+        name: Bump version (patch)
+        run: |
+          LATEST_TAG=$(git describe --tags --abbrev=0) || exit 1
+          NEW_COMMITS=$(git rev-list --count "${LATEST_TAG}"..) || exit 1
+          [ "${NEW_COMMITS}" -gt 0 ] || exit 0
+          git config user.name 'github-actions[bot]'
+          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
+          npm ci
+          npm version patch
+          git push --follow-tags
+      # This is required if the package has a prepare script that uses something
+      # in dependencies or devDependencies.
+      -
+        run: npm ci
       # `npm publish` must come after `git push` otherwise there is a race
       # condition: If two PRs are merged back-to-back then master/main will be
       # updated with the commits from the second PR before the first PR's
@@ -75,9 +111,12 @@ jobs:
       # already-used version number. By running `npm publish` after `git push`,
       # back-to-back merges will cause the first merge's workflow to fail but
       # the second's will succeed.
-      - run: npm publish
+      -
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+      -
+        name: Add package to etherpad organization
+        run: npm access grant read-write etherpad:developers
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
-
-##ETHERPAD_NPM_V=2
-## NPM configuration automatically created using bin/plugins/updateAllPluginsScript.sh

package/package.json

@@ -26,7 +26,7 @@
   "description": "Etherpad plugin to show performance stats in /stats url",
   "funding": {
     "type": "individual",
-    "url": "http://etherpad.org/"
+    "url": "https://etherpad.org/"
   },
   "homepage": "https://github.com/ether/ep_performance_test_hooks#readme",
   "keywords": [
@@ -40,20 +40,11 @@
     "type": "git",
     "url": "git+https://github.com/ether/ep_performance_test_hooks.git"
   },
-  "version": "0.0.11",
+  "version": "0.0.14",
   "devDependencies": {
-    "eslint": "^7.18.0",
-    "eslint-config-etherpad": "^1.0.24",
-    "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-mocha": "^8.0.0",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prefer-arrow": "^1.2.3",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-you-dont-need-lodash-underscore": "^6.10.0"
-  },
-  "eslintConfig": {
-    "root": true,
-    "extends": "etherpad/plugin"
+    "eslint": "^8.9.0",
+    "eslint-config-etherpad": "^3.0.1",
+    "typescript": "^4.5.5"
   },
   "peerDependencies": {
     "ep_etherpad-lite": ">=1.8.7"
@@ -63,6 +54,6 @@
     "lint:fix": "eslint --fix ."
   },
   "engines": {
-    "node": "^10.17.0 || >=11.14.0"
+    "node": ">=12.17.0"
   }
 }

package/static/tests/frontend/specs/tests.js

@@ -824,15 +824,9 @@ describe('Performance tests', function () {
     this.timeout(60000);
     stats = await getStats();
     stats.ep_performance_test_hooks.averageSize =
-        getAverage(
-            stats.ep_performance_test_hooks.loadSizes,
-            'transferSize'
-        );
+        getAverage(stats.ep_performance_test_hooks.loadSizes, 'transferSize');
     stats.ep_performance_test_hooks.averageFetchTime =
-        getAverage(
-            stats.ep_performance_test_hooks.loadTimes,
-            'fetchUntilResponseEndTime'
-        );
+        getAverage(stats.ep_performance_test_hooks.loadTimes, 'fetchUntilResponseEndTime');
     testValues(stats);
   });
 
@@ -841,14 +835,10 @@ describe('Performance tests', function () {
     // make sure the new values are lower and/or file size is smaller and/or
     // page load is quicker :)
     const newStats = await getStats();
-    const newLoadAverage = getAverage(
-        newStats.ep_performance_test_hooks.loadTimes,
-        'fetchUntilResponseEndTime'
-    );
-    const newSizeAverage = getAverage(
-        newStats.ep_performance_test_hooks.loadSizes,
-        'transferSize'
-    );
+    const newLoadAverage =
+        getAverage(newStats.ep_performance_test_hooks.loadTimes, 'fetchUntilResponseEndTime');
+    const newSizeAverage =
+        getAverage(newStats.ep_performance_test_hooks.loadSizes, 'transferSize');
 
     if (newLoadAverage >= stats.ep_performance_test_hooks.averageFetchTime) {
       throw new Error(
@@ -857,20 +847,18 @@ describe('Performance tests', function () {
     } else {
       // all good, but lets just let console know :)
       console.info(
-          `Average fetch time ${newLoadAverage} of 2nd pad load was faster than the
-        first load ${stats.ep_performance_test_hooks.averageFetchTime}`
-      );
+          `Average fetch time ${newLoadAverage} of 2nd pad load was faster than the first load ` +
+          `${stats.ep_performance_test_hooks.averageFetchTime}`);
     }
     if (newSizeAverage >= stats.ep_performance_test_hooks.averageSize) {
       throw new Error(
-          `Average size ${newSizeAverage} was not smaller than the
-          first load ${stats.ep_performance_test_hooks.averageSize}`);
+          `Average size ${newSizeAverage} was not smaller than the first load ` +
+          `${stats.ep_performance_test_hooks.averageSize}`);
     } else {
       // all good, but lets just let console know :)
       console.info(
-          `Average size ${newSizeAverage} of 2nd pad load was smaller than the
-        first load ${stats.ep_performance_test_hooks.averageSize}`
-      );
+          `Average size ${newSizeAverage} of 2nd pad load was smaller than the first load ` +
+          `${stats.ep_performance_test_hooks.averageSize}`);
     }
   });
 });