-
Notifications
You must be signed in to change notification settings - Fork 80
/
module.ts
204 lines (176 loc) · 6.41 KB
/
module.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
import { pathToFileURL } from 'node:url'
import { addVitePlugin, createResolver, defineNuxtModule, logger, resolvePath } from '@nuxt/kit'
import type { File, Reporter, Vitest, UserConfig as VitestConfig } from 'vitest'
import { mergeConfig } from 'vite'
import type { InlineConfig as ViteConfig } from 'vite'
import { getPort } from 'get-port-please'
import { h } from 'vue'
import { debounce } from 'perfect-debounce'
import { isCI } from 'std-env'
import { defu } from 'defu'
import { getVitestConfigFromNuxt } from './config'
import { setupImportMocking } from './module/mock'
import { NuxtRootStubPlugin } from './module/plugins/entry'
export interface NuxtVitestOptions {
startOnBoot?: boolean
logToConsole?: boolean
vitestConfig?: VitestConfig
}
/**
* List of plugins that are not compatible with test env.
* Hard-coded for now, should remove by PR to upstream.
*/
const vitePluginBlocklist = ['vite-plugin-vue-inspector', 'vite-plugin-vue-inspector:post', 'vite-plugin-inspect', 'nuxt:type-check']
export default defineNuxtModule<NuxtVitestOptions>({
meta: {
name: '@nuxt/test-utils',
configKey: 'testUtils',
},
defaults: {
startOnBoot: false,
logToConsole: false,
},
async setup(options, nuxt) {
if (nuxt.options.test || nuxt.options.dev) {
setupImportMocking()
}
const resolver = createResolver(import.meta.url)
addVitePlugin(NuxtRootStubPlugin.vite({
entry: await resolvePath('#app/entry', { alias: nuxt.options.alias }),
rootStubPath: await resolvePath(resolver.resolve('./runtime/nuxt-root')),
}))
// Support for in-source testing
if (!nuxt.options.test && !nuxt.options.dev) {
nuxt.options.vite.define ||= {}
nuxt.options.vite.define['import.meta.vitest'] = 'undefined'
}
nuxt.hook('prepare:types', ({ references }) => {
references.push({ types: 'vitest/import-meta' })
})
if (!nuxt.options.dev) return
// the nuxt instance is used by a standalone Vitest env, we skip this module
if (process.env.TEST || process.env.VITE_TEST) return
const rawViteConfigPromise = new Promise<ViteConfig>((resolve) => {
// Wrap with app:resolve to ensure we got the final vite config
nuxt.hook('app:resolve', () => {
nuxt.hook('vite:configResolved', (config, { isClient }) => {
if (isClient) resolve(config)
})
})
})
let loaded = false
let promise: Promise<void> | undefined
let ctx: Vitest = undefined!
let testFiles: File[] | null = null
const updateTabs = debounce(() => {
nuxt.callHook('devtools:customTabs:refresh')
}, 100)
let URL: string
async function start() {
const rawViteConfig = mergeConfig({}, await rawViteConfigPromise)
const viteConfig = await getVitestConfigFromNuxt({ nuxt, viteConfig: defu({ test: options.vitestConfig }, rawViteConfig) })
viteConfig.plugins = (viteConfig.plugins || []).filter((p) => {
return !p || !('name' in p) || !vitePluginBlocklist.includes(p.name)
})
process.env.__NUXT_VITEST_RESOLVED__ = 'true'
const { startVitest } = (await import(pathToFileURL(await resolvePath('vitest/node')).href)) as typeof import('vitest/node')
const customReporter: Reporter = {
onInit(_ctx) {
ctx = _ctx
},
onTaskUpdate() {
testFiles = ctx.state.getFiles()
updateTabs()
},
onFinished() {
testFiles = ctx.state.getFiles()
updateTabs()
},
}
const watchMode = !process.env.NUXT_VITEST_DEV_TEST && !isCI
// We resolve the path here to ensure the dev server is already running with the correct protocol
const PORT = await getPort({ port: 15555 })
const PROTOCOL = nuxt.options.devServer.https ? 'https' : 'http'
URL = `${PROTOCOL}://localhost:${PORT}/__vitest__/`
// For testing dev mode in CI, maybe expose an option to user later
const overrides: VitestConfig = watchMode
? {
passWithNoTests: true,
reporters: options.logToConsole
? [
...toArray(options.vitestConfig?.reporters ?? ['default']),
customReporter,
]
: [customReporter], // do not report to console
watch: true,
ui: true,
open: false,
api: {
port: PORT,
},
}
: { watch: false }
// Start Vitest
const promise = startVitest('test', [], defu(overrides, viteConfig.test), viteConfig)
promise.catch(() => process.exit(1))
if (watchMode) {
logger.info(`Vitest UI starting on ${URL}`)
nuxt.hook('close', () => promise.then(v => v?.close()))
await new Promise(resolve => setTimeout(resolve, 1000))
}
else {
promise.then(v => nuxt.close().then(() => v?.close()).then(() => process.exit()))
}
loaded = true
}
nuxt.hook('devtools:customTabs', (tabs) => {
const failedCount
= testFiles?.filter(f => f.result?.state === 'fail').length ?? 0
const passedCount
= testFiles?.filter(f => f.result?.state === 'pass').length ?? 0
const totalCount = testFiles?.length ?? 0
tabs.push({
title: 'Vitest',
name: 'vitest',
icon: 'logos-vitest',
view: loaded
? {
type: 'iframe',
src: URL,
}
: {
type: 'launch',
description: 'Start tests along with Nuxt',
actions: [
{
label: promise ? 'Starting...' : 'Start Vitest',
pending: !!promise,
handle: () => {
promise = promise || start()
return promise
},
},
],
},
extraTabVNode: totalCount
? h('div', { style: { color: failedCount ? 'orange' : 'green' } }, [
h('span', {}, passedCount),
h('span', { style: { opacity: '0.5', fontSize: '0.9em' } }, '/'),
h(
'span',
{ style: { opacity: '0.8', fontSize: '0.9em' } },
totalCount,
),
])
: undefined,
})
})
if (options.startOnBoot) {
promise = promise || start()
promise.then(updateTabs)
}
},
})
function toArray<T>(value: T | T[]): T[] {
return Array.isArray(value) ? value : [value]
}