Skip to content
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.

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

fix: show correct line numbers in stack trace when using vi.resetModules() #3020

Merged
merged 1 commit into from
Mar 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/vite-node/src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,14 @@ export class ModuleCacheMap extends Map<string, ModuleCache> {
return this.deleteByModuleId(this.normalizePath(fsPath))
}

invalidateModule(mod: ModuleCache) {
delete mod.evaluated
delete mod.resolving
delete mod.promise
delete mod.exports
return true
}

/**
* Invalidate modules that dependent on the given modules, up to the main entry
*/
Expand Down
4 changes: 2 additions & 2 deletions packages/vitest/src/utils/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ export function resetModules(modules: ModuleCacheMap, resetMocks = false) {
// don't clear mocks
...(!resetMocks ? [/^mock:/] : []),
]
modules.forEach((_, path) => {
modules.forEach((mod, path) => {
if (skipPaths.some(re => re.test(path)))
return
modules.delete(path)
modules.invalidateModule(mod)
})
}

Expand Down
63 changes: 36 additions & 27 deletions test/core/test/utils.spec.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import { describe, expect, test } from 'vitest'
import { beforeAll, describe, expect, test } from 'vitest'
import { assertTypes, deepClone, objectAttr, toArray } from '@vitest/utils'
import { deepMerge, resetModules } from '../../../packages/vitest/src/utils'
import { deepMergeSnapshot } from '../../../packages/vitest/src/integrations/snapshot/port/utils'
import type { ModuleCacheMap } from '../../../packages/vite-node/src/types'
import type { EncodedSourceMap } from '../../../packages/vite-node/src/types'
import { ModuleCacheMap } from '../../../packages/vite-node/dist/client'

describe('assertTypes', () => {
test('the type of value should be number', () => {
Expand Down Expand Up @@ -151,36 +152,44 @@ describe('deepClone', () => {
})

describe('resetModules doesn\'t resets only user modules', () => {
test('resets user modules', () => {
const moduleCache = new Map() as ModuleCacheMap
moduleCache.set('/some-module.ts', {})
moduleCache.set('/@fs/some-path.ts', {})

resetModules(moduleCache)

expect(moduleCache.size).toBe(0)
})

test('doesn\'t reset vitest modules', () => {
const moduleCache = new Map() as ModuleCacheMap
moduleCache.set('/node_modules/vitest/dist/index.js', {})
moduleCache.set('/node_modules/vitest-virtual-da9876a/dist/index.js', {})
moduleCache.set('/node_modules/some-module@vitest/dist/index.js', {})
moduleCache.set('/packages/vitest/dist/index.js', {})

const mod = () => ({ evaluated: true, promise: Promise.resolve({}), resolving: false, exports: {}, map: {} as EncodedSourceMap })

const moduleCache = new ModuleCacheMap()
const modules = [
['/some-module.ts', true],
['/@fs/some-path.ts', true],
['/node_modules/vitest/dist/index.js', false],
['/node_modules/vitest-virtual-da9876a/dist/index.js', false],
['/node_modules/some-module@vitest/dist/index.js', false],
['/packages/vitest/dist/index.js', false],
['mock:/some-module.ts', false],
['mock:/@fs/some-path.ts', false],
] as const

beforeAll(() => {
modules.forEach(([path]) => {
moduleCache.set(path, mod())
})
resetModules(moduleCache)

expect(moduleCache.size).toBe(4)
})

test('doesn\'t reset mocks', () => {
const moduleCache = new Map() as ModuleCacheMap
moduleCache.set('mock:/some-module.ts', {})
moduleCache.set('mock:/@fs/some-path.ts', {})
test.each(modules)('Cashe for %s is reseted (%s)', (path, reset) => {
const cached = moduleCache.get(path)

resetModules(moduleCache)
if (reset) {
expect(cached).not.toHaveProperty('evaluated')
expect(cached).not.toHaveProperty('resolving')
expect(cached).not.toHaveProperty('exports')
expect(cached).not.toHaveProperty('promise')
}
else {
expect(cached).toHaveProperty('evaluated')
expect(cached).toHaveProperty('resolving')
expect(cached).toHaveProperty('exports')
expect(cached).toHaveProperty('promise')
}

expect(moduleCache.size).toBe(2)
expect(cached).toHaveProperty('map')
})
})

Expand Down
18 changes: 18 additions & 0 deletions test/stacktraces/fixtures/reset-modules.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { assert, describe, expect, it, vi } from 'vitest'

describe('suite name', () => {
it('foo', () => {
vi.resetModules()
// a comment here
// another comment
// another comment
// another comment
// another comment
// another comment
// this will mess up the stacktrace lines
expect(1 + 1).eq(2)
expect(2 + 1).eq(3)
assert.equal(Math.sqrt(4), 2)
expect(Math.sqrt(4)).toBe(1)
})
})
13 changes: 12 additions & 1 deletion test/stacktraces/test/__snapshots__/runner.test.ts.snap
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Vitest Snapshot v1
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`stacktraces should pick error frame if present > frame.spec.imba > frame.spec.imba 1`] = `
" FAIL frame.spec.imba [ frame.spec.imba ]
Expand Down Expand Up @@ -43,3 +43,14 @@ exports[`stacktraces should respect sourcemaps > add-in-js.test.js > add-in-js.t
8| return expect(add(1, 2, 3)).toBe(6)
"
`;

exports[`stacktraces should respect sourcemaps > reset-modules.test.ts > reset-modules.test.ts 1`] = `
" ❯ reset-modules.test.ts:16:26
14| expect(2 + 1).eq(3)
15| assert.equal(Math.sqrt(4), 2)
16| expect(Math.sqrt(4)).toBe(1)
| ^
17| })
18| })
"
`;