mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-05-13 17:26:22 +00:00
*PR Created by the Glary-Bot Agent* --- ## Summary - Eliminates the confusing dual-helpers structure where `browser_tests/helpers/` and `browser_tests/fixtures/helpers/` coexisted one tier apart with overlapping purposes - Routes each file to its natural home based on what it actually *is*: page objects → `components/`, standalone utils → `utils/`, domain helper classes stay in `helpers/` - Adds an ESLint guard (`no-restricted-imports`) to prevent re-creating `browser_tests/helpers/` ## File Moves | File | From | To | Reason | |---|---|---|---| | `actionbar.ts` | `helpers/` | `fixtures/components/Actionbar.ts` | Page object class imported by ComfyPage | | `templates.ts` | `helpers/` | `fixtures/components/Templates.ts` | Page object class imported by ComfyPage | | `boundsUtils.ts` | `fixtures/helpers/` | `fixtures/utils/` | Pure function, not a helper class | | `mimeTypeUtil.ts` | `fixtures/helpers/` | `fixtures/utils/` | Pure function, not a helper class | | `builderTestUtils.ts` | `helpers/` | `fixtures/utils/` | Shared test setup functions | | `clipboardSpy.ts` | `helpers/` | `fixtures/utils/` | Page injection utility | | `fitToView.ts` | `helpers/` | `fixtures/utils/` | Canvas utility function | | `manageGroupNode.ts` | `helpers/` | `fixtures/utils/` | Litegraph interaction helper | | `painter.ts` | `helpers/` | `fixtures/utils/` | Test helper functions | | `perfReporter.ts` | `helpers/` | `fixtures/utils/` | Test infrastructure | | `promotedWidgets.ts` | `helpers/` | `fixtures/utils/` | Query helpers for specs | ## What Changed Beyond File Moves - **28 import statements** updated across test specs, fixtures, and infra files - **AGENTS.md** — directory tree diagram and architectural separation descriptions updated - **README.md** — "Leverage Existing Fixtures and Helpers" section updated - **`.claude/skills/perf-fix-with-proof/SKILL.md`** — perfReporter path reference updated - **`eslint.config.ts`** — added `@e2e/helpers/*` restricted import pattern to both spec and non-spec browser_tests rules ## Verification - `pnpm typecheck` — clean - `pnpm typecheck:browser` — clean - `pnpm lint` — 0 errors, 0 warnings - `pnpm format:check` — all files formatted - `pnpm knip` — clean - Pre-commit hooks passed full pipeline (oxfmt, oxlint, eslint, typecheck, typecheck:browser) ## Config Audit No changes needed to: `tsconfig.json` (`@e2e/*` alias covers all subdirs), `playwright.config.ts`, `vite.config.mts`, `knip.config.ts`, `.oxlintrc.json`, `nx.json` ## Manual Verification Note This is a pure structural refactoring (file moves + import updates) with zero behavioral or visual changes. The typecheck and lint passes confirm all imports resolve correctly. ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-11411-refactor-consolidate-browser_tests-helpers-into-fixtures-3476d73d3650816cb671ef7fa8433f66) by [Unito](https://www.unito.io) --------- Co-authored-by: glary-bot <glary-bot@comfy.org> Co-authored-by: Glary-Bot <glary-bot@users.noreply.github.com> Co-authored-by: DrJKL <DrJKL0424@gmail.com> Co-authored-by: Amp <amp@ampcode.com>
90 lines
2.7 KiB
TypeScript
90 lines
2.7 KiB
TypeScript
import { mkdirSync, readdirSync, readFileSync, writeFileSync } from 'fs'
|
|
import { join } from 'path'
|
|
|
|
import type { PerfMeasurement } from '@e2e/fixtures/helpers/PerformanceHelper'
|
|
|
|
export interface PerfReport {
|
|
timestamp: string
|
|
gitSha: string
|
|
branch: string
|
|
measurements: PerfMeasurement[]
|
|
}
|
|
|
|
const TEMP_DIR = join('test-results', 'perf-temp')
|
|
|
|
type MeasurementField = keyof PerfMeasurement
|
|
|
|
const FIELD_FORMATTERS: Record<string, (m: PerfMeasurement) => string> = {
|
|
styleRecalcs: (m) => `${m.styleRecalcs} recalcs`,
|
|
layouts: (m) => `${m.layouts} layouts`,
|
|
taskDurationMs: (m) => `${m.taskDurationMs.toFixed(1)}ms task`,
|
|
layoutDurationMs: (m) => `${m.layoutDurationMs.toFixed(1)}ms layout`,
|
|
frameDurationMs: (m) => `${m.frameDurationMs.toFixed(1)}ms/frame`,
|
|
totalBlockingTimeMs: (m) => `TBT=${m.totalBlockingTimeMs.toFixed(0)}ms`,
|
|
durationMs: (m) => `${m.durationMs.toFixed(0)}ms total`,
|
|
heapDeltaBytes: (m) => `heap Δ${(m.heapDeltaBytes / 1024).toFixed(0)}KB`,
|
|
domNodes: (m) => `DOM Δ${m.domNodes}`,
|
|
heapUsedBytes: (m) => `heap ${(m.heapUsedBytes / 1024 / 1024).toFixed(1)}MB`
|
|
}
|
|
|
|
/**
|
|
* Log a perf measurement to the console in a consistent format.
|
|
* Fields are formatted automatically based on their type.
|
|
*/
|
|
export function logMeasurement(
|
|
label: string,
|
|
m: PerfMeasurement,
|
|
fields: MeasurementField[]
|
|
) {
|
|
const parts = fields.map((f) => {
|
|
const formatter = FIELD_FORMATTERS[f]
|
|
if (formatter) return formatter(m)
|
|
return `${f}=${m[f]}`
|
|
})
|
|
// oxlint-disable-next-line no-console -- perf reporter intentionally logs to stdout
|
|
console.log(`${label}: ${parts.join(', ')}`)
|
|
}
|
|
|
|
export function recordMeasurement(m: PerfMeasurement) {
|
|
mkdirSync(TEMP_DIR, { recursive: true })
|
|
const filename = `${m.name}-${Date.now()}.json`
|
|
const { allFrameDurationsMs: _, ...serializable } = m
|
|
writeFileSync(join(TEMP_DIR, filename), JSON.stringify(serializable))
|
|
}
|
|
|
|
export function writePerfReport(
|
|
gitSha = process.env.GITHUB_SHA ?? 'local',
|
|
branch = process.env.GITHUB_HEAD_REF ?? 'local'
|
|
) {
|
|
let entries
|
|
try {
|
|
entries = readdirSync('test-results', { withFileTypes: true })
|
|
} catch {
|
|
return
|
|
}
|
|
if (!entries.length) return
|
|
|
|
let tempFiles: string[]
|
|
try {
|
|
tempFiles = readdirSync(TEMP_DIR).filter((f) => f.endsWith('.json'))
|
|
} catch {
|
|
return
|
|
}
|
|
if (tempFiles.length === 0) return
|
|
|
|
const measurements: PerfMeasurement[] = tempFiles.map((f) =>
|
|
JSON.parse(readFileSync(join(TEMP_DIR, f), 'utf-8'))
|
|
)
|
|
|
|
const report: PerfReport = {
|
|
timestamp: new Date().toISOString(),
|
|
gitSha,
|
|
branch,
|
|
measurements
|
|
}
|
|
writeFileSync(
|
|
join('test-results', 'perf-metrics.json'),
|
|
JSON.stringify(report, null, 2)
|
|
)
|
|
}
|