diff --git a/packages/docs/src/components/InReview.astro b/packages/docs/src/components/InReview.astro new file mode 100644 index 00000000..da9a0f18 --- /dev/null +++ b/packages/docs/src/components/InReview.astro @@ -0,0 +1,13 @@ +--- +import type { MeasurementName } from '@framework-performance/results/measurements-config' +import { isMeasurementShown } from '../lib/measurement-status' + +interface Props { + /** Hidden on production if any of these tests is in review */ + test: MeasurementName | MeasurementName[] +} + +const tests = [Astro.props.test].flat() +--- + +{tests.every(isMeasurementShown) && } diff --git a/packages/docs/src/content/docs/dev-time.mdx b/packages/docs/src/content/docs/dev-time.mdx index c9c35341..30b8eafc 100644 --- a/packages/docs/src/content/docs/dev-time.mdx +++ b/packages/docs/src/content/docs/dev-time.mdx @@ -3,6 +3,7 @@ title: Dev Time Stats description: Framework project footprint and build cost metrics. --- +import InReview from '../../components/InReview.astro' import { Content as DevTimeSetup } from '../../benchmarks/shared/DevTimeSetup.mdx' import { Content as DependencyCountsDescription } from '../../benchmarks/dependency-counts/Description.mdx' import FrameworkDependencyResults from '../../benchmarks/dependency-counts/FrameworkResults.astro' @@ -17,6 +18,8 @@ import MinimumNodeVersionCompare from '../../benchmarks/minimum-node-version/Com + + ## Dependency Counts @@ -33,26 +36,52 @@ import MinimumNodeVersionCompare from '../../benchmarks/minimum-node-version/Com + + + + ## Node Modules Size + + + + ## Build and Install Times + + + + ## Dev Server Startup + + + + ## Core-JS Polyfills + + + + ## Browser Baseline + + + + ## Minimum Node Version + + diff --git a/packages/docs/src/content/docs/framework/astro.mdx b/packages/docs/src/content/docs/framework/astro.mdx index 4e19c1c3..f3cb1de7 100644 --- a/packages/docs/src/content/docs/framework/astro.mdx +++ b/packages/docs/src/content/docs/framework/astro.mdx @@ -3,6 +3,7 @@ title: Astro description: Astro version comparison page. --- +import InReview from '../../../components/InReview.astro' import { Content as DevTimeSetup } from '../../../benchmarks/shared/DevTimeSetup.mdx' import { Content as RunTimeSetup } from '../../../benchmarks/shared/RunTimeSetup.mdx' import DependencyCountsDetails from '../../../benchmarks/dependency-counts/Details.astro' @@ -29,50 +30,94 @@ export const astroRuntimeVersions = getRuntimeVersionStats('app-astro') + + ### Dependency Counts + + + + ### Node Modules Size + + + + ### Build and Install Times + + + + ### Dev Server Startup + + + + ### Core-JS Polyfills + + + + ### Browser Baseline + + ## Run Time + + ### Initial Load + + + + ### Client Side Rendered Tests (Lighthouse) + + + + ### Server Side Rendered Tests (Lighthouse) + + + + ### Server Side Throughput Tests + + + + ### SSR Load Test + + diff --git a/packages/docs/src/content/docs/framework/next-js.mdx b/packages/docs/src/content/docs/framework/next-js.mdx index fbab21d6..f5217577 100644 --- a/packages/docs/src/content/docs/framework/next-js.mdx +++ b/packages/docs/src/content/docs/framework/next-js.mdx @@ -3,6 +3,7 @@ title: Next.js description: Next.js version comparison page. --- +import InReview from '../../../components/InReview.astro' import { Content as DevTimeSetup } from '../../../benchmarks/shared/DevTimeSetup.mdx' import { Content as RunTimeSetup } from '../../../benchmarks/shared/RunTimeSetup.mdx' import DependencyCountsDetails from '../../../benchmarks/dependency-counts/Details.astro' @@ -30,50 +31,92 @@ export const nextJsRuntimeVersions = getRuntimeVersionStats('app-next-js') + + ### Dependency Counts + + + + ### Node Modules Size + + + + ### Build and Install Times + + + + ### Dev Server Startup + + + + ### Core-JS Polyfills + + + + ### Browser Baseline + + ## Run Time + + ### Initial Load + + + + ### Client Side Rendered Tests (Lighthouse) + + + + ### Server Side Rendered Tests (Lighthouse) + + + + ### Server Side Throughput Tests + + + + ### SSR Load Test @@ -83,6 +126,10 @@ measurements are unavailable; new CI runs will populate this series. + + + + ### SSR Router Link Load Test @@ -91,3 +138,5 @@ Framework router links at `/server-side-rendered`. Historical HTTP load results are preserved in this series. + + diff --git a/packages/docs/src/content/docs/framework/nuxt.mdx b/packages/docs/src/content/docs/framework/nuxt.mdx index dd2380be..3966c708 100644 --- a/packages/docs/src/content/docs/framework/nuxt.mdx +++ b/packages/docs/src/content/docs/framework/nuxt.mdx @@ -3,6 +3,7 @@ title: Nuxt description: Nuxt version comparison page. --- +import InReview from '../../../components/InReview.astro' import { Content as DevTimeSetup } from '../../../benchmarks/shared/DevTimeSetup.mdx' import { Content as RunTimeSetup } from '../../../benchmarks/shared/RunTimeSetup.mdx' import DependencyCountsDetails from '../../../benchmarks/dependency-counts/Details.astro' @@ -30,50 +31,92 @@ export const nuxtRuntimeVersions = getRuntimeVersionStats('app-nuxt') + + ### Dependency Counts + + + + ### Node Modules Size + + + + ### Build and Install Times + + + + ### Dev Server Startup + + + + ### Core-JS Polyfills + + + + ### Browser Baseline + + ## Run Time + + ### Initial Load + + + + ### Client Side Rendered Tests (Lighthouse) + + + + ### Server Side Rendered Tests (Lighthouse) + + + + ### Server Side Throughput Tests + + + + ### SSR Load Test @@ -83,6 +126,10 @@ measurements are unavailable; new CI runs will populate this series. + + + + ### SSR Router Link Load Test @@ -91,3 +138,5 @@ Framework router links at `/server-side-rendered`. Historical HTTP load results are preserved in this series. + + diff --git a/packages/docs/src/content/docs/framework/pracht.mdx b/packages/docs/src/content/docs/framework/pracht.mdx index 6c7b5256..0c49dac3 100644 --- a/packages/docs/src/content/docs/framework/pracht.mdx +++ b/packages/docs/src/content/docs/framework/pracht.mdx @@ -3,6 +3,7 @@ title: Pracht description: Pracht version comparison page. --- +import InReview from '../../../components/InReview.astro' import { Content as DevTimeSetup } from '../../../benchmarks/shared/DevTimeSetup.mdx' import { Content as RunTimeSetup } from '../../../benchmarks/shared/RunTimeSetup.mdx' import DependencyCountsDetails from '../../../benchmarks/dependency-counts/Details.astro' @@ -37,50 +38,92 @@ prachtStarterVersions.length === 0 && prachtRuntimeVersions.length === 0 ? ( + + ### Dependency Counts + + + + ### Node Modules Size + + + + ### Build and Install Times + + + + ### Dev Server Startup + + + + ### Core-JS Polyfills + + + + ### Browser Baseline + + ## Run Time + + ### Initial Load + + + + ### Client Side Rendered Tests (Lighthouse) + + + + ### Server Side Rendered Tests (Lighthouse) + + + + ### Server Side Throughput Tests + + + + ### SSR Load Test @@ -89,6 +132,10 @@ Ordinary anchors at `/server-side-rendered-plain-links`. + + + + ### SSR Router Link Load Test @@ -96,3 +143,5 @@ Ordinary anchors at `/server-side-rendered-plain-links`. Pracht router links at `/server-side-rendered`. + + diff --git a/packages/docs/src/content/docs/framework/react-router.mdx b/packages/docs/src/content/docs/framework/react-router.mdx index 2e8f009f..fed831f0 100644 --- a/packages/docs/src/content/docs/framework/react-router.mdx +++ b/packages/docs/src/content/docs/framework/react-router.mdx @@ -3,6 +3,7 @@ title: React Router description: React Router version comparison page. --- +import InReview from '../../../components/InReview.astro' import { Content as DevTimeSetup } from '../../../benchmarks/shared/DevTimeSetup.mdx' import { Content as RunTimeSetup } from '../../../benchmarks/shared/RunTimeSetup.mdx' import DependencyCountsDetails from '../../../benchmarks/dependency-counts/Details.astro' @@ -33,54 +34,102 @@ export const reactRouterRuntimeVersions = + + ### Dependency Counts + + + + ### Node Modules Size + + + + ### Build and Install Times + + + + ### Dev Server Startup + + + + ### Core-JS Polyfills + + + + ### Browser Baseline + + ## Run Time + + ### Initial Load + + + + ### Client Side Rendered Tests (Lighthouse) + + + + ### Server Side Rendered Tests (Lighthouse) + + + + ### Server Side Throughput Tests + + + + ### SSR Load Test + + + + ### SSR Router Link Load Test + + diff --git a/packages/docs/src/content/docs/framework/solid-start.mdx b/packages/docs/src/content/docs/framework/solid-start.mdx index 4cd95d66..93901971 100644 --- a/packages/docs/src/content/docs/framework/solid-start.mdx +++ b/packages/docs/src/content/docs/framework/solid-start.mdx @@ -3,6 +3,7 @@ title: SolidStart description: SolidStart version comparison page. --- +import InReview from '../../../components/InReview.astro' import { Content as DevTimeSetup } from '../../../benchmarks/shared/DevTimeSetup.mdx' import { Content as RunTimeSetup } from '../../../benchmarks/shared/RunTimeSetup.mdx' import DependencyCountsDetails from '../../../benchmarks/dependency-counts/Details.astro' @@ -32,50 +33,94 @@ export const solidStartRuntimeVersions = + + ### Dependency Counts + + + + ### Node Modules Size + + + + ### Build and Install Times + + + + ### Dev Server Startup + + + + ### Core-JS Polyfills + + + + ### Browser Baseline + + ## Run Time + + ### Initial Load + + + + ### Client Side Rendered Tests (Lighthouse) + + + + ### Server Side Rendered Tests (Lighthouse) + + + + ### Server Side Throughput Tests + + + + ### SSR Load Test + + diff --git a/packages/docs/src/content/docs/framework/solid.mdx b/packages/docs/src/content/docs/framework/solid.mdx index 28ae7f6a..898d5768 100644 --- a/packages/docs/src/content/docs/framework/solid.mdx +++ b/packages/docs/src/content/docs/framework/solid.mdx @@ -3,6 +3,7 @@ title: Solid 2.0 description: Solid 2.0 version comparison page. --- +import InReview from '../../../components/InReview.astro' import { Content as DevTimeSetup } from '../../../benchmarks/shared/DevTimeSetup.mdx' import { Content as RunTimeSetup } from '../../../benchmarks/shared/RunTimeSetup.mdx' import DependencyCountsDetails from '../../../benchmarks/dependency-counts/Details.astro' @@ -29,50 +30,94 @@ export const solidRuntimeVersions = getRuntimeVersionStats('app-solid') + + ### Dependency Counts + + + + ### Node Modules Size + + + + ### Build and Install Times + + + + ### Dev Server Startup + + + + ### Core-JS Polyfills + + + + ### Browser Baseline + + ## Run Time + + ### Initial Load + + + + ### Client Side Rendered Tests (Lighthouse) + + + + ### Server Side Rendered Tests (Lighthouse) + + + + ### Server Side Throughput Tests + + + + ### SSR Load Test + + diff --git a/packages/docs/src/content/docs/framework/sveltekit.mdx b/packages/docs/src/content/docs/framework/sveltekit.mdx index cb23b32d..cf16f1e3 100644 --- a/packages/docs/src/content/docs/framework/sveltekit.mdx +++ b/packages/docs/src/content/docs/framework/sveltekit.mdx @@ -3,6 +3,7 @@ title: SvelteKit description: SvelteKit version comparison page. --- +import InReview from '../../../components/InReview.astro' import { Content as DevTimeSetup } from '../../../benchmarks/shared/DevTimeSetup.mdx' import { Content as RunTimeSetup } from '../../../benchmarks/shared/RunTimeSetup.mdx' import DependencyCountsDetails from '../../../benchmarks/dependency-counts/Details.astro' @@ -30,50 +31,94 @@ export const sveltekitRuntimeVersions = getRuntimeVersionStats('app-sveltekit') + + ### Dependency Counts + + + + ### Node Modules Size + + + + ### Build and Install Times + + + + ### Dev Server Startup + + + + ### Core-JS Polyfills + + + + ### Browser Baseline + + ## Run Time + + ### Initial Load + + + + ### Client Side Rendered Tests (Lighthouse) + + + + ### Server Side Rendered Tests (Lighthouse) + + + + ### Server Side Throughput Tests + + + + ### SSR Load Test + + diff --git a/packages/docs/src/content/docs/framework/tanstack-start-react.mdx b/packages/docs/src/content/docs/framework/tanstack-start-react.mdx index 1a5c1f1e..7c3c30fa 100644 --- a/packages/docs/src/content/docs/framework/tanstack-start-react.mdx +++ b/packages/docs/src/content/docs/framework/tanstack-start-react.mdx @@ -3,6 +3,7 @@ title: TanStack Start description: TanStack Start version comparison page. --- +import InReview from '../../../components/InReview.astro' import { Content as DevTimeSetup } from '../../../benchmarks/shared/DevTimeSetup.mdx' import { Content as RunTimeSetup } from '../../../benchmarks/shared/RunTimeSetup.mdx' import DependencyCountsDetails from '../../../benchmarks/dependency-counts/Details.astro' @@ -34,50 +35,92 @@ export const tanstackStartRuntimeVersions = getRuntimeVersionStats( + + ### Dependency Counts + + + + ### Node Modules Size + + + + ### Build and Install Times + + + + ### Dev Server Startup + + + + ### Core-JS Polyfills + + + + ### Browser Baseline + + ## Run Time + + ### Initial Load + + + + ### Client Side Rendered Tests (Lighthouse) + + + + ### Server Side Rendered Tests (Lighthouse) + + + + ### Server Side Throughput Tests + + + + ### SSR Load Test @@ -87,6 +130,10 @@ measurements are unavailable; new CI runs will populate this series. + + + + ### SSR Router Link Load Test @@ -95,3 +142,5 @@ Framework router links at `/server-side-rendered`. Historical HTTP load results are preserved in this series. + + diff --git a/packages/docs/src/content/docs/framework/void.mdx b/packages/docs/src/content/docs/framework/void.mdx index b973f689..2fb3c7d2 100644 --- a/packages/docs/src/content/docs/framework/void.mdx +++ b/packages/docs/src/content/docs/framework/void.mdx @@ -3,6 +3,7 @@ title: Void description: Void version comparison page. --- +import InReview from '../../../components/InReview.astro' import { Content as DevTimeSetup } from '../../../benchmarks/shared/DevTimeSetup.mdx' import { Content as RunTimeSetup } from '../../../benchmarks/shared/RunTimeSetup.mdx' import DependencyCountsDetails from '../../../benchmarks/dependency-counts/Details.astro' @@ -30,54 +31,102 @@ export const voidRuntimeVersions = getRuntimeVersionStats('app-void') + + ### Dependency Counts + + + + ### Node Modules Size + + + + ### Build and Install Times + + + + ### Dev Server Startup + + + + ### Core-JS Polyfills + + + + ### Browser Baseline + + ## Run Time + + ### Initial Load + + + + ### Client Side Rendered Tests (Lighthouse) + + + + ### Server Side Rendered Tests (Lighthouse) + + + + ### Server Side Throughput Tests + + + + ### SSR Load Test + + + + ### SSR Router Link Load Test + + diff --git a/packages/docs/src/content/docs/run-time.mdx b/packages/docs/src/content/docs/run-time.mdx index 81a57488..07c99824 100644 --- a/packages/docs/src/content/docs/run-time.mdx +++ b/packages/docs/src/content/docs/run-time.mdx @@ -3,6 +3,7 @@ title: Run Time Stats description: Framework browser and server runtime metrics. --- +import InReview from '../../components/InReview.astro' import { Content as RunTimeSetup } from '../../benchmarks/shared/RunTimeSetup.mdx' import LighthouseClientSideRenderedCompare from '../../benchmarks/lighthouse-client-side-rendered-tests/Compare.astro' import LighthouseServerSideRenderedCompare from '../../benchmarks/lighthouse-server-side-rendered-tests/Compare.astro' @@ -16,22 +17,40 @@ import { Content as SSRRouterLinkLoadDescription } from '../../benchmarks/ssr-ro + + ## Client Side Rendered Tests (Lighthouse) + + + + ## Server Side Rendered Tests (Lighthouse) + + + + ## Initial Load + + + + ## Server Side Throughput Tests + + + + ## SSR Load Test @@ -48,6 +67,10 @@ import { Content as SSRRouterLinkLoadDescription } from '../../benchmarks/ssr-ro + + + + ## SSR Router Link Load Test @@ -63,3 +86,5 @@ import { Content as SSRRouterLinkLoadDescription } from '../../benchmarks/ssr-ro ### P75 Latency + + diff --git a/packages/docs/src/lib/measurement-status.ts b/packages/docs/src/lib/measurement-status.ts new file mode 100644 index 00000000..ec73cc24 --- /dev/null +++ b/packages/docs/src/lib/measurement-status.ts @@ -0,0 +1,12 @@ +import { + measurementsConfig, + type MeasurementName, +} from '@framework-performance/results/measurements-config' + +// Cloudflare Workers Builds deploys the production site from main +const isProductionBuild = process.env.WORKERS_CI_BRANCH === 'main' + +/** In-review tests show in local builds and deploy previews, not production */ +export function isMeasurementShown(name: MeasurementName) { + return !isProductionBuild || measurementsConfig[name].status === 'live' +} diff --git a/packages/results/src/measurements-config.ts b/packages/results/src/measurements-config.ts index 3743c471..331a98fc 100644 --- a/packages/results/src/measurements-config.ts +++ b/packages/results/src/measurements-config.ts @@ -10,15 +10,19 @@ const ssrLoad = { const interactionScenarioLabel = 'first-row-detail-navigation' +/** `in-review` tests only show in local builds and deploy previews, not the production site. */ +export type MeasurementStatus = 'live' | 'in-review' + /** Shared defaults for every framework. Scans run once; benchmarks repeat. */ export const measurementsConfig = { - install: { runs: 5 }, - build: { runs: 5 }, - devServer: { runs: 5 }, - dependencies: null, - browserBaseline: null, - nodeEngines: null, + install: { status: 'live', runs: 5 }, + build: { status: 'live', runs: 5 }, + devServer: { status: 'live', runs: 5 }, + dependencies: { status: 'live' }, + browserBaseline: { status: 'live' }, + nodeEngines: { status: 'live' }, ssrRequestThroughput: { + status: 'live', runs: 5, durationMs: 10_000, warmupDurationMs: 250, @@ -27,23 +31,30 @@ export const measurementsConfig = { path: '/ssr-throughput', }, ssrLoad: { + status: 'live', ...ssrLoad, plainLinksPath: '/server-side-rendered-plain-links', }, - ssrRouterLinkLoad: { ...ssrLoad }, + ssrRouterLinkLoad: { status: 'live', ...ssrLoad }, clientSideRendered: { + status: 'live', runs: 5, scenario: interactionScenarioLabel, path: '/client-side-rendered', }, serverSideRendered: { + status: 'live', runs: 5, scenario: interactionScenarioLabel, path: '/server-side-rendered', }, initialLoad: { + status: 'live', path: '/initial-load', }, -} as const +} as const satisfies Record< + string, + { status: MeasurementStatus; [setting: string]: unknown } +> export type MeasurementName = keyof typeof measurementsConfig