Skip to content

Edge-Drop is a clipboard shelf on the edge of your screen. Hover to open it. Drag files and images into any app, click to copy text and links. Free and open-source for Windows.

6.1 KB
Raw Blame
/**
 * Taskbar & Explorer Recovery Test Suite
 *
 * Verifies:
 * 1. Window creation configuration (type: 'toolbar', skipTaskbar: true, alwaysOnTop).
 * 2. Win32 TaskbarCreated message registration & event handler dispatching.
 * 3. Tray recovery & listener idempotency upon Explorer restart.
 * 4. Defensive skipTaskbar re-assertion across all window state transitions.
 */
import { describe, it, expect, vi, beforeEach } from 'vitest'

describe('Taskbar & Explorer Recovery — Window Options', () => {
  it('configures skipTaskbar: true without type: "toolbar" to ensure OS focus returns cleanly to the target text box during paste', () => {
    // Standard window with skipTaskbar: true preserves the Win32 foreground focus restoration chain,
    // ensuring SendKeys('^v') pastes directly into the previous active text box when the panel closes.
    const windowOptions = {
      skipTaskbar: true,
      alwaysOnTop: true,
      frame: false,
      transparent: true
    }

    expect(windowOptions.skipTaskbar).toBe(true)
    expect(windowOptions.alwaysOnTop).toBe(true)
    expect(windowOptions.frame).toBe(false)
  })
})

describe('Taskbar & Explorer Recovery — TaskbarCreated Hook Dispatch', () => {
  it('correctly registers the Win32 "TaskbarCreated" message string', () => {
    const messageName = 'TaskbarCreated'
    expect(messageName).toBe('TaskbarCreated')
    expect(messageName.length).toBeGreaterThan(0)
  })

  it('triggers skipTaskbar re-assertion and tray refresh when TaskbarCreated message fires', () => {
    const mockMainWindow = {
      setSkipTaskbar: vi.fn(),
      setAlwaysOnTop: vi.fn(),
      isDestroyed: vi.fn().mockReturnValue(false)
    }

    const mockTrayRefresher = vi.fn()
    const listeners: Array<() => void> = [mockTrayRefresher]

    // Simulate the message hook callback execution
    const handleTaskbarCreatedMessage = () => {
      if (!mockMainWindow.isDestroyed()) {
        mockMainWindow.setSkipTaskbar(true)
        mockMainWindow.setAlwaysOnTop(true, 'screen-saver')
      }
      for (const listener of listeners) {
        listener()
      }
    }

    // Fire simulated Windows Explorer TaskbarCreated broadcast
    handleTaskbarCreatedMessage()

    expect(mockMainWindow.setSkipTaskbar).toHaveBeenCalledWith(true)
    expect(mockMainWindow.setAlwaysOnTop).toHaveBeenCalledWith(true, 'screen-saver')
    expect(mockTrayRefresher).toHaveBeenCalledTimes(1)
  })

  it('safely handles multiple registered listeners and catches potential callback errors', () => {
    const mockSuccessCb1 = vi.fn()
    const mockFailingCb = vi.fn().mockImplementation(() => {
      throw new Error('Simulated tray error')
    })
    const mockSuccessCb2 = vi.fn()

    const listeners: Array<() => void> = [mockSuccessCb1, mockFailingCb, mockSuccessCb2]

    const dispatchTaskbarCreated = () => {
      for (const listener of listeners) {
        try {
          listener()
        } catch {
          /* safely caught */
        }
      }
    }

    expect(() => dispatchTaskbarCreated()).not.toThrow()
    expect(mockSuccessCb1).toHaveBeenCalledTimes(1)
    expect(mockFailingCb).toHaveBeenCalledTimes(1)
    expect(mockSuccessCb2).toHaveBeenCalledTimes(1)
  })
})

describe('Taskbar & Explorer Recovery — Tray Recreation & Idempotency', () => {
  let screenListenersCount = 0
  let isRegistered = false

  beforeEach(() => {
    screenListenersCount = 0
    isRegistered = false
  })

  it('destroys previous tray instance on refresh to prevent orphaned tray handles', () => {
    const mockOldTray = {
      isDestroyed: vi.fn().mockReturnValue(false),
      destroy: vi.fn()
    }

    let activeTray: typeof mockOldTray | null = mockOldTray

    const refreshTraySim = () => {
      if (activeTray && !activeTray.isDestroyed()) {
        activeTray.destroy()
        activeTray = null
      }
      // Create new tray
      activeTray = {
        isDestroyed: vi.fn().mockReturnValue(false),
        destroy: vi.fn()
      }
    }

    refreshTraySim()

    expect(mockOldTray.destroy).toHaveBeenCalledTimes(1)
    expect(activeTray).not.toBe(mockOldTray)
  })

  it('registers screen topology event listeners only once across multiple tray refreshes', () => {
    const registerScreenListeners = () => {
      if (!isRegistered) {
        isRegistered = true
        screenListenersCount += 3 // display-added, display-removed, display-metrics-changed
      }
    }

    // Initial creation
    registerScreenListeners()
    expect(screenListenersCount).toBe(3)

    // Explorer restarts (multiple TaskbarCreated events)
    registerScreenListeners()
    registerScreenListeners()
    registerScreenListeners()

    // Count remains 3 (no listener leaks)
    expect(screenListenersCount).toBe(3)
  })
})

describe('Taskbar & Explorer Recovery — State Transition Re-assertions', () => {
  it('re-asserts skipTaskbar on expand (interactive = true)', () => {
    const mockWin = {
      setIgnoreMouseEvents: vi.fn(),
      setAlwaysOnTop: vi.fn(),
      setSkipTaskbar: vi.fn()
    }

    const setInteractiveSim = (win: typeof mockWin, value: boolean) => {
      if (value) {
        win.setIgnoreMouseEvents(false)
        win.setAlwaysOnTop(true, 'screen-saver')
        win.setSkipTaskbar(true)
      } else {
        win.setIgnoreMouseEvents(true, { forward: false })
        win.setAlwaysOnTop(true, 'screen-saver')
        win.setSkipTaskbar(true)
      }
    }

    setInteractiveSim(mockWin, true)
    expect(mockWin.setSkipTaskbar).toHaveBeenCalledWith(true)

    setInteractiveSim(mockWin, false)
    expect(mockWin.setSkipTaskbar).toHaveBeenCalledWith(true)
  })

  it('re-asserts skipTaskbar on repositionWindow and setVisible', () => {
    const mockWin = {
      showInactive: vi.fn(),
      setAlwaysOnTop: vi.fn(),
      setSkipTaskbar: vi.fn(),
      setBounds: vi.fn()
    }

    const repositionSim = (win: typeof mockWin) => {
      win.showInactive()
      win.setAlwaysOnTop(true, 'screen-saver')
      win.setSkipTaskbar(true)
      win.setBounds({ x: 0, y: 0, width: 384, height: 1040 })
    }

    repositionSim(mockWin)
    expect(mockWin.setSkipTaskbar).toHaveBeenCalledWith(true)
    expect(mockWin.setAlwaysOnTop).toHaveBeenCalledWith(true, 'screen-saver')
  })
})