Files
supabase/e2e/www/utils/resolve-www-scope.ts
Miranda LimonczenkoandClaude Opus 5 6d3a4bcc48 feat(www) Add scaffolding for WWW E2E tests and CI check (#48861)
Closes DOCS-1278

## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

Feature. Adds E2E test scaffolding and a CI check for the marketing
site.

## What is the current behavior?

Closes [FE-4047](https://linear.app/supabase/issue/FE-4047).

The marketing site has no E2E coverage. Docs has a suite in `e2e/docs`,
but its
runner, git helpers and axe reporting are private to that package, so a
second
site cannot reuse them.

## What is the new behavior?

* **A www suite scoped to changed content.** Changed `.mdx` files in
`_blog`,
`_events`, `_customers` and `_alternatives` map to the URLs they render.
Pages
with `disable_page_build: true` are skipped because they 404 by design.
Capped
at 20 pages. Enforces `heading-order` and `page-has-heading-one`,
matching docs.
* **`e2e/shared` The docs site is also static with similar needs. This
folder shares the docs logic with www.
* **A CI check that is safe to mark required.** Path scoping lives in a
`Detect changed paths` step rather than a `paths:` trigger, so the check
  reports on every pull request instead of being skipped.
`waitForVercelDocsPreview.js` becomes `waitForVercelPreview.js`, shared
by both
  workflows.

## How the check behaves

The job always reports a check run, so it is safe to mark required. Path
scoping
happens in a step rather than a `paths:` trigger, which would leave
non-www pull
requests waiting on a check that never reports.

| Case | Behavior |
| --- | --- |
| Fork pull request adds new pages | Passes without testing. The Vercel
wait is gated on `head.repo.full_name == github.repository`, so forks
resolve no preview URL. The job emits a `::warning` and a job summary
containing a ready-to-run `gh workflow run www-e2e.yml` command with the
resolved page paths, so a maintainer can run it against the preview. |
| Vercel preview times out or fails | Passes without testing. The wait
step is `continue-on-error: true`, so a 900s timeout or a failed
deployment leaves the URL unset and the suite skips. Vercel's own
`Vercel – zone-www-dot-com` check already reports the failure. |
| Draft pull request | Job does not run at all, gated at the job level
on `pull_request.draft == false`. `ready_for_review` is in the trigger's
`types`, so marking it ready runs the check. |
| Another app changed, www untouched | Job runs and every step skips.
The `www` filter matches only the four content directories, `e2e/www`,
`e2e/shared`, the lockfile, and this workflow. |
| Only the harness changed | Passes without testing. Scope resolves to
zero pages, and the Vercel wait is additionally gated on `www_app`, so
it does not wait for a preview Vercel skipped. |
| No preview resolves, any reason | Skips rather than falling back to
production. Production does not serve pages the pull request adds, so
testing it would fail a valid change. |

### Not covered

Changes to `apps/www` components and routes do not trigger this check —
only the
four content directories do. A follow-up can check global components
such as the navigation and the footer.

## Manual testing

1. Start the site: `pnpm dev:www`
2. Run `pnpm e2e:www` with no www content changed. It should resolve
zero pages
   and skip Playwright, not fail.
3. Touch a post, then run `pnpm e2e:www` again:
`echo "" >> apps/www/_blog/2024-01-01-some-post.mdx`. The resolved
`/blog/...`
   path should be listed before Playwright starts.
4. Run against production with no local server:
`PLAYWRIGHT_BASE_URL=https://supabase.com
WWW_E2E_PAGE_PATHS=/blog/postgres-language-server pnpm e2e:www`
5. Point step 4 at a page with a known heading problem. The failure
should name
   the rule, the CSS selector and the markup.
6. Confirm docs still passes on the shared runner: `pnpm dev:docs`, then
   `pnpm e2e:docs`

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added WWW end-to-end testing for affected content pages, including
accessibility checks.
* Added standard and full-site test commands, configurable preview
testing, and failure reports.
* Added shared utilities for page discovery, accessibility scanning, and
test execution.

* **Documentation**
* Documented WWW test setup, coverage, debugging, CI behavior, and
running checks against production or preview environments.

* **Improvements**
* Updated documentation test workflows to better identify affected
changes and handle preview environments.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-08-11 22:06:51 +00:00

92 lines
2.9 KiB
TypeScript

import { readdir, readFile } from 'node:fs/promises'
import { basename, join } from 'node:path'
import { normalizeRepoPath } from '../../shared/paths.ts'
const DATE_PREFIX_LENGTH = 11
export const MAX_SCOPED_PAGES = 20
const FRONTMATTER_RE = /^---\r?\n([\s\S]*?)\r?\n---/
const DISABLE_PAGE_BUILD_RE = /^\s*disable_page_build:\s*true\s*$/m
const CONTENT_SOURCES = [
{ dir: 'apps/www/_blog', urlPrefix: '/blog/', datePrefixed: true },
{ dir: 'apps/www/_events', urlPrefix: '/events/', datePrefixed: true },
{ dir: 'apps/www/_customers', urlPrefix: '/customers/', datePrefixed: false },
{ dir: 'apps/www/_alternatives', urlPrefix: '/alternatives/', datePrefixed: false },
] as const
export type ResolveWwwScopeOptions = {
changedFiles: string[]
repoRoot: string
maxPages?: number
}
export function changedFileToPagePath(filePath: string): string | null {
const normalized = normalizeRepoPath(filePath)
if (!normalized.endsWith('.mdx')) return null
for (const { dir, urlPrefix, datePrefixed } of CONTENT_SOURCES) {
if (!normalized.startsWith(`${dir}/`)) continue
const filename = normalized.slice(dir.length + 1)
if (filename.includes('/')) return null
const name = basename(filename, '.mdx')
const slug = datePrefixed ? name.substring(DATE_PREFIX_LENGTH) : name
return slug ? `${urlPrefix}${slug}` : null
}
return null
}
async function isPageBuilt(absolutePath: string): Promise<boolean> {
let source: string
try {
source = await readFile(absolutePath, 'utf8')
} catch (error) {
// A deleted page has no route to test; anything else is a real failure.
if ((error as NodeJS.ErrnoException).code === 'ENOENT') return false
throw error
}
const frontmatter = FRONTMATTER_RE.exec(source)?.[1]
return !frontmatter || !DISABLE_PAGE_BUILD_RE.test(frontmatter)
}
export async function resolveWwwScope(options: ResolveWwwScopeOptions) {
const pages = new Set<string>()
for (const file of options.changedFiles) {
const page = changedFileToPagePath(file)
if (page && (await isPageBuilt(join(options.repoRoot, file)))) {
pages.add(page)
}
}
const sorted = [...pages].sort().slice(0, options.maxPages ?? MAX_SCOPED_PAGES)
return { pages: sorted, skip: sorted.length === 0 }
}
export async function resolveAllWwwPages(repoRoot: string): Promise<string[]> {
const pages = new Set<string>()
for (const { dir, urlPrefix, datePrefixed } of CONTENT_SOURCES) {
const absoluteDir = join(repoRoot, dir)
const entries = await readdir(absoluteDir, { withFileTypes: true }).catch(() => [])
for (const entry of entries) {
if (!entry.isFile() || !entry.name.endsWith('.mdx')) continue
if (!(await isPageBuilt(join(absoluteDir, entry.name)))) continue
const name = basename(entry.name, '.mdx')
const slug = datePrefixed ? name.substring(DATE_PREFIX_LENGTH) : name
if (slug) pages.add(`${urlPrefix}${slug}`)
}
}
return [...pages].sort()
}