upstream-tauri/packages/api-e2e/test/specs/tray.spec.ts

// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT

import { expect } from '@wdio/globals'
import { tauri, describeApi } from '../helpers/index.js'

// Tray commands are allowed by default, but a tray host is not always available
// in headless environments — set `E2E_SKIP=tray` there. The tray plugin is
// desktop-only, so the whole module is skipped on mobile.
describeApi('tray', { desktopOnly: true }, () => {
  it('creates a tray icon, looks it up and removes it', async () => {
    const created = await tauri(async (api) => {
      const icon = await api.app.defaultWindowIcon()
      const tray = await api.tray.TrayIcon.new({
        id: 'e2e-tray',
        icon: icon ?? undefined,
        tooltip: 'e2e tray'
      })
      return tray.id
    })
    expect(created).toBe('e2e-tray')

    const foundById = await tauri(async (api) => {
      const tray = await api.tray.TrayIcon.getById('e2e-tray')
      return tray !== null
    })
    expect(foundById).toBe(true)

    await tauri(async (api) => {
      const tray = await api.tray.TrayIcon.getById('e2e-tray')
      await tray?.setVisible(true)
      return null
    })

    const removed = await tauri(async (api) => {
      await api.tray.TrayIcon.removeById('e2e-tray')
      const tray = await api.tray.TrayIcon.getById('e2e-tray')
      return tray === null
    })
    expect(removed).toBe(true)
  })
})