fix: allow finding async component stubs by definition

Author: xanf

src/vnodeTransformers/stubComponentsTransformer.ts

@@ -11,8 +11,8 @@ import {
   ConcreteComponent,
   ComponentPropsOptions,
   ComponentObjectPropsOptions,
-  DefineComponent,
-  Component
+  Component,
+  ComponentOptions
 } from 'vue'
 import { hyphenate } from '../utils/vueShared'
 import { matchName } from '../utils/matchName'
@@ -28,6 +28,7 @@ import { registerStub } from '../stubs'
 export type CustomCreateStub = (params: {
   name: string
   component: ConcreteComponent
+  registerStub: (config: { source: Component; stub: Component }) => void
 }) => ConcreteComponent
 
 interface StubOptions {
@@ -54,15 +55,15 @@ export const createStub = ({
   name,
   type,
   renderStubDefaultSlot
-}: StubOptions): DefineComponent => {
+}: StubOptions) => {
   const anonName = 'anonymous-stub'
   const tag = name ? `${hyphenate(name)}-stub` : anonName
 
   const componentOptions = type
     ? unwrapLegacyVueExtendComponent(type) || {}
     : {}
 
-  return defineComponent({
+  const stub = defineComponent({
     name: name || anonName,
     props: (componentOptions as ConcreteComponent).props || {},
     // fix #1550 - respect old-style v-model for shallow mounted components with @vue/compat
@@ -84,6 +85,18 @@ export const createStub = ({
       }
     }
   })
+
+  const { __asyncLoader: asyncLoader } = type as ComponentOptions
+  if (asyncLoader) {
+    asyncLoader().then(() => {
+      registerStub({
+        source: (type as ComponentOptions).__asyncResolved,
+        stub
+      })
+    })
+  }
+
+  return stub
 }
 
 const resolveComponentStubByName = (
@@ -230,7 +243,8 @@ export function createStubComponentsTransformer({
       return (
         config.plugins.createStubs?.({
           name: stubName,
-          component: type
+          component: type,
+          registerStub
         }) ??
         createStub({
           name: stubName,

tests/features/async-components.spec.ts

@@ -1,6 +1,7 @@
 import { afterAll, beforeAll, describe, expect, it, vi } from 'vitest'
 import { defineAsyncComponent, defineComponent, h, AppConfig } from 'vue'
-import { mount, flushPromises } from '../../src'
+import { mount, shallowMount, flushPromises } from '../../src'
+import Hello from '../components/Hello.vue'
 
 const config: Partial<AppConfig> = {
   errorHandler: (error: unknown) => {
@@ -108,4 +109,38 @@ describe('defineAsyncComponent', () => {
     await vi.dynamicImportSettled()
     expect(wrapper.html()).toContain('Hello world')
   })
+
+  it('finds Async Component by async definition when using shallow mount', async () => {
+    const AsyncHello = defineAsyncComponent(
+      () => import('../components/Hello.vue')
+    )
+
+    const Comp = defineComponent({
+      render() {
+        return h(AsyncHello)
+      }
+    })
+
+    const wrapper = shallowMount(Comp)
+    await flushPromises()
+    await vi.dynamicImportSettled()
+    expect(wrapper.findComponent(AsyncHello).exists()).toBe(true)
+  })
+
+  it('finds Async Component by definition when using shallow mount', async () => {
+    const AsyncHello = defineAsyncComponent(
+      () => import('../components/Hello.vue')
+    )
+
+    const Comp = defineComponent({
+      render() {
+        return h(AsyncHello)
+      }
+    })
+
+    const wrapper = shallowMount(Comp)
+    await flushPromises()
+    await vi.dynamicImportSettled()
+    expect(wrapper.findComponent(Hello).exists()).toBe(true)
+  })
 })

tests/features/plugins.spec.ts

@@ -8,7 +8,6 @@ import {
   vi
 } from 'vitest'
 import { ComponentPublicInstance, h } from 'vue'
-
 import { mount, config, VueWrapper } from '../../src'
 
 declare module '../../src/vueWrapper' {
@@ -145,11 +144,13 @@ describe('createStubs', () => {
     expect(customCreateStub).toHaveBeenCalledTimes(2)
     expect(customCreateStub).toHaveBeenCalledWith({
       name: 'child1',
-      component: Child1
+      component: Child1,
+      registerStub: expect.any(Function)
     })
     expect(customCreateStub).toHaveBeenCalledWith({
       name: 'child2',
-      component: Child2
+      component: Child2,
+      registerStub: expect.any(Function)
     })
   })
 
@@ -173,7 +174,8 @@ describe('createStubs', () => {
     expect(customCreateStub).toHaveBeenCalledTimes(1)
     expect(customCreateStub).toHaveBeenCalledWith({
       name: 'child2',
-      component: Child2
+      component: Child2,
+      registerStub: expect.any(Function)
     })
   })
 
@@ -212,7 +214,8 @@ describe('createStubs', () => {
     expect(customCreateStub).toHaveBeenCalledTimes(1)
     expect(customCreateStub).toHaveBeenCalledWith({
       name: 'child1',
-      component: Child1
+      component: Child1,
+      registerStub: expect.any(Function)
     })
   })
 })

tests/mountingOptions/global.stubs.spec.ts

@@ -679,16 +679,16 @@ describe('mounting options: stubs', () => {
   })
 
   describe('stub async component', () => {
-    const AsyncComponent = defineAsyncComponent(async () => ({
-      name: 'AsyncComponent',
-      template: '<span>AsyncComponent</span>'
-    }))
-
     const AsyncComponentWithoutName = defineAsyncComponent(async () => ({
       template: '<span>AsyncComponent</span>'
     }))
 
     it('stubs async component with name', async () => {
+      const AsyncComponent = defineAsyncComponent(async () => ({
+        name: 'AsyncComponent',
+        template: '<span>AsyncComponent</span>'
+      }))
+
       const TestComponent = defineComponent({
         components: {
           MyComponent: AsyncComponent
@@ -716,6 +716,11 @@ describe('mounting options: stubs', () => {
     })
 
     it('stubs async component with name by alias', () => {
+      const AsyncComponent = defineAsyncComponent(async () => ({
+        name: 'AsyncComponent',
+        template: '<span>AsyncComponent</span>'
+      }))
+
       const TestComponent = defineComponent({
         components: {
           MyComponent: AsyncComponent