feat(core): support custom test environments by 9aoy · Pull Request #1287 · web-infra-dev/rstest

9aoy · 2026-05-20T08:18:44Z

Summary

This PR adds config-level custom test environment support to @rstest/core, so projects are no longer limited to the built-in node, jsdom, and happy-dom environments. It allows loading environment objects from local JavaScript files or rstest-environment-* packages, exports builtinEnvironments and TestEnvironment types for user extension, clarifies when to use custom environments versus setupFiles, and adds unit and e2e coverage for builtin wrappers, named exports, and package fallback resolution.

import { builtinEnvironments } from '@rstest/core';

/** @type {import('@rstest/core').TestEnvironment<typeof globalThis, { marker: string }>} */
const environment = {
  name: 'custom-jsdom',
  async setup(global, options) {
    const base = await builtinEnvironments.jsdom.setup(global, {
      url: 'https://example.com',
    });

    global.__MARKER__ = options.marker;

    return {
      async teardown() {
        delete global.__MARKER__;
        await base.teardown();
      },
    };
  },
};

export default environment;

import { defineConfig } from '@rstest/core';

export default defineConfig({
  testEnvironment: {
    name: './my-environment.mjs',
    options: {
      marker: 'custom-marker',
    },
  },
});

Checklist

Tests updated (or not required).
Documentation updated (or not required).

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 44254466e1

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

github-actions · 2026-05-20T08:30:13Z

Rsdoctor Bundle Diff Analysis

Found 13 projects in monorepo, 2 projects with changes.

📊 Quick Summary

Project	Total Size	Change
adapter-rsbuild	5.4 KB	0
adapter-rslib	25.6 KB	0
adapter-rspack	9.3 KB	0
browser	2.0 MB	0
browser-react	6.4 KB	0
browser-ui	809.5 KB	0
coverage-istanbul	18.8 KB	0
coverage-v8	19.4 KB	0
core/browser	1.1 MB	+523.0 B (0.0%)
core/loaders	869.0 B	0
core/main	1.9 MB	+5.1 KB (0.3%)
vscode/extension	27.0 MB	0
vscode/worker	14.5 KB	0

📋 Detailed Reports (Click to expand)

📁 core/browser

Path: packages/core/.rsdoctor/browser/rsdoctor-data.json

📌 Baseline Commit: ce1f1218a7 | PR: #1403

Metric	Current	Baseline	Change
📊 Total Size	1.1 MB	1.1 MB	+523.0 B (0.0%)
📄 JavaScript	970.0 KB	970.0 KB	0
🎨 CSS	0 B	0 B	0
🌐 HTML	0 B	0 B	0
📁 Other Assets	115.1 KB	114.6 KB	+523.0 B (0.4%)

📦 Download Diff Report: core/browser Bundle Diff

📁 core/main

Path: packages/core/.rsdoctor/main/rsdoctor-data.json

📌 Baseline Commit: ce1f1218a7 | PR: #1403

Metric	Current	Baseline	Change
📊 Total Size	1.9 MB	1.9 MB	+5.1 KB (0.3%)
📄 JavaScript	1.6 MB	1.6 MB	+4.2 KB (0.3%)
🎨 CSS	0 B	0 B	0
🌐 HTML	0 B	0 B	0
📁 Other Assets	292.9 KB	291.9 KB	+968.0 B (0.3%)

📦 Download Diff Report: core/main Bundle Diff

Generated by Rsdoctor GitHub Action

cloudflare-workers-and-pages · 2026-05-20T08:53:04Z

Deploying rstest with Cloudflare Pages

Latest commit:	`caad7f5`
Status:	✅ Deploy successful!
Preview URL:	https://1f5b5aa5.rstest.pages.dev
Branch Preview URL:	https://feat-custom-test-environment.rstest.pages.dev

View logs

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 1fa7ba855e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d76a0cdf02

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3ff7c7d8cb

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6f32f28656

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

…ronment # Conflicts: # website/docs/en/guide/migration/vitest.mdx # website/docs/zh/guide/migration/vitest.mdx

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2c1872896c

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 91a5e677c0

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6a72fec7d0

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

fi3ework

are the API of custom envs the final version before 1.0.0?

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: bded029260

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e17b033717

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f5e418a376

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

9aoy · 2026-05-27T03:16:09Z

are the API of custom envs the final version before 1.0.0?

@fi3ework Not final yet. The current design should already cover the main use cases we want to support, but we may make minor adjustments based on real-world feedback.

…conflicts # Conflicts: # website/docs/en/config/test/test-environment.mdx # website/docs/en/guide/migration/vitest.mdx # website/docs/zh/config/test/test-environment.mdx # website/docs/zh/guide/migration/vitest.mdx

9aoy · 2026-06-23T07:35:58Z

@codex review

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 69b1295540

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

9aoy · 2026-06-23T10:11:51Z

@codex review

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ff4dc2b797

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

9aoy · 2026-06-23T11:43:01Z

@codex review

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b6d4c1ad81

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

9aoy · 2026-06-24T04:57:04Z

@codex review

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3467532d38

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

9aoy · 2026-06-24T07:48:52Z

@codex review

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: aabbe8c16e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2026-06-24T07:58:55Z

+  const testEnvironmentFiles = await resolveTestEnvironmentWatchFiles(
+    projects,
+    command,
+    context.rootPath,
+  );


Recompute environment watch files after env edits

In watch mode this collects the custom environment import graph only once, before the dev server is created. If a user edits test-environment.mjs to import a new local helper, the environment file itself triggers one rerun, but that new helper is never added to TestFileWatchPlugin's file dependencies, so later edits to the helper do not rerun tests until the watcher is restarted. Please refresh the collected environment files after recompiles or derive the watched dependencies from the current environment file.

Useful? React with 👍 / 👎.

feat(core): support custom test environments

4425446

chatgpt-codex-connector Bot reviewed May 20, 2026

View reviewed changes

Comment thread packages/core/src/runtime/worker/testEnvironment.ts Outdated

fix: align custom environment resolution and docs

1fa7ba8

chatgpt-codex-connector Bot reviewed May 20, 2026

View reviewed changes

Comment thread packages/core/src/types/config.ts

Comment thread packages/core/src/runtime/worker/testEnvironment.ts Outdated

9aoy added 2 commits May 20, 2026 18:40

fix: custom environments, transform mode, and review feedback

21fc374

style: format test files

d76a0cd

chatgpt-codex-connector Bot reviewed May 20, 2026

View reviewed changes

Comment thread packages/core/src/runtime/worker/testEnvironment.ts Outdated

Comment thread e2e/dom/fixtures/rstest.packageEnvironment.config.mts

9aoy added 2 commits May 20, 2026 19:30

fix: stabilize custom test environment resolution

019d878

fix: lint

3ff7c7d

chatgpt-codex-connector Bot reviewed May 21, 2026

View reviewed changes

Comment thread e2e/dom/fixtures/rstest-environment-package-marker/index.mjs Outdated

9aoy added 4 commits May 21, 2026 11:48

fix: expose package environment marker during setup

c5f69a5

docs: update custom-environment-vs-setup-files

ea7d542

docs: add Test environment types

ca4c2b4

docs: add Browser Mode tip

6f32f28

chatgpt-codex-connector Bot reviewed May 21, 2026

View reviewed changes

Comment thread packages/core/src/runtime/worker/testEnvironment.ts Outdated

9aoy added 5 commits May 21, 2026 16:52

fix(core): refine custom environment loading

e3f6a20

Merge remote-tracking branch 'origin/main' into feat/custom-test-envi…

f37d878

…ronment # Conflicts: # website/docs/en/guide/migration/vitest.mdx # website/docs/zh/guide/migration/vitest.mdx

fix(core): resolve test environment before worker run

4223d16

chore: merge main into custom test environment

bb8b3d0

chore: format Vitest migration docs

2c18728

chatgpt-codex-connector Bot reviewed May 22, 2026

View reviewed changes

Comment thread packages/core/src/core/resolveTestEnvironment.ts Outdated

fix(core): continue environment fallback after import errors

91a5e67

chatgpt-codex-connector Bot reviewed May 22, 2026

View reviewed changes

Comment thread packages/core/src/core/resolveTestEnvironment.ts Outdated

Comment thread packages/core/src/core/resolveTestEnvironment.ts Outdated

fix(core): surface custom environment import errors

6a72fec

chatgpt-codex-connector Bot reviewed May 22, 2026

View reviewed changes

Comment thread packages/core/src/core/resolveTestEnvironment.ts Outdated

Comment thread website/docs/en/api/javascript-api/types.mdx

fix(core): report fallback environment import errors

13ce612

fi3ework reviewed May 25, 2026

View reviewed changes

docs: update custom environment guide

db997ce

chatgpt-codex-connector Bot reviewed May 26, 2026

View reviewed changes

Comment thread packages/core/src/core/resolveTestEnvironment.ts Outdated

fix: align environment package fallback with node resolution

e17b033

chatgpt-codex-connector Bot reviewed May 26, 2026

View reviewed changes

Comment thread packages/core/src/core/resolveTestEnvironment.ts Outdated

fix: resolve environment packages with rspack resolver

f5e418a

chatgpt-codex-connector Bot reviewed May 26, 2026

View reviewed changes

Comment thread packages/core/src/core/resolveTestEnvironment.ts Outdated

fix: avoid require condition for environment imports

51ca46e

9aoy requested a review from fi3ework May 27, 2026 03:16

fi3ework reviewed May 27, 2026

View reviewed changes

Comment thread website/docs/zh/config/test/test-environment.mdx Outdated

Comment thread website/docs/zh/config/test/test-environment.mdx Outdated

fi3ework reviewed May 27, 2026

View reviewed changes

Comment thread website/docs/zh/config/test/test-environment.mdx Outdated

9aoy added 4 commits May 27, 2026 15:46

docs: move custom environment migration guide

348cb4f

chore: merge main and update custom env target

470b0f5

fix(core): type environment comments

69b1295

chatgpt-codex-connector Bot reviewed Jun 23, 2026

View reviewed changes

Comment thread packages/core/src/types/config.ts

Comment thread packages/core/src/core/resolveTestEnvironment.ts

9aoy added 2 commits June 23, 2026 17:22

fix: address environment review feedback

fdeeb59

fix: keep watch plugin snapshots stable

ff4dc2b

chatgpt-codex-connector Bot reviewed Jun 23, 2026

View reviewed changes

Comment thread packages/core/src/runtime/worker/testEnvironment.ts

Comment thread packages/core/src/core/rsbuild.ts Outdated

9aoy added 2 commits June 23, 2026 19:15

fix: refresh custom environment watch reruns

c88dc86

fix: handle optional watch changed files

b6d4c1a

chatgpt-codex-connector Bot reviewed Jun 23, 2026

View reviewed changes

Comment thread packages/core/src/runtime/worker/testEnvironment.ts Outdated

Comment thread packages/core/src/runtime/worker/testEnvironment.ts Outdated

Comment thread packages/core/src/runtime/worker/testEnvironment.ts Outdated

fix: refresh custom environment workers in watch

3467532

chatgpt-codex-connector Bot reviewed Jun 24, 2026

View reviewed changes

Comment thread packages/core/src/core/rsbuild.ts

Comment thread packages/core/src/core/resolveTestEnvironment.ts Outdated

Comment thread website/docs/en/config/test/test-environment.mdx

fix: watch custom environment dependencies

aabbe8c

chatgpt-codex-connector Bot reviewed Jun 24, 2026

View reviewed changes

Uh oh!

Conversation

9aoy commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

github-actions Bot commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rsdoctor Bundle Diff Analysis

📁 core/browser

📁 core/main

Uh oh!

cloudflare-workers-and-pages Bot commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying rstest with Cloudflare Pages

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

fi3ework left a comment

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

9aoy commented May 27, 2026

9aoy commented May 20, 2026 •

edited

Loading

github-actions Bot commented May 20, 2026 •

edited

Loading

cloudflare-workers-and-pages Bot commented May 20, 2026 •

edited

Loading