forked from vuejs/test-utils
/
createInstance.ts
301 lines (271 loc) · 8.1 KB
/
createInstance.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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
import {
h,
createApp,
defineComponent,
reactive,
shallowReactive,
isRef,
AppConfig,
ComponentOptions,
ConcreteComponent,
DefineComponent
} from 'vue'
import { MountingOptions, Slot } from './types'
import {
isFunctionalComponent,
isObjectComponent,
mergeGlobalProperties
} from './utils'
import { processSlot } from './utils/compileSlots'
import { attachEmitListener } from './emit'
import { stubComponents, addToDoNotStubComponents, registerStub } from './stubs'
import {
isLegacyFunctionalComponent,
unwrapLegacyVueExtendComponent
} from './utils/vueCompatSupport'
const MOUNT_OPTIONS: Array<keyof MountingOptions<any>> = [
'attachTo',
'attrs',
'data',
'props',
'slots',
'global',
'shallow'
]
function getInstanceOptions(
options: MountingOptions<any> & Record<string, any>
): Record<string, any> {
if (options.methods) {
console.warn(
"Passing a `methods` option to mount was deprecated on Vue Test Utils v1, and it won't have any effect on v2. For additional info: https://vue-test-utils.vuejs.org/upgrading-to-v1/#setmethods-and-mountingoptions-methods"
)
delete options.methods
}
const resultOptions = { ...options }
for (const key of Object.keys(options)) {
if (MOUNT_OPTIONS.includes(key as keyof MountingOptions<any>)) {
delete resultOptions[key]
}
}
return resultOptions
}
// implementation
export function createInstance(
inputComponent: DefineComponent<{}, {}, any>,
options?: MountingOptions<any> & Record<string, any>
) {
// normalize the incoming component
const originalComponent = unwrapLegacyVueExtendComponent(inputComponent)
let component: ConcreteComponent
const instanceOptions = getInstanceOptions(options ?? {})
if (
isFunctionalComponent(originalComponent) ||
isLegacyFunctionalComponent(originalComponent)
) {
component = defineComponent({
compatConfig: {
MODE: 3,
INSTANCE_LISTENERS: false,
INSTANCE_ATTRS_CLASS_STYLE: false,
COMPONENT_FUNCTIONAL: isLegacyFunctionalComponent(originalComponent)
? 'suppress-warning'
: false
},
props: originalComponent.props || {},
setup:
(props, { attrs, slots }) =>
() =>
h(originalComponent, { ...props, ...attrs }, slots),
...instanceOptions
})
addToDoNotStubComponents(originalComponent)
} else if (isObjectComponent(originalComponent)) {
component = { ...originalComponent, ...instanceOptions }
} else {
component = originalComponent
}
addToDoNotStubComponents(component)
registerStub({ source: originalComponent, stub: component })
const el = document.createElement('div')
if (options?.attachTo) {
let to: Element | null
if (typeof options.attachTo === 'string') {
to = document.querySelector(options.attachTo)
if (!to) {
throw new Error(
`Unable to find the element matching the selector ${options.attachTo} given as the \`attachTo\` option`
)
}
} else {
to = options.attachTo
}
to.appendChild(el)
}
function slotToFunction(slot: Slot) {
switch (typeof slot) {
case 'function':
return slot
case 'object':
return () => h(slot)
case 'string':
return processSlot(slot)
default:
throw Error(`Invalid slot received.`)
}
}
// handle any slots passed via mounting options
const slots =
options?.slots &&
Object.entries(options.slots).reduce(
(
acc: { [key: string]: Function },
[name, slot]: [string, Slot]
): { [key: string]: Function } => {
if (Array.isArray(slot)) {
const normalized = slot.map(slotToFunction)
acc[name] = (args: unknown) => normalized.map((f) => f(args))
return acc
}
acc[name] = slotToFunction(slot)
return acc
},
{}
)
// override component data with mounting options data
if (options?.data) {
const providedData = options.data()
if (isObjectComponent(originalComponent)) {
// component is guaranteed to be the same type as originalComponent
const objectComponent = component as ComponentOptions
const originalDataFn = originalComponent.data || (() => ({}))
objectComponent.data = (vm) => ({
...originalDataFn.call(vm, vm),
...providedData
})
} else {
throw new Error(
'data() option is not supported on functional and class components'
)
}
}
const MOUNT_COMPONENT_REF = 'VTU_COMPONENT'
// we define props as reactive so that way when we update them with `setProps`
// Vue's reactivity system will cause a rerender.
const refs = shallowReactive<Record<string, unknown>>({})
const props = reactive<Record<string, unknown>>({})
Object.entries({
...options?.attrs,
...options?.propsData,
...options?.props,
ref: MOUNT_COMPONENT_REF
}).forEach(([k, v]) => {
if (isRef(v)) {
refs[k] = v
} else {
props[k] = v
}
})
const global = mergeGlobalProperties(options?.global)
if (isObjectComponent(component)) {
component.components = { ...component.components, ...global.components }
}
// create the wrapper component
const Parent = defineComponent({
name: 'VTU_ROOT',
render() {
return h(component as ComponentOptions, { ...props, ...refs }, slots)
}
})
// create the app
const app = createApp(Parent)
// the Parent type must not be stubbed
// but we can't add it directly, as createApp creates a copy
// and store it in app._component (since v3.2.32)
// So we store this one instead
addToDoNotStubComponents(app._component)
// add tracking for emitted events
// this must be done after `createApp`: https://github.com/vuejs/test-utils/issues/436
attachEmitListener()
// global mocks mixin
if (global?.mocks) {
const mixin = {
beforeCreate() {
for (const [k, v] of Object.entries(
global.mocks as { [key: string]: any }
)) {
;(this as any)[k] = v
}
}
}
app.mixin(mixin)
}
// AppConfig
if (global.config) {
for (const [k, v] of Object.entries(global.config) as [
keyof Omit<AppConfig, 'isNativeTag'>,
any
][]) {
app.config[k] = v
}
}
// use and plugins from mounting options
if (global.plugins) {
for (const plugin of global.plugins) {
if (Array.isArray(plugin)) {
app.use(plugin[0], ...plugin.slice(1))
continue
}
app.use(plugin)
}
}
// use any mixins from mounting options
if (global.mixins) {
for (const mixin of global.mixins) app.mixin(mixin)
}
if (global.components) {
for (const key of Object.keys(global.components)) {
// avoid registering components that are stubbed twice
if (!(key in global.stubs)) {
app.component(key, global.components[key])
}
}
}
if (global.directives) {
for (const key of Object.keys(global.directives))
app.directive(key, global.directives[key])
}
// provide any values passed via provides mounting option
if (global.provide) {
for (const key of Reflect.ownKeys(global.provide)) {
// @ts-ignore: https://github.com/microsoft/TypeScript/issues/1863
app.provide(key, global.provide[key])
}
}
// stubs
// even if we are using `mount`, we will still
// stub out Transition and Transition Group by default.
stubComponents(global.stubs, options?.shallow, global?.renderStubDefaultSlot)
// users expect stubs to work with globally registered
// components so we register stubs as global components to avoid
// warning about not being able to resolve component
//
// component implementation provided here will never be called
// but we need name to make sure that stubComponents will
// properly stub this later by matching stub name
//
// ref: https://github.com/vuejs/test-utils/issues/249
// ref: https://github.com/vuejs/test-utils/issues/425
if (global?.stubs) {
for (const name of Object.keys(global.stubs)) {
if (!app.component(name)) {
app.component(name, { name })
}
}
}
return {
app,
el,
props,
MOUNT_COMPONENT_REF
}
}