Penulis naskah E2E di GitHub Actions sebagai langkah wajib sebelum diterapkan ke Vercel
Masalah dengan penerapan default
Proyek Vercel yang terhubung ke GitHub menyebarkan setiap push di main langsung ke produksi. Pengujian di GitHub Actions berjalan secara paralel, dan jika gagal, versi yang rusak sudah melayani pengguna. Kami memerlukan urutan: pengujian pertama, lalu penerapan, dan penerapan perakitan yang telah diuji.
Ada dua skema kerja.
Skema A. CI membuat aplikasi, menjalankannya secara lokal, menjalankan Playwright, dan jika berhasil, mengirimkan artefak yang telah dirakit ke Vercel melalui CLI.
Skema B. Vercel membuat penerapan pratinjau, CI mengujinya berdasarkan URL, dan jika berhasil, penerapan yang sama dipromosikan ke produksi.
Skema A lebih mudah dikonfigurasi dan tidak bergantung pada ketersediaan pratinjau. Sirkuit B menguji infrastruktur Vercel yang sebenarnya (middleware, fungsi edge, pratinjau variabel lingkungan). Di bawah ini adalah versi lengkap skema A dan perbedaannya untuk B.
Nonaktifkan penerapan otomatis dari Git
Dalam vercel.json:
{
"git": {
"deploymentEnabled": false
}
}Hanya dapat dinonaktifkan untuk masing-masing cabang: "deploymentEnabled": { "main": false }. Kemudian preview pull request akan terus dibuat secara otomatis.
Konfigurasi penulis naskah
// playwright.config.ts
import { defineConfig, devices } from "@playwright/test";
const baseURL = process.env.E2E_BASE_URL ?? "http://localhost:3000";
export default defineConfig({
testDir: "./e2e",
fullyParallel: true,
forbidOnly: !!process.env.CI,
retries: process.env.CI ? 2 : 0,
reporter: process.env.CI ? [["html", { open: "never" }], ["github"]] : "list",
use: {
baseURL,
trace: "on-first-retry",
extraHTTPHeaders: process.env.VERCEL_AUTOMATION_BYPASS_SECRET
? { "x-vercel-protection-bypass": process.env.VERCEL_AUTOMATION_BYPASS_SECRET }
: undefined,
},
projects: [{ name: "chromium", use: { ...devices["Desktop Chrome"] } }],
webServer: process.env.E2E_BASE_URL
? undefined
: {
command: "npm run start",
url: "http://localhost:3000",
reuseExistingServer: !process.env.CI,
timeout: 120_000,
},
});forbidOnly akan mencegah test.only yang dilakukan secara tidak sengaja melewati pengujian lainnya. trace: "on-first-retry" hanya menyimpan jejak untuk pengujian yang tidak stabil untuk menghindari artefak yang membengkak.
Apa yang harus diuji
E2E sebelum penerapan bukanlah tempat untuk cakupan penuh. Ambil skenario yang membutuhkan uang atau pengguna untuk memecahkannya:
// e2e/critical.spec.ts
import { test, expect } from "@playwright/test";
test("главная отдаёт контент и навигацию", async ({ page }) => {
await page.goto("/");
await expect(page.getByRole("navigation")).toBeVisible();
await expect(page.getByRole("heading", { level: 1 })).toBeVisible();
});
test("вход с тестовым пользователем", async ({ page }) => {
await page.goto("/login");
await page.getByLabel("Email").fill(process.env.E2E_USER_EMAIL!);
await page.getByLabel("Пароль").fill(process.env.E2E_USER_PASSWORD!);
await page.getByRole("button", { name: "Войти" }).click();
await expect(page).toHaveURL(/\/dashboard/);
});
test("страница статьи открывается при клиентской навигации", async ({ page }) => {
await page.goto("/forum");
await page.locator('a[href*="/forum/"]').first().click();
await expect(page.locator("article")).toBeVisible();
});Tes terakhir menangkap kelas kesalahan yang tidak terlihat ketika memuat halaman secara langsung: crash ketika melewati <Link>. Pengguna pengujian harus hanya ada di database pengujian atau pratinjau.
Alur kerja untuk diagram A
# .github/workflows/deploy.yml
name: test-and-deploy
on:
push:
branches: [main]
jobs:
e2e-deploy:
runs-on: ubuntu-latest
env:
VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- run: npm ci
- run: npm i -g vercel@latest
- run: vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }}
- run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}
- run: npm run build
- run: npx playwright install --with-deps chromium
- run: npx playwright test
env:
E2E_USER_EMAIL: ${{ secrets.E2E_USER_EMAIL }}
E2E_USER_PASSWORD: ${{ secrets.E2E_USER_PASSWORD }}
- uses: actions/upload-artifact@v4
if: failure()
with:
name: playwright-report
path: playwright-report/
retention-days: 7
- run: vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }}vercel pull memuat pengaturan proyek dan variabel lingkungan, vercel build mengumpulkan output ke dalam .vercel/output, dan deploy --prebuilt mengirimkannya tanpa menyusun kembali di sisi Vercel. Langkah penerapan dijalankan hanya jika semua langkah sebelumnya telah dilewati.
Di sini aplikasi dibuat dua kali: vercel build untuk penerapan dan npm run build untuk peluncuran lokal. Jika rakitan pengujian masuk ke database produksi, ini berbahaya - gunakan variabel lingkungan pengujian terpisah untuk npm run build dan next start.
Perbedaan skema B
Alih-alih server lokal, atur E2E_BASE_URL dengan alamat penerapan pratinjau (vercel deploy --token=... mencetaknya ke stdout). Pratinjau biasanya ditutup oleh Deployment Protection; untuk otomatisasi, aktifkan Protection Bypass for Automation di pengaturan proyek dan teruskan rahasia di header x-vercel-protection-bypass - konfigurasi di atas sudah melakukan ini. Setelah pengujian berhasil, jalankan vercel promote <url> --token=....
Cara mengatasi crash
- Unduh artefak
playwright-reportdan bukanpx playwright show-report. Pelacakan menunjukkan DOM, jaringan, dan konsol di setiap langkah. - Tes hanya crash di CI: paling sering penyebabnya adalah waktu habis selama start yang dingin atau zona waktu yang berbeda. Bandingkan
TZdanlocalediuse. - Tes yang tidak stabil tidak ditangani dengan meningkatkan
retries. Cari wait lewatwaitForTimeoutdan ganti dengan cek status lewatexpect.
Jika tidak diperlukan
Untuk situs statis tanpa formulir dan otorisasi, membangun dan memeriksa tautan saja sudah cukup. Jika pengujian memerlukan waktu lebih dari 10–15 menit, bagilah pengujian tersebut: rangkaian asap singkat memblokir penerapan, rangkaian lengkap dilanjutkan sesuai jadwal.