mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-04-20 06:20:11 +00:00
## What
Adds a `cloud` Playwright project so E2E tests can run against
`DISTRIBUTION=cloud` builds, with `@cloud` / `@oss` test tagging.
## Why
100+ usages of `isCloud` / `DISTRIBUTION` across 9 categories (API
routing, UI visibility, settings, auth). Zero cloud test infrastructure
existed — cloud-specific UI components (LoginButton, SubscribeButton,
etc.) had no E2E coverage path.
## Investigation: Runtime Toggle
Investigated whether `isCloud` could be made runtime-toggleable in
dev/test mode (via `window.__FORCE_CLOUD__`). **Not feasible** —
`__DISTRIBUTION__` is a Vite `define` compile-time constant used for
dead-code elimination. Runtime override would break tree-shaking in
production.
Full investigation:
`research/architecture/cloud-runtime-toggle-investigation.md`
## What's included
### Playwright Config
- New `cloud` project alongside existing `chromium`
- Cloud project: `grep: /@cloud/` — only runs `@cloud` tagged tests
- Chromium project: `grepInvert: /@cloud/` — excludes cloud tests
### Build Script
- `npm run build:cloud` → `DISTRIBUTION=cloud vite build`
### Test Tagging Convention
```typescript
test('works in both', async () => { ... });
test('subscription button visible @cloud', async () => { ... });
test('install manager prompt @oss', async () => { ... });
```
### Example Tests
- 2 cloud-only tests validating cloud UI visibility
## NOT included (future work)
- CI workflow job for cloud tests (separate PR)
- Cloud project is opt-in — not run by default locally
## Unblocks
- Cloud-specific E2E tests for entire team
- TB-03 LoginButton, TB-04 SubscribeButton (@Kaili Yang)
- DLG-04 SignIn, DLG-06 CancelSubscription
Part of: Test Coverage Q2 Overhaul
┆Issue is synchronized with this [Notion
page](https://www.notion.so/PR-10546-test-infra-cloud-Playwright-project-with-cloud-oss-tagging-32f6d73d3650810ebb59dea8ce4891e9)
by [Unito](https://www.unito.io)
---------
Co-authored-by: GitHub Action <action@github.com>
Co-authored-by: Alexander Brown <drjkl@comfy.org>
125 lines
3.3 KiB
TypeScript
125 lines
3.3 KiB
TypeScript
import { defineConfig, devices } from '@playwright/test'
|
|
import type { PlaywrightTestConfig } from '@playwright/test'
|
|
|
|
const maybeLocalOptions: PlaywrightTestConfig = process.env.PLAYWRIGHT_LOCAL
|
|
? {
|
|
// VERY HELPFUL: Skip screenshot tests locally
|
|
// grep: process.env.CI ? undefined : /^(?!.*screenshot).*$/,
|
|
timeout: 30_000, // Longer timeout for breakpoints
|
|
retries: 0, // No retries while debugging. Increase if writing new tests. that may be flaky.
|
|
workers: 1, // Single worker for easier debugging. Increase to match CPU cores if you want to run a lot of tests in parallel.
|
|
|
|
use: {
|
|
trace: 'on', // Always capture traces (CI uses 'on-first-retry')
|
|
video: 'on' // Always record video (CI uses 'retain-on-failure')
|
|
}
|
|
}
|
|
: {
|
|
retries: process.env.CI ? 3 : 0,
|
|
use: {
|
|
trace: 'on-first-retry'
|
|
}
|
|
}
|
|
|
|
export default defineConfig({
|
|
testDir: './browser_tests',
|
|
fullyParallel: true,
|
|
forbidOnly: !!process.env.CI,
|
|
reporter: 'html',
|
|
...maybeLocalOptions,
|
|
|
|
globalSetup: './browser_tests/globalSetup.ts',
|
|
globalTeardown: './browser_tests/globalTeardown.ts',
|
|
|
|
projects: [
|
|
{
|
|
name: 'chromium',
|
|
use: { ...devices['Desktop Chrome'] },
|
|
timeout: 15000,
|
|
grepInvert: /@mobile|@perf|@audit|@cloud/ // Run all tests except those tagged with @mobile, @perf, @audit, or @cloud
|
|
},
|
|
|
|
{
|
|
name: 'performance',
|
|
use: {
|
|
...devices['Desktop Chrome'],
|
|
trace: 'retain-on-failure'
|
|
},
|
|
timeout: 60_000,
|
|
grep: /@perf/,
|
|
fullyParallel: false
|
|
},
|
|
|
|
{
|
|
name: 'audit',
|
|
use: {
|
|
...devices['Desktop Chrome'],
|
|
trace: 'retain-on-failure'
|
|
},
|
|
timeout: 120_000,
|
|
grep: /@audit/,
|
|
fullyParallel: false
|
|
},
|
|
|
|
{
|
|
name: 'chromium-2x',
|
|
use: { ...devices['Desktop Chrome'], deviceScaleFactor: 2 },
|
|
timeout: 15000,
|
|
grep: /@2x/ // Run all tests tagged with @2x
|
|
},
|
|
|
|
{
|
|
name: 'chromium-0.5x',
|
|
use: { ...devices['Desktop Chrome'], deviceScaleFactor: 0.5 },
|
|
timeout: 15000,
|
|
grep: /@0.5x/ // Run all tests tagged with @0.5x
|
|
},
|
|
|
|
// {
|
|
// name: 'firefox',
|
|
// use: { ...devices['Desktop Firefox'] },
|
|
// },
|
|
|
|
// {
|
|
// name: 'webkit',
|
|
// use: { ...devices['Desktop Safari'] },
|
|
// },
|
|
|
|
{
|
|
name: 'cloud',
|
|
use: { ...devices['Desktop Chrome'] },
|
|
timeout: 15000,
|
|
grep: /@cloud/, // Run only tests tagged with @cloud
|
|
grepInvert: /@oss/ // Exclude tests tagged with @oss
|
|
},
|
|
|
|
/* Test against mobile viewports. */
|
|
{
|
|
name: 'mobile-chrome',
|
|
use: { ...devices['Pixel 5'], hasTouch: true },
|
|
grep: /@mobile/ // Run only tests tagged with @mobile
|
|
}
|
|
// {
|
|
// name: 'Mobile Safari',
|
|
// use: { ...devices['iPhone 12'] },
|
|
// },
|
|
|
|
/* Test against branded browsers. */
|
|
// {
|
|
// name: 'Microsoft Edge',
|
|
// use: { ...devices['Desktop Edge'], channel: 'msedge' },
|
|
// },
|
|
// {
|
|
// name: 'Google Chrome',
|
|
// use: { ...devices['Desktop Chrome'], channel: 'chrome' },
|
|
// },
|
|
]
|
|
|
|
/* Run your local dev server before starting the tests */
|
|
// webServer: {
|
|
// command: 'pnpm dev',
|
|
// url: 'http://127.0.0.1:5173',
|
|
// reuseExistingServer: !process.env.CI,
|
|
// },
|
|
})
|