fix(#47): setting to configure retry attempts, setting to toggle debug logging, refactoring

Author: joeyhage

CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.3.2] - 2023-08-08
+
+### Added
+
+- New plugin setting for debug logging. This is helpful for troubleshooting issues and when requesting support.
+
+### Fixed
+
+- New plugin settings to enable and configure one automatic retry because some Wi-Fi enabled Spotify speakers cannot be found when attempting to start a playlist after a period of inactivity. (#47)
+
 ## [1.3.1] - 2023-04-29
 
 ### Changed
@@ -32,7 +42,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Change poblouin references to joeyhage since the old homebridge plugin is no longer maintained
 
-[unreleased]: https://github.com/joeyhage/homebridge-spotify-speaker/compare/v1.3.1...HEAD
+[unreleased]: https://github.com/joeyhage/homebridge-spotify-speaker/compare/v1.3.2...HEAD
+[1.3.2]: https://github.com/joeyhage/homebridge-spotify-speaker/compare/v1.3.1...v1.3.2
 [1.3.1]: https://github.com/joeyhage/homebridge-spotify-speaker/compare/v1.3.0...v1.3.1
 [1.3.0]: https://github.com/joeyhage/homebridge-spotify-speaker/compare/v1.2.4...v1.3.0
 [1.2.4]: https://github.com/joeyhage/homebridge-spotify-speaker/compare/v1.2.3...v1.2.4

README.md

@@ -95,7 +95,7 @@ Once the spotify authentication flow is done, the plugin will display the list o
 
 You can then take the `name` from the Spotify device that you want to control and this is what you put in the plugin's configuration as the `spotifyDeviceName`.
 
-This is the suggested option because the device id used by Spotify is prone to change.
+This is the suggested option because the device id used by Spotify has been known to change.
 
 ### Alternative option
 

config.schema.json

@@ -41,6 +41,27 @@
         "placeholder": "Get speaker status every __ seconds",
         "description": "Speaker status does not update live and must be fetched periodically. This is done every 20 seconds by default"
       },
+      "deviceNotFoundRetry": {
+        "type": "object",
+        "properties": {
+          "enable": {
+            "title": "Enable retry when 'device not found' errors occur",
+            "type": "boolean",
+            "required": false,
+            "default": false,
+            "description": "Wi-Fi enabled Spotify devices may disconnect from Spotify after a period of time causing device not found errors. This setting determines if the current operation (e.g. play/set volume) should be retried."
+          },
+          "retryDelay": {
+            "title": "Device not found retry delay milliseconds",
+            "type": "integer",
+            "default": 2000,
+            "minimum": 500,
+            "maximum": 10000,
+            "placeholder": "Retry operation after __ milliseconds if Spotify reports device was not found.",
+            "description": "Wi-Fi enabled Spotify devices may disconnect from Spotify after a period of time causing device not found errors. This setting determines how long to wait to allow the device to wake (reconnect to Spotify) before retrying once."
+          }
+        }
+      },
       "devices": {
         "type": "array",
         "items": {
@@ -95,6 +116,13 @@
             }
           }
         }
+      },
+      "debug": {
+        "title": "Debug logging",
+        "description": "Whether to enable debug logging for troubleshooting issues and support.",
+        "type": "boolean",
+        "required": false,
+        "default": false
       }
     }
   }

package-lock.json

@@ -1,7 +1,7 @@
 {
   "displayName": "Homebridge Spotify Speaker",
   "name": "homebridge-spotify-speaker",
-  "version": "1.3.2-beta.1",
+  "version": "1.3.1",
   "description": "Homebridge plugin that creates a speaker that plays a specific Spotify playlist",
   "license": "MIT",
   "author": "Joey Hage <contact@jmhage.com>",

package.json

@@ -10,60 +10,80 @@ import {
 import { URL } from 'url';
 import { PLATFORM_NAME, PLUGIN_NAME } from './settings';
 import { SpotifyApiWrapper } from './spotify-api-wrapper';
-import { HomebridgeSpotifySpeakerDevice, SpotifySpeakerAccessory } from './spotify-speaker-accessory';
+import { SpotifySpeakerAccessory } from './spotify-speaker-accessory';
+import type { HomebridgeSpotifySpeakerDevice } from './types';
+import { PluginLogger } from './plugin-logger';
 
 const DEVICE_CLASS_CONFIG_MAP = {
   speaker: SpotifySpeakerAccessory,
 };
 
-const DAY_INTERVAL = 60 * 60 * 24 * 1000;
+const DAY_INTERVAL_MS = 60 * 60 * 24 * 1000;
+const MINUTE_INTERVAL_MS = 60 * 1000;
+const DEFAULT_POLL_INTERVAL_S = 20;
 
 export class HomebridgeSpotifySpeakerPlatform implements DynamicPlatformPlugin {
   public readonly Service: typeof Service = this.api.hap.Service;
   public readonly Characteristic: typeof Characteristic = this.api.hap.Characteristic;
+  public readonly logger: PluginLogger;
   public readonly spotifyApiWrapper: SpotifyApiWrapper;
+  public readonly pollIntervalSec: number;
   public readonly accessories: {
     [uuid: string]: PlatformAccessory;
   } = {};
 
-  constructor(public readonly log: Logger, public readonly config: PlatformConfig, public readonly api: API) {
-    this.log.debug('Finished initializing platform:', this.config.name);
+  constructor(readonly log: Logger, public readonly config: PlatformConfig, public readonly api: API) {
+    this.logger = new PluginLogger(log, config);
+    this.logger.debug('Finished initializing platform:', this.config.name);
 
     if (!config.spotifyClientId || !config.spotifyClientSecret || !config.spotifyAuthCode) {
-      this.log.error('Missing configuration for this plugin to work, see the documentation for initial setup');
+      this.logger.error('Missing configuration for this plugin to work, see the documentation for initial setup');
       return;
     }
+    this.pollIntervalSec = config.spotifyPollInterval || DEFAULT_POLL_INTERVAL_S;
 
-    this.spotifyApiWrapper = new SpotifyApiWrapper(log, config, api);
+    this.spotifyApiWrapper = new SpotifyApiWrapper(this.logger, config, api);
 
     this.api.on('didFinishLaunching', async () => {
-      log.debug('Executed didFinishLaunching callback');
+      this.logger.debug('Executed didFinishLaunching callback');
 
       const isAuthenticated = await this.spotifyApiWrapper.authenticate();
       if (!isAuthenticated) {
         return;
       }
 
-      this.logAvailableSpotifyDevices();
+      await this.logAvailableSpotifyDevices();
+      await this.setSpotifyPlaybackState();
       this.discoverDevices();
+      if (Object.keys(this.accessories).length) {
+        setInterval(() => {
+          this.setSpotifyDevices();
+        }, MINUTE_INTERVAL_MS);
+
+        setInterval(() => {
+          this.setSpotifyPlaybackState();
+        }, this.pollIntervalSec * 1000);
+      }
     });
 
     // Make sure we have the latest tokens saved
     this.api.on('shutdown', () => {
       this.spotifyApiWrapper.persistTokens();
     });
 
-    setInterval(async () => await this.spotifyApiWrapper.refreshTokens(), DAY_INTERVAL);
+    setInterval(async () => await this.spotifyApiWrapper.refreshTokens(), DAY_INTERVAL_MS);
   }
 
   configureAccessory(accessory: PlatformAccessory) {
-    this.log.info('Loading accessory from cache:', accessory.displayName);
+    this.logger.info('Loading accessory from cache:', accessory.displayName);
     this.accessories[accessory.UUID] = accessory;
   }
 
   discoverDevices() {
     if (!this.config.devices) {
-      this.log.error('The "devices" section is missing in your plugin configuration, please add at least one device.');
+      this.logger.error(
+        'The "devices" section is missing in your plugin configuration, please add at least one device.',
+      );
       return;
     }
 
@@ -77,7 +97,7 @@ export class HomebridgeSpotifySpeakerPlatform implements DynamicPlatformPlugin {
         continue;
       }
       if (!this.deviceConfigurationIsValid(device)) {
-        this.log.error(
+        this.logger.error(
           `${
             device.deviceName ?? 'unknown device'
           } is not configured correctly. See the documentation for initial setup`,
@@ -95,13 +115,13 @@ export class HomebridgeSpotifySpeakerPlatform implements DynamicPlatformPlugin {
         existingAccessory ?? new this.api.platformAccessory(device.deviceName, uuid, deviceClass.CATEGORY);
       accessory.context.device = device;
       accessory.context.playlistId = playlistId;
-      new deviceClass(this, accessory, device, this.log);
+      new deviceClass(this, accessory, device, this.logger);
       activeAccessoryIds.push(uuid);
 
       if (existingAccessory) {
-        this.log.info('Restoring existing accessory from cache:', accessory.displayName);
+        this.logger.info('Restoring existing accessory from cache:', accessory.displayName);
       } else {
-        this.log.info('Adding new accessory:', device.deviceName);
+        this.logger.info('Adding new accessory:', device.deviceName);
         platformAccessories.push(accessory);
       }
     }
@@ -115,14 +135,32 @@ export class HomebridgeSpotifySpeakerPlatform implements DynamicPlatformPlugin {
       .map((id) => this.accessories[id]);
 
     staleAccessories.forEach((staleAccessory) => {
-      this.log.info(`Removing stale cached accessory ${staleAccessory.UUID} ${staleAccessory.displayName}`);
+      this.logger.info(`Removing stale cached accessory ${staleAccessory.UUID} ${staleAccessory.displayName}`);
     });
 
     if (staleAccessories.length) {
       this.api.unregisterPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, staleAccessories);
     }
   }
 
+  async setSpotifyDevices(): Promise<void> {
+    try {
+      const devices = await this.spotifyApiWrapper.getMyDevices();
+      SpotifySpeakerAccessory.DEVICES = devices;
+    } catch {
+      this.logger.error('Error setting spotify devices');
+    }
+  }
+
+  async setSpotifyPlaybackState(): Promise<void> {
+    try {
+      const state = await this.spotifyApiWrapper.getPlaybackState();
+      SpotifySpeakerAccessory.CURRENT_STATE = state?.body;
+    } catch {
+      this.logger.error('Error setting spotify playback state');
+    }
+  }
+
   private extractPlaylistId(playlistUrl: string): string | null {
     try {
       // Empty playlist ID is allowed for cases where one wants to only
@@ -133,11 +171,11 @@ export class HomebridgeSpotifySpeakerPlatform implements DynamicPlatformPlugin {
 
       const url = new URL(playlistUrl);
       const playlistId = url.pathname.split('/')[2];
-      this.log.debug(`Found playlistId: ${playlistId}`);
+      this.logger.debug(`Found playlistId: ${playlistId}`);
 
       return playlistId;
     } catch (error) {
-      this.log.error(
+      this.logger.error(
         `Failed to extract playlist ID, the plugin might behave in an unexpected way.
         Please check the configuration and provide a valid playlist URL`,
       );
@@ -148,22 +186,22 @@ export class HomebridgeSpotifySpeakerPlatform implements DynamicPlatformPlugin {
 
   private getDeviceConstructor(deviceType): typeof SpotifySpeakerAccessory | null {
     if (!deviceType) {
-      this.log.error('It is missing the `deviceType` in the configuration.');
+      this.logger.error('It is missing the `deviceType` in the configuration.');
       return null;
     }
 
     return DEVICE_CLASS_CONFIG_MAP[deviceType];
   }
 
   private async logAvailableSpotifyDevices(): Promise<void> {
-    const spotifyDevices = await this.spotifyApiWrapper.getMyDevices();
+    await this.setSpotifyDevices();
 
-    if (!spotifyDevices || spotifyDevices.length === 0) {
-      this.log.warn(
+    if (!SpotifySpeakerAccessory.DEVICES?.length) {
+      this.logger.warn(
         'No available spotify devices found, make sure that the speaker you configured is On and visible by Spotify Connect',
       );
     } else {
-      this.log.info('Available Spotify devices', spotifyDevices);
+      this.logger.info('Available Spotify devices', SpotifySpeakerAccessory.DEVICES);
     }
   }
 

src/global.d.ts

@@ -0,0 +1,24 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { Logger, PlatformConfig } from 'homebridge';
+
+export class PluginLogger {
+  constructor(private readonly log: Logger, private readonly config: PlatformConfig) {}
+
+  debug(message: string, ...parameters: any[]): void {
+    if (this.config.debug) {
+      this.log.info(message, ...parameters);
+    }
+  }
+
+  info(message: string, ...parameters: any[]): void {
+    this.log.info(message, ...parameters);
+  }
+
+  warn(message: string, ...parameters: any[]): void {
+    this.log.warn(message, ...parameters);
+  }
+
+  error(message: string, ...parameters: any[]): void {
+    this.log.error(message, ...parameters);
+  }
+}

src/platform.ts

@@ -1,4 +1,5 @@
-import { API, Logger, PlatformConfig } from 'homebridge';
+import { API, PlatformConfig } from 'homebridge';
+import type { PluginLogger } from './plugin-logger';
 import { SpotifyApiWrapper } from './spotify-api-wrapper';
 
 it('should authenticate and persist tokens', async () => {
@@ -39,11 +40,12 @@ it('should retrieve playback state', async () => {
 
 function getSpotifyApiWrapper(): SpotifyApiWrapper {
   return new SpotifyApiWrapper(
-    console as Logger,
+    console as unknown as PluginLogger,
     {
       spotifyAuthCode: process.env.SPOTIFY_AUTH_CODE!,
       spotifyClientId: process.env.SPOTIFY_CLIENT_ID!,
       spotifyClientSecret: process.env.SPOTIFY_CLIENT_SECRET!,
+      deviceNotFoundRetry: { enable: false },
     } as unknown as PlatformConfig,
     { user: { persistPath: () => '.' } } as API,
   );