fix: guard disposable and optional body (#9912)

sheremet-va · web-flow · commit 6fdb2ba614bc · 2026-03-21T13:13:52.000+09:00
diff --git a/packages/runner/src/types/tasks.ts b/packages/runner/src/types/tasks.ts
@@ -1262,7 +1262,7 @@ export interface TestAttachment {
   /** File system path to the attachment */
   path?: string
   /** Inline attachment content as a string or raw binary data */
-  body?: string | Uint8Array
+  body?: string | Uint8Array | undefined
 }
 
 export interface Location {
diff --git a/packages/spy/optional-types.d.ts b/packages/spy/optional-types.d.ts
@@ -0,0 +1,6 @@
+/* eslint-disable ts/ban-ts-comment */
+
+export interface Disposable {
+  // @ts-ignore -- Symbol.dispose might not be in user types
+  [Symbol.dispose]: () => void
+}
diff --git a/packages/spy/package.json b/packages/spy/package.json
@@ -27,13 +27,17 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./optional-types.js": {
+      "types": "./optional-types.d.ts"
+    },
     "./*": "./*"
   },
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "optional-types.d.ts"
   ],
   "scripts": {
     "build": "premove dist && rollup -c",
diff --git a/packages/spy/rollup.config.js b/packages/spy/rollup.config.js
@@ -10,6 +10,7 @@ const external = [
   ...builtinModules,
   ...Object.keys(pkg.dependencies || {}),
   ...Object.keys(pkg.peerDependencies || {}),
+  '@vitest/spy/optional-types.js',
 ]
 
 const dtsUtils = createDtsUtils()
diff --git a/packages/spy/src/types.ts b/packages/spy/src/types.ts
@@ -1,3 +1,5 @@
+import type { Disposable } from '@vitest/spy/optional-types.js'
+
 export interface MockResultReturn<T> {
   type: 'return'
   /**
diff --git a/packages/vitest/optional-runtime-types.d.ts b/packages/vitest/optional-runtime-types.d.ts
@@ -0,0 +1,6 @@
+/* eslint-disable ts/ban-ts-comment */
+
+export interface Disposable {
+  // @ts-ignore -- Symbol.dispose might not be in user types
+  [Symbol.dispose]: () => void
+}
diff --git a/packages/vitest/package.json b/packages/vitest/package.json
@@ -48,6 +48,9 @@
     "./optional-types.js": {
       "types": "./optional-types.d.ts"
     },
+    "./optional-runtime-types.js": {
+      "types": "./optional-runtime-types.d.ts"
+    },
     "./src/*": "./src/*",
     "./globals": {
       "types": "./globals.d.ts"
diff --git a/packages/vitest/rollup.config.js b/packages/vitest/rollup.config.js
@@ -75,6 +75,7 @@ const external = [
   'node:console',
   'node:events',
   'inspector',
+  'vitest/optional-runtime-types.js',
   'vitest/optional-types.js',
   'vitest/browser',
   'vite/module-runner',
diff --git a/packages/vitest/src/integrations/vi.ts b/packages/vitest/src/integrations/vi.ts
@@ -6,6 +6,7 @@ import type {
   MaybePartiallyMockedDeep,
   MockInstance,
 } from '@vitest/spy'
+import type { Disposable } from 'vitest/optional-runtime-types.js'
 import type { RuntimeOptions, SerializedConfig } from '../runtime/config'
 import type { VitestMocker } from '../runtime/moduleRunner/moduleMocker'
 import type { MockFactoryWithHelper, MockOptions } from '../types/mocker'
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/test/cli/dts/exact-optional-property-no-node/package.json b/test/cli/dts/exact-optional-property-no-node/package.json
diff --git a/test/cli/dts/exact-optional-property-no-node/src/runner.ts b/test/cli/dts/exact-optional-property-no-node/src/runner.ts
@@ -1,4 +1,7 @@
 import type { VitestRunner } from '@vitest/runner'
+import type { FailureScreenshotArtifact } from '@vitest/runner/types'
 import { VitestTestRunner } from 'vitest/runners'
 
+type _Override = FailureScreenshotArtifact
+
 export class MyRunner extends VitestTestRunner implements VitestRunner {}
diff --git a/test/cli/dts/exact-optional-property-no-node/tsconfig.json b/test/cli/dts/exact-optional-property-no-node/tsconfig.json
@@ -0,0 +1,17 @@
+{
+  "extends": ["../_shared/tsconfig.patch.json"],
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "types": [],
+    "strict": true,
+    "exactOptionalPropertyTypes": true,
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "verbatimModuleSyntax": true,
+    "skipLibCheck": false
+  }
+}
diff --git a/test/cli/dts/exact-optional-property-node/package.json b/test/cli/dts/exact-optional-property-node/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "@vitest/test-integration-dts-exact-optional-property",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "test": "tsc -b"
+  },
+  "devDependencies": {
+    "@vitest/runner": "workspace:*",
+    "vitest": "workspace:*"
+  }
+}
diff --git a/test/cli/dts/exact-optional-property-node/src/reporter.ts b/test/cli/dts/exact-optional-property-node/src/reporter.ts
@@ -1,5 +1,5 @@
 import type { File } from '@vitest/runner'
-import { DefaultReporter } from 'vitest/reporters'
+import { DefaultReporter } from 'vitest/node'
 
 export class MyReporter extends DefaultReporter {
   override reportTestSummary(files: File[], errors: unknown[], leakCount: number): void {
diff --git a/test/cli/dts/exact-optional-property-node/tsconfig.json b/test/cli/dts/exact-optional-property-node/tsconfig.json
@@ -4,6 +4,7 @@
     "target": "ESNext",
     "module": "ESNext",
     "moduleResolution": "Bundler",
+    "types": [],
     "strict": true,
     "exactOptionalPropertyTypes": true,
     "declaration": true,
diff --git a/test/cli/dts/no-dispose/package.json b/test/cli/dts/no-dispose/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "@vitest/test-integration-dts-exact-optional-property",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "test": "tsc -b"
+  },
+  "devDependencies": {
+    "@vitest/runner": "workspace:*",
+    "vitest": "workspace:*"
+  }
+}
diff --git a/test/cli/dts/no-dispose/src/vitest.ts b/test/cli/dts/no-dispose/src/vitest.ts
@@ -0,0 +1,4 @@
+import { vi } from 'vitest'
+
+const _fn = vi.fn()
+const _mock = vi.doMock('./vitest.ts')
diff --git a/test/cli/dts/no-dispose/tsconfig.json b/test/cli/dts/no-dispose/tsconfig.json
@@ -0,0 +1,17 @@
+{
+  "extends": ["../_shared/tsconfig.patch.json"],
+  "compilerOptions": {
+    "target": "es2020",
+    "lib": ["DOM", "ES2020"],
+    "module": "node16",
+    "types": [],
+    "strict": true,
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "verbatimModuleSyntax": true,
+    "skipLibCheck": false
+  },
+  "include": ["src/*.ts"]
+}

Original file line number	Diff line number	Diff line change
`@@ -1262,7 +1262,7 @@ export interface TestAttachment {`
`1262`	`1262`	`/** File system path to the attachment */`
`1263`	`1263`	`path?: string`
`1264`	`1264`	`/** Inline attachment content as a string or raw binary data */`
`1265`		`- body?: string \| Uint8Array`
	`1265`	`+ body?: string \| Uint8Array \| undefined`
`1266`	`1266`	`}`
`1267`	`1267`
`1268`	`1268`	`export interface Location {`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ const external = [`
`10`	`10`	`...builtinModules,`
`11`	`11`	`...Object.keys(pkg.dependencies \|\| {}),`
`12`	`12`	`...Object.keys(pkg.peerDependencies \|\| {}),`
	`13`	`+ '@vitest/spy/optional-types.js',`
`13`	`14`	`]`
`14`	`15`
`15`	`16`	`const dtsUtils = createDtsUtils()`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+import type { Disposable } from '@vitest/spy/optional-types.js'`
	`2`	`+`
`1`	`3`	`export interface MockResultReturn<T> {`
`2`	`4`	`type: 'return'`
`3`	`5`	`/**`