@switchbot/homebridge-switchbot 5.0.0-beta.12 → 5.0.0-beta.121

package/test/matter-integration.spec.ts

@@ -0,0 +1,136 @@
+import { describe, expect, it } from 'vitest'
+
+import SwitchBotHAPPlatform, { SwitchBotMatterPlatform } from '../src/platform'
+import { makeFakeApiWithMatter, makeFakeApiWithoutMatter, makeFakeMatterApi } from './helpers/matter-harness'
+
+// Expanded Matter integration harness tests
+
+describe('matter integration harness', () => {
+  it('normalizes Color Bulb and Motion Sensor to Matter-supported categories', async () => {
+    const matterApi = makeFakeMatterApi()
+    const api = makeFakeApiWithMatter(matterApi)
+
+    const platform = new SwitchBotMatterPlatform(console as any, {
+      devices: [
+        { id: 'cb-1', type: 'Color Bulb', name: 'Color Bulb 1' },
+        { id: 'ms-1', type: 'Motion Sensor', name: 'Motion Sensor 1' },
+      ],
+      enableMatter: true,
+      preferMatter: true,
+    } as any, api as any)
+
+    await (platform as any).registerMatterAccessories()
+
+    const regs = matterApi.getRegistered()
+    expect(regs.length).toBeGreaterThanOrEqual(2)
+    const ids = regs.map((r: any) => r?.context?.deviceId)
+    expect(ids).toContain('cb-1')
+    expect(ids).toContain('ms-1')
+  })
+
+  it('uses conformant window covering type for curtain Matter registration', async () => {
+    const matterApi = makeFakeMatterApi()
+    const api = makeFakeApiWithMatter(matterApi)
+
+    const platform = new SwitchBotMatterPlatform(console as any, {
+      devices: [{ id: 'curtain-1', type: 'curtain', name: 'Curtain 1' }],
+      enableMatter: true,
+      preferMatter: true,
+    } as any, api as any)
+
+    await (platform as any).registerMatterAccessories()
+
+    const regs = matterApi.getRegistered()
+    expect(regs.length).toBeGreaterThanOrEqual(1)
+    const wcType = regs[0]?.clusters?.windowCovering?.type
+    expect(wcType).toBe(0) // 0 = RollerShade (default for standard lift-only curtains)
+  })
+
+  it('registers RGBIC Neon Wire Rope Light as lightstrip with conformant ColorControl defaults', async () => {
+    const matterApi = makeFakeMatterApi()
+    const api = makeFakeApiWithMatter(matterApi)
+
+    const platform = new SwitchBotMatterPlatform(console as any, {
+      devices: [{ id: 'neon-1', type: 'RGBIC Neon Wire Rope Light', name: 'Family Room Neon Wire Rope Light' }],
+      enableMatter: true,
+      preferMatter: true,
+    } as any, api as any)
+
+    await (platform as any).registerMatterAccessories()
+
+    const regs = matterApi.getRegistered()
+    expect(regs.length).toBeGreaterThanOrEqual(1)
+    const neon = regs.find((r: any) => r?.context?.deviceId === 'neon-1')
+    expect(neon).toBeDefined()
+    expect(neon?.context?.type).toBe('lightstrip')
+    expect(neon?.clusters?.colorControl).toBeDefined()
+    expect(neon?.clusters?.colorControl?.colorMode).toBe(0)
+  })
+
+  it('registers Matter accessories when Matter API available', async () => {
+    // Instantiate the real Matter platform directly to test its registration path
+    const matterApi = makeFakeMatterApi()
+    const api = makeFakeApiWithMatter(matterApi)
+
+    const platform = new SwitchBotMatterPlatform(console as any, { devices: [{ id: 'm-1', type: 'light', name: 'L1' }], enableMatter: true, preferMatter: true } as any, api as any)
+
+    // Call register path directly
+    if (typeof (platform as any).registerMatterAccessories === 'function') {
+      await (platform as any).registerMatterAccessories()
+    } else if (typeof (platform as any).loadDevices === 'function') {
+      await (platform as any).loadDevices()
+    }
+
+    const regs = matterApi.getRegistered()
+    expect(regs.length).toBeGreaterThanOrEqual(1)
+    // The platform registers serialized accessories; ensure deviceId is present in context
+    expect(regs[0]).toHaveProperty('context')
+    expect(regs[0].context).toHaveProperty('deviceId', 'm-1')
+  })
+
+  it('falls back to HAP when Matter API unavailable', async () => {
+    // Directly instantiate the HAP platform to exercise HAP fallback
+    const api = makeFakeApiWithoutMatter()
+    const platform = new SwitchBotHAPPlatform(console as any, { devices: [{ id: 'h-1', type: 'light', name: 'H1' }], enableMatter: true, preferMatter: true } as any, api as any)
+
+    // call loadDevices for HAP flow
+    if (typeof (platform as any).loadDevices === 'function') {
+      await (platform as any).loadDevices()
+    }
+
+    // Platform should have an accessories map populated
+    const accMap = (platform as any).accessories
+    expect(accMap).toBeDefined()
+    const keys = [...accMap.keys()]
+    expect(keys.length).toBeGreaterThanOrEqual(1)
+  })
+
+  it('reuses restored Matter accessories instead of registering duplicates', async () => {
+    const matterApi = makeFakeMatterApi()
+    const api = makeFakeApiWithMatter(matterApi)
+
+    const platform = new SwitchBotMatterPlatform(console as any, { devices: [{ id: 'r-1', type: 'light', name: 'R1' }], enableMatter: true, preferMatter: true } as any, api as any)
+
+    // Simulate a restored accessory present before registration
+    const restored = { uuid: matterApi.uuid.generate('r-1'), displayName: 'Restored R1', context: { deviceId: 'r-1' } }
+    if (typeof (platform as any).configureMatterAccessory === 'function') {
+      await (platform as any).configureMatterAccessory(restored)
+    } else if (typeof (platform as any).configureAccessory === 'function') {
+      await (platform as any).configureAccessory(restored)
+    }
+
+    // Now call register path
+    if (typeof (platform as any).registerMatterAccessories === 'function') {
+      await (platform as any).registerMatterAccessories()
+    } else if (typeof (platform as any).loadDevices === 'function') {
+      await (platform as any).loadDevices()
+      if (typeof (platform as any).registerMatterAccessories === 'function') {
+        await (platform as any).registerMatterAccessories()
+      }
+    }
+
+    const accs = (platform as any).accessories
+    const found = [...accs.values()].some((a: any) => a && (a.uuid === restored.uuid || a.UUID === restored.uuid))
+    expect(found).toBeTruthy()
+  })
+})

package/test/platform.integration.spec.ts

@@ -0,0 +1,55 @@
+import { describe, it, expect } from 'vitest'
+import { SwitchBotHAPPlatform } from '../src/platform'
+
+// Minimal mock logger
+const log = {
+  info: () => {},
+  warn: () => {},
+  error: () => {},
+  debug: () => {},
+}
+
+describe('platform integration (HAP)', () => {
+  it('registers HAP accessories using Homebridge API', async () => {
+    const registered: any[] = []
+
+    // Minimal hap stub
+    const hap = {
+      uuid: { generate: (s: string) => `uuid-${s}` },
+      Service: { Switch: 'Switch', Lightbulb: 'Lightbulb' },
+      Characteristic: { On: 'On', Brightness: 'Brightness' },
+    }
+
+    // Simple platformAccessory constructor
+    function PlatformAccessory(name: string, uuid: string) {
+      this.displayName = name
+      this.UUID = uuid
+      this.services = []
+      this.getService = (type: any) => this.services.find((s: any) => s.type === type)
+      this.addService = (type: any) => {
+        const s: any = { type, characteristics: {} }
+        this.services.push(s)
+        return s
+      }
+    }
+
+    const api: any = {
+      hap,
+      platformAccessory: PlatformAccessory as any,
+      registerPlatformAccessories: (_p: string, _n: string, accs: any[]) => registered.push(...accs),
+      on: (_ev: string, cb: Function) => { /* do not auto-run */ },
+    }
+
+    const config: any = { devices: [{ id: 'dev1', type: 'light', name: 'L1' }] }
+
+    const platform = new SwitchBotHAPPlatform(log as any, config, api)
+
+    // call loadDevices directly to control flow
+    await (platform as any).loadDevices()
+
+    // Expect accessory created and registered
+    expect(registered.length).toBeGreaterThanOrEqual(1)
+    const keys = Array.from((platform as any).accessories.keys())
+    expect(keys.some((k: string) => k.includes('dev1'))).toBeTruthy()
+  })
+})

package/test/switchbot-client-debounce.spec.ts

@@ -0,0 +1,131 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
+import { SwitchBotClient } from '../src/switchbotClient'
+
+describe('SwitchBotClient debounce/coalesce', () => {
+  let origFetch: any
+
+  beforeEach(() => {
+    origFetch = (global as any).fetch
+    vi.useFakeTimers()
+  })
+
+  afterEach(() => {
+    (global as any).fetch = origFetch
+    vi.restoreAllMocks()
+    vi.useRealTimers()
+  })
+
+  it('coalesces rapid writes for the same device (last write wins)', async () => {
+    const respBody = { status: 'ok' }
+    const fetchMock = vi.fn(async (url: string, opts: any) => ({ json: async () => respBody }))
+    ;(global as any).fetch = fetchMock
+
+    // Set a short debounce in config to keep the test fast
+    const c = new SwitchBotClient({ openApiToken: 't', writeDebounceMs: 10 } as any)
+    await c.init()
+
+    const body1 = { command: 'one' }
+    const body2 = { command: 'two' }
+
+    const p1 = c.setDeviceState('d-debounce', body1)
+    const p2 = c.setDeviceState('d-debounce', body2)
+
+    // Fast-forward timers past debounce window
+    vi.advanceTimersByTime(20)
+    // Allow pending microtasks to resolve
+    await Promise.resolve()
+    await Promise.resolve()
+
+    const [r1, r2] = await Promise.all([p1, p2])
+    expect(r1).toEqual(respBody)
+    expect(r2).toEqual(respBody)
+
+    // Only one network call should have been made
+    expect(fetchMock).toHaveBeenCalledTimes(1)
+    const calledBody = JSON.parse(fetchMock.mock.calls[0][1].body)
+    expect(calledBody).toEqual(body2)
+  })
+
+  it('does not coalesce writes for different devices', async () => {
+    const respBody = { status: 'ok' }
+    const fetchMock = vi.fn(async (url: string, opts: any) => ({ json: async () => respBody }))
+    ;(global as any).fetch = fetchMock
+
+    const c = new SwitchBotClient({ openApiToken: 't', writeDebounceMs: 10 } as any)
+    await c.init()
+
+    const p1 = c.setDeviceState('d-A', { command: 'a' })
+    const p2 = c.setDeviceState('d-B', { command: 'b' })
+
+    vi.advanceTimersByTime(20)
+    await Promise.resolve()
+    await Promise.resolve()
+
+    await Promise.all([p1, p2])
+
+    expect(fetchMock).toHaveBeenCalledTimes(2)
+    const b1 = JSON.parse(fetchMock.mock.calls[0][1].body)
+    const b2 = JSON.parse(fetchMock.mock.calls[1][1].body)
+    expect(b1).toEqual({ command: 'a' })
+    expect(b2).toEqual({ command: 'b' })
+  })
+
+  it('coalesces multiple rapid writes (three) and resolves all promises with last response', async () => {
+    const respBody = { status: 'ok', val: 'last' }
+    const fetchMock = vi.fn(async (url: string, opts: any) => ({ json: async () => respBody }))
+    ;(global as any).fetch = fetchMock
+
+    const c = new SwitchBotClient({ openApiToken: 't', writeDebounceMs: 10 } as any)
+    await c.init()
+
+    const p1 = c.setDeviceState('d-debounce', { command: 'one' })
+    const p2 = c.setDeviceState('d-debounce', { command: 'two' })
+    const p3 = c.setDeviceState('d-debounce', { command: 'three' })
+
+    vi.advanceTimersByTime(20)
+    await Promise.resolve()
+    await Promise.resolve()
+
+    const [r1, r2, r3] = await Promise.all([p1, p2, p3])
+    expect(r1).toEqual(respBody)
+    expect(r2).toEqual(respBody)
+    expect(r3).toEqual(respBody)
+
+    expect(fetchMock).toHaveBeenCalledTimes(1)
+    const calledBody = JSON.parse(fetchMock.mock.calls[0][1].body)
+    expect(calledBody).toEqual({ command: 'three' })
+  })
+
+  it('separate writes outside debounce window produce multiple network calls', async () => {
+    const respBody1 = { status: 'ok', seq: 1 }
+    const respBody2 = { status: 'ok', seq: 2 }
+    const fetchMock = vi.fn()
+      .mockImplementationOnce(async () => ({ json: async () => respBody1 }))
+      .mockImplementationOnce(async () => ({ json: async () => respBody2 }))
+    ;(global as any).fetch = fetchMock
+
+    const c = new SwitchBotClient({ openApiToken: 't', writeDebounceMs: 10 } as any)
+    await c.init()
+
+    const p1 = c.setDeviceState('d-debounce', { command: 'one' })
+    vi.advanceTimersByTime(20)
+    await Promise.resolve()
+    await Promise.resolve()
+
+    const p2 = c.setDeviceState('d-debounce', { command: 'two' })
+    vi.advanceTimersByTime(20)
+    await Promise.resolve()
+    await Promise.resolve()
+
+    const r1 = await p1
+    const r2 = await p2
+
+    expect(fetchMock).toHaveBeenCalledTimes(2)
+    const b1 = JSON.parse(fetchMock.mock.calls[0][1].body)
+    const b2 = JSON.parse(fetchMock.mock.calls[1][1].body)
+    expect(b1).toEqual({ command: 'one' })
+    expect(b2).toEqual({ command: 'two' })
+    expect(r1).toEqual(respBody1)
+    expect(r2).toEqual(respBody2)
+  })
+})

package/test/switchbot-client-openapi.spec.ts

@@ -0,0 +1,56 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
+import { SwitchBotClient } from '../src/switchbotClient'
+
+describe('SwitchBotClient OpenAPI fallback', () => {
+  let origFetch: any
+
+  beforeEach(() => {
+    origFetch = (global as any).fetch
+  })
+
+  afterEach(() => {
+    (global as any).fetch = origFetch
+    vi.restoreAllMocks()
+  })
+
+  it('throws when no client and no token', async () => {
+    const c = new SwitchBotClient({} as any)
+    await c.init()
+    await expect(c.getDevice('nope')).rejects.toThrow('No SwitchBot client available')
+  })
+
+  it('uses OpenAPI when token provided for getDevice', async () => {
+    const fakeResp = { body: { device: { id: 'd1', state: 'ok' } } }
+    const fetchMock = vi.fn(async (url: string, opts: any) => ({ json: async () => fakeResp }))
+    ;(global as any).fetch = fetchMock
+
+    const c = new SwitchBotClient({ openApiToken: 'token-123' } as any)
+    await c.init()
+    const res = await c.getDevice('d1')
+    expect(res).toEqual(fakeResp)
+    expect(fetchMock).toHaveBeenCalledWith('https://api.switch-bot.com/v1.0/devices/d1', { headers: { Authorization: 'token-123' } })
+  })
+
+  it('posts commands to OpenAPI for setDeviceState', async () => {
+    const respBody = { status: 'ok' }
+    const fetchMock = vi.fn(async (url: string, opts: any) => ({ json: async () => respBody }))
+    ;(global as any).fetch = fetchMock
+
+    const c = new SwitchBotClient({ openApiToken: 't' } as any)
+    await c.init()
+    const body = { command: 'turnOn', parameter: 'default', commandType: 'command' }
+    const out = await c.setDeviceState('d2', body)
+    expect(out).toEqual(respBody)
+    expect(fetchMock).toHaveBeenCalledWith('https://api.switch-bot.com/v1.0/devices/d2/commands', expect.objectContaining({ method: 'POST' }))
+    const calledBody = JSON.parse((fetchMock.mock.calls[0][1].body))
+    expect(calledBody).toEqual(body)
+  })
+
+  it('propagates fetch errors', async () => {
+    const fetchMock = vi.fn(async () => { throw new Error('network') })
+    ;(global as any).fetch = fetchMock
+    const c = new SwitchBotClient({ openApiToken: 't' } as any)
+    await c.init()
+    await expect(c.getDevice('x')).rejects.toThrow('network')
+  })
+})

package/test/switchbotClient.spec.ts

@@ -0,0 +1,10 @@
+import { describe, it, expect } from 'vitest'
+import { SwitchBotClient } from '../src/switchbotClient'
+
+describe('SwitchBotClient', () => {
+  it('init does not throw and getDevice throws when no token/client', async () => {
+    const c = new SwitchBotClient({})
+    await c.init()
+    await expect(c.getDevice('nope')).rejects.toThrow()
+  })
+})

package/test/utils.spec.ts

@@ -0,0 +1,36 @@
+import { describe, it, expect } from 'vitest'
+import { createPlatformProxy } from '../src/utils'
+
+describe('createPlatformProxy', () => {
+  it('returns Matter platform when preferMatter, enabled, and Matter API is available', () => {
+    class HAP {}
+    class Matter {}
+    const ProxyCtor: any = createPlatformProxy(HAP, Matter)
+    const api = {
+      isMatterAvailable: () => true,
+      isMatterEnabled: () => true,
+    }
+    const impl = new (ProxyCtor as any)(console, { preferMatter: true, enableMatter: true }, api)
+    expect(impl).toBeInstanceOf(Matter)
+  })
+
+  it('returns HAP platform when preferMatter is false', () => {
+    class HAP {}
+    class Matter {}
+    const ProxyCtor: any = createPlatformProxy(HAP, Matter)
+    const impl = new (ProxyCtor as any)(console, { preferMatter: false, enableMatter: true }, undefined)
+    expect(impl).toBeInstanceOf(HAP)
+  })
+
+  it('returns HAP platform when Matter API is unavailable', () => {
+    class HAP {}
+    class Matter {}
+    const ProxyCtor: any = createPlatformProxy(HAP, Matter)
+    const api = {
+      isMatterAvailable: () => false,
+      isMatterEnabled: () => false,
+    }
+    const impl = new (ProxyCtor as any)(console, { preferMatter: true, enableMatter: true }, api)
+    expect(impl).toBeInstanceOf(HAP)
+  })
+})