Filter Out Disabled Update Notifications from Available Updates (#188)

Author: Copilot

src/ignore-plugins.test.ts

@@ -102,4 +102,45 @@ describe('Plugin Update Filtering', () => {
     expect(ignoredWithUpdates).toHaveLength(1)
     expect(ignoredWithUpdates[0].name).toBe('homebridge-plugin-ignored')
   })
+
+  it('should filter homebridge-config-ui-x when in ignore list', () => {
+    const mockPlugins = [
+      {
+        name: 'homebridge-config-ui-x',
+        installedVersion: '4.0.0',
+        latestVersion: '4.1.0',
+        updateAvailable: true,
+      },
+    ]
+
+    const ignoredPlugins = ['homebridge-config-ui-x']
+
+    // Test filtering homebridge-config-ui-x updates when ignored
+    const shouldFilterUI = ignoredPlugins.includes('homebridge-config-ui-x')
+    expect(shouldFilterUI).toBe(true)
+
+    // Simulate what would happen in the checkUi() method
+    const uiPlugin = mockPlugins.find(plugin => plugin.name === 'homebridge-config-ui-x')
+    const shouldAddUpdate = uiPlugin && uiPlugin.updateAvailable && !shouldFilterUI
+    expect(shouldAddUpdate).toBe(false)
+  })
+
+  it('should filter homebridge core updates when in ignore list', () => {
+    const mockHomebridge = {
+      name: 'homebridge',
+      installedVersion: '1.0.0',
+      latestVersion: '1.1.0',
+      updateAvailable: true,
+    }
+
+    const ignoredPlugins = ['homebridge']
+
+    // Test filtering homebridge core updates when ignored
+    const shouldFilterHomebridge = ignoredPlugins.includes('homebridge')
+    expect(shouldFilterHomebridge).toBe(true)
+
+    // Simulate what would happen in the checkUi() method
+    const shouldAddUpdate = mockHomebridge.updateAvailable && !shouldFilterHomebridge
+    expect(shouldAddUpdate).toBe(false)
+  })
 })

src/index.ts

@@ -170,50 +170,74 @@ class PluginUpdatePlatform implements DynamicPlatformPlugin {
 
     let logLevel = (this.firstDailyRun === true) ? LogLevel.INFO : LogLevel.DEBUG
     const updatesAvailable: InstalledPlugin[] = []
+    
+    // Get ignored plugins from API if respectDisabledPlugins is enabled
+    let ignoredPlugins: string[] = []
+    if (this.respectDisabledPlugins) {
+      try {
+        ignoredPlugins = await this.uiApi.getIgnoredPlugins()
+        this.log.debug(`Retrieved ${ignoredPlugins.length} ignored plugin(s) from homebridge-config-ui-x: ${ignoredPlugins.join(', ')}`)
+      } catch (error) {
+        this.log.warn(`Failed to retrieve ignored plugins list, filtering disabled: ${error}`)
+        ignoredPlugins = []
+      }
+    } else {
+      this.log.debug('respectDisabledPlugins is disabled, skipping plugin filtering')
+    }
 
     if (this.checkHB) {
       const homebridge = await this.uiApi.getHomebridge()
 
       if (homebridge.updateAvailable) {
-        updatesAvailable.push(homebridge)
+        // Check if homebridge core updates are ignored
+        const isIgnored = this.respectDisabledPlugins && ignoredPlugins.includes('homebridge')
+        
+        if (!isIgnored) {
+          updatesAvailable.push(homebridge)
 
-        const version: string = homebridge.latestVersion
+          const version: string = homebridge.latestVersion
 
-        if (this.hbUpdates.length === 0 || !this.hbUpdates.includes(version)) logLevel = LogLevel.INFO
-        this.log.log(logLevel, `Homebridge update available: ${version}`)
+          if (this.hbUpdates.length === 0 || !this.hbUpdates.includes(version)) logLevel = LogLevel.INFO
+          this.log.log(logLevel, `Homebridge update available: ${version}`)
 
-        this.hbUpdates = [version]
+          this.hbUpdates = [version]
+        } else {
+          this.log.debug(`Ignoring Homebridge core update: ${homebridge.latestVersion} (update notifications disabled in homebridge-config-ui-x)`)
+        }
       }
     }
 
     if (this.checkHBUI || this.checkPlugins) {
       const plugins = await this.uiApi.getPlugins()
-      let ignoredPlugins: string[] = []
-      
-      // Get ignored plugins from API if respectDisabledPlugins is enabled
-      if (this.respectDisabledPlugins) {
-        ignoredPlugins = await this.uiApi.getIgnoredPlugins()
-      }
 
       if (this.checkHBUI) {
         const homebridgeUiPlugins = plugins.filter(plugin => plugin.name === 'homebridge-config-ui-x')
 
         // Only one plugin is returned
         homebridgeUiPlugins.forEach((homebridgeUI) => {
           if (homebridgeUI.updateAvailable) {
-            updatesAvailable.push(homebridgeUI)
+            // Check if homebridge-config-ui-x updates are ignored
+            const isIgnored = this.respectDisabledPlugins && ignoredPlugins.includes('homebridge-config-ui-x')
+            
+            if (!isIgnored) {
+              updatesAvailable.push(homebridgeUI)
 
-            const version: string = homebridgeUI.latestVersion
+              const version: string = homebridgeUI.latestVersion
 
-            if (this.hbUIUpdates.length === 0 || !this.hbUIUpdates.includes(version)) logLevel = LogLevel.INFO
-            this.log.log(logLevel, `Homebridge UI update available: ${version}`)
+              if (this.hbUIUpdates.length === 0 || !this.hbUIUpdates.includes(version)) logLevel = LogLevel.INFO
+              this.log.log(logLevel, `Homebridge UI update available: ${version}`)
 
-            this.hbUIUpdates = [version]
+              this.hbUIUpdates = [version]
+            } else {
+              this.log.debug(`Ignoring Homebridge UI update: ${homebridgeUI.latestVersion} (update notifications disabled in homebridge-config-ui-x)`)
+            }
           }
         })
       }
 
       if (this.checkPlugins) {
+        this.log.debug(`Checking ${plugins.length} plugins for updates (respectDisabledPlugins: ${this.respectDisabledPlugins})`)
+        
         const filteredPlugins = plugins.filter(plugin => {
           // Always exclude homebridge-config-ui-x
           if (plugin.name === 'homebridge-config-ui-x') {
@@ -223,13 +247,16 @@ class PluginUpdatePlatform implements DynamicPlatformPlugin {
           // If respectDisabledPlugins is enabled, check API ignored list
           if (this.respectDisabledPlugins) {
             if (ignoredPlugins.includes(plugin.name)) {
+              this.log.debug(`Filtering out plugin ${plugin.name} (ignored in homebridge-config-ui-x)`)
               return false
             }
           }
 
           return true
         })
 
+        this.log.debug(`After filtering: ${filteredPlugins.length} plugins to check for updates`)
+
         filteredPlugins.forEach((plugin) => {
           if (plugin.updateAvailable) {
             updatesAvailable.push(plugin)
@@ -251,7 +278,7 @@ class PluginUpdatePlatform implements DynamicPlatformPlugin {
             ignoredPlugins.includes(plugin.name)
           )
           if (ignoredWithUpdates.length > 0) {
-            this.log.debug(`Ignoring updates for ${ignoredWithUpdates.length} plugin(s): ${ignoredWithUpdates.map(p => p.name).join(', ')}`)
+            this.log.info(`Ignoring updates for ${ignoredWithUpdates.length} plugin(s): ${ignoredWithUpdates.map(p => p.name).join(', ')}`)
           }
         }
       }
@@ -273,6 +300,15 @@ class PluginUpdatePlatform implements DynamicPlatformPlugin {
     }
 
     this.log.log(logLevel, `Found ${updatesAvailable.length} available update(s)`)
+    
+    // Provide additional diagnostic information in debug mode
+    if (this.respectDisabledPlugins && ignoredPlugins.length > 0) {
+      this.log.debug(`Filtering enabled with ${ignoredPlugins.length} ignored plugins: ${ignoredPlugins.join(', ')}`)
+    } else if (this.respectDisabledPlugins) {
+      this.log.debug('Filtering enabled but no ignored plugins found')
+    } else {
+      this.log.debug('Plugin filtering is disabled (respectDisabledPlugins: false)')
+    }
 
     return updatesAvailable.length
   }

src/ui-api.ts

@@ -122,12 +122,29 @@ export class UiApi {
   public async getIgnoredPlugins(): Promise<Array<string>> {
     if (this.isConfigured()) {
       try {
-        return await this.makeCall('/config-editor/ui/plugins/hide-updates-for') as Array<string>
-      } catch (error) {
-        this.log.warn(`Failed to retrieve ignored plugins list: ${error}`)
+        this.log.debug('Calling /config-editor/ui/plugins/hide-updates-for API endpoint')
+        const result = await this.makeCall('/config-editor/ui/plugins/hide-updates-for')
+        
+        // Validate the response format
+        if (!Array.isArray(result)) {
+          this.log.warn(`Unexpected response format from ignored plugins API: ${typeof result}, expected array`)
+          return []
+        }
+        
+        const ignoredPlugins = result as Array<string>
+        this.log.debug(`API returned ${ignoredPlugins.length} ignored plugins: ${ignoredPlugins.join(', ')}`)
+        return ignoredPlugins
+      } catch (error: any) {
+        // Check if it's a 404 error (API endpoint doesn't exist)
+        if (error?.response?.status === 404) {
+          this.log.warn('Ignored plugins API endpoint not found - requires homebridge-config-ui-x v5.6.2-beta.2 or later')
+        } else {
+          this.log.warn(`Failed to retrieve ignored plugins list from /config-editor/ui/plugins/hide-updates-for: ${error}`)
+        }
         return []
       }
     } else {
+      this.log.debug('homebridge-config-ui-x not configured, cannot retrieve ignored plugins list')
       return []
     }
   }