From 7150e464203f0201a291e9f9f1230b08a2f3a00b Mon Sep 17 00:00:00 2001 From: Nate Moore Date: Thu, 12 Nov 2026 22:03:16 -0500 Subject: [PATCH 1/2] feat(framework-baseline): record framework dom usage and check profiles in ci --- .github/workflows/framework-baseline.yml | 57 ++ knip.config.ts | 5 + packages/framework-baseline/.gitignore | 1 + packages/framework-baseline/README.md | 21 + packages/framework-baseline/knip.json | 5 + packages/framework-baseline/package.json | 25 + packages/framework-baseline/src/audit.ts | 104 ++++ .../framework-baseline/src/drivers/preact.ts | 72 +++ .../framework-baseline/src/drivers/react.ts | 84 +++ .../framework-baseline/src/drivers/solid.ts | 73 +++ .../framework-baseline/src/drivers/svelte.ts | 82 +++ .../framework-baseline/src/drivers/vue.ts | 85 +++ packages/framework-baseline/src/recorder.ts | 124 ++++ packages/framework-baseline/src/run.ts | 26 + packages/framework-baseline/src/scenario.ts | 148 +++++ packages/framework-baseline/tsconfig.json | 8 + pnpm-lock.yaml | 539 +++++++++++++++++- 17 files changed, 1443 insertions(+), 16 deletions(-) create mode 100644 .github/workflows/framework-baseline.yml create mode 100644 packages/framework-baseline/.gitignore create mode 100644 packages/framework-baseline/README.md create mode 100644 packages/framework-baseline/knip.json create mode 100644 packages/framework-baseline/package.json create mode 100644 packages/framework-baseline/src/audit.ts create mode 100644 packages/framework-baseline/src/drivers/preact.ts create mode 100644 packages/framework-baseline/src/drivers/react.ts create mode 100644 packages/framework-baseline/src/drivers/solid.ts create mode 100644 packages/framework-baseline/src/drivers/svelte.ts create mode 100644 packages/framework-baseline/src/drivers/vue.ts create mode 100644 packages/framework-baseline/src/recorder.ts create mode 100644 packages/framework-baseline/src/run.ts create mode 100644 packages/framework-baseline/src/scenario.ts create mode 100644 packages/framework-baseline/tsconfig.json diff --git a/.github/workflows/framework-baseline.yml b/.github/workflows/framework-baseline.yml new file mode 100644 index 0000000..ec9e8d1 --- /dev/null +++ b/.github/workflows/framework-baseline.yml @@ -0,0 +1,57 @@ +name: framework-baseline + +on: + pull_request: + paths: + - packages/framework-baseline/** + - packages/web-platform-tests/src/frameworks/** + - pnpm-lock.yaml + - .github/workflows/framework-baseline.yml + push: + branches: [main] + schedule: + # Mondays: catch framework releases that touch DOM members missing from the profiles. + - cron: '0 12 * * 1' + workflow_dispatch: + +permissions: + contents: read + +env: + MISE_IDIOMATIC_VERSION_FILE_ENABLE_TOOLS: node,pnpm + +jobs: + pinned: + if: github.event_name != 'schedule' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + persist-credentials: false + - uses: jdx/mise-action@c2a87611a18de5b3828c5652fe268e992400cb5c # v4.3.0 + - run: pnpm install --frozen-lockfile + - run: pnpm --filter @bomb.sh/web-platform-tests build + - run: pnpm --filter @bomb.sh/framework-baseline run check + + latest: + if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + persist-credentials: false + - uses: jdx/mise-action@c2a87611a18de5b3828c5652fe268e992400cb5c # v4.3.0 + - run: pnpm install --frozen-lockfile + - run: >- + pnpm --filter @bomb.sh/framework-baseline update --latest + preact react react-dom solid-js svelte vue @happy-dom/global-registrator + - run: pnpm --filter @bomb.sh/web-platform-tests build + - name: Audit latest framework releases + shell: bash + run: | + set -o pipefail + echo '```' >> "$GITHUB_STEP_SUMMARY" + status=0 + pnpm --filter @bomb.sh/framework-baseline --silent run check | tee -a "$GITHUB_STEP_SUMMARY" || status=$? + echo '```' >> "$GITHUB_STEP_SUMMARY" + exit $status diff --git a/knip.config.ts b/knip.config.ts index 4a9ed76..a4172ec 100644 --- a/knip.config.ts +++ b/knip.config.ts @@ -1,7 +1,12 @@ +import frameworkBaseline from './packages/framework-baseline/knip.json' with { type: 'json' }; import webPlatformTests from './packages/web-platform-tests/knip.json' with { type: 'json' }; export default { workspaces: { + 'packages/framework-baseline': { + entry: frameworkBaseline.entry, + project: frameworkBaseline.project, + }, 'packages/web-platform-tests': { entry: webPlatformTests.entry, project: webPlatformTests.project, diff --git a/packages/framework-baseline/.gitignore b/packages/framework-baseline/.gitignore new file mode 100644 index 0000000..3f0e9b0 --- /dev/null +++ b/packages/framework-baseline/.gitignore @@ -0,0 +1 @@ +.compiled/ diff --git a/packages/framework-baseline/README.md b/packages/framework-baseline/README.md new file mode 100644 index 0000000..22c9280 --- /dev/null +++ b/packages/framework-baseline/README.md @@ -0,0 +1,21 @@ +# @bomb.sh/framework-baseline + +Private tooling that records which DOM members each supported framework uses, then checks them against the [framework profiles](../web-platform-tests/src/frameworks/frameworks.ts) in `@bomb.sh/web-platform-tests`. + +Each framework renders the same [scenario](src/scenario.ts) app into happy-dom: mount, events, keyed list updates, conditionals, class/style, `innerHTML`, form bindings, SVG, focus, and unmount. The [recorder](src/recorder.ts) wraps every DOM prototype member and keeps only accesses whose direct caller is framework code; happy-dom internals and the scenario itself are ignored. Production builds are recorded, without hydration. + +```sh +pnpm --filter @bomb.sh/web-platform-tests build +pnpm --filter @bomb.sh/framework-baseline run check # all frameworks +pnpm --filter @bomb.sh/framework-baseline run check react vue # selected +pnpm --filter @bomb.sh/framework-baseline run check --json +``` + +The check fails when a framework uses a member whose feature is missing from its profile, or a member that has no feature at all. Add the feature to [`features.ts`](../web-platform-tests/src/frameworks/features.ts) with the WPT cases covering it, or an empty map when none are adapted yet. Required features the scenario never observes are reported for information only: frameworks rely on event propagation without calling `dispatchEvent`, and some paths, such as handler removal or hydration, are outside the scenario. + +CI runs the check against the pinned versions on relevant changes and against the latest releases every Monday ([workflow](../../.github/workflows/framework-baseline.yml)). + +Known recorder gaps: + +- `style.color = …` assignments bypass happy-dom's prototype accessors and are not observed. +- happy-dom does not match `:checked` on `