Visitar URL original
fix!: throw an error if hoistable methods are outside the top level s… · vitest-dev/vitest@d0b4fdd · GitHub
Skip to content

Commit d0b4fdd

Browse files
sheremet-vasheremet-va
authored
fix!: throw an error if hoistable methods are outside the top level scope (#10460)
1 parent aab60c0 commit d0b4fdd

6 files changed

Lines changed: 144 additions & 147 deletions

File tree

‎packages/mocker/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@
8787
}
8888
},
8989
"dependencies": {
90+
"@jridgewell/trace-mapping": "catalog:",
9091
"@vitest/spy": "workspace:*",
9192
"estree-walker": "^3.0.3",
9293
"magic-string": "catalog:"

‎packages/mocker/src/node/hoistMocks.ts‎

Lines changed: 47 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,12 @@ import type {
88
ImportDeclaration,
99
VariableDeclaration,
1010
} from 'estree'
11+
import type { Rollup } from 'vite'
1112
import type { Node, Positioned } from './esmWalker'
13+
import { originalPositionFor, TraceMap } from '@jridgewell/trace-mapping'
1214
import { findNodeAround } from 'acorn-walk'
1315
import MagicString from 'magic-string'
16+
import { relative } from 'pathe'
1417
import { esmWalker } from './esmWalker'
1518

1619
export interface HoistMocksOptions {
@@ -39,6 +42,12 @@ export interface HoistMocksOptions {
3942
regexpHoistable?: RegExp
4043
codeFrameGenerator?: CodeFrameGenerator
4144
magicString?: () => MagicString
45+
/**
46+
* Root of the project
47+
* @default process.cwd()
48+
*/
49+
root?: string
50+
getMap?: () => Rollup.SourceMap
4251
}
4352

4453
const API_NOT_FOUND_ERROR = `There are some problems in resolving the mocks API.
@@ -488,13 +497,26 @@ export function hoistMocks(
488497
}
489498
}
490499

491-
for (const invalidNode of hoistedNodes) {
492-
console.warn(
493-
`Warning: A ${getNodeName(getNodeCall(invalidNode))} call in "${id}" is not at the top level of the module. `
494-
+ `Although it appears nested, it will be hoisted and executed before any tests run. `
495-
+ `Move it to the top level to reflect its actual execution order. This will become an error in a future version.\n`
496-
+ `See: https://vitest.dev/guide/mocking/modules#how-it-works`,
497-
)
500+
if (hoistedNodes.size) {
501+
const locations = createIndexLocationsMap(code)
502+
const map = options.getMap && new TraceMap(options.getMap() as any)
503+
const plural = hoistedNodes.size > 1
504+
const message = [
505+
`${hoistedNodes.size} call${plural ? 's' : ''} in "${relative(options.root || process.cwd(), id)}" ${plural ? 'were' : 'was'} defined outside of the module's top level scope:`,
506+
'',
507+
...[...hoistedNodes].map((invalidNode) => {
508+
const currentLocation = locations.get(invalidNode.start)
509+
const originalLocation = map && currentLocation && originalPositionFor(map, currentLocation)
510+
const location = originalLocation?.column != null && originalLocation?.line != null
511+
? ` at ${relative(options.root || process.cwd(), id)}:${originalLocation.line}:${originalLocation.column + 1}`
512+
: ''
513+
return `- ${getNodeName(getNodeCall(invalidNode))}${location}`
514+
}),
515+
'',
516+
`Although ${plural ? 'they appear nested, they' : 'it appears nested, it'} will be hoisted and executed before anything in this file. Move ${plural ? 'them' : 'it'} to the top level to reflect ${plural ? 'their' : 'its'} actual execution order.`,
517+
'See: https://vitest.dev/guide/mocking/modules#how-it-works',
518+
].join('\n')
519+
throw new Error(message)
498520
}
499521
}
500522

@@ -563,3 +585,21 @@ export function hoistMocks(
563585
interface CodeFrameGenerator {
564586
(node: Positioned<Node>, id: string, code: string): string
565587
}
588+
589+
function createIndexLocationsMap(source: string): Map<number, { line: number; column: number }> {
590+
const map = new Map<number, { line: number; column: number }>()
591+
let offset = 0
592+
let line = 1
593+
let column = 1
594+
for (const char of source) {
595+
map.set(offset++, { line, column })
596+
if (char === '\n' || char === '\r\n') {
597+
line++
598+
column = 0
599+
}
600+
else {
601+
column++
602+
}
603+
}
604+
return map
605+
}

‎packages/mocker/src/node/hoistMocksPlugin.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,14 @@ export function hoistMocksPlugin(options: HoistMocksPluginOptions = {}): Plugin
3434
`\\b(?:${utilsObjectNames.join('|')})\\s*\.\\s*(?:${Array.from(methods).join('|')})\\s*\\(`,
3535
)
3636

37+
let root: string
38+
3739
return {
3840
name: 'vitest:mocks',
3941
enforce: 'post',
42+
configResolved(config) {
43+
root = config.root
44+
},
4045
transform(code, id) {
4146
if (!filter(id)) {
4247
return
@@ -47,6 +52,8 @@ export function hoistMocksPlugin(options: HoistMocksPluginOptions = {}): Plugin
4752
hoistedMethodNames,
4853
utilsObjectNames,
4954
dynamicImportMockMethodNames,
55+
root,
56+
getMap: () => this.getCombinedSourcemap(),
5057
...options,
5158
})
5259
if (s) {

‎pnpm-lock.yaml‎

Lines changed: 6 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎test/unit/test/hoisted-async-simple.test.ts‎

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,13 @@ afterAll(() => {
1818

1919
// _order is set in the hoisted function before tests are collected
2020
// @ts-expect-error not typed global
21-
expect(globalThis._order).toEqual([1, 2, 3])
21+
expect(globalThis._order).toEqual([1, 2])
2222

2323
it('imported value is equal to returned from hoisted', () => {
2424
expect(value).toBe(globalValue)
2525
})
2626

27-
it('hoists async "vi.hoisted", but leaves the wrapper alone', async () => {
28-
expect.assertions(1)
29-
await (async () => {
30-
expect(1).toBe(1)
31-
vi.hoisted(() => {
32-
// @ts-expect-error not typed global
33-
;(globalThis._order ??= []).push(2)
34-
})
35-
})()
36-
})
37-
3827
await vi.hoisted(async () => {
3928
// @ts-expect-error not typed global
40-
;(globalThis._order ??= []).push(3)
29+
;(globalThis._order ??= []).push(2)
4130
})

0 commit comments

Comments
 (0)