autofixes from Etherpad checkPlugin.js

.github/workflows/backend-tests.yml

@@ -1,7 +1,8 @@
-name: "Backend tests"
+name: Backend Tests
 
 # any branch is useful for testing before a PR is submitted
-on: [push, pull_request]
+on:
+  workflow_call:
 
 jobs:
   withplugins:
@@ -12,64 +13,80 @@ jobs:
       || (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
+        uses: awalsh128/cache-apt-pkgs-action@v1.4.2
+        with:
+          packages: libreoffice libreoffice-pdfimport
+          version: 1.0
       -
         name: Install etherpad core
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
         with:
           repository: ether/etherpad-lite
+          path: etherpad-lite
+      - uses: pnpm/action-setup@v3
+        name: Install pnpm
+        with:
+          version: 8
+          run_install: false
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
       -
         name: Checkout plugin repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
         with:
-          path: ./node_modules/__tmp
+          path: plugin
       -
         name: Determine plugin name
         id: plugin_name
+        working-directory: ./plugin
         run: |
-          cd ./node_modules/__tmp
           npx -c 'printf %s\\n "::set-output name=plugin_name::${npm_package_name}"'
       -
-        name: Rename plugin directory
+        name: Link plugin directory
+        working-directory: ./plugin
         run: |
-          mv ./node_modules/__tmp ./node_modules/"${PLUGIN_NAME}"
-        env:
-          PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          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
-      - run: npm install npm@6.14.18 -g
-        name: Install legacy npm for correct dependency resolution
-      - name: Install plugin dependencies
+          pnpm link --global
+      - name: Remove tests
+        working-directory: ./etherpad-lite
+        run: rm -rf ./src/tests/backend/specs
+      -
+        name: Install Etherpad core dependencies
+        working-directory: ./etherpad-lite
+        run: bin/installDeps.sh
+      - name: Link plugin to etherpad-lite
+        working-directory: ./etherpad-lite
         run: |
-          cd ./node_modules/"${PLUGIN_NAME}"
-          npm ci
+          pnpm link --global $PLUGIN_NAME
+          pnpm run install-plugins --path  ../../plugin
         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: Link ep_etherpad-lite
+        working-directory: ./etherpad-lite/src
+        run: |
+          pnpm link --global
+      - name: Link etherpad to plugin
+        working-directory: ./plugin
+        run: |
+          pnpm link --global ep_etherpad-lite
       -
         name: Run the backend tests
-        run: cd src && npm test
+        working-directory: ./etherpad-lite
+        run: |
+          res=$(find .. -path "./node_modules/ep_*/static/tests/backend/specs/**" | wc -l)
+          if [ $res -eq 0 ]; then
+          echo "No backend tests found"
+          else
+          pnpm run test
+          fi

.github/workflows/frontend-tests.yml

@@ -1,38 +1,39 @@
 # Publicly credit Sauce Labs because they generously support open source
 # projects.
-name: "frontend tests powered by Sauce Labs"
+name: Frontend Tests
 
-on: [push]
+on:
+  workflow_call:
 
 jobs:
-  test:
-    if: ${{ github.actor != 'dependabot[bot]' }}
+  test-frontend:
     runs-on: ubuntu-latest
 
     steps:
-      -
-        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@v4
+        uses: actions/checkout@v3
         with:
           repository: ether/etherpad-lite
-      - uses: actions/setup-node@v4
+      - uses: pnpm/action-setup@v3
+        name: Install pnpm
         with:
-          node-version: 20
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      - run: npm install npm@6.14.18 -g
-        name: Install legacy npm for correct dependency resolution
+          version: 8
+          run_install: false
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
       -
         name: Check out the plugin
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
         with:
           path: ./node_modules/__tmp
       -
@@ -59,7 +60,7 @@ jobs:
           PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
         run: |
           cd ./node_modules/"${PLUGIN_NAME}"
-          npm ci
+          pnpm i
       # 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
@@ -71,31 +72,23 @@ jobs:
       # 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.3.6
-        with:
-          username: ${{ secrets.SAUCE_USERNAME }}
-          accessKey: ${{ secrets.SAUCE_ACCESS_KEY }}
-          tunnelIdentifier: ${{ steps.sauce_strings.outputs.tunnel_id }}
-      -
-        name: Run the frontend tests
+        run: bin/installDeps.sh
+      - name: Create settings.json
+        run: cp ./src/tests/settings.json settings.json
+      - 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
+          pnpm run dev &
+          connected=false
+          can_connect() {
+          curl -sSfo /dev/null http://localhost:9001/ || return 1
+          connected=true
+          }
+          now() { date +%s; }
+          start=$(now)
+          while [ $(($(now) - $start)) -le 15 ] && ! can_connect; do
+          sleep 1
+          done
+          cd src
+          pnpm exec playwright install chromium  --with-deps
+          pnpm run test-ui --project=chromium

.github/workflows/npmpublish.yml

@@ -4,90 +4,40 @@
 name: Node.js Package
 
 on:
-  pull_request:
-  push:
-    branches:
-      - main
-      - master
+  workflow_call:
 
 jobs:
-  test:
+  publish-npm:
     runs-on: ubuntu-latest
     steps:
-      # Clone ether/etherpad-lite to ../etherpad-lite so that ep_etherpad-lite
-      # can be "installed" in this plugin's node_modules. The checkout v2 action
-      # doesn't support cloning outside of $GITHUB_WORKSPACE (see
-      # https://github.com/actions/checkout/issues/197), so the repo is first
-      # 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@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - name: Check out Etherpad core
+        uses: actions/checkout@v3
         with:
           repository: ether/etherpad-lite
-          path: 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@v4
-      # This is necessary for actions/setup-node because '..' can't be used in
-      # cache-dependency-path.
-      -
-        name: Create ep_etherpad-lite symlink
+      - uses: pnpm/action-setup@v3
+        name: Install pnpm
+        with:
+          version: 8
+          run_install: false
+      - name: Get pnpm store directory
+        shell: bash
         run: |
-          mkdir -p node_modules
-          ln -s ../../etherpad-lite/src node_modules/ep_etherpad-lite
-      -
-        uses: actions/setup-node@v4
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
         with:
-          node-version: 20
-          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
-      - run: npm install npm@6.14.18 -g
-        name: Install legacy npm for correct dependency resolution
-      # 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
-      # 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')`.
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
       -
-        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@v4
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: 12
-          registry-url: https://registry.npmjs.org/
-          cache: 'npm'
       -
         name: Bump version (patch)
         run: |
@@ -96,13 +46,13 @@ jobs:
           [ "${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
+          pnpm i
+          pnpm 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
+        run: pnpm i
       # `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
@@ -114,11 +64,11 @@ jobs:
       # back-to-back merges will cause the first merge's workflow to fail but
       # the second's will succeed.
       -
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
-      -
-        name: Add package to etherpad organization
-        run: npm access grant read-write etherpad:developers
+        run: pnpm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+      #-
+      #  name: Add package to etherpad organization
+      #  run: pnpm access grant read-write etherpad:developers
+      #  env:
+      #    NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}