element-plus/packages/hooks/__tests__/use-deprecated.test.ts

import { computed, defineComponent, nextTick } from 'vue'
import { mount } from '@vue/test-utils'
import { afterEach, describe, expect, it, vi } from 'vitest'
import { debugWarn } from '@element-plus/utils'
import { useDeprecated } from '../use-deprecated'

const AXIOM = 'Rem is the best girl'

vi.mock('@element-plus/utils/error', async () => {
  return {
    ...(await vi.importActual<any>('@element-plus/utils/error')),
    debugWarn: vi.fn(),
  }
})

const DummyComponent = defineComponent({
  props: {
    shouldWarn: Boolean,
  },
  setup(props) {
    useDeprecated(
      {
        from: 'oldApi',
        replacement: 'newApi',
        scope: 'dummyComponent',
        version: 'some version',
        ref: '',
      },
      computed(() => props.shouldWarn)
    )
    return () => AXIOM
  },
})

describe('useDeprecated', () => {
  afterEach(() => {
    vi.restoreAllMocks()
  })

  it('should warn when condition is true', async () => {
    mount(DummyComponent, {
      props: {
        shouldWarn: true,
      },
    })
    await nextTick()
    expect(debugWarn).toHaveBeenCalled()
  })

  it('should not warn when condition is false', async () => {
    mount(DummyComponent)
    await nextTick()
    expect(debugWarn).not.toHaveBeenCalled()
  })
})