diff --git a/contributor-docs/testing.md b/contributor-docs/testing.md index 785597d097f..01e22833454 100644 --- a/contributor-docs/testing.md +++ b/contributor-docs/testing.md @@ -11,6 +11,7 @@ - [Browser locator pilot](#browser-locator-pilot) - [Snapshots](#snapshots) - [Running Tests](#running-tests) + - [React Server Component Tests](#react-server-component-tests) - [Interaction Tests](#interaction-tests) - [As A Part Of Unit Tests](#as-a-part-of-unit-tests) - [Visual Regression Tests](#visual-regression-tests) @@ -124,6 +125,10 @@ We are slowly moving away from using snapshots as a way to test visual changes o By default, Vitest fails when tests emit unexpected console output in CI. For local debugging, it is disabled unless you opt in with `VITEST_FAIL_ON_CONSOLE=true`. +### React Server Component Tests + +Tests named `*.rsc.test.tsx` render components inside a React Server Component boundary using [`vitest-plugin-rsc`](https://github.com/storybookjs/vitest-plugin-rsc). They run in their own `@primer/react (rsc)` Vitest project (`packages/react/vitest.config.rsc.mts`) because the plugin needs browser mode, and they are excluded from the main browser project. Server Components require React 19, so the project has no tests when React 18 is installed and runs in the React 19 CI job. + ## Interaction Tests ### As A Part Of Unit Tests diff --git a/package-lock.json b/package-lock.json index c8cdfb482b0..bca54bd62ee 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5371,7 +5371,9 @@ } }, "node_modules/@jridgewell/gen-mapping": { - "version": "0.3.12", + "version": "0.3.13", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz", + "integrity": "sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA==", "dev": true, "license": "MIT", "dependencies": { @@ -11123,6 +11125,66 @@ } } }, + "node_modules/@vitejs/plugin-rsc": { + "version": "0.5.36", + "resolved": "https://registry.npmjs.org/@vitejs/plugin-rsc/-/plugin-rsc-0.5.36.tgz", + "integrity": "sha512-xi/x4vBzv14+QiGid6h0iTrs30j596BZcNGwspfiEfuIpGet6Arwjvj6rwoVAlOK42APVSqj1YH6/oP5T/P+qQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@rolldown/pluginutils": "^1.0.1", + "es-module-lexer": "^3.0.3", + "estree-walker": "^3.0.3", + "magic-string": "^1.4.3", + "obug": "^3.0.0", + "srvx": "^1.0.5", + "strip-literal": "^4.0.0", + "turbo-stream": "^3.2.1", + "vitefu": "^1.1.3" + }, + "peerDependencies": { + "react": "*", + "react-dom": "*", + "react-server-dom-webpack": "*", + "vite": "*" + }, + "peerDependenciesMeta": { + "react-server-dom-webpack": { + "optional": true + } + } + }, + "node_modules/@vitejs/plugin-rsc/node_modules/es-module-lexer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-3.0.4.tgz", + "integrity": "sha512-BldNY5mwkVu+cQ5Ymn3e6hB9Sx8XHx4ZevWbiUyZbfKxJxYO27Hf0wfzkxIaD5CAJMaGl3YspKELj0ff/7nCMA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@vitejs/plugin-rsc/node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + } + }, + "node_modules/@vitejs/plugin-rsc/node_modules/obug": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/obug/-/obug-3.0.0.tgz", + "integrity": "sha512-5vvB5+W7ePv+p3uqxi+RcW1XAzLW0/hxt3/4X4Lc4qHudzOhmBiBwOY6DRob4WnanAEGvNcLjF+KNOufrUoEQw==", + "dev": true, + "funding": [ + "https://github.com/sponsors/sxzz", + "https://opencollective.com/debug" + ], + "license": "MIT", + "engines": { + "node": ">=12.20.0" + } + }, "node_modules/@vitest/browser": { "version": "5.0.5", "integrity": "sha512-IDMoZX/iZ8rkilw7weaSgN8tJ7iZ9hUv0wYoKXyiyjWjWFwLSWAY707DcVTgxTYOudWC1E3HA9LYn7kVa9a7uQ==", @@ -12989,6 +13051,13 @@ "node": ">=8" } }, + "node_modules/cjs-module-lexer": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/cjs-module-lexer/-/cjs-module-lexer-2.3.0.tgz", + "integrity": "sha512-lmNyBzi6iYiqyrExTctfmjd8tInx+dHu9PBomTfH5RXS53c27JMFJgzNv5TyAnm3PgGf+MLy0+Ws41/HlVxdKQ==", + "dev": true, + "license": "MIT" + }, "node_modules/class-variance-authority": { "version": "0.7.1", "integrity": "sha512-Ka+9Trutv7G8M6WT6SeiRWz792K5qEqIGEGzXKhAE6xOWAY6pPH8U+9IY3oCMv6kqTmLsv7Xh/2w2RigkePMsg==", @@ -27237,6 +27306,19 @@ "dev": true, "license": "MIT" }, + "node_modules/srvx": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/srvx/-/srvx-1.0.8.tgz", + "integrity": "sha512-ngFS/J6St4PJfHRHGjr78xkPPtbyXtdMOLNE4x/XZunEK3OhV7aGUWMHf9WTUEy6wm1U0W4okkd82ZFFWRVQTw==", + "dev": true, + "license": "MIT", + "bin": { + "srvx": "bin/srvx.mjs" + }, + "engines": { + "node": ">=20.16.0" + } + }, "node_modules/stable-hash": { "version": "0.0.4", "dev": true, @@ -27546,6 +27628,26 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/strip-literal": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/strip-literal/-/strip-literal-4.0.0.tgz", + "integrity": "sha512-PaqAvfUZKBwc/SLmNZtHmzK+v19Z4O4eS3cKPeGvbIv/U3pnyEq4Tuw3/4v/FwfM8VQaEawsyCcOQ0P+kpwWWw==", + "dev": true, + "license": "MIT", + "dependencies": { + "js-tokens": "^10.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/antfu" + } + }, + "node_modules/strip-literal/node_modules/js-tokens": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-10.0.0.tgz", + "integrity": "sha512-lM/UBzQmfJRo9ABXbPWemivdCW8V2G8FHaHdypQaIy523snUjog0W71ayWXTjiR+ixeMyVHN2XcpnTd/liPg/Q==", + "dev": true, + "license": "MIT" + }, "node_modules/structured-source": { "version": "4.0.0", "integrity": "sha512-qGzRFNJDjFieQkl/sVOI2dUjHKRyL9dAJi2gCPGJLbJHBIkyOHxjuocpIEfbLioX+qSJpvbYdT49/YCdMznKxA==", @@ -28992,6 +29094,13 @@ "@turbo/windows-arm64": "2.9.18" } }, + "node_modules/turbo-stream": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/turbo-stream/-/turbo-stream-3.2.1.tgz", + "integrity": "sha512-BaX0eWz3IrypOVDFqPv3VGD6uZZW8y3oFAOJqZQ+oopmOyQ8/xNm7IMwAJFvxax2DBa8zSk+/AeqA6D6b1PXGg==", + "dev": true, + "license": "MIT" + }, "node_modules/turndown": { "version": "7.2.0", "license": "MIT", @@ -30295,6 +30404,26 @@ "url": "https://github.com/sponsors/jonschlinkert" } }, + "node_modules/vitefu": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/vitefu/-/vitefu-1.1.3.tgz", + "integrity": "sha512-ub4okH7Z5KLjb6hDyjqrGXqWtWvoYdU3IGm/NorpgHncKoLTCfRIbvlhBm7r0YstIaQRYlp4yEbFqDcKSzXSSg==", + "dev": true, + "license": "MIT", + "workspaces": [ + "tests/deps/*", + "tests/projects/*", + "tests/projects/workspace/packages/*" + ], + "peerDependencies": { + "vite": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0" + }, + "peerDependenciesMeta": { + "vite": { + "optional": true + } + } + }, "node_modules/vitest": { "version": "5.0.5", "integrity": "sha512-cPODOMF8YnkiiYtDdHo6n4wWmBrOBBbOIYH2d33M4l3CdNn72h+qMmO6uXffUN6A5AZFXNND/d+krS9mgkXRfg==", @@ -30390,6 +30519,35 @@ "vitest": ">=0.26.2" } }, + "node_modules/vitest-plugin-rsc": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/vitest-plugin-rsc/-/vitest-plugin-rsc-0.3.0.tgz", + "integrity": "sha512-hUTCrVb8tVOh+eleUps2maXRfRTPkHFIYZUenN0YLFvEom5vCcAdPqCilPZNJH66n4edCpxFyvQGwUEGSkiaqQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.13", + "@vitejs/plugin-rsc": "0.5.36", + "cjs-module-lexer": "^2.3.0", + "convert-source-map": "^2.0.0" + }, + "peerDependencies": { + "@next/routing": ">=16.4.0-0", + "next": ">=16.4.0-0", + "react": "*", + "react-dom": "*", + "vite": ">=8.0.0", + "vitest": ">=5.0.3" + }, + "peerDependenciesMeta": { + "@next/routing": { + "optional": true + }, + "next": { + "optional": true + } + } + }, "node_modules/vitest/node_modules/chai": { "version": "6.3.0", "integrity": "sha512-XWAtwJ6OHO+tj0EKCs0Y2UamnyOxseZWltU4x2U2wh8g4AigdjwvtUjvLP2tqkA/avxHEtzxNaqGq/YGNwckKg==", @@ -31275,6 +31433,7 @@ "unist-util-find": "3.0.0", "unist-util-find-before": "4.0.0", "unist-util-flat-filter": "2.0.0", + "vitest-plugin-rsc": "^0.3.0", "yaml": "2.7.0" }, "engines": { @@ -32117,7 +32276,7 @@ "@types/react-dom": "18.3.1", "@types/styled-components": "^5.1.26", "@vitejs/plugin-react": "^6.1.1", - "babel-plugin-styled-components": "^2.4.0", + "babel-plugin-styled-components": "2.4.0", "oxc-transform-react": "^0.157.0", "postcss-preset-primer": "^0.0.0", "publint": "^0.3.15", diff --git a/packages/react/config/vitest/rsc/setup.ts b/packages/react/config/vitest/rsc/setup.ts new file mode 100644 index 00000000000..dcbb270142f --- /dev/null +++ b/packages/react/config/vitest/rsc/setup.ts @@ -0,0 +1,10 @@ +import {beforeAll, beforeEach} from 'vitest' +import {cleanup, initialize} from 'vitest-plugin-rsc/testing-library' + +beforeAll(() => { + initialize() +}) + +beforeEach(async () => { + await cleanup() +}) diff --git a/packages/react/package.json b/packages/react/package.json index 5f94d88229f..0433f878952 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -178,6 +178,7 @@ "unist-util-find": "3.0.0", "unist-util-find-before": "4.0.0", "unist-util-flat-filter": "2.0.0", + "vitest-plugin-rsc": "^0.3.0", "yaml": "2.7.0" }, "peerDependencies": { diff --git a/packages/react/src/__tests__/components.rsc.test.tsx b/packages/react/src/__tests__/components.rsc.test.tsx new file mode 100644 index 00000000000..dce1b47fa10 --- /dev/null +++ b/packages/react/src/__tests__/components.rsc.test.tsx @@ -0,0 +1,34 @@ +import {describe, expect, test} from 'vitest' +import {page} from 'vitest/browser' +import {renderServer} from 'vitest-plugin-rsc/testing-library' +import {Heading, Text} from '../index' +import {Counter} from './rsc-fixtures/Counter' + +// `src/index.ts` is the `'use client'` boundary, so everything imported from it is a client +// reference when it is rendered by a Server Component. +function Greeting({name}: {name: string}) { + return ( +
+ Hello, {name} + Rendered on the server +
+ ) +} + +describe('React Server Components', () => { + test('renders components inside a Server Component', async () => { + await renderServer() + + await expect.element(page.getByRole('heading', {name: 'Hello, Primer'})).toBeVisible() + await expect.element(page.getByText('Rendered on the server')).toBeVisible() + }) + + test('runs client state and handlers for a client component rendered by a Server Component', async () => { + await renderServer() + + const button = page.getByRole('button', {name: 'Count: 1'}) + await expect.element(button).toBeVisible() + await button.click() + await expect.element(page.getByRole('button', {name: 'Count: 2'})).toBeVisible() + }) +}) diff --git a/packages/react/src/__tests__/rsc-fixtures/Counter.tsx b/packages/react/src/__tests__/rsc-fixtures/Counter.tsx new file mode 100644 index 00000000000..566f4a5296d --- /dev/null +++ b/packages/react/src/__tests__/rsc-fixtures/Counter.tsx @@ -0,0 +1,9 @@ +'use client' + +import {useState} from 'react' +import {Button} from '../../index' + +export function Counter({initialCount}: {initialCount: number}) { + const [count, setCount] = useState(initialCount) + return +} diff --git a/packages/react/tsconfig.json b/packages/react/tsconfig.json index 89c7004f3e5..8dcff247d84 100644 --- a/packages/react/tsconfig.json +++ b/packages/react/tsconfig.json @@ -13,6 +13,7 @@ "script/**/*.ts", "rolldown.config.ts", "vitest.config.mts", + "vitest.config.rsc.mts", "config/**/*.ts", ".storybook/**/*.ts", ".storybook/**/*.tsx" diff --git a/packages/react/vitest.config.browser.mts b/packages/react/vitest.config.browser.mts index 8521b32f5d9..c240950d8d6 100644 --- a/packages/react/vitest.config.browser.mts +++ b/packages/react/vitest.config.browser.mts @@ -37,6 +37,7 @@ export default defineConfig({ '**/*.figma.tsx', '**/*.types.test.ts', '**/*.types.test.tsx', + '**/*.rsc.test.tsx', 'src/__tests__/exports.test.ts', 'src/__tests__/ssr.test.tsx', 'src/__tests__/storybook.test.tsx', diff --git a/packages/react/vitest.config.rsc.mts b/packages/react/vitest.config.rsc.mts new file mode 100644 index 00000000000..8370b6f7cd9 --- /dev/null +++ b/packages/react/vitest.config.rsc.mts @@ -0,0 +1,34 @@ +import {createRequire} from 'node:module' +import {defineConfig} from '@primer/vitest-config/config' + +import react from '@vitejs/plugin-react' +import {playwright} from '@vitest/browser-playwright' +import {vitestPluginRSC} from 'vitest-plugin-rsc' + +const require = createRequire(import.meta.url) +// React Server Components need React 19, so the project has no tests on React 18 (the default). +const supportsRSC = Number.parseInt(require('react/package.json').version, 10) >= 19 + +// vitest-plugin-rsc runs the server (RSC) and client environments inside the test's browser tab, +// so it needs browser mode. It lives in its own project to keep it out of the main browser suite. +export default defineConfig({ + plugins: [react(), vitestPluginRSC()], + resolve: { + dedupe: ['react', 'react-dom'], + }, + define: { + __DEV__: true, + }, + test: { + name: '@primer/react (rsc)', + include: supportsRSC ? ['src/**/*.rsc.test.?(c|m)[jt]s?(x)'] : [], + setupFiles: ['config/vitest/rsc/setup.ts'], + browser: { + provider: playwright(), + enabled: true, + headless: true, + instances: [{browser: 'chromium'}], + screenshotFailures: false, + }, + }, +}) diff --git a/script/check-classname-tests.mjs b/script/check-classname-tests.mjs index a271626203f..46973f48d8d 100755 --- a/script/check-classname-tests.mjs +++ b/script/check-classname-tests.mjs @@ -27,6 +27,8 @@ const IGNORED_FILES = [ 'packages/react/src/__tests__/Caret.test.tsx', // Asserts server rendering behavior, not rendered markup 'packages/react/src/__tests__/ssr.test.tsx', + // Asserts rendering inside a Server Component boundary, not a component's className prop + 'packages/react/src/__tests__/components.rsc.test.tsx', 'packages/react/src/FilteredActionList/useAnnouncements.test.tsx', 'packages/react/src/TreeView/useRovingTabIndex.test.tsx', ] diff --git a/vitest.config.mts b/vitest.config.mts index 56ca8d03eb7..53d2de181d6 100644 --- a/vitest.config.mts +++ b/vitest.config.mts @@ -7,6 +7,7 @@ export default defineConfig({ 'packages/*/vitest.config.mts', 'packages/*/vitest.config.browser.ts', 'packages/*/vitest.config.browser.mts', + 'packages/*/vitest.config.rsc.mts', ], }, })