element-plus/packages/components/message/__tests__/message.test.ts

import { h, nextTick } from 'vue'
import { describe, expect, test, vi } from 'vitest'
import makeMount from '@element-plus/test-utils/make-mount'
import { rAF } from '@element-plus/test-utils/tick'
import { TypeComponentsMap } from '@element-plus/utils'
import { EVENT_CODE } from '@element-plus/constants'
import Message from '../src/message.vue'
import { messageTypes } from '../src/message'

import type { CSSProperties, Component, ComponentPublicInstance } from 'vue'

const AXIOM = 'Rem is the best girl'

type MessageInstance = ComponentPublicInstance<{
  visible: boolean
  iconComponent: string | Component
  customStyle: CSSProperties
  placement?: 'top' | 'bottom'
  offset: number
}>

const onClose = vi.fn()
const _mount = makeMount(Message, {
  props: {
    onClose,
  },
})

describe('Message.vue', () => {
  describe('render', () => {
    test('basic render test', () => {
      const wrapper = _mount({
        slots: {
          default: AXIOM,
        },
      })

      const vm = wrapper.vm as MessageInstance

      expect(wrapper.text()).toEqual(AXIOM)
      expect(vm.visible).toBe(true)
      expect(vm.iconComponent).toBe(TypeComponentsMap['info'])
      expect(vm.customStyle).toEqual({ top: '16px', zIndex: 2001 })
    })

    test('should be able to render VNode', () => {
      const wrapper = _mount({
        slots: {
          default: h('span', { class: 'text-node' }, AXIOM),
        },
      })

      expect(wrapper.find('.text-node').exists()).toBe(true)
    })

    test('should be able to render raw HTML with dangerouslyUseHTMLString prop', () => {
      const tagClass = 'test-class'
      const wrapper = _mount({
        props: {
          dangerouslyUseHTMLString: true,
          message: `<strong class="${tagClass}"'>${AXIOM}</strong>`,
        },
      })

      expect(wrapper.find(`.${tagClass}`).exists()).toBe(true)
    })

    test('should not be able to render raw HTML without dangerouslyUseHTMLString prop', () => {
      const tagClass = 'test-class'
      const wrapper = _mount({
        props: {
          dangerouslyUseHTMLString: false,
          message: `<strong class="${tagClass}"'>${AXIOM}</strong>`,
        },
      })

      expect(wrapper.find(`.${tagClass}`).exists()).toBe(false)
    })
  })

  describe('Message.type', () => {
    test('should be able to render typed messages', () => {
      for (const type of messageTypes) {
        const wrapper = _mount({ props: { type } })

        expect(wrapper.findComponent(TypeComponentsMap[type]).exists()).toBe(
          true
        )
      }
    })

    test('should not be able to render invalid type icon', () => {
      const consoleWarn = console.warn
      console.warn = vi.fn()
      const type = 'some-type'
      const wrapper = _mount({ props: { type } })

      for (const component of Object.values(TypeComponentsMap)) {
        expect(wrapper.findComponent(component).exists()).toBe(false)
      }
      console.warn = consoleWarn
    })
  })

  describe('event handlers', () => {
    test('it should be able to close the message by clicking close button', async () => {
      const onClose = vi.fn()
      const wrapper = _mount({
        slots: { default: AXIOM },
        props: {
          onClose,
          showClose: true,
        },
      })

      const closeBtn = wrapper.find('.el-message__closeBtn')
      expect(closeBtn.exists()).toBe(true)
      await closeBtn.trigger('click')
      expect((wrapper.vm as MessageInstance).visible).toBe(false)
    })

    test('it should close after duration', async () => {
      vi.useFakeTimers()
      const duration = 1000
      const wrapper = _mount({ props: { duration } })
      const vm = wrapper.vm as MessageInstance
      await nextTick()
      expect(vm.visible).toBe(true)
      vi.runAllTimers()
      await nextTick()
      expect(vm.visible).toBe(false)
      vi.useRealTimers()
    })

    test('it should prevent close when hovered', async () => {
      vi.useFakeTimers()
      const duration = 1000
      const wrapper = _mount({ props: { duration } })
      const vm = wrapper.vm as MessageInstance
      vi.advanceTimersByTime(50)
      expect(vm.visible).toBe(true)
      await wrapper.find('[role="alert"]').trigger('mouseenter')
      vi.runAllTimers()
      expect(vm.visible).toBe(true)
      await wrapper.find('[role="alert"]').trigger('mouseleave')
      expect(vm.visible).toBe(true)
      vi.runAllTimers()
      expect(vm.visible).toBe(false)
      vi.useRealTimers()
    })

    test('it should not close when duration is set to 0', () => {
      vi.useFakeTimers()
      const duration = 0
      const wrapper = _mount({ props: { duration } })
      const vm = wrapper.vm as MessageInstance
      expect(vm.visible).toBe(true)
      vi.runAllTimers()
      expect(vm.visible).toBe(true)
      vi.useRealTimers()
    })

    test('it should close when esc is pressed', async () => {
      const wrapper = _mount({ slots: { default: AXIOM } })

      const event = new KeyboardEvent('keydown', {
        code: EVENT_CODE.esc,
      })
      document.dispatchEvent(event)

      expect((wrapper.vm as MessageInstance).visible).toBe(false)
    })

    test('it should call close after transition ends', async () => {
      const onClose = vi.fn()
      const wrapper = _mount({
        slots: { default: AXIOM },
        props: { onClose },
      })
      await rAF()
      const vm = wrapper.vm as MessageInstance
      vm.visible = false
      await rAF()

      expect(onClose).toHaveBeenCalledTimes(1)
    })
  })

  describe('placement', () => {
    test('should render with top placement by default', () => {
      const wrapper = _mount({
        slots: { default: AXIOM },
      })
      const vm = wrapper.vm as MessageInstance
      expect(vm.customStyle).toHaveProperty('top', '16px')
      expect(wrapper.classes()).not.toContain('is-bottom')
    })

    test('should render with top-left placement', () => {
      const wrapper = _mount({
        slots: { default: AXIOM },
        props: {
          placement: 'top-left',
        },
      })
      const vm = wrapper.vm as MessageInstance
      expect(vm.customStyle).toHaveProperty('top', '16px')
      expect(vm.placement).toBe('top-left')
    })

    test('should render with top-right placement', () => {
      const wrapper = _mount({
        slots: { default: AXIOM },
        props: {
          placement: 'top-right',
        },
      })
      const vm = wrapper.vm as MessageInstance
      expect(vm.customStyle).toHaveProperty('top', '16px')
      expect(vm.placement).toBe('top-right')
    })

    test('should render with bottom placement', () => {
      const wrapper = _mount({
        slots: { default: AXIOM },
        props: {
          placement: 'bottom',
        },
      })
      const vm = wrapper.vm as MessageInstance
      expect(vm.customStyle).toHaveProperty('bottom', '16px')
      expect(wrapper.classes()).toContain('is-bottom')
    })

    test('should render with bottom-left placement', () => {
      const wrapper = _mount({
        slots: { default: AXIOM },
        props: {
          placement: 'bottom-left',
        },
      })
      const vm = wrapper.vm as MessageInstance
      expect(vm.customStyle).toHaveProperty('bottom', '16px')
      expect(vm.placement).toBe('bottom-left')
      expect(wrapper.classes()).toContain('is-bottom')
    })

    test('should render with bottom-right placement', () => {
      const wrapper = _mount({
        slots: { default: AXIOM },
        props: {
          placement: 'bottom-right',
        },
      })
      const vm = wrapper.vm as MessageInstance
      expect(vm.customStyle).toHaveProperty('bottom', '16px')
      expect(vm.placement).toBe('bottom-right')
      expect(wrapper.classes()).toContain('is-bottom')
    })
  })
})