fix: migrate PluginUpdate→HomebridgeUpdater via direct config.json read to fix scoped plugin upgrade clearing config

Agent-Logs-Url: https://github.com/homebridge-plugins/homebridge-updater/sessions/004aa914-1c4d-4972-92fa-b50c628f35dd

Co-authored-by: donavanbecker <9875439+donavanbecker@users.noreply.github.com>

Author: Copilot

CHANGELOG.md

@@ -4,6 +4,7 @@
 ### Bug Fixes
 
 * persist failureSensorType to JSON config by marking it required in schema ([#245](https://github.com/homebridge-plugins/homebridge-updater/issues/245)) ([accf14b](https://github.com/homebridge-plugins/homebridge-updater/commit/accf14b8343609b4534bdf9224d9866505dd056f))
+* fix scoped plugin upgrade clearing config: migrate `PluginUpdate` → `HomebridgeUpdater` by reading `config.json` directly instead of relying on the Homebridge UI API, which cannot return legacy platform entries for the new plugin name ([#246](https://github.com/homebridge-plugins/homebridge-updater/issues/246))
 
 
 

src/configMigration.test.ts

@@ -1,6 +1,13 @@
-import { describe, expect, it } from 'vitest'
+import { describe, expect, it, vi, beforeEach } from 'vitest'
 
-import { migratePlatformAliasInPluginConfigs } from './configMigration.js'
+// Mock node:fs before any imports that use it — vitest hoists vi.mock automatically.
+vi.mock('node:fs', () => ({
+  readFileSync: vi.fn(),
+  writeFileSync: vi.fn(),
+}))
+
+import * as fs from 'node:fs'
+import { migratePlatformAliasInPluginConfigs, migrateLegacyPlatformAlias } from './configMigration.js'
 
 describe('config migration', () => {
   it('should migrate legacy platform alias in plugin config entries', () => {
@@ -26,4 +33,117 @@ describe('config migration', () => {
     expect(updated).toBe(0)
     expect(pluginConfigs[0].platform).toBe('HomebridgeUpdater')
   })
+
+  it('should return 0 for a non-array input', () => {
+    expect(migratePlatformAliasInPluginConfigs(null as any)).toBe(0)
+    expect(migratePlatformAliasInPluginConfigs(undefined as any)).toBe(0)
+  })
+})
+
+describe('migrateLegacyPlatformAlias (direct file migration)', () => {
+  const FAKE_STORAGE = '/fake/homebridge'
+  const FAKE_CONFIG_PATH = `${FAKE_STORAGE}/config.json`
+
+  const readFileSyncMock = vi.mocked(fs.readFileSync)
+  const writeFileSyncMock = vi.mocked(fs.writeFileSync)
+
+  function makeApi(storagePath: string | undefined) {
+    return {
+      user: { storagePath: () => storagePath },
+    } as any
+  }
+
+  beforeEach(() => {
+    vi.clearAllMocks()
+  })
+
+  it('should do nothing when storagePath is missing', async () => {
+    await migrateLegacyPlatformAlias(makeApi(undefined))
+
+    expect(readFileSyncMock).not.toHaveBeenCalled()
+    expect(writeFileSyncMock).not.toHaveBeenCalled()
+  })
+
+  it('should migrate PluginUpdate → HomebridgeUpdater entries directly in config.json', async () => {
+    const originalConfig = {
+      bridge: { name: 'Homebridge', username: 'AA:BB:CC:DD:EE:FF', port: 51826 },
+      platforms: [
+        { platform: 'PluginUpdate', name: 'Plugin Update', checkPluginUpdates: true },
+        { platform: 'OtherPlugin', name: 'Other' },
+      ],
+    }
+
+    readFileSyncMock.mockReturnValue(JSON.stringify(originalConfig) as any)
+    writeFileSyncMock.mockImplementation(() => {})
+
+    await migrateLegacyPlatformAlias(makeApi(FAKE_STORAGE))
+
+    expect(writeFileSyncMock).toHaveBeenCalledTimes(1)
+    const [writtenPath, writtenData] = writeFileSyncMock.mock.calls[0] as [string, string, string]
+    expect(writtenPath).toBe(FAKE_CONFIG_PATH)
+
+    const written = JSON.parse(writtenData)
+    expect(written.platforms[0].platform).toBe('HomebridgeUpdater')
+    expect(written.platforms[0].name).toBe('Plugin Update')
+    expect(written.platforms[0].checkPluginUpdates).toBe(true)
+    // Unrelated platform entries must remain untouched
+    expect(written.platforms[1].platform).toBe('OtherPlugin')
+  })
+
+  it('should not write config.json when no legacy entries exist', async () => {
+    const currentConfig = {
+      bridge: { name: 'Homebridge', username: 'AA:BB:CC:DD:EE:FF', port: 51826 },
+      platforms: [
+        { platform: 'HomebridgeUpdater', name: 'Updater' },
+      ],
+    }
+
+    // readFileSync is called at least once (for config.json). Any extra calls (e.g. from
+    // the UiApi fallback path) should also not find legacy entries.
+    readFileSyncMock.mockReturnValue(JSON.stringify(currentConfig) as any)
+    writeFileSyncMock.mockImplementation(() => {})
+
+    await migrateLegacyPlatformAlias(makeApi(FAKE_STORAGE))
+
+    expect(writeFileSyncMock).not.toHaveBeenCalled()
+  })
+
+  it('should not throw when config.json cannot be read', async () => {
+    readFileSyncMock.mockImplementation(() => {
+      throw new Error('ENOENT: no such file')
+    })
+    writeFileSyncMock.mockImplementation(() => {})
+
+    await expect(migrateLegacyPlatformAlias(makeApi(FAKE_STORAGE))).resolves.toBeUndefined()
+    expect(writeFileSyncMock).not.toHaveBeenCalled()
+  })
+
+  it('should preserve all config fields (_bridge, etc.) when migrating', async () => {
+    const configWithBridge = {
+      bridge: { name: 'Homebridge', username: 'AA:BB:CC:DD:EE:FF', port: 51826 },
+      platforms: [
+        {
+          platform: 'PluginUpdate',
+          name: 'Plugin Update',
+          _bridge: { username: '11:22:33:44:55:66', port: 51828, name: 'Plugin Update Child Bridge' },
+          checkPluginUpdates: true,
+          autoUpdatePlugins: false,
+        },
+      ],
+    }
+
+    readFileSyncMock.mockReturnValue(JSON.stringify(configWithBridge) as any)
+    writeFileSyncMock.mockImplementation(() => {})
+
+    await migrateLegacyPlatformAlias(makeApi(FAKE_STORAGE))
+
+    expect(writeFileSyncMock).toHaveBeenCalledTimes(1)
+    const written = JSON.parse((writeFileSyncMock.mock.calls[0] as [string, string, string])[1])
+    const migratedPlatform = written.platforms[0]
+    expect(migratedPlatform.platform).toBe('HomebridgeUpdater')
+    // Child bridge config must be preserved intact
+    expect(migratedPlatform._bridge).toEqual(configWithBridge.platforms[0]._bridge)
+    expect(migratedPlatform.checkPluginUpdates).toBe(true)
+    expect(migratedPlatform.autoUpdatePlugins).toBe(false)
+  })
 })

src/configMigration.ts

@@ -1,4 +1,7 @@
-import type { API } from 'homebridge'
+import type { API, HomebridgeConfig } from 'homebridge'
+
+import { readFileSync, writeFileSync } from 'node:fs'
+import path from 'node:path'
 
 import { PLUGIN_NAME, PLATFORM_NAME } from './settings.js'
 import { UiApi } from './ui-api.js'
@@ -35,6 +38,32 @@ export async function migrateLegacyPlatformAlias(api: API): Promise<void> {
   }
 
   try {
+    // Primary approach: read config.json directly so that legacy 'PluginUpdate' entries
+    // are found and migrated regardless of which npm package name they were last saved
+    // under. This is required when upgrading from the old unscoped package
+    // (homebridge-plugin-update-check) or from a v2.x install where the platform alias
+    // was still 'PluginUpdate', because the Homebridge UI API only returns entries for
+    // the current plugin alias ('HomebridgeUpdater') and will return an empty array
+    // before the first migration completes.
+    const configPath = path.resolve(hbStoragePath, 'config.json')
+    let hbConfig: HomebridgeConfig | undefined
+    try {
+      hbConfig = JSON.parse(readFileSync(configPath, 'utf8')) as HomebridgeConfig
+    }
+    catch {
+      hbConfig = undefined
+    }
+
+    if (hbConfig?.platforms && Array.isArray(hbConfig.platforms)) {
+      const updatedDirect = migratePlatformAliasInPluginConfigs(hbConfig.platforms as Array<Record<string, unknown>>)
+      if (updatedDirect > 0) {
+        writeFileSync(configPath, JSON.stringify(hbConfig, null, 4), 'utf8')
+        return
+      }
+    }
+
+    // Fallback: use the UI API for cases where the direct file approach found nothing
+    // but the UI API may have additional context (e.g. partial earlier migration).
     const uiApi = new UiApi(hbStoragePath, silentLog as any)
     if (!uiApi.isConfigured()) {
       return
@@ -48,7 +77,8 @@ export async function migrateLegacyPlatformAlias(api: API): Promise<void> {
 
     await uiApi.updatePluginConfig(PLUGIN_NAME, pluginConfigs)
     await uiApi.savePluginConfig(PLUGIN_NAME)
-  } catch {
+  }
+  catch {
     // Ignore migration errors so plugin startup is never blocked.
   }
 }