yaoyao/tests/server/dashboardSupervisor.test.ts

import { describe, expect, it } from 'vitest'
import {
  DashboardSupervisor,
  DEFAULT_DASHBOARD_USERNAME,
} from '../../src/server/dashboardSupervisor.js'

function supervisor(overrides: {
  values?: Record<string, string>
  running?: boolean
  runningHost?: '127.0.0.1' | '0.0.0.0'
  allowLan?: boolean
  resolveLanProbeHost?: () => string | undefined
} = {}) {
  const values = { ...overrides.values }
  let running = overrides.running ?? false
  let runningHost = overrides.runningHost ?? '127.0.0.1'
  const lanProbeHost = '192.168.1.20'
  const calls: string[][] = []
  const launches: string[][] = []
  const instance = new DashboardSupervisor({
    allowLan: overrides.allowLan ?? false,
    lanProbeHost: overrides.resolveLanProbeHost ? undefined : lanProbeHost,
    resolveLanProbeHost: overrides.resolveLanProbeHost,
    run(args) {
      calls.push([...args])
      if (args[0] === 'config' && args[1] === 'get') return values[args[2]] ?? ''
      if (args[0] === 'config' && args[1] === 'set') {
        values[args[2]] = args[3]
        return ''
      }
      if (args[0] === 'dashboard' && args[1] === '--stop') {
        running = false
        return ''
      }
      return ''
    },
    launch(args) {
      launches.push([...args])
      running = true
      runningHost = args[2] as typeof runningHost
    },
    probe: async (host) => running && (
      host === '127.0.0.1'
      || (host === lanProbeHost && runningHost === '0.0.0.0')
    ),
    log: () => undefined,
  })
  return { instance, calls, launches, values }
}

describe('DashboardSupervisor', () => {
  it('configures the requested default credentials and starts an unavailable dashboard', async () => {
    const value = supervisor()
    await value.instance.checkNow()

    expect(value.values['dashboard.basic_auth.username']).toBe(DEFAULT_DASHBOARD_USERNAME)
    expect(value.values['dashboard.basic_auth.password_hash']).toMatch(/^scrypt\$16384\$8\$1\$/)
    expect(value.values['dashboard.basic_auth.secret']).toMatch(/.{32,}/)
    expect(value.launches).toEqual([['dashboard', '--host', '127.0.0.1', '--no-open']])
  })

  it('does not overwrite configured dashboard credentials', async () => {
    const value = supervisor({
      running: true,
      values: {
        'dashboard.basic_auth.username': 'operator',
        'dashboard.basic_auth.password_hash': 'scrypt$existing',
        'dashboard.basic_auth.secret': 'configured-secret',
      },
    })
    await value.instance.checkNow()

    expect(value.calls.filter((args) => args[1] === 'set')).toEqual([])
    expect(value.launches).toEqual([])
  })

  it('restarts a running dashboard after filling missing authentication and uses LAN binding when enabled', async () => {
    const value = supervisor({ running: true, allowLan: true })
    await value.instance.checkNow()

    expect(value.calls).toContainEqual(['dashboard', '--stop'])
    expect(value.launches).toEqual([['dashboard', '--host', '0.0.0.0', '--no-open']])
  })

  it('moves an authenticated loopback dashboard onto the LAN when managed installation requires it', async () => {
    const value = supervisor({
      running: true,
      runningHost: '127.0.0.1',
      allowLan: true,
      values: {
        'dashboard.basic_auth.username': 'operator',
        'dashboard.basic_auth.password_hash': 'scrypt$existing',
        'dashboard.basic_auth.secret': 'configured-secret',
      },
    })
    await value.instance.checkNow()

    expect(value.calls).toContainEqual(['dashboard', '--stop'])
    expect(value.launches).toEqual([['dashboard', '--host', '0.0.0.0', '--no-open']])
  })

  it('keeps an authenticated dashboard running when it already listens on the LAN', async () => {
    const value = supervisor({
      running: true,
      runningHost: '0.0.0.0',
      allowLan: true,
      values: {
        'dashboard.basic_auth.username': 'operator',
        'dashboard.basic_auth.password_hash': 'scrypt$existing',
        'dashboard.basic_auth.secret': 'configured-secret',
      },
    })
    await value.instance.checkNow()

    expect(value.calls).not.toContainEqual(['dashboard', '--stop'])
    expect(value.launches).toEqual([])
  })

  it('moves an authenticated LAN dashboard back to loopback when unmanaged LAN is requested', async () => {
    const value = supervisor({
      running: true,
      runningHost: '0.0.0.0',
      allowLan: false,
      values: {
        'dashboard.basic_auth.username': 'operator',
        'dashboard.basic_auth.password_hash': 'scrypt$existing',
        'dashboard.basic_auth.secret': 'configured-secret',
      },
    })
    await value.instance.checkNow()

    expect(value.calls).toContainEqual(['dashboard', '--stop'])
    expect(value.launches).toEqual([['dashboard', '--host', '127.0.0.1', '--no-open']])
  })

  it('rechecks LAN binding after the network interface becomes available', async () => {
    let networkReady = false
    const value = supervisor({
      running: true,
      runningHost: '127.0.0.1',
      allowLan: true,
      resolveLanProbeHost: () => networkReady ? '192.168.1.20' : undefined,
      values: {
        'dashboard.basic_auth.username': 'operator',
        'dashboard.basic_auth.password_hash': 'scrypt$existing',
        'dashboard.basic_auth.secret': 'configured-secret',
      },
    })

    await value.instance.checkNow()
    expect(value.launches).toEqual([])

    networkReady = true
    await value.instance.checkNow()
    expect(value.calls).toContainEqual(['dashboard', '--stop'])
    expect(value.launches).toEqual([['dashboard', '--host', '0.0.0.0', '--no-open']])
  })

  it('explicitly restarts a healthy dashboard and waits for 9119 to return', async () => {
    const value = supervisor({
      running: true,
      values: {
        'dashboard.basic_auth.username': 'operator',
        'dashboard.basic_auth.password_hash': 'scrypt$existing',
        'dashboard.basic_auth.secret': 'configured-secret',
      },
    })

    await value.instance.restart()

    expect(value.calls).toContainEqual(['dashboard', '--stop'])
    expect(value.launches).toEqual([['dashboard', '--host', '127.0.0.1', '--no-open']])
  })
})