Skip to content

ci: parallel jobs + PR-gate + jest-junit + report (mirror of API #672) #1908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Hugo0 merged 4 commits into from
Apr 28, 2026
+353 −35
Merged

ci: parallel jobs + PR-gate + jest-junit + report (mirror of API #672) #1908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0c765df
ci: split serial test job into parallel + PR-gate + jest-junit + report
Hugo0 Apr 28, 2026
5c34751
ci(format): prettier-fix package.json after Python json.dump rewrite
Hugo0 Apr 28, 2026
608cbdf
ci: add ci-success umbrella job for branch-protection gating
Hugo0 Apr 28, 2026
0efb8b8
ci(report): wait for all gating jobs + paginate listComments (CR feed…
Hugo0 Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
343 changes: 311 additions & 32 deletions .github/workflows/tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,41 +1,75 @@
name: Tests

on:
push:
branches: ['**']
pull_request:
branches:
- main
- dev
- develop
workflow_dispatch:

# Cancel in-progress runs on the same branch when a newer commit lands.
# Rapid-iteration sessions burn CI minutes on stale runs without this.
# Cancel in-progress runs on the same PR when a newer commit lands.
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

permissions:
contents: read
# `checks: write` lets dorny/test-reporter publish per-PR check
# annotations from the JUnit XML below.
checks: write

jobs:
test:
# Lint + format. Fast, no node_modules needed beyond what setup-node
# cache restores.
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: true
token: ${{ secrets.SUBMODULE_TOKEN }}

- uses: pnpm/action-setup@v4
with:
version: 10

- uses: actions/setup-node@v4
with:
node-version: '21.1.0'
node-version: '20'
cache: 'pnpm'

- run: pnpm install --frozen-lockfile

- name: Check formatting
run: pnpm prettier --check .

# Validates content-submodule integrity. Currently advisory
# because of unrelated content-baseline drift.
- name: Validate internal links
run: pnpm validate-links
continue-on-error: true

# Typecheck job. Independent of unit tests so type errors surface in
# parallel.
typecheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: true
token: ${{ secrets.SUBMODULE_TOKEN }}

- uses: pnpm/action-setup@v4
with:
version: 10

- name: Install Dependencies
run: pnpm install
- uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'pnpm'

- name: Check formatting
run: pnpm prettier --check .
- run: pnpm install --frozen-lockfile

# Generate Next.js route + asset type declarations without a full
# build. tsconfig includes .next/types/**/*.ts; without these,
Expand All @@ -47,37 +81,282 @@ jobs:
- name: Typecheck
run: pnpm typecheck

# Validates content-submodule integrity (broken links, MDX
# component coverage, page-count baseline). Owned by the content
# team — currently failing on src/content drift unrelated to
# code PRs. Advisory until the content baseline is rebased.
- name: Validate internal links
run: pnpm validate-links
continue-on-error: true
unit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: true
token: ${{ secrets.SUBMODULE_TOKEN }}

- name: Run Unit Tests
run: pnpm test
- uses: pnpm/action-setup@v4
with:
version: 10

- name: Install Playwright Browsers
run: npx playwright install --with-deps chromium
- uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'pnpm'

# Playwright e2e tests need TEST_HARNESS_SECRET to match the API
# side. Until that secret is wired into repo settings + the
# harness API is reachable from CI, this is advisory. Local devs
# still run via `pnpm test:e2e` against the dev stack.
- name: Run E2E Tests
run: pnpm test:e2e
continue-on-error: true
- run: pnpm install --frozen-lockfile

- name: Generate Next types
run: pnpm next typegen

- name: Run unit tests
run: pnpm test:unit:ci

- name: Publish unit test report
uses: dorny/test-reporter@v1
if: always()
with:
name: Unit test report
path: test-results/junit.xml
reporter: jest-junit
fail-on-error: false

- name: Upload unit coverage
if: always()
uses: actions/upload-artifact@v4
with:
name: coverage-unit
path: coverage/coverage-final.json
retention-days: 7

- name: Upload Coverage
- name: Upload unit JUnit XML
if: always()
uses: actions/upload-artifact@v4
with:
name: coverage
path: coverage/
name: junit-unit
path: test-results/junit.xml
retention-days: 7

# Playwright e2e — advisory until TEST_HARNESS_SECRET + harness API
# reachability are wired in repo settings (per the prior comment).
e2e:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: true
token: ${{ secrets.SUBMODULE_TOKEN }}

- uses: pnpm/action-setup@v4
with:
version: 10

- name: Upload Playwright Report
- uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'pnpm'

- run: pnpm install --frozen-lockfile

- name: Install Playwright browsers
run: npx playwright install --with-deps chromium

- name: Run E2E tests
run: pnpm test:e2e
continue-on-error: true

- name: Upload Playwright report
if: always()
uses: actions/upload-artifact@v4
with:
name: playwright-report
path: playwright-report/
retention-days: 7

# Coverage + test-summary aggregator. Mirrors the pattern from
# peanut-api-ts/.github/workflows/tests.yaml `report` job.
report:
runs-on: ubuntu-latest
# Wait for lint + typecheck + e2e too — the report header says
# "all green", which would lie if only unit results were
# considered (per CR feedback on PR #1908).
needs: [lint, typecheck, unit, e2e]
if: always()
Comment thread
coderabbitai[bot] marked this conversation as resolved.
permissions:
contents: read
pull-requests: write
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: '20'

- name: Download unit coverage
uses: actions/download-artifact@v4
continue-on-error: true
with:
name: coverage-unit
path: coverage-raw/unit

- name: Download unit JUnit
uses: actions/download-artifact@v4
continue-on-error: true
with:
name: junit-unit
path: junit-raw/unit

- name: Summarize
id: report
run: |
set -euo pipefail
mkdir -p coverage-merged coverage-input

[[ -f coverage-raw/unit/coverage-final.json ]] && cp coverage-raw/unit/coverage-final.json coverage-input/unit.json || echo "no unit coverage"

if ls coverage-input/*.json >/dev/null 2>&1; then
npx --yes nyc@15 merge coverage-input coverage-merged/coverage-final.json
npx --yes nyc@15 report --reporter=json-summary --temp-dir=coverage-merged --report-dir=coverage-merged
else
echo '{"total":{"statements":{"pct":0},"branches":{"pct":0},"functions":{"pct":0},"lines":{"pct":0}}}' > coverage-merged/coverage-summary.json
fi

node -e "
const fs = require('fs');
let cov = { total: { statements:{pct:0}, branches:{pct:0}, functions:{pct:0}, lines:{pct:0} } };
try { cov = JSON.parse(fs.readFileSync('coverage-merged/coverage-summary.json','utf8')); } catch {}

function decode(s) {
return s.replaceAll('&amp;','&').replaceAll('&lt;','<').replaceAll('&gt;','>').replaceAll('&quot;','\"').replaceAll('&apos;','\\'');
}
Comment on lines +223 to +225
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify the current escaping behavior vs the fix
echo "=== Current escaping (produces backslash) ==="
node -e "console.log('test'.replaceAll('t','\\\\'))"

echo ""
echo "=== Correct escaping for single quote ==="
node -e "console.log('test'.replaceAll('t',\"'\"))"

Repository: peanutprotocol/peanut-ui

Length of output: 167

🏁 Script executed:

cd .github/workflows && head -n 225 tests.yml | tail -n 15

Repository: peanutprotocol/peanut-ui

Length of output: 877

Escaping bug in decode function: &apos; replacement produces backslash instead of single quote.

The current code .replaceAll('&apos;','\\'') replaces XML &apos; entities with a backslash character (\), not a single quote ('). In JavaScript, '\\' is a string containing one backslash.

Fix by using "'" inside the double-quoted shell context:

🐛 Proposed fix 
                  function decode(s) {
-                     return s.replaceAll('&amp;','&').replaceAll('&lt;','<').replaceAll('&gt;','>').replaceAll('&quot;','\"').replaceAll('&apos;','\\'');
+                     return s.replaceAll('&amp;','&').replaceAll('&lt;','<').replaceAll('&gt;','>').replaceAll('&quot;','\"').replaceAll('&apos;',"'");
                  }
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/tests.yml around lines 220 - 222, The decode function's
replacement for &apos; is wrong: change the `.replaceAll('&apos;','\\'')`
occurrence inside function decode to replace &apos; with a single-quote
character instead of a backslash-escaped string; update the replacement argument
so it is a single-quote (e.g., use a literal "'" as the replacement) ensuring
proper quoting in the workflow/YAML context so the resulting JavaScript uses
.replaceAll('&apos;', "'").


function parseJunit(p, label) {
try {
const xml = fs.readFileSync(p,'utf8');
const tests = parseInt((xml.match(/<testsuites [^>]*tests=\"(\d+)\"/) || [])[1] || '0', 10);
const failures = parseInt((xml.match(/<testsuites [^>]*failures=\"(\d+)\"/) || [])[1] || '0', 10);
const skipped = parseInt((xml.match(/<testsuites [^>]*skipped=\"(\d+)\"/) || [])[1] || '0', 10);
const time = parseFloat((xml.match(/<testsuites [^>]*time=\"([\d.]+)\"/) || [])[1] || '0');
const cases = [];
for (const m of xml.matchAll(/<testsuite name=\"([^\"]+)\"[^>]*>([\\s\\S]*?)<\\/testsuite>/g)) {
const file = decode(m[1]);
for (const tc of m[2].matchAll(/<testcase[^>]*classname=\"([^\"]*)\"[^>]*name=\"([^\"]+)\"[^>]*time=\"([\d.]+)\"[^>]*(\\/>|>([\\s\\S]*?)<\\/testcase>)/g)) {
const failed = tc[5] && /<failure/.test(tc[5]);
cases.push({ file, project: label, suite: decode(tc[1]), name: decode(tc[2]), time: parseFloat(tc[3]), failed: !!failed });
}
}
return { tests, failures, skipped, time, cases };
} catch { return null; }
}

const unit = parseJunit('junit-raw/unit/junit.xml','unit');
const allCases = unit?.cases || [];
const failed = allCases.filter(c => c.failed);
const slowest = [...allCases].sort((a,b) => b.time - a.time).slice(0, 10);
Comment thread
coderabbitai[bot] marked this conversation as resolved.
fs.writeFileSync('report-payload.json', JSON.stringify({ cov, unit, failed, slowest }, null, 2));
"

- name: Comment on PR
if: github.event_name == 'pull_request'
uses: actions/github-script@v7
with:
script: |
const fs = require('fs');
const p = JSON.parse(fs.readFileSync('report-payload.json','utf8'));
const pct = (n) => (n == null ? '—' : `${n.toFixed(1)}%`);
const dur = (n) => (n == null ? '—' : n >= 60 ? `${(n/60).toFixed(1)}m` : `${n.toFixed(1)}s`);

const status = p.failed.length === 0 ? '✅ all green' : `🔴 ${p.failed.length} failing`;
const suiteLine = (label, s) => {
if (!s) return `- **${label}**: skipped / unavailable`;
const icon = s.failures > 0 ? '🔴' : '✅';
return `- ${icon} **${label}**: ${s.tests - s.skipped} ran, ${s.failures} failed, ${s.skipped} skipped, ${dur(s.time)}`;
};
const failedBlock = p.failed.length === 0 ? '' : [
'### 🔴 Failing tests',
'',
...p.failed.map(c => `- \`${c.file}\` › ${c.suite ? c.suite + ' › ' : ''}**${c.name}** — ${c.time.toFixed(2)}s`),
'',
].join('\n');
const slowBlock = p.slowest.length === 0 ? '' : [
'<details><summary>⏱ 10 slowest test cases</summary>',
'',
'| time | test |',
'| ---: | --- |',
...p.slowest.map(c => `| ${c.time >= 5 ? '🐢 ' : ''}${dur(c.time)} | \`${c.file}\` › ${c.name} |`),
'',
'</details>',
].join('\n');
const covBlock = [
'### 📊 Coverage (unit)',
'',
'| metric | % |',
'| --- | ---: |',
`| statements | ${pct(p.cov.total.statements?.pct)} |`,
`| branches | ${pct(p.cov.total.branches?.pct)} |`,
`| functions | ${pct(p.cov.total.functions?.pct)} |`,
`| lines | ${pct(p.cov.total.lines?.pct)} |`,
].join('\n');

const body = [
'<!-- ui-test-report -->',
`## 🧪 UI test report — ${status}`,
'',
'### Suites',
suiteLine('unit', p.unit),
'',
failedBlock,
covBlock,
'',
slowBlock,
'',
'<sub>📍 Inline annotations are in the **Unit test report** check above. Coverage artifact: `coverage-unit`. Generated by `.github/workflows/tests.yml`.</sub>',
].filter(Boolean).join('\n');

const tag = '<!-- ui-test-report -->';
// Paginate so the idempotent-update lookup doesn't break once
// a PR accumulates >30 comments (CR feedback on #1908).
const comments = await github.paginate(github.rest.issues.listComments, {
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
per_page: 100,
});
const existing = comments.find(c => c.body && c.body.includes(tag));
Comment thread
coderabbitai[bot] marked this conversation as resolved.
if (existing) {
await github.rest.issues.updateComment({
comment_id: existing.id,
owner: context.repo.owner,
repo: context.repo.repo,
body,
});
} else {
await github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body,
});
}

# Single umbrella check that aggregates all required test/quality jobs.
# Branch protection on `dev`/`main` requires only `ci-success` instead of
# listing every individual job — keeps the ruleset stable as jobs are
# added/renamed. To gate a new job: add it to `needs:` here.
#
# `if: always()` so this runs even when an upstream fails. Explicit
# `failure || cancelled` check because GitHub treats `skipped` as neutral
# (an upstream skip would silently let this pass without the explicit gate).
ci-success:
name: ci-success
if: always()
needs: [lint, typecheck, unit, e2e, report]
runs-on: ubuntu-latest
steps:
- name: Verify all required jobs passed
run: |
if [[ "${{ contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') }}" == "true" ]]; then
echo "::error::One or more required jobs failed or were cancelled"
echo "Job results:"
echo " lint: ${{ needs.lint.result }}"
echo " typecheck: ${{ needs.typecheck.result }}"
echo " unit: ${{ needs.unit.result }}"
echo " e2e: ${{ needs.e2e.result }}"
echo " report: ${{ needs.report.result }}"
exit 1
fi
echo "✅ All required jobs passed"
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,5 @@ keystore.properties

# capgo ota signing key
.capgo_key_v2
test-results/
coverage/
Loading
Loading