refactor: common vitest configurations #1107

poltorak · 2025-09-05T11:15:11Z

Centralize and Standardize Vitest Configurations

What Changed

New centralized configuration system: Created testing/test-setup-config package with a factory-based approach for generating Vitest configurations
Setup presets: Introduced modular setup file presets that can be composed for different test types (unit, integration, e2e)
Simplified configuration files: Refactored 6 existing Vitest config files to use the new centralized system, reducing them from verbose configurations to simple function calls

Benefits

Eliminates duplication: Removes repetitive boilerplate across multiple vitest config files
Ensures consistency: Standardizes test configurations, coverage settings, and setup files across all packages
Improves maintainability: Changes to test configuration defaults now only need to be made in one place
Better developer experience: New configs are more readable and easier to customize with sensible defaults and preset combinations

The new system provides createUnitConfig, createIntConfig, and createE2eConfig factory functions that automatically handle common configuration patterns while still allowing customization through override parameters.

Relates to first part of #1065

nx-cloud · 2025-09-05T11:16:26Z

View your CI Pipeline Execution ↗ for commit 9433ca5

Command	Status	Duration	Result
`nx code-pushup --nx-bail -- compare`	✅ Succeeded	1m 4s	View ↗
`nx code-pushup --nx-bail --`	✅ Succeeded	1m 27s	View ↗
`nx code-pushup --nx-bail -- print-config --outp...`	✅ Succeeded	4m 23s	View ↗

☁️ Nx Cloud last updated this comment at 2025-09-09 14:17:53 UTC

pkg-pr-new · 2025-09-05T11:16:48Z

Open in StackBlitz

@code-pushup/ci

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/ci@1107

@code-pushup/cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@1107

@code-pushup/create-cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/create-cli@1107

@code-pushup/core

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/core@1107

@code-pushup/models

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/models@1107

@code-pushup/nx-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/nx-plugin@1107

@code-pushup/coverage-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/coverage-plugin@1107

@code-pushup/eslint-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/eslint-plugin@1107

@code-pushup/js-packages-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/js-packages-plugin@1107

@code-pushup/jsdocs-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/jsdocs-plugin@1107

@code-pushup/lighthouse-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/lighthouse-plugin@1107

@code-pushup/typescript-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/typescript-plugin@1107

@code-pushup/utils

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/utils@1107

@code-pushup/models-transformers

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/models-transformers@1107

commit: 9433ca5

github-actions · 2025-09-05T11:24:07Z

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit 0640602 with previous commit df16191.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Performance	🔴 37	🔴 36
Code coverage	🟡 90	🟡 90
Security	🟡 64	🟡 64	–
Updates	🟡 85	🟡 85	–
Accessibility	🟢 92	🟢 92	–
Best Practices	🟢 100	🟢 100	–
SEO	🟡 61	🟡 61	–
Type Safety	🟢 100	🟢 100	–
Bug prevention	🟢 100	🟢 100	–
Miscellaneous	🟢 100	🟢 100	–
Code style	🟢 100	🟢 100	–
Documentation	🔴 24	🔴 24	–

👎 2 groups regressed, 👍 4 audits improved, 👎 5 audits regressed, 12 audits changed without impacting score

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score	🔄 Score change
Lighthouse	Performance	🔴 37	🔴 36
Code coverage	Code coverage metrics	🟡 90	🟡 90

19 other groups are unchanged.

🛡️ Audits

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value
Lighthouse	Initial server response time was short	🟥 Root document took 650 ms	🟩 Root document took 540 ms
Lighthouse	Total Blocking Time	🟥 1,640 ms	🟥 2,400 ms
Lighthouse	First Contentful Paint	🟥 3.2 s	🟨 3.0 s
Lighthouse	Speed Index	🟥 6.2 s	🟥 6.4 s
Lighthouse	Time to Interactive	🟥 16.0 s	🟥 17.0 s
Code coverage	Line coverage	🟨 86.3 %	🟨 84.4 %
Lighthouse	Max Potential First Input Delay	🟥 800 ms	🟥 920 ms
Code coverage	Function coverage	🟩 92.3 %	🟩 92.4 %
Code coverage	Branch coverage	🟨 85.5 %	🟨 85.5 %
Lighthouse	Avoids enormous network payloads	🟨 Total size was 2,687 KiB	🟨 Total size was 2,724 KiB
Lighthouse	Minimizes main-thread work	🟥 9.6 s	🟥 11.5 s
Lighthouse	Uses efficient cache policy on static assets	🟨 30 resources found	🟨 31 resources found
Lighthouse	Metrics	🟩 100%	🟩 100%
Lighthouse	JavaScript execution time	🟥 4.2 s	🟥 4.9 s
Lighthouse	Largest Contentful Paint	🟥 11.0 s	🟥 11.2 s
Lighthouse	Server Backend Latencies	🟩 1,540 ms	🟩 1,450 ms
Lighthouse	Reduce unused JavaScript	🟥 Potential savings of 602 KiB	🟥 Potential savings of 598 KiB
Lighthouse	Avoids an excessive DOM size	🟥 2,296 elements	🟥 2,303 elements
JS Packages	Outdated NPM dev dependencies.	🟨 50 outdated package versions (21 major, 23 minor, 6 patch)	🟨 56 outdated package versions (21 major, 29 minor, 6 patch)
JS Packages	Outdated NPM prod dependencies.	🟨 14 outdated package versions (3 major, 6 minor, 5 patch)	🟨 16 outdated package versions (3 major, 8 minor, 5 patch)
Lighthouse	Network Round Trip Times	🟩 70 ms	🟩 70 ms

589 other audits are unchanged.

BioPhoton

Thanks for cleaning up our test config mess :)

I left some comments.

please add a proper PR description that contains the scope and planned changes
move the config code under a Nx project in testing/vitest-setup. I updated the issue accordingly.

BioPhoton · 2025-09-05T11:42:52Z

e2e/ci-e2e/vitest.e2e.config.ts

-    environment: 'node',
-    include: ['tests/**/*.e2e.test.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
-    globalSetup: './global-setup.ts',
-    setupFiles: ['../../testing/test-setup/src/lib/reset.mocks.ts'],


Did you forgot to keep this?

BioPhoton · 2025-09-05T11:44:56Z

packages/core/vitest.unit.config.ts

+  projectRoot: new URL('../../', import.meta.url),
+  setupFiles: [
+    'testing/test-setup/src/lib/cliui.mock.ts',
+    'testing/test-setup/src/lib/fs.mock.ts',


This can be default

BioPhoton · 2025-09-05T11:45:33Z

packages/core/vitest.unit.config.ts

+    'testing/test-setup/src/lib/portal-client.mock.ts',
+    'testing/test-setup/src/lib/extend/ui-logger.matcher.ts',
+    'testing/test-setup/src/lib/extend/markdown-table.matcher.ts',
+    'testing/test-setup/src/lib/extend/jest-extended.matcher.ts',


this could also be in defaults

BioPhoton · 2025-09-05T11:46:02Z

packages/utils/vitest.unit.config.ts

+    'testing/test-setup/src/lib/extend/path.matcher.ts',
+    'testing/test-setup/src/lib/extend/jest-extended.matcher.ts',


Those could be defaults

BioPhoton · 2025-09-05T11:46:33Z

tools/README.md

@@ -0,0 +1,154 @@
+## Vitest config factory and setup presets
+
+This folder contains utilities to centralize and standardize Vitest configuration across the monorepo.


Suggested change

This folder contains utilities to centralize and standardize Vitest configuration across the monorepo.

This project contains utilities to centralize and standardize Vitest configuration across a monorepo.

BioPhoton · 2025-09-05T11:51:00Z

tools/README.md

+- `createIntConfig(projectKey, { projectRoot, ...options })`
+- `createE2eConfig(projectKey, { projectRoot, ...options })`
+
+`projectKey` is used for cache and coverage directories.


You could give an example

BioPhoton · 2025-09-05T11:51:55Z

tools/README.md

+### Defaults
+
+Common to all kinds:
+
+- `reporters: ['basic']`, `globals: true`, `environment: 'node'`
+- `alias: tsconfigPathAliases()`
+- `pool: 'threads'` with `singleThread: true`
+- Cache directories resolved from `projectRoot` (absolute paths)
+
+Coverage:
+
+- Unit/Int: enabled by default, reports to `<projectRoot>/coverage/<project>/<kind>-tests`
+- E2E: disabled by default
+- Default exclude: `['mocks/**', '**/types.ts']`
+
+Global setup:
+
+- Unit/Int: `['<projectRoot>/global-setup.ts']` by default
+- E2E: none by default (set per-suite if needed)
+
+Include patterns:
+
+- Unit: `src/**/*.unit.test.*`
+- Int: `src/**/*.int.test.*`
+- E2E: `tests/**/*.e2e.test.*`


This information is tightly coupled to our implementation. MAybe link the perset directly here instead of repeating?

BioPhoton · 2025-09-05T11:53:34Z

tools/README.md

+### setupFiles strategy
+
+Baseline `setupFiles` are injected automatically by kind:
+
+- Unit baseline: `console.mock.ts`, `reset.mocks.ts`
+- Int baseline: `console.mock.ts`, `reset.mocks.ts`
+- E2E baseline: `reset.mocks.ts`
+
+Extend with additional files using `options.setupFiles` — they append after the baseline (paths are project-root-relative):
+
+```ts
+export default createUnitConfig('core', {
+  projectRoot: new URL('../../', import.meta.url),
+  setupFiles: ['testing/test-setup/src/lib/cliui.mock.ts'],
+});
+```


Same here, strongly coupled to implementation that can change often.

BioPhoton · 2025-09-05T11:56:12Z

tools/README.md

+
+`CreateVitestConfigOptions` (required + optional):
+
+- `projectKey` (string): coverage/cache naming.
+- `kind` ('unit' | 'int' | 'e2e'): test kind.
+- `projectRoot` (string | URL): absolute root for all paths.
+- `include?: string[]`: override default include globs.
+- `setupFiles?: string[]`: extra setup files (appended to baseline; project-root-relative).
+- `overrideSetupFiles?: boolean`: skip baseline and use only provided list.
+- `globalSetup?: string[]`: override default global setup (project-root-relative).
+- `coverage?: { enabled?, exclude?, reportsSubdir? }`
+- `testTimeout?: number`: e.g., for E2E.
+- `typecheckInclude?: string[]`: include patterns for Vitest typecheck.
+- `cacheKey?: string`: custom cache dir suffix.


The best DX is given if the user does no need to lear another type.

I would suggest try to keep the types as close as possible to existing virest types.

e.g. : createIntConfig({/*vitestTestConfig*/}, { projectKey: 'unit', /*other custom options we need that are not already inside vitest types */})

BioPhoton · 2025-09-05T11:58:45Z

tools/vitest-config-factory.ts

+export function createVitestConfig(
+  options: CreateVitestConfigOptions,
+): ViteUserConfig {


As mentioned in this comment I would use a API and more important data structure/types as lose as possible to vitest.

BioPhoton · 2025-09-05T12:10:55Z

tools/vitest-config-factory.ts

+export const createUnitConfig = (
+  projectKey: string,
+  rest: Omit<CreateVitestConfigOptions, 'projectKey' | 'kind'>,
+): ViteUserConfig => createVitestConfig({ projectKey, kind: 'unit', ...rest });
+
+export const createIntConfig = (
+  projectKey: string,
+  rest: Omit<CreateVitestConfigOptions, 'projectKey' | 'kind'>,
+): ViteUserConfig => createVitestConfig({ projectKey, kind: 'int', ...rest });
+
+export const createE2eConfig = (
+  projectKey: string,
+  rest: Omit<CreateVitestConfigOptions, 'projectKey' | 'kind'>,
+): ViteUserConfig => createVitestConfig({ projectKey, kind: 'e2e', ...rest });


I would move all non abstract logic into vitest-setup-presets.ts

BioPhoton · 2025-09-05T12:33:56Z

tools/vitest-config-factory.ts

+  include?: string[];
+  setupFiles?: string[];
+  /** If true, the factory will not inject the baseline setupFiles for the given kind. */
+  overrideSetupFiles?: boolean;


I would only apply vitest helper and the special merge logic is handled in each project.

Szymon.Poltorak added 2 commits September 5, 2025 13:13

feat(): create common vitest config setup

553fa74

refactor(): wip use common vitest on few files

b1f60e4

github-actions bot assigned poltorak Sep 5, 2025

github-actions bot added 📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests 🛠️ tooling labels Sep 5, 2025

BioPhoton requested changes Sep 5, 2025

View reviewed changes

refactor(): change coverage reports directory

5e85864

BioPhoton reviewed Sep 5, 2025

View reviewed changes

Szymon.Poltorak added 9 commits September 9, 2025 10:25

refactor(): simplify vitest factory and split abstract logic

5b9cb36

docs(): update new tools readme

1f73933

test(): add unit tests for new tools

6af1f24

refactor(): fix circular dependency by creating new internal library

52e0e6b

fix: path resolution

14ca642

fix: path resolution #2

307b179

fix: path resolution #3

d2557c0

fix: path resolution #4

3cd092b

fix: path resolution #5

9433ca5

poltorak requested review from BioPhoton, matejchalk and hanna-skryl September 10, 2025 06:44

poltorak marked this pull request as ready for review September 10, 2025 06:45

		'testing/test-setup/src/lib/extend/path.matcher.ts',
		'testing/test-setup/src/lib/extend/jest-extended.matcher.ts',

		@@ -0,0 +1,154 @@
		## Vitest config factory and setup presets

		This folder contains utilities to centralize and standardize Vitest configuration across the monorepo.

	This folder contains utilities to centralize and standardize Vitest configuration across the monorepo.
	This project contains utilities to centralize and standardize Vitest configuration across a monorepo.

refactor: common vitest configurations #1107

Are you sure you want to change the base?

refactor: common vitest configurations #1107

Uh oh!

Conversation

poltorak commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Centralize and Standardize Vitest Configurations

What Changed

Benefits

Uh oh!

nx-cloud bot commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code PushUp

🏷️ Categories

🗃️ Groups

🛡️ Audits

Uh oh!

BioPhoton left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

poltorak commented Sep 5, 2025 •

edited

Loading

nx-cloud bot commented Sep 5, 2025 •

edited

Loading

pkg-pr-new bot commented Sep 5, 2025 •

edited

Loading

github-actions bot commented Sep 5, 2025 •

edited

Loading

BioPhoton left a comment •

edited

Loading