Skip to content

fix(@angular/build): add webcontainer support for Vitest browser provider #31711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2025
Merged

fix(@angular/build): add webcontainer support for Vitest browser provider #31711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions packages/angular/build/src/builders/unit-test/runners/vitest/browser-provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,16 @@ export interface BrowserConfiguration {
function findBrowserProvider(
projectResolver: NodeJS.RequireResolve,
): BrowserBuiltinProvider | undefined {
const requiresPreview = !!process.versions.webcontainer;

// One of these must be installed in the project to use browser testing
const vitestBuiltinProviders = ['playwright', 'webdriverio'] as const;
const vitestBuiltinProviders = requiresPreview
? (['preview'] as const)
: (['playwright', 'webdriverio', 'preview'] as const);

for (const providerName of vitestBuiltinProviders) {
try {
projectResolver(providerName);
projectResolver(`@vitest/browser-${providerName}`);

return providerName;
} catch {}
Expand Down Expand Up @@ -102,13 +106,18 @@ export async function setupBrowserConfiguration(
}

const isCI = !!process.env['CI'];
const headless = isCI || browsers.some((name) => name.toLowerCase().includes('headless'));
let headless = isCI || browsers.some((name) => name.toLowerCase().includes('headless'));
if (providerName === 'preview') {
// `preview` provider does not support headless mode
headless = false;
}

const browser = {
enabled: true,
provider,
headless,
ui: !headless,
isolate: debug,
viewport,
instances: browsers.map((browserName) => ({
browser: normalizeBrowserName(browserName),
Expand Down
19 changes: 15 additions & 4 deletions packages/angular/build/src/builders/unit-test/runners/vitest/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,15 @@ const VitestTestRunner: TestRunner = {
checker.check('vitest');

if (options.browsers?.length) {
checker.checkAny(
['playwright', 'webdriverio'],
'The "browsers" option requires either "playwright" or "webdriverio" to be installed.',
);
if (process.versions.webcontainer) {
checker.check('@vitest/browser-preview');
} else {
checker.checkAny(
['@vitest/browser-playwright', '@vitest/browser-webdriverio', '@vitest/browser-preview'],
'The "browsers" option requires either ' +
'"@vitest/browser-playwright", "@vitest/browser-webdriverio", or "@vitest/browser-preview" to be installed.',
);
}
} else {
// JSDOM is used when no browsers are specified
checker.check('jsdom');
Expand All @@ -47,6 +52,12 @@ const VitestTestRunner: TestRunner = {
const projectName = context.target?.project;
assert(projectName, 'The builder requires a target.');

if (!!process.versions.webcontainer && options.browsers?.length) {
context.logger.info(
`Webcontainer environment detected. Using '@vitest/browser-preview' for browser-based tests.`,
);
}

if (typeof options.runnerConfig === 'string') {
context.logger.info(`Using Vitest configuration file: ${options.runnerConfig}`);
} else if (options.runnerConfig) {
Expand Down