Skip to content

fix(toast): 修复清除toast时未正确卸载组件 #3311

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.

Sign up for GitHub

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

Open
betterhyq wants to merge 2 commits into
base: v4
Choose a base branch
from
+123 −10
Open

fix(toast): 修复清除toast时未正确卸载组件 #3311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f70f2ae
fix(toast): 修复清除toast时未正确卸载组件
betterhyq Feb 3, 2026
81046cd
test(toast): 增加清除toast时的unmount测试用例
betterhyq Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 114 additions & 1 deletion src/packages/__VUE/toast/__tests__/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
import { mount } from '@vue/test-utils'
import { nextTick } from 'vue'
import { Toast } from '@nutui/nutui'
import Toast, { showToast } from '../index'
import * as CreateUtils from '@/packages/utils/create'

describe('component toast', () => {
// 每个测试后清理所有 toast
afterEach(() => {
showToast.hide()
})

test('should render toast after using msg and id', async () => {
const wrapper = mount(Toast, {
props: {
Expand Down Expand Up @@ -64,4 +70,111 @@ describe('component toast', () => {
const toast: any = wrapper.find('.custom')
expect(toast.exists()).toBe(true)
})

test('should call unmount when clearing single toast', async () => {
// Mock CreateComponent 来追踪 unmount 调用
const unmountSpy = vi.fn()
const originalCreateComponent = CreateUtils.CreateComponent
let actualElementId = ''

const mockUnmount = vi.fn(() => {
unmountSpy()
// 移除实际的 DOM 元素
const element = document.getElementById(actualElementId)
if (element) {
element.parentNode?.removeChild(element)
}
})

vi.spyOn(CreateUtils, 'CreateComponent').mockImplementation((opts: any, component: any) => {
const result = originalCreateComponent(opts, component)
// 捕获实际创建的元素 id
actualElementId = result.instance.$el?.parentElement?.id || ''
return {
...result,
unmount: mockUnmount
}
})

// 创建 toast
showToast.success('Test message', { id: 'test-unmount-single', duration: 0 })
await nextTick()

// 验证 DOM 元素存在
const toastElement = document.getElementById(actualElementId)
expect(toastElement).toBeTruthy()

// 清除 toast
showToast.hide('test-unmount-single')
await nextTick()

// 验证 unmount 被调用
expect(mockUnmount).toHaveBeenCalled()

// 恢复原始实现
vi.restoreAllMocks()
})

test('should call unmount for all toasts when clearing all', async () => {
const unmountSpies: any[] = []
const originalCreateComponent = CreateUtils.CreateComponent

// Mock CreateComponent
vi.spyOn(CreateUtils, 'CreateComponent').mockImplementation((opts: any, component: any) => {
const result = originalCreateComponent(opts, component)
const elementId = result.instance.$el?.parentElement?.id || ''
const spy = vi.fn(() => {
// 移除对应的 DOM 元素
const element = document.getElementById(elementId)
if (element) {
element.parentNode?.removeChild(element)
}
})
unmountSpies.push(spy)
return {
...result,
unmount: spy
}
})

// 创建多个 toast
showToast.success('Toast 1', { id: 'test-1', duration: 0 })
showToast.success('Toast 2', { id: 'test-2', duration: 0 })
showToast.success('Toast 3', { id: 'test-3', duration: 0 })
await nextTick()

// 验证创建了 3 个 toast
expect(unmountSpies.length).toBe(3)

// 清除所有 toast
showToast.hide()
await nextTick()

// 验证所有 unmount 都被调用
unmountSpies.forEach((spy) => {
expect(spy).toHaveBeenCalled()
})

// 恢复原始实现
vi.restoreAllMocks()
})

test('should properly clean up DOM when toast is cleared', async () => {
// 创建 toast
showToast.success('Test cleanup', { id: 'test-cleanup', duration: 0 })
await nextTick()

// 验证 DOM 存在 - 查找包含 test-cleanup 的元素
let toastElements = document.querySelectorAll('[id*="test-cleanup"]')
expect(toastElements.length).toBeGreaterThan(0)

// 清除 toast
showToast.hide('test-cleanup')
await nextTick()
await new Promise(resolve => setTimeout(resolve, 100))

// 验证 DOM 已被清除
toastElements = document.querySelectorAll('[id*="test-cleanup"]')
expect(toastElements.length).toBe(0)
})
})
18 changes: 9 additions & 9 deletions src/packages/__VUE/toast/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,16 @@ let idsMap: string[] = []
let optsMap: any[] = []
const clearToast = (id?: string) => {
if (id) {
const container = document.getElementById(id)
const opts = optsMap.find(item => item.id === id)
if (opts && opts._unmount) {
opts._unmount()
}
optsMap = optsMap.filter(item => item.id !== id)
idsMap = idsMap.filter(item => item !== id)
if (container) {
document.body.removeChild(container)
}
} else {
idsMap.forEach((item) => {
const container = document.getElementById(item)
if (container) {
document.body.removeChild(container)
optsMap.forEach((opts) => {
if (opts._unmount) {
opts._unmount()
}
})
optsMap = []
Expand Down Expand Up @@ -78,9 +77,10 @@ const mountToast = (opts: any) => {
idsMap.push(opts.id)
optsMap.push(opts)

CreateComponent(opts, {
const { unmount } = CreateComponent(opts, {
wrapper: Toast
})
opts._unmount = unmount

return showToast
}
Expand Down