mirror of
https://github.com/ether/etherpad-lite.git
synced 2026-05-05 20:26:49 +02:00
4704d80e82
* ci: add ep_font_color and ep_hash_auth to plugin test matrix These are the #12 and #14 most-installed Etherpad plugins on npm (last 30d) and were the only top-15 plugins not exercised by the withpluginsLinux / withpluginsWindows / Playwright with-plugins jobs. Adding them broadens coverage of the plugin loader against two real-world hooks: aceEditorCSS / aceAttribsToClasses (ep_font_color) and authenticate / handleMessage (ep_hash_auth). ep_hash_auth's authenticate hook is a no-op unless a Basic auth header is sent and a matching settings.users[user].hash exists, so it falls through cleanly with the default test settings. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * test(change_user_color): close users popup before opening chat The "Own user color is shown when you enter a chat" spec leaves the users popup open after picking a color, then calls showChat(). In the with-plugins matrix the popup overlaps #chaticon and intercepts pointer events, so the click in showChat() is retried until the 90s timeout (× 5 retries ≈ 7m), failing both Firefox and Chrome with-plugins jobs. Toggle the users button off and wait for popup-show to drop before clicking the chat icon, matching the close pattern used in a11y_dialogs.spec.ts. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
357 lines
13 KiB
YAML
357 lines
13 KiB
YAML
name: "Frontend tests"
|
|
|
|
on:
|
|
push:
|
|
paths-ignore:
|
|
- 'doc/**'
|
|
pull_request:
|
|
paths-ignore:
|
|
- 'doc/**'
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
playwright-chrome:
|
|
env:
|
|
PNPM_HOME: ~/.pnpm-store
|
|
name: Playwright Chrome
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
-
|
|
name: Checkout repository
|
|
uses: actions/checkout@v6
|
|
- uses: actions/cache@v5
|
|
name: Cache pnpm store
|
|
with:
|
|
path: ${{ env.PNPM_HOME }}
|
|
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-pnpm-store-
|
|
- uses: actions/cache@v5
|
|
name: Cache Playwright browsers
|
|
with:
|
|
path: ~/.cache/ms-playwright
|
|
key: ${{ runner.os }}-playwright-${{ hashFiles('src/package.json', 'pnpm-lock.yaml') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-playwright-
|
|
- uses: pnpm/action-setup@v6
|
|
name: Install pnpm
|
|
with:
|
|
version: 10.33.2
|
|
run_install: false
|
|
- name: Use Node.js
|
|
uses: actions/setup-node@v6
|
|
with:
|
|
node-version: 22
|
|
cache: pnpm
|
|
-
|
|
name: Install all dependencies and symlink for ep_etherpad-lite
|
|
run: pnpm install --frozen-lockfile
|
|
-
|
|
name: Create settings.json
|
|
run: cp ./src/tests/settings.json settings.json
|
|
- name: Run the frontend tests
|
|
shell: bash
|
|
run: |
|
|
set -euo pipefail
|
|
pnpm run prod > /tmp/etherpad-server.log 2>&1 &
|
|
# Generous 90s budget so a slow runner (or, in the with-plugins
|
|
# variant, plugin boot) doesn't lose the race against the test
|
|
# phase. Fail loudly on timeout rather than silently falling
|
|
# through to tests against a half-started server.
|
|
# --max-time bounds each probe so a stuck server can't make a
|
|
# single curl call eat the whole 90s budget.
|
|
can_connect() { curl --max-time 3 -sSfo /dev/null http://localhost:9001/; }
|
|
for i in $(seq 1 90); do can_connect && break; sleep 1; done
|
|
if ! can_connect; then
|
|
echo "::error::Etherpad did not respond on :9001 within 90s"
|
|
echo "----- server log -----"
|
|
tail -n 200 /tmp/etherpad-server.log || true
|
|
exit 1
|
|
fi
|
|
cd src
|
|
pnpm exec playwright install chromium --with-deps
|
|
pnpm run test-ui --project=chromium
|
|
- name: Upload server log on failure
|
|
uses: actions/upload-artifact@v7
|
|
if: failure()
|
|
with:
|
|
name: server-log-chrome
|
|
path: /tmp/etherpad-server.log
|
|
retention-days: 7
|
|
- uses: actions/upload-artifact@v7
|
|
if: always()
|
|
with:
|
|
name: playwright-report-chrome
|
|
path: src/playwright-report/
|
|
retention-days: 30
|
|
playwright-firefox:
|
|
env:
|
|
PNPM_HOME: ~/.pnpm-store
|
|
name: Playwright Firefox
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v6
|
|
- uses: actions/cache@v5
|
|
name: Cache pnpm store
|
|
with:
|
|
path: ${{ env.PNPM_HOME }}
|
|
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-pnpm-store-
|
|
- uses: actions/cache@v5
|
|
name: Cache Playwright browsers
|
|
with:
|
|
path: ~/.cache/ms-playwright
|
|
key: ${{ runner.os }}-playwright-${{ hashFiles('src/package.json', 'pnpm-lock.yaml') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-playwright-
|
|
- uses: pnpm/action-setup@v6
|
|
name: Install pnpm
|
|
with:
|
|
version: 10.33.2
|
|
run_install: false
|
|
- name: Use Node.js
|
|
uses: actions/setup-node@v6
|
|
with:
|
|
node-version: 22
|
|
cache: pnpm
|
|
- name: Install all dependencies and symlink for ep_etherpad-lite
|
|
run: pnpm install --frozen-lockfile
|
|
- name: Create settings.json
|
|
run: cp ./src/tests/settings.json settings.json
|
|
- name: Run the frontend tests
|
|
shell: bash
|
|
run: |
|
|
set -euo pipefail
|
|
pnpm run prod > /tmp/etherpad-server.log 2>&1 &
|
|
# Generous 90s budget so a slow runner (or, in the with-plugins
|
|
# variant, plugin boot) doesn't lose the race against the test
|
|
# phase. Fail loudly on timeout rather than silently falling
|
|
# through to tests against a half-started server.
|
|
# --max-time bounds each probe so a stuck server can't make a
|
|
# single curl call eat the whole 90s budget.
|
|
can_connect() { curl --max-time 3 -sSfo /dev/null http://localhost:9001/; }
|
|
for i in $(seq 1 90); do can_connect && break; sleep 1; done
|
|
if ! can_connect; then
|
|
echo "::error::Etherpad did not respond on :9001 within 90s"
|
|
echo "----- server log -----"
|
|
tail -n 200 /tmp/etherpad-server.log || true
|
|
exit 1
|
|
fi
|
|
cd src
|
|
pnpm exec playwright install firefox --with-deps
|
|
pnpm run test-ui --project=firefox
|
|
- name: Upload server log on failure
|
|
uses: actions/upload-artifact@v7
|
|
if: failure()
|
|
with:
|
|
name: server-log-firefox
|
|
path: /tmp/etherpad-server.log
|
|
retention-days: 7
|
|
- uses: actions/upload-artifact@v7
|
|
if: always()
|
|
with:
|
|
name: playwright-report-firefox
|
|
path: src/playwright-report/
|
|
retention-days: 30
|
|
|
|
# Frontend tests with the same /ether plugin set that backend-tests.yml
|
|
# exercises, so a core change that breaks plugin UX is caught in PR CI
|
|
# rather than after release. Re-introduces coverage that was lost when
|
|
# the workflows were nuked & rebuilt in 2023 (commit cc80db2d3) and the
|
|
# backend equivalent was restored without the frontend half.
|
|
playwright-chrome-with-plugins:
|
|
env:
|
|
PNPM_HOME: ~/.pnpm-store
|
|
name: Playwright Chrome with plugins
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v6
|
|
- uses: actions/cache@v5
|
|
name: Cache pnpm store
|
|
with:
|
|
path: ${{ env.PNPM_HOME }}
|
|
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-pnpm-store-
|
|
- uses: actions/cache@v5
|
|
name: Cache Playwright browsers
|
|
with:
|
|
path: ~/.cache/ms-playwright
|
|
key: ${{ runner.os }}-playwright-${{ hashFiles('src/package.json', 'pnpm-lock.yaml') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-playwright-
|
|
- uses: pnpm/action-setup@v6
|
|
name: Install pnpm
|
|
with:
|
|
version: 10.33.2
|
|
run_install: false
|
|
- name: Use Node.js
|
|
uses: actions/setup-node@v6
|
|
with:
|
|
node-version: 22
|
|
cache: pnpm
|
|
- name: Install all dependencies and symlink for ep_etherpad-lite
|
|
run: pnpm install --frozen-lockfile
|
|
- name: Install Etherpad plugins
|
|
# Same plugin set as backend-tests.yml's withpluginsLinux job,
|
|
# MINUS ep_cursortrace.
|
|
#
|
|
# ep_cursortrace's `aceEditEvent` hook fires on every keyboard
|
|
# event (handleClick, handleKeyEvent, idleWorkTimer) and sends a
|
|
# cursor-position socket message per call. Under the test
|
|
# harness's `writeToPad` bursts (insertText + Enter loops) that
|
|
# stream of socket messages saturates the editor's input
|
|
# pipeline in Firefox specifically, causing intermittent
|
|
# keystroke drops and a long tail of test flakiness.
|
|
#
|
|
# Bisected via a 4-iteration probe on this branch — see commit
|
|
# history of .github/workflows/frontend-tests.yml around the
|
|
# PR-7630 timeframe. Tracked for a follow-up fix
|
|
# (debounce / throttle in ep_cursortrace's main.js).
|
|
run: >
|
|
pnpm add -w
|
|
ep_align
|
|
ep_author_hover
|
|
ep_font_color
|
|
ep_font_size
|
|
ep_hash_auth
|
|
ep_headings2
|
|
ep_markdown
|
|
ep_readonly_guest
|
|
ep_set_title_on_pad
|
|
ep_spellcheck
|
|
ep_subscript_and_superscript
|
|
ep_table_of_contents
|
|
- name: Create settings.json
|
|
run: cp ./src/tests/settings.json settings.json
|
|
- name: Run the frontend tests
|
|
shell: bash
|
|
run: |
|
|
set -euo pipefail
|
|
pnpm run prod > /tmp/etherpad-server.log 2>&1 &
|
|
# Generous 90s budget so a slow runner (or, in the with-plugins
|
|
# variant, plugin boot) doesn't lose the race against the test
|
|
# phase. Fail loudly on timeout rather than silently falling
|
|
# through to tests against a half-started server.
|
|
# --max-time bounds each probe so a stuck server can't make a
|
|
# single curl call eat the whole 90s budget.
|
|
can_connect() { curl --max-time 3 -sSfo /dev/null http://localhost:9001/; }
|
|
for i in $(seq 1 90); do can_connect && break; sleep 1; done
|
|
if ! can_connect; then
|
|
echo "::error::Etherpad did not respond on :9001 within 90s"
|
|
echo "----- server log -----"
|
|
tail -n 200 /tmp/etherpad-server.log || true
|
|
exit 1
|
|
fi
|
|
cd src
|
|
pnpm exec playwright install chromium --with-deps
|
|
WITH_PLUGINS=1 pnpm run test-ui --project=chromium
|
|
- name: Upload server log on failure
|
|
uses: actions/upload-artifact@v7
|
|
if: failure()
|
|
with:
|
|
name: server-log-chrome-with-plugins
|
|
path: /tmp/etherpad-server.log
|
|
retention-days: 7
|
|
- uses: actions/upload-artifact@v7
|
|
if: always()
|
|
with:
|
|
name: playwright-report-chrome-with-plugins
|
|
path: src/playwright-report/
|
|
retention-days: 30
|
|
|
|
playwright-firefox-with-plugins:
|
|
env:
|
|
PNPM_HOME: ~/.pnpm-store
|
|
name: Playwright Firefox with plugins
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v6
|
|
- uses: actions/cache@v5
|
|
name: Cache pnpm store
|
|
with:
|
|
path: ${{ env.PNPM_HOME }}
|
|
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-pnpm-store-
|
|
- uses: actions/cache@v5
|
|
name: Cache Playwright browsers
|
|
with:
|
|
path: ~/.cache/ms-playwright
|
|
key: ${{ runner.os }}-playwright-${{ hashFiles('src/package.json', 'pnpm-lock.yaml') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-playwright-
|
|
- uses: pnpm/action-setup@v6
|
|
name: Install pnpm
|
|
with:
|
|
version: 10.33.2
|
|
run_install: false
|
|
- name: Use Node.js
|
|
uses: actions/setup-node@v6
|
|
with:
|
|
node-version: 22
|
|
cache: pnpm
|
|
- name: Install all dependencies and symlink for ep_etherpad-lite
|
|
run: pnpm install --frozen-lockfile
|
|
- name: Install Etherpad plugins
|
|
# See sibling Playwright Chrome with plugins job for the full
|
|
# rationale on why ep_cursortrace is excluded from the test
|
|
# plugin set.
|
|
run: >
|
|
pnpm add -w
|
|
ep_align
|
|
ep_author_hover
|
|
ep_font_color
|
|
ep_font_size
|
|
ep_hash_auth
|
|
ep_headings2
|
|
ep_markdown
|
|
ep_readonly_guest
|
|
ep_set_title_on_pad
|
|
ep_spellcheck
|
|
ep_subscript_and_superscript
|
|
ep_table_of_contents
|
|
- name: Create settings.json
|
|
run: cp ./src/tests/settings.json settings.json
|
|
- name: Run the frontend tests
|
|
shell: bash
|
|
run: |
|
|
set -euo pipefail
|
|
pnpm run prod > /tmp/etherpad-server.log 2>&1 &
|
|
# Generous 90s budget so a slow runner (or, in the with-plugins
|
|
# variant, plugin boot) doesn't lose the race against the test
|
|
# phase. Fail loudly on timeout rather than silently falling
|
|
# through to tests against a half-started server.
|
|
# --max-time bounds each probe so a stuck server can't make a
|
|
# single curl call eat the whole 90s budget.
|
|
can_connect() { curl --max-time 3 -sSfo /dev/null http://localhost:9001/; }
|
|
for i in $(seq 1 90); do can_connect && break; sleep 1; done
|
|
if ! can_connect; then
|
|
echo "::error::Etherpad did not respond on :9001 within 90s"
|
|
echo "----- server log -----"
|
|
tail -n 200 /tmp/etherpad-server.log || true
|
|
exit 1
|
|
fi
|
|
cd src
|
|
pnpm exec playwright install firefox --with-deps
|
|
WITH_PLUGINS=1 pnpm run test-ui --project=firefox
|
|
- name: Upload server log on failure
|
|
uses: actions/upload-artifact@v7
|
|
if: failure()
|
|
with:
|
|
name: server-log-firefox-with-plugins
|
|
path: /tmp/etherpad-server.log
|
|
retention-days: 7
|
|
- uses: actions/upload-artifact@v7
|
|
if: always()
|
|
with:
|
|
name: playwright-report-firefox-with-plugins
|
|
path: src/playwright-report/
|
|
retention-days: 30
|